Files
Enterprise-Knowledge-Base/cli/internal/output/ndjson_stream_test.go
T
nullkey 2ce348d020 feat(cli): --format json default + NDJSON event stream + context→profile cascade + help calibration + docs (BREAKING)
D1 — --format default flipped to json regardless of TTY:
- v0.6: smart default (text on TTY, json on pipe).
- v0.7: always json; TTY only affects indent (compact in pipe). Enum
  values unchanged (text | json | ndjson).
- Typed FormatMode enum replaces untyped string consts.
- --format / --jq promoted to persistent root flags so unknown-
  subcommand paths still reach the typed-envelope guard (per-command
  registration in v0.6 would have rejected --format on unknown
  commands as cobra-prose exit 2).
- WEKNORA_FORMAT env var added; precedence --format > env > default.
  Invalid env values silently ignored.

D2 — chat / session ask default to NDJSON event-stream:
- New cli/internal/output/ndjson_stream.go: InitEvent struct +
  EmitInit / EmitSDKEvent / WriteNDJSONLine helpers. EmitInit doc
  encodes the must-be-first-line invariant agents key on.
- chat / session ask: --format json AND --format ndjson both emit one
  JSON event per line (no envelope wrapping). CLI injects exactly one
  `init` event at stream head carrying session_id + optional kb_id /
  agent_id / profile. Subsequent events pass through verbatim from the
  SDK (passthrough discipline per spec §5.1).
- --format text keeps the SSE-style live renderer.

context → profile full cascade:
- Command group: cli/cmd/context/ → cli/cmd/profile/ (git mv;
  package contextcmd → profilecmd).
- Global flag --context → --profile. Factory.ContextOverride →
  ProfileOverride. WEKNORA_PROFILE env var honored
  (--profile flag > env > config.CurrentContext). When --profile or
  WEKNORA_PROFILE references a missing profile, the error is
  input.invalid_argument with hint "weknora profile list" — not the
  destructive local.config_corrupt path (which would have told users
  to delete their config file).
- Binding file .weknora/project.yaml field context: → profile:
  (no backwards-compat alias; re-run weknora link).
- profile use JSON fields current_context / previous_context →
  current_profile / previous_profile.
- weknora link JSON field context → profile.
- CodeLocalContextNotFound → CodeLocalProfileNotFound (typed code
  rename).
- Envelope top-level profile field populated via globalProfile (set
  by root PersistentPreRunE from Factory.ActiveProfile). chat /
  session ask NDJSON init event carries the same profile.
- Rationale: "context" collided with LLM context window / RAG context
  / Go context.Context; mainstream multi-credential CLIs (AWS /
  Stripe / OpenAI / Anthropic / lark) all use "profile".

H2/C1' help calibration:
- AgentHelp gains Warnings []string; single SetAgentHelp helper
  routes on WEKNORA_AGENT_HELP=1 (emits JSON blob including
  warnings) vs human help (appends "AI agents:" block from same
  source). Warnings surface as both a structured JSON field and
  visible help-text addendum without drift.
- 9 destructive commands carry warnings: kb / doc / agent / session /
  chunk delete; profile remove; kb / agent edit; auth logout.
- weknora doc wait dedups ids at entry; SIGINT mid-wait returns
  silently (root signal handler maps to exit 130) instead of being
  miscategorised as operation.timeout / operation.failed.

A4 — docs:
- cli/AGENTS.md gains four agent-facing sections: Wire contract for
  AI agents (stdout / stderr / NDJSON / _notice evolution / SDK
  contract boundary); Deliberate deviations + mainstream alignments;
  Pre-1.0 breaking policy; Exit-10 anti-patterns. ERROR_REFERENCE
  table extended.
- cli/README.md adds Agent quick start under Wire contract.
- cli/CHANGELOG.md v0.7 section: BREAKING entries with migration
  notes, Added (WEKNORA_FORMAT / WEKNORA_PROFILE / retry_command /
  retry_after_seconds / risk / _notice reserved infra / meta.count /
  meta.has_more / doc fetch / doc create / session ask / doc delete
  --all / NDJSON init), Changed (docs additions), Deprecated (none —
  pre-release one-shot breaking).

Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3 / §4 / §5 / §6 / §11
2026-05-27 10:56:34 +08:00

75 lines
2.2 KiB
Go

package output_test
import (
"bytes"
"encoding/json"
"strings"
"testing"
"github.com/Tencent/WeKnora/cli/internal/output"
)
func TestEmitInit_ForcesTypeField(t *testing.T) {
var buf bytes.Buffer
// Pass an InitEvent with Type deliberately set to something wrong; EmitInit
// must overwrite it with "init".
ev := output.InitEvent{Type: "wrong", SessionID: "sess_x"}
if err := output.EmitInit(&buf, ev); err != nil {
t.Fatalf("EmitInit: %v", err)
}
var got struct {
Type string `json:"type"`
SessionID string `json:"session_id"`
}
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
t.Fatalf("unmarshal: %v\n%s", err, buf.String())
}
if got.Type != "init" {
t.Errorf("type: got %q, want init", got.Type)
}
if got.SessionID != "sess_x" {
t.Errorf("session_id: got %q, want sess_x", got.SessionID)
}
}
func TestEmitInit_OmitsEmptyOptionalFields(t *testing.T) {
var buf bytes.Buffer
// Only SessionID set; all optional fields should be absent from JSON.
ev := output.InitEvent{SessionID: "sess_only"}
if err := output.EmitInit(&buf, ev); err != nil {
t.Fatalf("EmitInit: %v", err)
}
line := buf.String()
for _, field := range []string{"kb_id", "agent_id", "model", "profile", "request_id"} {
if strings.Contains(line, `"`+field+`"`) {
t.Errorf("optional field %q should be omitted when empty, got: %s", field, line)
}
}
}
func TestEmitSDKEvent_PassthroughVerbatim(t *testing.T) {
var buf bytes.Buffer
payload := map[string]any{"type": "answer", "content": "hi"}
if err := output.EmitSDKEvent(&buf, payload); err != nil {
t.Fatalf("EmitSDKEvent: %v", err)
}
var got map[string]any
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
t.Fatalf("unmarshal: %v\n%s", err, buf.String())
}
if got["type"] != "answer" {
t.Errorf("type: got %v, want answer", got["type"])
}
if got["content"] != "hi" {
t.Errorf("content: got %v, want hi", got["content"])
}
// Must be a single NDJSON line terminated by newline.
raw := buf.String()
if !strings.HasSuffix(raw, "\n") {
t.Errorf("NDJSON line must end with newline, got %q", raw)
}
if strings.Count(raw, "\n") != 1 {
t.Errorf("expected exactly one newline, got %d in %q", strings.Count(raw, "\n"), raw)
}
}