mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-29 02:04:30 +08:00
d3c03b2f34
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.
Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
"no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
stream sets Done=true on an intermediate agent_query frame before the answer,
and AgentAccumulator treated the first Done as terminal. Terminate on the
`complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
including `doc upload --recursive` partial failures — a permanent per-file
failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
would loop on; per-item typed errors stay in the envelope.
Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
retrieval_ready, and kb create hints the fix when no embedding model is bound
— an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
(drift-guarded); output strings match the meta actually emitted; chunk list
and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
`link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
accept and ignore it, declared in schema) so a carried-over --kb doesn't
exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.
Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
(server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
model.update / kb.config.set) and batch example (failed item carries `error`);
session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
give an env-aware message instead of looping on "run auth login". `auth logout`
clears credentials but keeps the profile registered (host preserved for
re-login); deleting a profile is `profile remove`'s job (clean logout/remove
separation, matching gh / lark).
Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.
Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
170 lines
6.2 KiB
Go
170 lines
6.2 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
type RefreshOptions struct {
|
|
DryRun bool
|
|
}
|
|
|
|
// authRefreshFields enumerates the fields surfaced for `--format json` discovery
|
|
// on `auth refresh`. Token values are intentionally omitted - see refreshResult.
|
|
var authRefreshFields = []string{"profile"}
|
|
|
|
// 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 {
|
|
Profile string `json:"profile"`
|
|
}
|
|
|
|
// 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 profiles 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 profiles 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 active profile
|
|
weknora --profile staging auth refresh # refresh a specific profile`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, _ []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
// Pure-local validation runs before the dry-run gate so --dry-run
|
|
// rejects identically to the live path. Same typed errors as
|
|
// runRefresh (kept there for direct-call callers).
|
|
cfg, cfgErr := f.Config()
|
|
if cfgErr != nil {
|
|
return cfgErr
|
|
}
|
|
name := cfg.CurrentProfile
|
|
if name == "" {
|
|
if active, kind := cmdutil.EnvCredential(); active {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument,
|
|
"authenticated via "+kind+" (stateless env credential): there is no stored JWT to refresh — env credentials are supplied fresh each call, so no refresh is needed")
|
|
}
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no active profile configured; run `weknora auth login` to set one up")
|
|
}
|
|
prof, ok := cfg.Profiles[name]
|
|
if !ok {
|
|
return cmdutil.NewError(cmdutil.CodeLocalProfileNotFound,
|
|
fmt.Sprintf("profile not found: %s", name))
|
|
}
|
|
if prof.Host == "" {
|
|
return cmdutil.NewError(cmdutil.CodeLocalConfigCorrupt,
|
|
fmt.Sprintf("profile %q has no host", name))
|
|
}
|
|
if prof.RefreshRef == "" {
|
|
hint := "api-key profiles can't be refreshed - rotate the key in the server UI and run `weknora auth login --with-token`"
|
|
if prof.APIKeyRef == "" {
|
|
hint = "no refresh token stored - run `weknora auth login` to authenticate"
|
|
}
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("profile %q has no refresh token", name),
|
|
Hint: hint,
|
|
}
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "auth.refresh",
|
|
Args: map[string]any{},
|
|
}); handled {
|
|
return err
|
|
}
|
|
return runRefresh(c.Context(), opts, fopts, f, defaultRefresher)
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, authRefreshFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "Renew the JWT access token for the active profile (override with the global --profile) using the stored refresh token. API-key profiles are rejected.",
|
|
Output: "envelope.data has profile name that was refreshed",
|
|
Examples: []string{
|
|
"weknora auth refresh",
|
|
"weknora --profile staging auth refresh",
|
|
},
|
|
})
|
|
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, fopts *cmdutil.FormatOptions, f *cmdutil.Factory, refresherFor func(host string) cmdutil.Refresher) error {
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
name := cfg.CurrentProfile
|
|
if name == "" {
|
|
if active, kind := cmdutil.EnvCredential(); active {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument,
|
|
"authenticated via "+kind+" (stateless env credential): there is no stored JWT to refresh — env credentials are supplied fresh each call, so no refresh is needed")
|
|
}
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no active profile configured; run `weknora auth login` to set one up")
|
|
}
|
|
c, ok := cfg.Profiles[name]
|
|
if !ok {
|
|
return cmdutil.NewError(cmdutil.CodeLocalProfileNotFound,
|
|
fmt.Sprintf("profile not found: %s", name))
|
|
}
|
|
if c.Host == "" {
|
|
return cmdutil.NewError(cmdutil.CodeLocalConfigCorrupt,
|
|
fmt.Sprintf("profile %q has no host", name))
|
|
}
|
|
if c.RefreshRef == "" {
|
|
hint := "api-key profiles 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("profile %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 fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, refreshResult{Profile: name}, nil)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Refreshed access token for profile %s\n", name)
|
|
return nil
|
|
}
|