mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-02 22:02:16 +08:00
nullkey
d3c03b2f34
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.
82 lines
3.4 KiB
Go
82 lines
3.4 KiB
Go
package modelcmd
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
"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"
|
|
)
|
|
|
|
// fakeUpdateSvc scripts GetModel (fetch baseline) and captures the
|
|
// UpdateModelRequest so tests can assert the surgical overlay.
|
|
type fakeUpdateSvc struct {
|
|
cur *sdk.Model
|
|
gotReq *sdk.UpdateModelRequest
|
|
gotID string
|
|
}
|
|
|
|
func (f *fakeUpdateSvc) GetModel(_ context.Context, _ string) (*sdk.Model, error) {
|
|
return f.cur, nil
|
|
}
|
|
|
|
func (f *fakeUpdateSvc) UpdateModel(_ context.Context, id string, req *sdk.UpdateModelRequest) (*sdk.Model, error) {
|
|
f.gotID = id
|
|
f.gotReq = req
|
|
return &sdk.Model{ID: id, Name: req.Name, DisplayName: req.DisplayName, Parameters: req.Parameters, IsDefault: req.IsDefault}, nil
|
|
}
|
|
|
|
func baseModel() *sdk.Model {
|
|
return &sdk.Model{
|
|
ID: "mdl_x", Name: "keep-name", DisplayName: "old", Description: "olddesc",
|
|
Parameters: sdk.ModelParameters{"base_url": "http://old", "api_key": "SECRET-OLD", "provider": "generic"},
|
|
IsDefault: false,
|
|
}
|
|
}
|
|
|
|
// TestModelUpdate_SurgicalOverlay: only touched fields change; the rest (name,
|
|
// description, existing params) round-trip from the fetched baseline.
|
|
func TestModelUpdate_SurgicalOverlay(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeUpdateSvc{cur: baseModel()}
|
|
opts := &UpdateOptions{DisplayName: "new-display", flags: modelUpdateFlags{displayName: true}}
|
|
require.NoError(t, runUpdate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "mdl_x", nil))
|
|
|
|
require.NotNil(t, svc.gotReq)
|
|
assert.Equal(t, "mdl_x", svc.gotID, "id preserved (in-place update)")
|
|
assert.Equal(t, "new-display", svc.gotReq.DisplayName, "display-name overlaid")
|
|
assert.Equal(t, "keep-name", svc.gotReq.Name, "untouched name round-trips")
|
|
assert.Equal(t, "olddesc", svc.gotReq.Description, "untouched description round-trips")
|
|
assert.Equal(t, "http://old", svc.gotReq.Parameters["base_url"], "untouched params round-trip")
|
|
assert.Equal(t, "SECRET-OLD", svc.gotReq.Parameters["api_key"], "existing key preserved when not rotating")
|
|
}
|
|
|
|
// TestModelUpdate_RotateKeyAndBaseURL: --api-key-stdin + --base-url overlay the
|
|
// parameters map; the new key comes from stdin, never argv.
|
|
func TestModelUpdate_RotateKeyAndBaseURL(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeUpdateSvc{cur: baseModel()}
|
|
opts := &UpdateOptions{
|
|
BaseURL: "http://new", APIKeyStdin: true,
|
|
StdinReader: strings.NewReader("NEW-KEY\n"),
|
|
flags: modelUpdateFlags{baseURL: true},
|
|
}
|
|
require.NoError(t, runUpdate(context.Background(), opts, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "mdl_x", nil))
|
|
assert.Equal(t, "http://new", svc.gotReq.Parameters["base_url"])
|
|
assert.Equal(t, "NEW-KEY", svc.gotReq.Parameters["api_key"], "rotated key read from stdin")
|
|
}
|
|
|
|
// TestModelUpdate_RequiresAtLeastOneFlag: a bare `model update <id>` is rejected
|
|
// before any network call, matching agent update.
|
|
func TestModelUpdate_RequiresAtLeastOneFlag(t *testing.T) {
|
|
assert.False(t, modelUpdateHasFlag(&UpdateOptions{}))
|
|
assert.True(t, modelUpdateHasFlag(&UpdateOptions{flags: modelUpdateFlags{displayName: true}}))
|
|
assert.True(t, modelUpdateHasFlag(&UpdateOptions{APIKeyStdin: true}))
|
|
assert.True(t, modelUpdateHasFlag(&UpdateOptions{Params: []string{"k=v"}}))
|
|
}
|