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.
151 lines
5.2 KiB
Go
151 lines
5.2 KiB
Go
package contextcmd
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
type AddOptions struct {
|
|
Host string
|
|
User string
|
|
}
|
|
|
|
// contextAddFields enumerates the fields surfaced for `--json` discovery on
|
|
// `context add`. The result describes the newly-registered context.
|
|
var contextAddFields = []string{
|
|
"name", "host", "user", "current",
|
|
}
|
|
|
|
// addResult is the typed payload emitted under data on success.
|
|
type addResult struct {
|
|
Name string `json:"name"`
|
|
Host string `json:"host"`
|
|
User string `json:"user,omitempty"`
|
|
Current bool `json:"current"`
|
|
}
|
|
|
|
// NewCmdAdd builds `weknora context add`. Registers a *credentialless*
|
|
// connection target — host + optional user only. Credentials for the new
|
|
// context are attached separately with `weknora auth login --name <n>`,
|
|
// separating "where" the CLI talks to (the host) and "how" it authenticates
|
|
// (the credential). If you want one command for both, run
|
|
// `weknora auth login --name <n> --host <h>` instead.
|
|
func NewCmdAdd(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &AddOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "add <name>",
|
|
Short: "Register a new context (host without credentials)",
|
|
Long: `Add a new context entry to config.yaml. Stores host (and optionally
|
|
user) but does NOT prompt for credentials. Use ` + "`weknora auth login --name <n>`" + ` to
|
|
attach credentials in a single step instead, or run ` + "`weknora auth login --name <n>`" + ` after
|
|
` + "`weknora context add`" + ` to fill them in.
|
|
|
|
The first context added is auto-selected as the current context. Subsequent
|
|
adds leave the current context untouched.`,
|
|
Example: ` weknora context add staging --host https://staging.example.com
|
|
weknora context add prod --host https://prod.example.com --user alice@example.com`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runAdd(opts, jopts, args[0])
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.Host, "host", "", "Server base URL, e.g. https://kb.example.com (required)")
|
|
cmd.Flags().StringVar(&opts.User, "user", "", "Account email shown in 'context list' (optional, cosmetic only)")
|
|
cmdutil.AddJSONFlags(cmd, contextAddFields)
|
|
_ = cmd.MarkFlagRequired("host")
|
|
aiclient.SetAgentHelp(cmd, "Adds a context. First context added auto-becomes current. Errors with resource.already_exists if name collides; input.invalid_argument if --host is not an absolute http(s) URL.")
|
|
return cmd
|
|
}
|
|
|
|
func runAdd(opts *AddOptions, jopts *cmdutil.JSONOptions, name string) error {
|
|
if err := validateName(name); err != nil {
|
|
return err
|
|
}
|
|
host, err := cmdutil.NormalizeHost(opts.Host)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, exists := cfg.Contexts[name]; exists {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeResourceAlreadyExists,
|
|
Message: fmt.Sprintf("context %q already exists", name),
|
|
Hint: fmt.Sprintf("use a different name, or run `weknora context remove %s` first", name),
|
|
}
|
|
}
|
|
if cfg.Contexts == nil {
|
|
cfg.Contexts = map[string]config.Context{}
|
|
}
|
|
cfg.Contexts[name] = config.Context{Host: host, User: opts.User}
|
|
wasFirst := cfg.CurrentContext == ""
|
|
if wasFirst {
|
|
cfg.CurrentContext = name
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
|
|
if jopts.Enabled() {
|
|
return jopts.Emit(iostreams.IO.Out, addResult{Name: name, Host: host, User: opts.User, Current: wasFirst})
|
|
}
|
|
if wasFirst {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Added context %s (now current). Run `weknora auth login --name %s` to attach credentials.\n", name, name)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Added context %s. Run `weknora auth login --name %s` to attach credentials.\n", name, name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// validateName enforces the allowlist advertised in the --help hint: letters,
|
|
// digits, dash, underscore, dot. The `.` exception lets emails / DNS-like
|
|
// names through; the path-traversal `..` is structurally rejected by a
|
|
// separate guard because it would let a hand-edited config.yaml claim a
|
|
// context whose name walks out of the keyring namespace.
|
|
func validateName(name string) error {
|
|
if name == "" {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: "context name must not be empty",
|
|
}
|
|
}
|
|
if name == "." || name == ".." || strings.Contains(name, "/") || strings.Contains(name, "\\") {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("context name %q is reserved or path-like", name),
|
|
Hint: "use letters, digits, dashes, underscores, or dots",
|
|
}
|
|
}
|
|
for _, r := range name {
|
|
switch {
|
|
case r >= 'a' && r <= 'z',
|
|
r >= 'A' && r <= 'Z',
|
|
r >= '0' && r <= '9',
|
|
r == '-' || r == '_' || r == '.':
|
|
continue
|
|
default:
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("context name %q contains invalid character %q", name, r),
|
|
Hint: "use letters, digits, dashes, underscores, or dots",
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|