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.
83 lines
2.6 KiB
Go
83 lines
2.6 KiB
Go
// Package config reads and writes the user-level config at
|
|
// $XDG_CONFIG_HOME/weknora/config.yaml. yaml.v3 directly; viper is
|
|
// intentionally not used (see ADR-2). Multi-host context map lives here;
|
|
// the per-project link (.weknora/project.yaml) is handled by the
|
|
// projectlink package (see ADR-16).
|
|
package config
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
|
|
"gopkg.in/yaml.v3"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/xdg"
|
|
)
|
|
|
|
// Config is the on-disk schema. Empty zero-value is valid (returned when the
|
|
// file does not exist) so commands like --help / version don't fail.
|
|
type Config struct {
|
|
CurrentContext string `yaml:"current_context,omitempty"`
|
|
Contexts map[string]Context `yaml:"contexts,omitempty"`
|
|
|
|
// Defaults holds CLI-wide defaults; fields opt-in.
|
|
Defaults struct {
|
|
Format string `yaml:"format,omitempty"`
|
|
NoVersionCheck bool `yaml:"no_version_check,omitempty"`
|
|
RequestIDPrefix string `yaml:"request_id_prefix,omitempty"`
|
|
} `yaml:"defaults,omitempty"`
|
|
}
|
|
|
|
// Context is one named connection target (host + tenant + credential reference).
|
|
type Context struct {
|
|
Host string `yaml:"host"`
|
|
TenantID uint64 `yaml:"tenant_id,omitempty"`
|
|
User string `yaml:"user,omitempty"`
|
|
APIKeyRef string `yaml:"api_key_ref,omitempty"` // keychain://... or file://...
|
|
TokenRef string `yaml:"token_ref,omitempty"` // keychain://... or file://...
|
|
RefreshRef string `yaml:"refresh_token_ref,omitempty"`
|
|
DefaultKBID string `yaml:"default_kb_id,omitempty"`
|
|
}
|
|
|
|
// ErrCorrupt is returned by Load when the file exists but cannot be parsed.
|
|
// Callers should map this to error code "local.config_corrupt".
|
|
var ErrCorrupt = errors.New("config: file is malformed")
|
|
|
|
// Path returns the absolute config file path.
|
|
// Honors XDG_CONFIG_HOME via internal/xdg.
|
|
func Path() (string, error) {
|
|
return xdg.Path("XDG_CONFIG_HOME", ".config", "config.yaml")
|
|
}
|
|
|
|
// Load reads the config file. If it does not exist, returns a zero-value
|
|
// Config with no error (commands like `version` and `--help` must not fail
|
|
// just because the user has not run `auth login` yet).
|
|
func Load() (*Config, error) {
|
|
p, err := Path()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
data, err := os.ReadFile(p)
|
|
if errors.Is(err, os.ErrNotExist) {
|
|
return &Config{}, nil
|
|
}
|
|
if err != nil {
|
|
return nil, fmt.Errorf("read config: %w", err)
|
|
}
|
|
var c Config
|
|
if err := yaml.Unmarshal(data, &c); err != nil {
|
|
return nil, fmt.Errorf("%w: %v", ErrCorrupt, err)
|
|
}
|
|
return &c, nil
|
|
}
|
|
|
|
// Save writes the config atomically with mode 0600 via internal/xdg.WriteAtomicYAML.
|
|
func Save(c *Config) error {
|
|
p, err := Path()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return xdg.WriteAtomicYAML(p, c)
|
|
}
|