mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-29 02:04:30 +08:00
nullkey
733bb3aaa1
Re-introduce the agent-first symmetric envelope deleted in commite623e820(2026-05-15). Under the v0.7 constraint that AI agents are primary consumers, the bare-JSON shape can't carry protocol channels (_notice / risk / meta / request_id / profile) that agents need. Errors-on-stderr and typed exit codes frome623e820are preserved; the envelope wraps the success/error payloads on top. - cli/internal/output/envelope.go (new): Envelope / ErrorEnvelope / Meta / ErrDetail / RiskDetail structs; WriteEnvelope + WriteErrorEnvelope writers; PendingNotice plumbing for the open-map _notice channel (reserved infra; producer wiring planned for v0.8). - cli/internal/output/envelope_test.go (new): 7 tests covering success / error / TTY indent / Notice / Risk shapes. - cmdutil.Error extended with RetryCommand (directly-executable argv distinct from prose Hint), RetryAfterSeconds (HTTP Retry-After), *RiskInfo (nested level+action; ErrInternalServer- vs-NotFound distinction), Detail (open structured payload), Silent (suppress stderr emit while preserving Code for ExitCode). - ErrorToDetail single source of envelope.error construction; reused by stderr PrintError, MCP StructuredContent, and batch per-item error path. - WithHint / WithRetryCommand / WithRetryAfter / WithDetail / WithRisk builders. IsCancelled helper. AsError unwrap helper. - defaultHint covers ~21 codes; defaultRetryCommand symmetric counterpart for 6 keyway codes. DefaultHint / DefaultRetryCommand exported wrappers for cross-package callers. - ClassifyHTTPError tightened: rescues HTTP 500 with structured server-side code 1003 (ErrNotFound) into resource.not_found. Server's generic 1007 (ErrInternalServer) bucket stays as server.error — including it would mis-route validation failures (e.g. SQLSTATE 22001) as not-found. - PrintError dual-mode: text/human → prose with code:msg / hint / retry lines; json/ndjson → envelope on stderr. Mode pinned by root PersistentPreRunE via SetFormatMode. resolveFormatEarly() scans argv before cobra dispatch so cobra-side validators (unknown flag, arg-count) still surface as envelope when --format json is in effect. Silent typed errors short-circuit the stderr emit. FlagError mapped to input.invalid_argument for the envelope (exit code stays 2 via FlagError class). - Unknown-subcommand guard installed recursively at the root: parents with subcommands but no Run/RunE get a typed RunE that emits input.unknown_subcommand envelope with detail.{unknown, command_path, available[]} and retry_command "<parent> --help". cobra.ArbitraryArgs bypasses legacyArgs validation so the guard receives unmatched argv. - cmdutil.Error.Error() returns "<code>: <message>[: <cause>]" for chain debugging; ErrorToDetail strips the code prefix from envelope.message since the separate type field carries it (prevents the doubled-prefix "code: code: ..." that agents would see). Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §0 / §4
32 lines
902 B
Go
32 lines
902 B
Go
package cmdutil
|
|
|
|
import (
|
|
"testing"
|
|
)
|
|
|
|
func TestErrorToDetail_NilSafe(t *testing.T) {
|
|
if got := ErrorToDetail(nil); got != nil {
|
|
t.Errorf("ErrorToDetail(nil) should return nil; got %v", got)
|
|
}
|
|
}
|
|
|
|
func TestError_WithRetryCommand(t *testing.T) {
|
|
err := NewError(CodeAuthUnauthenticated, "session expired").
|
|
WithHint("run `weknora auth login`").
|
|
WithRetryCommand("weknora auth login --host https://kb.example.com")
|
|
|
|
if err.RetryCommand != "weknora auth login --host https://kb.example.com" {
|
|
t.Errorf("RetryCommand not set; got %q", err.RetryCommand)
|
|
}
|
|
if err.Hint != "run `weknora auth login`" {
|
|
t.Errorf("Hint changed unexpectedly; got %q", err.Hint)
|
|
}
|
|
}
|
|
|
|
func TestError_RetryCommand_EmptyByDefault(t *testing.T) {
|
|
err := NewError(CodeResourceAlreadyExists, "kb name exists")
|
|
if err.RetryCommand != "" {
|
|
t.Errorf("RetryCommand should default empty; got %q", err.RetryCommand)
|
|
}
|
|
}
|