mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-03 22:43:26 +08:00
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
183 lines
6.8 KiB
Go
183 lines
6.8 KiB
Go
package sessioncmd
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"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"
|
|
)
|
|
|
|
// fakeViewService scripts a GetSession + LoadMessages response.
|
|
type fakeViewService struct {
|
|
s *sdk.Session
|
|
err error
|
|
gotID string
|
|
msgs []sdk.Message
|
|
msgsErr error
|
|
loadCall struct {
|
|
sessionID string
|
|
limit int
|
|
called bool
|
|
}
|
|
}
|
|
|
|
func (f *fakeViewService) GetSession(_ context.Context, id string) (*sdk.Session, error) {
|
|
f.gotID = id
|
|
return f.s, f.err
|
|
}
|
|
|
|
func (f *fakeViewService) LoadMessages(_ context.Context, sessionID string, limit int, _ *time.Time) ([]sdk.Message, error) {
|
|
f.loadCall.called = true
|
|
f.loadCall.sessionID = sessionID
|
|
f.loadCall.limit = limit
|
|
return f.msgs, f.msgsErr
|
|
}
|
|
|
|
func TestView_Text(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{
|
|
ID: "s_abc",
|
|
Title: "Design review",
|
|
Description: "RAG chunking strategy review",
|
|
CreatedAt: "2026-05-10T09:00:00Z",
|
|
UpdatedAt: "2026-05-12T14:00:00Z",
|
|
}}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s_abc"))
|
|
got := out.String()
|
|
for _, want := range []string{"s_abc", "Design review", "RAG chunking strategy review", "2026-05-12"} {
|
|
assert.Contains(t, got, want)
|
|
}
|
|
assert.Equal(t, "s_abc", svc.gotID)
|
|
}
|
|
|
|
func TestView_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{ID: "s_abc", Title: "T", UpdatedAt: "2026-05-12T14:00:00Z"}}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "s_abc"))
|
|
|
|
body := out.String()
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data sdk.Session `json:"data"`
|
|
}
|
|
require.NoError(t, json.Unmarshal([]byte(body), &env), "expected valid JSON envelope; got %q", body)
|
|
assert.True(t, env.OK, "envelope.ok must be true")
|
|
assert.Equal(t, "s_abc", env.Data.ID, "envelope.data.id must be s_abc")
|
|
}
|
|
|
|
func TestView_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeViewService{err: errors.New("HTTP error 404: not found")}
|
|
err := runView(context.Background(), &ViewOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s_missing")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func TestView_OmitsEmptyDescription(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{ID: "s_min", Title: "Bare"}}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s_min"))
|
|
// Empty Description should not produce an empty `DESC:` line.
|
|
for line := range strings.SplitSeq(out.String(), "\n") {
|
|
if strings.HasPrefix(line, "DESC:") {
|
|
t.Errorf("empty description should be omitted, found %q", line)
|
|
}
|
|
}
|
|
}
|
|
|
|
// --- --full / --limit tests ---
|
|
|
|
func TestView_Full_LoadsMessages(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{
|
|
s: &sdk.Session{ID: "s_abc", Title: "Chat"},
|
|
msgs: []sdk.Message{
|
|
{ID: "m1", Role: "user", Content: "What is RAG?", CreatedAt: time.Date(2026, 5, 15, 14, 32, 0, 0, time.UTC)},
|
|
{ID: "m2", Role: "assistant", Content: "RAG stands for retrieval-augmented generation.", CreatedAt: time.Date(2026, 5, 15, 14, 32, 5, 0, time.UTC)},
|
|
},
|
|
}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{Full: true, Limit: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s_abc"))
|
|
got := out.String()
|
|
assert.True(t, svc.loadCall.called, "expected LoadMessages to be called")
|
|
assert.Equal(t, "s_abc", svc.loadCall.sessionID)
|
|
assert.Equal(t, 50, svc.loadCall.limit)
|
|
for _, want := range []string{"Messages (2)", "[user]", "[assistant]", "What is RAG?", "retrieval-augmented generation"} {
|
|
assert.Contains(t, got, want)
|
|
}
|
|
}
|
|
|
|
func TestView_Full_NoMessages(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{
|
|
s: &sdk.Session{ID: "s_empty", Title: "Empty"},
|
|
msgs: []sdk.Message{},
|
|
}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{Full: true, Limit: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s_empty"))
|
|
got := out.String()
|
|
assert.Contains(t, got, "Messages (0)")
|
|
}
|
|
|
|
func TestView_Full_LimitInvalid_Zero(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{ID: "s"}}
|
|
err := runView(context.Background(), &ViewOptions{Full: true, Limit: 0}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s")
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
func TestView_Full_LimitInvalid_TooLarge(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{ID: "s"}}
|
|
err := runView(context.Background(), &ViewOptions{Full: true, Limit: 1001}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s")
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
// --limit without --full is rejected with input.invalid_argument — same
|
|
// pattern as `--title` requires `--from-url` in `doc upload`.
|
|
func TestView_LimitWithoutFull(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{ID: "s"}}
|
|
err := runView(context.Background(), &ViewOptions{Full: false, Limit: 100, LimitSet: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, "s")
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
assert.Contains(t, err.Error(), "--limit")
|
|
assert.Contains(t, err.Error(), "--full")
|
|
}
|
|
|
|
func TestView_Full_JSON_HasMessages(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{
|
|
s: &sdk.Session{ID: "s_abc", Title: "T"},
|
|
msgs: []sdk.Message{
|
|
{ID: "m1", Role: "user", Content: "hi"},
|
|
},
|
|
}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{Full: true, Limit: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "s_abc"))
|
|
body := out.String()
|
|
assert.Contains(t, body, `"messages":`)
|
|
assert.Contains(t, body, `"id":"m1"`)
|
|
assert.Contains(t, body, `"role":"user"`)
|
|
}
|
|
|
|
// Without --full, the LoadMessages SDK call must not fire and the JSON
|
|
// payload must not contain a `messages` key.
|
|
func TestView_NoFull_DoesNotCallLoadMessages(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewService{s: &sdk.Session{ID: "s_abc"}}
|
|
require.NoError(t, runView(context.Background(), &ViewOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc, "s_abc"))
|
|
assert.False(t, svc.loadCall.called, "LoadMessages must not be called without --full")
|
|
assert.NotContains(t, out.String(), `"messages":`)
|
|
}
|