mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-03 06:24:15 +08:00
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
106 lines
3.7 KiB
Go
106 lines
3.7 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestClassifyHTTPError(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
err error
|
|
want ErrorCode
|
|
}{
|
|
{"nil", nil, ""},
|
|
{"non-HTTP transport", errors.New("dial tcp: lookup host: no such host"), CodeNetworkError},
|
|
{"401", fmt.Errorf("HTTP error 401: invalid token"), CodeAuthUnauthenticated},
|
|
{"403", fmt.Errorf("HTTP error 403: forbidden"), CodeAuthForbidden},
|
|
{"404", fmt.Errorf("HTTP error 404: kb not found"), CodeResourceNotFound},
|
|
{"409", fmt.Errorf("HTTP error 409: already exists"), CodeResourceAlreadyExists},
|
|
{"429", fmt.Errorf("HTTP error 429: slow down"), CodeServerRateLimited},
|
|
{"500", fmt.Errorf("HTTP error 500: internal"), CodeServerError},
|
|
{"503", fmt.Errorf("HTTP error 503: unavailable"), CodeServerError},
|
|
{"400 generic", fmt.Errorf("HTTP error 400: bad input"), CodeInputInvalidArgument},
|
|
{"422 unprocessable", fmt.Errorf("HTTP error 422: validation"), CodeInputInvalidArgument},
|
|
{"malformed status", fmt.Errorf("HTTP error abc: oops"), CodeServerError},
|
|
{"missing colon", fmt.Errorf("HTTP error 404 no colon"), CodeServerError},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
assert.Equal(t, tc.want, ClassifyHTTPError(tc.err))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestClassifyHTTPError_500NotFoundRescue(t *testing.T) {
|
|
// Server's 1003 = ErrNotFound is the only typed "not found" code we
|
|
// rescue. 1007 = ErrInternalServer is the catch-all bucket — its
|
|
// presence around a "not found"-shaped message reflects a server-side
|
|
// classification gap, not an authoritative not-found signal, so we
|
|
// must NOT silently re-route it.
|
|
err := fmt.Errorf("HTTP error 500: %s", `{"error":{"code":1003,"message":"Knowledge not found"},"success":false}`)
|
|
if got := ClassifyHTTPError(err); got != CodeResourceNotFound {
|
|
t.Errorf("expected resource.not_found rescue for code 1003; got %v", got)
|
|
}
|
|
}
|
|
|
|
// TestClassifyHTTPError_500GenericCode_StaysServerError pins the round-9
|
|
// finding: code 1007 is server's generic ErrInternalServer bucket
|
|
// (validation errors, DB failures, etc.), NOT a not-found signal. Even
|
|
// when its message text contains "not found", rescuing it would mis-route
|
|
// e.g. a 10k-char KB name (SQLSTATE 22001) as resource.not_found.
|
|
func TestClassifyHTTPError_500GenericCode_StaysServerError(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
body string
|
|
}{
|
|
{
|
|
name: "code 1007 with 'not found' in message",
|
|
body: `HTTP error 500: {"error":{"code":1007,"message":"knowledge base not found"},"success":false}`,
|
|
},
|
|
{
|
|
name: "code 1007 with SQLSTATE",
|
|
body: `HTTP error 500: {"error":{"code":1007,"message":"value too long for type character varying(255) (SQLSTATE 22001)"},"success":false}`,
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
err := fmt.Errorf("%s", tc.body)
|
|
if got := ClassifyHTTPError(err); got != CodeServerError {
|
|
t.Errorf("expected server.error for generic code 1007; got %v", got)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestClassifyHTTPError_500Generic_StaysServerError(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
body string
|
|
}{
|
|
{
|
|
name: "generic 500",
|
|
body: "HTTP error 500: internal server error",
|
|
},
|
|
{
|
|
name: "config file not found in stack trace",
|
|
body: "HTTP error 500: panic: config file not found in /etc/app/config.yaml",
|
|
},
|
|
{
|
|
name: "not found substring without server code",
|
|
body: `HTTP error 500: {"message":"something not found","other":true}`,
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
err := fmt.Errorf("%s", tc.body)
|
|
if got := ClassifyHTTPError(err); got != CodeServerError {
|
|
t.Errorf("expected server.error for generic 500; got %v", got)
|
|
}
|
|
})
|
|
}
|
|
}
|