mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-06-04 13:30:32 +08:00
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.
120 lines
4.2 KiB
Go
120 lines
4.2 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
type RefreshOptions struct {
|
|
Name string // --name: target context (defaults to current)
|
|
}
|
|
|
|
// authRefreshFields enumerates the fields surfaced for `--json` discovery
|
|
// on `auth refresh`. Token values are intentionally omitted — see refreshResult.
|
|
var authRefreshFields = []string{"context"}
|
|
|
|
// refreshResult is the typed payload emitted under data on success. Token
|
|
// values are intentionally NOT included — emitting them would leak secrets
|
|
// into stdout / agent transcripts. Agents needing to verify the new token
|
|
// can re-run `weknora auth status` (live API check).
|
|
type refreshResult struct {
|
|
Context string `json:"context"`
|
|
}
|
|
|
|
// NewCmdRefresh builds `weknora auth refresh`. Renews the JWT access
|
|
// token by spending the stored refresh_token via POST /auth/refresh —
|
|
// the standard OAuth refresh-token grant.
|
|
//
|
|
// API-key contexts are rejected — they have no refresh semantic;
|
|
// rotate the key via the server UI instead.
|
|
func NewCmdRefresh(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &RefreshOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "refresh",
|
|
Short: "Renew the JWT access token using the stored refresh token",
|
|
Long: `Reads the refresh token previously stored by ` + "`weknora auth login`" + ` and
|
|
exchanges it for a new access + refresh token pair via POST /api/v1/auth/refresh.
|
|
Both new tokens replace the existing entries in the OS keyring.
|
|
|
|
API-key contexts are rejected with input.invalid_argument — they have no
|
|
refresh semantic. Rotate the key in the server UI instead.`,
|
|
Example: ` weknora auth refresh # refresh the current context
|
|
weknora auth refresh --name staging # refresh a specific context`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, _ []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runRefresh(c.Context(), opts, jopts, f, defaultRefresher)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.Name, "name", "", "Context to refresh (defaults to the current context)")
|
|
cmdutil.AddJSONFlags(cmd, authRefreshFields)
|
|
aiclient.SetAgentHelp(cmd, "Renews the access token using the stored refresh token. Errors with auth.token_expired when refresh itself is rejected — surface the hint to re-run auth login.")
|
|
return cmd
|
|
}
|
|
|
|
// defaultRefresher constructs a fresh, unauthenticated SDK client targeting
|
|
// host — the /auth/refresh endpoint reads the refresh token from the body,
|
|
// so no bearer / api-key header is needed.
|
|
func defaultRefresher(host string) cmdutil.Refresher {
|
|
return sdk.NewClient(host)
|
|
}
|
|
|
|
func runRefresh(ctx context.Context, opts *RefreshOptions, jopts *cmdutil.JSONOptions, f *cmdutil.Factory, refresherFor func(host string) cmdutil.Refresher) error {
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
name := opts.Name
|
|
if name == "" {
|
|
name = cfg.CurrentContext
|
|
}
|
|
if name == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no current context configured; run `weknora auth login` to set one up")
|
|
}
|
|
c, ok := cfg.Contexts[name]
|
|
if !ok {
|
|
return cmdutil.NewError(cmdutil.CodeLocalContextNotFound,
|
|
fmt.Sprintf("context not found: %s", name))
|
|
}
|
|
if c.Host == "" {
|
|
return cmdutil.NewError(cmdutil.CodeLocalConfigCorrupt,
|
|
fmt.Sprintf("context %q has no host", name))
|
|
}
|
|
if c.RefreshRef == "" {
|
|
hint := "api-key contexts can't be refreshed — rotate the key in the server UI and run `weknora auth login --with-token`"
|
|
if c.APIKeyRef == "" {
|
|
hint = "no refresh token stored — run `weknora auth login` to authenticate"
|
|
}
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("context %q has no refresh token", name),
|
|
Hint: hint,
|
|
}
|
|
}
|
|
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, err := cmdutil.RefreshAndPersist(ctx, store, refresherFor(c.Host), name); err != nil {
|
|
return err
|
|
}
|
|
|
|
if jopts.Enabled() {
|
|
return jopts.Emit(iostreams.IO.Out, refreshResult{Context: name})
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Refreshed access token for context %s\n", name)
|
|
return nil
|
|
}
|