mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-02 05:03:00 +08:00
Batch-write surface and pagination consistency:
* weknora doc delete <doc-id> [<doc-id>...] — positional multi-id, default
keep-going on failure. Single -y confirms entire batch.
* weknora session delete <session-id> [<session-id>...] — same shape.
* weknora chunk delete <chunk-id> [<chunk-id>...] --doc <doc-id> — multi-id
with shared --doc parent.
* Multi-id partial-failure rolls up as operation.failed (exit 1), not
server.error (exit 7) — failures are operation outcomes, not transient
transport issues, and the retry-with-backoff hint for server.* would
mislead callers.
* weknora api <path> --paginate — auto-walks offset pagination and merges
pages into a single {data, total} JSON response.
* Paginate truncation fix across 6 list/follower call sites.
* All doc / search / chunk / session / kb list commands migrated to
FormatOptions API.
Multi-id RunE only emits the {ok, failed} envelope when the operation
actually ran — pre-flight failures (e.g. confirmation_required) leave
stdout empty per the wire contract.
doc upload's missing-positional-or-flag check is wrapped as FlagError so
the exit code (2) matches the convention used by other commands that
require a positional argument directly.
432 lines
15 KiB
Go
432 lines
15 KiB
Go
package api
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeAPISvc is a test double for Service that delegates each call to a
|
|
// caller-supplied do function, giving full control over per-call responses.
|
|
type fakeAPISvc struct {
|
|
do func(method, path string, body any) (*http.Response, error)
|
|
}
|
|
|
|
func (f *fakeAPISvc) Raw(_ context.Context, method, path string, body any) (*http.Response, error) {
|
|
return f.do(method, path, body)
|
|
}
|
|
|
|
// newTestClient stands up an httptest server with the supplied handler and
|
|
// returns an *sdk.Client targeting it plus a teardown closure. The real SDK is
|
|
// used so we exercise the same Raw() code path as production (header
|
|
// injection, JSON marshalling, etc.).
|
|
func newTestClient(t *testing.T, h http.HandlerFunc) (*sdk.Client, func()) {
|
|
t.Helper()
|
|
srv := httptest.NewServer(h)
|
|
return sdk.NewClient(srv.URL), srv.Close
|
|
}
|
|
|
|
func TestAPI_GetSuccess(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodGet || r.URL.Path != "/api/v1/foo" {
|
|
t.Errorf("unexpected request: %s %s", r.Method, r.URL.Path)
|
|
}
|
|
w.Header().Set("Content-Type", "application/json")
|
|
_, _ = w.Write([]byte(`{"hello":"world"}`))
|
|
})
|
|
defer stop()
|
|
|
|
if err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "GET", "/api/v1/foo", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
got := out.String()
|
|
if !strings.Contains(got, `"hello":"world"`) {
|
|
t.Errorf("expected raw JSON body in stdout, got %q", got)
|
|
}
|
|
if !strings.HasSuffix(got, "\n") {
|
|
t.Errorf("expected trailing newline appended, got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestAPI_GetSuccess_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.Header().Set("X-Request-Id", "req-123")
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"value":42}`))
|
|
})
|
|
defer stop()
|
|
|
|
if err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, cli, "GET", "/api/v1/foo", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
var got struct {
|
|
Status int `json:"status"`
|
|
Headers map[string]string `json:"headers"`
|
|
Body map[string]any `json:"body"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &got); err != nil {
|
|
t.Fatalf("decode bare JSON: %v\n%s", err, out.String())
|
|
}
|
|
if got.Status != 200 {
|
|
t.Errorf("status: want 200, got %d", got.Status)
|
|
}
|
|
if got.Headers["Content-Type"] != "application/json" {
|
|
t.Errorf("Content-Type header missing: %v", got.Headers)
|
|
}
|
|
if v, ok := got.Body["value"]; !ok || v.(float64) != 42 {
|
|
t.Errorf("body.value: want 42, got %v", got.Body)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PostWithData(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
var seenBody []byte
|
|
var seenMethod, seenPath string
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenMethod = r.Method
|
|
seenPath = r.URL.Path
|
|
seenBody, _ = io.ReadAll(r.Body)
|
|
w.Header().Set("Content-Type", "application/json")
|
|
_, _ = w.Write([]byte(`{"id":"new"}`))
|
|
})
|
|
defer stop()
|
|
|
|
opts := &Options{Data: `{"name":"foo"}`}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "POST", "/api/v1/things", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if seenMethod != http.MethodPost || seenPath != "/api/v1/things" {
|
|
t.Errorf("server saw %s %s, want POST /api/v1/things", seenMethod, seenPath)
|
|
}
|
|
// SDK marshals body via json.Marshal; json.RawMessage round-trips
|
|
// verbatim so the bytes server-side equal the --data argument.
|
|
if string(seenBody) != `{"name":"foo"}` {
|
|
t.Errorf("server received body %q, want %q", seenBody, `{"name":"foo"}`)
|
|
}
|
|
}
|
|
|
|
// TestAPI_InputFile verifies --input <file> reads the request body from disk.
|
|
func TestAPI_InputFile(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
tmp := filepath.Join(t.TempDir(), "body.json")
|
|
payload := `{"k":"from-file"}`
|
|
if err := os.WriteFile(tmp, []byte(payload), 0o600); err != nil {
|
|
t.Fatalf("write temp: %v", err)
|
|
}
|
|
var seenBody []byte
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenBody, _ = io.ReadAll(r.Body)
|
|
_, _ = w.Write([]byte(`{}`))
|
|
})
|
|
defer stop()
|
|
|
|
opts := &Options{Input: tmp}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "POST", "/api/v1/x", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if string(seenBody) != payload {
|
|
t.Errorf("body from --input: got %q, want %q", seenBody, payload)
|
|
}
|
|
}
|
|
|
|
// TestAPI_InputDash_Stdin verifies the "--input -" form: the payload comes
|
|
// from opts.StdinReader (production-default iostreams.IO.In).
|
|
func TestAPI_InputDash_Stdin(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
var seenBody []byte
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
seenBody, _ = io.ReadAll(r.Body)
|
|
_, _ = w.Write([]byte(`{}`))
|
|
})
|
|
defer stop()
|
|
|
|
payload := `{"k":"from-stdin"}`
|
|
opts := &Options{Input: "-", StdinReader: strings.NewReader(payload)}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "POST", "/api/v1/x", false); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if string(seenBody) != payload {
|
|
t.Errorf("body from --input -: got %q, want %q", seenBody, payload)
|
|
}
|
|
}
|
|
|
|
func TestAPI_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusNotFound)
|
|
_, _ = w.Write([]byte(`{"error":"missing"}`))
|
|
})
|
|
defer stop()
|
|
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, cli, "GET", "/api/v1/missing", false)
|
|
if err == nil {
|
|
t.Fatal("expected error for 404")
|
|
}
|
|
if !cmdutil.IsNotFound(err) {
|
|
t.Errorf("expected resource.not_found, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestAPI_InvalidMethod(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
// No server needed: validation should fail before dispatch.
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, nil, "FOO", "/api/v1/things", false)
|
|
if err == nil {
|
|
t.Fatal("expected error for unsupported method")
|
|
}
|
|
var ce *cmdutil.Error
|
|
if !asTypedError(err, &ce) || ce.Code != cmdutil.CodeInputInvalidArgument {
|
|
t.Errorf("expected input.invalid_argument, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PathWithoutSlash(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
err := runAPI(context.Background(), &Options{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, nil, "GET", "api/v1/things", false)
|
|
if err == nil {
|
|
t.Fatal("expected error for missing leading slash")
|
|
}
|
|
var ce *cmdutil.Error
|
|
if !asTypedError(err, &ce) || ce.Code != cmdutil.CodeInputInvalidArgument {
|
|
t.Errorf("expected input.invalid_argument, got %v", err)
|
|
}
|
|
}
|
|
|
|
// withRootHarness wraps `weknora api ...` under a synthetic root cmd that
|
|
// registers the global `-y/--yes` persistent flag (mirrors addGlobalFlags in
|
|
// cmd/root.go). Required because api's NewCmd doesn't register --yes itself
|
|
// - it inherits from root in production.
|
|
func withRootHarness(api *cobra.Command, args ...string) *cobra.Command {
|
|
root := &cobra.Command{Use: "weknora"}
|
|
root.PersistentFlags().BoolP("yes", "y", false, "")
|
|
root.AddCommand(api)
|
|
root.SetArgs(append([]string{"api"}, args...))
|
|
root.SetContext(context.Background())
|
|
root.SilenceErrors = true
|
|
root.SilenceUsage = true
|
|
return root
|
|
}
|
|
|
|
// TestAPI_DELETE_RequiresConfirmation pins the exit-10 protocol on the
|
|
// escape-hatch DELETE path: agent invokes `weknora api DELETE /...` without
|
|
// -y/--yes, must get input.confirmation_required + exit 10. Confirmation is
|
|
// enforced in NewCmd.RunE (not runAPI), so the test drives the cobra cmd.
|
|
func TestAPI_DELETE_RequiresConfirmation(t *testing.T) {
|
|
iostreams.SetForTest(t) // non-TTY
|
|
f := &cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
Prompter: func() prompt.Prompter { return prompt.AgentPrompter{} },
|
|
}
|
|
root := withRootHarness(NewCmd(f), "/api/v1/knowledge-bases/kb_xxx", "-X", "DELETE")
|
|
err := root.Execute()
|
|
if err == nil {
|
|
t.Fatal("expected confirmation_required error for DELETE without -y")
|
|
}
|
|
var ce *cmdutil.Error
|
|
if !asTypedError(err, &ce) || ce.Code != cmdutil.CodeInputConfirmationRequired {
|
|
t.Errorf("want input.confirmation_required, got %v", err)
|
|
}
|
|
if got := cmdutil.ExitCode(err); got != 10 {
|
|
t.Errorf("exit code = %d, want 10", got)
|
|
}
|
|
}
|
|
|
|
// TestAPI_DELETE_WithYes_Proceeds: -y/--yes opt-in skips confirmation and
|
|
// dispatches to the SDK. Server returns 200 to verify the happy-path lands
|
|
// on the response body emit.
|
|
func TestAPI_DELETE_WithYes_Proceeds(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
called := false
|
|
cli, stop := newTestClient(t, func(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodDelete {
|
|
t.Errorf("expected DELETE, got %s", r.Method)
|
|
}
|
|
called = true
|
|
w.WriteHeader(http.StatusOK)
|
|
})
|
|
defer stop()
|
|
f := &cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return cli, nil },
|
|
Prompter: func() prompt.Prompter { return prompt.AgentPrompter{} },
|
|
}
|
|
root := withRootHarness(NewCmd(f), "/api/v1/knowledge-bases/kb_xxx", "-X", "DELETE", "-y")
|
|
if err := root.Execute(); err != nil {
|
|
t.Fatalf("execute: %v", err)
|
|
}
|
|
if !called {
|
|
t.Error("DELETE handler not called - confirmation may have blocked")
|
|
}
|
|
}
|
|
|
|
// asTypedError is a tiny wrapper around errors.As that keeps the call sites
|
|
// concise. Returns true on success, populating dst.
|
|
func asTypedError(err error, dst **cmdutil.Error) bool {
|
|
for e := err; e != nil; {
|
|
if t, ok := e.(*cmdutil.Error); ok {
|
|
*dst = t
|
|
return true
|
|
}
|
|
type unwrapper interface{ Unwrap() error }
|
|
u, ok := e.(unwrapper)
|
|
if !ok {
|
|
return false
|
|
}
|
|
e = u.Unwrap()
|
|
}
|
|
return false
|
|
}
|
|
|
|
func TestAPI_PaginateMergesPages(t *testing.T) {
|
|
pages := [][]byte{
|
|
[]byte(`{"success":true,"data":[{"id":"1"},{"id":"2"}],"total":5,"page":1,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"3"},{"id":"4"}],"total":5,"page":2,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"5"}],"total":5,"page":3,"page_size":2}`),
|
|
}
|
|
idx := 0
|
|
svc := &fakeAPISvc{do: func(method, path string, _ any) (*http.Response, error) {
|
|
if idx >= len(pages) {
|
|
return nil, fmt.Errorf("too many calls; idx=%d", idx)
|
|
}
|
|
body := pages[idx]
|
|
idx++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader(body)),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
opts := &Options{}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "GET", "/api/v1/knowledge-base?page=1&page_size=2", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
var got struct {
|
|
Data []map[string]string `json:"data"`
|
|
Total int `json:"total"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &got); err != nil {
|
|
t.Fatalf("unmarshal: %v\n%s", err, out.String())
|
|
}
|
|
if len(got.Data) != 5 || got.Total != 5 {
|
|
t.Errorf("got %d records (total %d), want 5/5", len(got.Data), got.Total)
|
|
}
|
|
if idx != 3 {
|
|
t.Errorf("called %d times, want 3", idx)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PaginateIgnoredForPOST(t *testing.T) {
|
|
// --paginate should be a no-op for non-GET methods (no pagination
|
|
// semantic for POST/PUT/DELETE). Single call expected.
|
|
called := 0
|
|
svc := &fakeAPISvc{do: func(method, path string, _ any) (*http.Response, error) {
|
|
called++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader([]byte(`{"success":true,"data":[],"total":5,"page":1,"page_size":2}`))),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
opts := &Options{Data: `{"name":"foo"}`}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "POST", "/api/v1/knowledge-base", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if called != 1 {
|
|
t.Errorf("called %d times, want 1 (POST should not paginate)", called)
|
|
}
|
|
}
|
|
|
|
func TestAPI_PaginateNoMetadataPassesThrough(t *testing.T) {
|
|
// If response doesn't look paginated (no total/page/page_size), --paginate
|
|
// should fall back to single-call behavior (don't crash).
|
|
called := 0
|
|
svc := &fakeAPISvc{do: func(method, path string, _ any) (*http.Response, error) {
|
|
called++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader([]byte(`{"hello":"world"}`))),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
opts := &Options{}
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "GET", "/api/v1/whoami", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
if called != 1 {
|
|
t.Errorf("called %d times, want 1 (non-paginated response)", called)
|
|
}
|
|
}
|
|
|
|
// TestAPI_PaginateServerCapsPageSize covers the case where the user
|
|
// requests --page_size=50 but the server caps page_size at a smaller
|
|
// value (e.g. 2). Termination must count actually-collected records
|
|
// (len(allData)) not requested-page-count (page*pageSize) — otherwise
|
|
// we'd break early and silently truncate results.
|
|
func TestAPI_PaginateServerCapsPageSize(t *testing.T) {
|
|
// User asks page_size=10; server only ever returns 2 per page (cap).
|
|
// Total = 5 records; should make 3 calls (2+2+1) and return all 5.
|
|
pages := [][]byte{
|
|
[]byte(`{"success":true,"data":[{"id":"1"},{"id":"2"}],"total":5,"page":1,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"3"},{"id":"4"}],"total":5,"page":2,"page_size":2}`),
|
|
[]byte(`{"success":true,"data":[{"id":"5"}],"total":5,"page":3,"page_size":2}`),
|
|
}
|
|
idx := 0
|
|
svc := &fakeAPISvc{do: func(_, _ string, _ any) (*http.Response, error) {
|
|
if idx >= len(pages) {
|
|
return nil, fmt.Errorf("too many calls; idx=%d", idx)
|
|
}
|
|
body := pages[idx]
|
|
idx++
|
|
return &http.Response{
|
|
StatusCode: 200,
|
|
Body: io.NopCloser(bytes.NewReader(body)),
|
|
Header: make(http.Header),
|
|
}, nil
|
|
}}
|
|
var stdout bytes.Buffer
|
|
iostreams.IO.Out = &stdout
|
|
defer func() { iostreams.IO.Out = os.Stdout }()
|
|
|
|
opts := &Options{}
|
|
// User requests page_size=10; server caps at 2 each response.
|
|
if err := runAPI(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "GET", "/api/v1/items?page=1&page_size=10", true); err != nil {
|
|
t.Fatalf("runAPI: %v", err)
|
|
}
|
|
var got struct {
|
|
Data []map[string]string `json:"data"`
|
|
Total int `json:"total"`
|
|
}
|
|
if err := json.Unmarshal(stdout.Bytes(), &got); err != nil {
|
|
t.Fatalf("unmarshal: %v\n%s", err, stdout.String())
|
|
}
|
|
if len(got.Data) != 5 {
|
|
t.Errorf("got %d records, want 5 (server-capped page_size should not cause truncation)", len(got.Data))
|
|
}
|
|
}
|