mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-01 20:52:50 +08:00
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.
Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
"no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
stream sets Done=true on an intermediate agent_query frame before the answer,
and AgentAccumulator treated the first Done as terminal. Terminate on the
`complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
including `doc upload --recursive` partial failures — a permanent per-file
failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
would loop on; per-item typed errors stay in the envelope.
Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
retrieval_ready, and kb create hints the fix when no embedding model is bound
— an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
(drift-guarded); output strings match the meta actually emitted; chunk list
and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
`link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
accept and ignore it, declared in schema) so a carried-over --kb doesn't
exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.
Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
(server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
model.update / kb.config.set) and batch example (failed item carries `error`);
session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
give an env-aware message instead of looping on "run auth login". `auth logout`
clears credentials but keeps the profile registered (host preserved for
re-login); deleting a profile is `profile remove`'s job (clean logout/remove
separation, matching gh / lark).
Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.
Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
171 lines
6.5 KiB
Go
171 lines
6.5 KiB
Go
package doc
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeCreateSvc captures call arguments and returns canned responses.
|
|
type fakeCreateSvc struct {
|
|
resp *sdk.Knowledge
|
|
err error
|
|
got struct {
|
|
kbID string
|
|
req *sdk.CreateManualKnowledgeRequest
|
|
}
|
|
}
|
|
|
|
func (f *fakeCreateSvc) CreateManualKnowledge(
|
|
_ context.Context,
|
|
kbID string,
|
|
req *sdk.CreateManualKnowledgeRequest,
|
|
) (*sdk.Knowledge, error) {
|
|
f.got.kbID = kbID
|
|
f.got.req = req
|
|
return f.resp, f.err
|
|
}
|
|
|
|
// TestCreate_TitleSetsRequestTitle: --title is the sole title flag and flows
|
|
// straight into the create request.
|
|
func TestCreate_TitleSetsRequestTitle(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "d1"}}
|
|
require.NoError(t, runCreate(context.Background(),
|
|
&CreateOptions{Text: "x", Title: "FromTitle"},
|
|
&cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb1"))
|
|
assert.Equal(t, "FromTitle", svc.got.req.Title)
|
|
}
|
|
|
|
func TestCreate_Success_Text(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_manual_1", Title: "Sprint Notes"}}
|
|
opts := &CreateOptions{Text: "# Sprint Notes\n\nAction items: ...", Title: "Sprint Notes"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
|
|
assert.Equal(t, "kb_xxx", svc.got.kbID)
|
|
assert.Equal(t, "# Sprint Notes\n\nAction items: ...", svc.got.req.Content)
|
|
assert.Equal(t, "Sprint Notes", svc.got.req.Title)
|
|
assert.Contains(t, out.String(), "Created")
|
|
assert.Contains(t, out.String(), "doc_manual_1")
|
|
}
|
|
|
|
func TestCreate_Success_NoName_FallsBackToTitle(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_manual_2", Title: "Server Title"}}
|
|
opts := &CreateOptions{Text: "Some content"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
// When --name is omitted the display falls back to k.Title from the server response.
|
|
assert.Contains(t, out.String(), "Server Title")
|
|
}
|
|
|
|
func TestCreate_Success_NoName_NoTitle_FallsBackToID(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_manual_3"}}
|
|
opts := &CreateOptions{Text: "Some content"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Contains(t, out.String(), "doc_manual_3")
|
|
}
|
|
|
|
func TestCreate_TagID_Forwarded(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_t"}}
|
|
opts := &CreateOptions{Text: "content", TagID: "tag_42"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "tag_42", svc.got.req.TagID)
|
|
}
|
|
|
|
func TestCreate_Channel_Override(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_ch"}}
|
|
opts := &CreateOptions{Text: "content", Channel: "browser_extension"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, "browser_extension", svc.got.req.Channel)
|
|
}
|
|
|
|
func TestCreate_Channel_DefaultIsAPI(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_ch"}}
|
|
opts := &CreateOptions{Text: "content"}
|
|
require.NoError(t, runCreate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx"))
|
|
assert.Equal(t, uploadChannel, svc.got.req.Channel)
|
|
}
|
|
|
|
func TestCreate_JSON_Envelope(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "doc_manual_json", Title: "My Note"}}
|
|
opts := &CreateOptions{Text: "# My Note", Title: "My Note"}
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}
|
|
require.NoError(t, runCreate(context.Background(), opts, fopts, svc, "kb_xxx"))
|
|
|
|
got := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data sdk.Knowledge `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal([]byte(got), &env), "expected valid JSON envelope, got %q", got)
|
|
assert.True(t, env.OK, "envelope.ok must be true")
|
|
assert.Equal(t, "doc_manual_json", env.Data.ID, "envelope.data.id must match")
|
|
}
|
|
|
|
func TestCreate_ServerError_Wraps(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{err: errors.New("HTTP error 500: internal server error")}
|
|
err := runCreate(context.Background(),
|
|
&CreateOptions{Text: "content"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
|
|
}
|
|
|
|
func TestCreate_HTTPError_400_Wraps(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeCreateSvc{err: errors.New("HTTP error 400: bad request")}
|
|
err := runCreate(context.Background(),
|
|
&CreateOptions{Text: "content"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
}
|
|
|
|
func TestCreate_EmptyText_RejectsBeforeSDK(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
// The SDK should never be called when --text is empty (runCreate has a
|
|
// defensive guard; cobra's MarkFlagRequired catches it earlier in RunE).
|
|
svc := &fakeCreateSvc{resp: &sdk.Knowledge{ID: "should-not-reach"}}
|
|
err := runCreate(context.Background(),
|
|
&CreateOptions{Text: ""}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "kb_xxx")
|
|
require.Error(t, err)
|
|
// Verify the SDK was NOT called.
|
|
assert.Nil(t, svc.got.req, "SDK must not be called when --text is empty")
|
|
}
|
|
|
|
// TestCreate_AgentHelp_EmitsUsedFor verifies that when WEKNORA_AGENT_HELP=1
|
|
// the `doc create --help` path emits a JSON blob containing "used_for".
|
|
// This is the representative test for 3.2; the mechanism is covered by
|
|
// internal/cmdutil/agenthelp_test.go — we test the wiring here.
|
|
func TestCreate_AgentHelp_EmitsUsedFor(t *testing.T) {
|
|
t.Setenv("WEKNORA_AGENT_HELP", "1")
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
f := &cmdutil.Factory{}
|
|
cmd := NewCmdCreate(f)
|
|
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.HelpFunc()(cmd, nil)
|
|
|
|
assert.Contains(t, buf.String(), `"used_for"`)
|
|
}
|