e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
93 lines
3.5 KiB
Go
93 lines
3.5 KiB
Go
// Package sse provides helpers for consuming server-sent event streams from
|
|
// the WeKnora SDK (KnowledgeQAStream, ContinueStream).
|
|
//
|
|
// Accumulator is the canonical sink: every callback event appends to a
|
|
// buffered Content string and updates terminal-state fields like References
|
|
// and SessionID. The non-streaming JSON mode reads .Result() once .Done()
|
|
// is true; streaming mode writes Content tokens directly to stdout and
|
|
// only consults the accumulator for the final References footer.
|
|
package sse
|
|
|
|
import (
|
|
"strings"
|
|
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// Accumulator buffers a KnowledgeQAStream callback sequence.
|
|
//
|
|
// Zero value is ready to use. Not safe for concurrent Append calls — the SDK
|
|
// invokes its callback sequentially on a single goroutine, so this matches
|
|
// the only contract that exists today.
|
|
//
|
|
// Demuxes by ResponseType so the answer string is not polluted by thinking
|
|
// or reflection fragments — the model layer (internal/models/chat/
|
|
// remote_api.go) emits ResponseTypeThinking events whenever the upstream
|
|
// LLM produces reasoning_content (GPT-5 / Claude extended thinking), and
|
|
// without demux those would be silently concatenated into Result().
|
|
type Accumulator struct {
|
|
answer strings.Builder
|
|
thinking strings.Builder
|
|
References []*sdk.SearchResult
|
|
SessionID string
|
|
AssistantMessageID string
|
|
finished bool
|
|
}
|
|
|
|
// Append consumes one StreamResponse event. Safe to call multiple times;
|
|
// idempotent post-Done so callers do not need to special-case late events.
|
|
func (a *Accumulator) Append(r *sdk.StreamResponse) {
|
|
if r == nil || a.finished {
|
|
return
|
|
}
|
|
switch r.ResponseType {
|
|
case sdk.ResponseTypeAnswer:
|
|
if r.Content != "" {
|
|
a.answer.WriteString(r.Content)
|
|
}
|
|
case sdk.ResponseTypeThinking, sdk.ResponseTypeReflection:
|
|
if r.Content != "" {
|
|
a.thinking.WriteString(r.Content)
|
|
}
|
|
default:
|
|
// Frames without a typed ResponseType (legacy / metadata-only
|
|
// payloads) that still carry an answer fragment fall through here.
|
|
// Preserve the legacy contract by treating untyped Content as
|
|
// answer text.
|
|
if r.ResponseType == "" && r.Content != "" {
|
|
a.answer.WriteString(r.Content)
|
|
}
|
|
}
|
|
if r.SessionID != "" && a.SessionID == "" {
|
|
a.SessionID = r.SessionID
|
|
}
|
|
if r.AssistantMessageID != "" && a.AssistantMessageID == "" {
|
|
a.AssistantMessageID = r.AssistantMessageID
|
|
}
|
|
// Capture references whenever they arrive — they may land on a
|
|
// dedicated `references` event before the terminal `complete`.
|
|
if r.KnowledgeReferences != nil {
|
|
a.References = r.KnowledgeReferences
|
|
}
|
|
// Stream is only truly done on response_type=complete. Other events
|
|
// (notably the leading agent_query metadata frame) carry done=true to
|
|
// mark their own per-event completion, but the answer fragments arrive
|
|
// in subsequent response_type=answer events. Gating on response_type
|
|
// avoids the off-by-one termination that would discard the entire
|
|
// answer.
|
|
if r.ResponseType == sdk.ResponseTypeComplete {
|
|
a.finished = true
|
|
}
|
|
}
|
|
|
|
// Done reports whether a terminal event was observed.
|
|
func (a *Accumulator) Done() bool { return a.finished }
|
|
|
|
// Result returns the accumulated answer-event content.
|
|
func (a *Accumulator) Result() string { return a.answer.String() }
|
|
|
|
// Thinking returns the accumulated reasoning / reflection content surfaced
|
|
// by the upstream LLM (only populated when the active model produces
|
|
// reasoning_content). Empty for non-reasoning models.
|
|
func (a *Accumulator) Thinking() string { return a.thinking.String() }
|