mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-03 06:24:15 +08:00
nullkey
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.
57 lines
1.6 KiB
Go
57 lines
1.6 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestExitCode(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
err error
|
|
want int
|
|
}{
|
|
{"nil success", nil, 0},
|
|
{"flag error", NewFlagError(errors.New("bad flag")), 2},
|
|
{"silent", SilentError, 1},
|
|
{"auth.* prefix", NewError(CodeAuthUnauthenticated, "x"), 3},
|
|
{"auth.token_expired", NewError(CodeAuthTokenExpired, "x"), 3},
|
|
{"resource.not_found", NewError(CodeResourceNotFound, "x"), 4},
|
|
{"input.* prefix", NewError(CodeInputInvalidArgument, "x"), 5},
|
|
{"input.missing_flag", NewError(CodeInputMissingFlag, "x"), 5},
|
|
{"server.rate_limited", NewError(CodeServerRateLimited, "x"), 6},
|
|
{"server.* prefix", NewError(CodeServerError, "x"), 7},
|
|
{"server.timeout", NewError(CodeServerTimeout, "x"), 7},
|
|
{"network.* prefix", NewError(CodeNetworkError, "x"), 7},
|
|
{"unknown error", errors.New("plain"), 1},
|
|
{"local.* prefix", NewError(CodeLocalConfigCorrupt, "x"), 1},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
assert.Equal(t, tc.want, ExitCode(tc.err))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestPrintError(t *testing.T) {
|
|
t.Run("nil is silent", func(t *testing.T) {
|
|
var buf bytes.Buffer
|
|
PrintError(&buf, nil)
|
|
assert.Empty(t, buf.String())
|
|
})
|
|
t.Run("SilentError is silent", func(t *testing.T) {
|
|
var buf bytes.Buffer
|
|
PrintError(&buf, SilentError)
|
|
assert.Empty(t, buf.String())
|
|
})
|
|
t.Run("typed error prints message", func(t *testing.T) {
|
|
var buf bytes.Buffer
|
|
PrintError(&buf, NewError(CodeAuthUnauthenticated, "no creds"))
|
|
assert.Contains(t, buf.String(), "auth.unauthenticated")
|
|
assert.Contains(t, buf.String(), "no creds")
|
|
})
|
|
}
|