Files
Enterprise-Knowledge-Base/cli/cmd/session/resume_test.go
T
nullkey d3c03b2f34 feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening
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.
2026-07-06 22:53:01 +08:00

218 lines
8.4 KiB
Go

package sessioncmd
import (
"bytes"
"context"
"encoding/json"
"errors"
"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"
)
// scriptedResumeSvc serves a canned stream of StreamResponse events
// to runResume and records the (sessionID, messageID) passed in.
type scriptedResumeSvc struct {
events []*sdk.StreamResponse
streamErr error
got struct {
sessionID string
messageID string
}
}
func (s *scriptedResumeSvc) ContinueStream(_ context.Context, sessionID, messageID string, cb func(*sdk.StreamResponse) error) error {
s.got.sessionID = sessionID
s.got.messageID = messageID
for _, e := range s.events {
if err := cb(e); err != nil {
return err
}
}
return s.streamErr
}
func contStreamAnswer(content string) *sdk.StreamResponse {
return &sdk.StreamResponse{ResponseType: sdk.ResponseTypeAnswer, Content: content}
}
func contStreamComplete() *sdk.StreamResponse {
return &sdk.StreamResponse{ResponseType: sdk.ResponseTypeComplete, Done: true}
}
// TestContinueStream_NDJSON_FirstLineIsInitWithMessageID verifies the
// CLI-injected init line carries both session_id and message_id, so agents
// can key dedupe tables on the resumed message before the first SDK frame
// arrives.
func TestContinueStream_NDJSON_FirstLineIsInitWithMessageID(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &scriptedResumeSvc{
events: []*sdk.StreamResponse{contStreamAnswer("hello"), contStreamComplete()},
}
opts := &ResumeOptions{SessionID: "sess_xyz", MessageID: "msg_abc"}
require.NoError(t, runResume(context.Background(), opts, ndjsonOpts(), svc))
lines := strings.Split(strings.TrimRight(out.String(), "\n"), "\n")
require.GreaterOrEqual(t, len(lines), 1, "expected at least the init line")
var first struct {
Type string `json:"type"`
SessionID string `json:"session_id"`
MessageID string `json:"message_id"`
}
require.NoError(t, json.Unmarshal([]byte(lines[0]), &first), "first line must be valid JSON: %q", lines[0])
assert.Equal(t, "init", first.Type)
assert.Equal(t, "sess_xyz", first.SessionID)
assert.Equal(t, "msg_abc", first.MessageID, "init.message_id must echo --message (anchor for dedupe)")
}
// TestContinueStream_NDJSON_PassthroughEvents verifies: 1 init line + N SDK
// events = N+1 total lines, all valid JSON.
func TestContinueStream_NDJSON_PassthroughEvents(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &scriptedResumeSvc{
events: []*sdk.StreamResponse{
contStreamAnswer("alpha"),
contStreamAnswer("beta"),
contStreamComplete(),
},
}
opts := &ResumeOptions{SessionID: "sess_x", MessageID: "msg_y"}
require.NoError(t, runResume(context.Background(), opts, ndjsonOpts(), svc))
lines := strings.Split(strings.TrimRight(out.String(), "\n"), "\n")
// 1 init + 3 SDK events = 4 lines.
require.Equal(t, 4, len(lines), "expected init + 3 SDK events:\n%s", out.String())
for i, line := range lines {
var obj map[string]any
assert.NoError(t, json.Unmarshal([]byte(line), &obj), "line %d not valid JSON: %q", i+1, line)
}
}
// TestContinueStream_PassesSessionAndMessageIDToSDK verifies the args + flag
// flow through to the SDK call.
func TestContinueStream_PassesSessionAndMessageIDToSDK(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &scriptedResumeSvc{events: []*sdk.StreamResponse{contStreamComplete()}}
opts := &ResumeOptions{SessionID: "sess_42", MessageID: "msg_99"}
require.NoError(t, runResume(context.Background(), opts, ndjsonOpts(), svc))
assert.Equal(t, "sess_42", svc.got.sessionID)
assert.Equal(t, "msg_99", svc.got.messageID)
}
// TestContinueStream_EmptySessionID_Rejected guards the direct-test entry
// point (cobra blocks empty positional via ExactArgs(1), but the runtime
// core must also refuse empty strings).
func TestContinueStream_EmptySessionID_Rejected(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &scriptedResumeSvc{}
opts := &ResumeOptions{SessionID: "", MessageID: "msg_x"}
err := runResume(context.Background(), opts, ndjsonOpts(), svc)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
}
// TestContinueStream_EmptyMessageID_Rejected guards the direct-test entry
// point.
func TestContinueStream_EmptyMessageID_Rejected(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &scriptedResumeSvc{}
opts := &ResumeOptions{SessionID: "sess_x", MessageID: ""}
err := runResume(context.Background(), opts, ndjsonOpts(), svc)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
}
// TestContinueStream_Cancellation_MapsToOperationCancelled verifies a
// cancelled context maps to operation.cancelled (Ctrl-C lineage).
func TestContinueStream_Cancellation_MapsToOperationCancelled(t *testing.T) {
_, _ = iostreams.SetForTest(t)
ctx, cancel := context.WithCancel(context.Background())
cancel()
svc := &scriptedResumeSvc{streamErr: context.Canceled}
opts := &ResumeOptions{SessionID: "sess_x", MessageID: "msg_x"}
err := runResume(ctx, opts, ndjsonOpts(), svc)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeOperationCancelled, typed.Code)
}
// TestContinueStream_NotFound_MapsToResourceNotFound verifies an SDK 404
// (e.g. unknown message_id, or buffer expired past TTL) is classified by
// the canonical HTTP classifier.
func TestContinueStream_NotFound_MapsToResourceNotFound(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &scriptedResumeSvc{streamErr: errors.New("HTTP error 404: not found")}
opts := &ResumeOptions{SessionID: "sess_x", MessageID: "msg_missing"}
err := runResume(context.Background(), opts, ndjsonOpts(), svc)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
}
// TestResume_TerminalStreamError_MapsToServerError pins that a terminal SSE
// error frame (surfaced by the SDK as *SSEStreamError) classifies as
// server.error (exit 7) — the SAME as chat / session ask. Guards against the
// prior inconsistency where resume reported the identical server condition as
// exit 1 while chat/ask reported exit 7.
func TestResume_TerminalStreamError_MapsToServerError(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &scriptedResumeSvc{streamErr: sdk.NewSSEStreamError("no chat model configured")}
opts := &ResumeOptions{SessionID: "sess_x", MessageID: "msg_x"}
err := runResume(context.Background(), opts, ndjsonOpts(), svc)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
}
// TestContinueStream_RequiresMessageFlag verifies cobra refuses to run the
// command without --message (the flag is marked required).
func TestContinueStream_RequiresMessageFlag(t *testing.T) {
f := &cmdutil.Factory{}
cmd := NewCmdResume(f)
var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.SetErr(&buf)
cmd.SetArgs([]string{"sess_xyz"}) // positional only, no --message
err := cmd.Execute()
require.Error(t, err, "expected required-flag error when --message is missing")
assert.True(t,
strings.Contains(err.Error(), "message") || strings.Contains(err.Error(), "required"),
"error should mention the required --message flag: %v", err)
// Note: cobra's bare required-flag error here is not yet wrapped as
// FlagError - that mapping happens in cmd/root.go for top-level Execute.
// Asserting the message text is sufficient for this unit-level check;
// exit-code mapping is covered by cmd/root tests.
}
// TestContinueStream_RequiresSessionIDArg verifies cobra refuses to run the
// command without the positional <session-id>.
func TestContinueStream_RequiresSessionIDArg(t *testing.T) {
f := &cmdutil.Factory{}
cmd := NewCmdResume(f)
var buf bytes.Buffer
cmd.SetOut(&buf)
cmd.SetErr(&buf)
cmd.SetArgs([]string{"--message", "msg_abc"}) // missing positional
err := cmd.Execute()
require.Error(t, err, "expected ExactArgs(1) error when <session-id> is missing")
// Cobra reports "accepts 1 arg(s), received 0" — assert on substance,
// not exit-code mapping (the latter happens in cmd/root, see
// TestContinueStream_RequiresMessageFlag note).
assert.True(t,
strings.Contains(err.Error(), "arg") || strings.Contains(err.Error(), "received"),
"error should mention arg-count: %v", err)
}