6d8c8650cd
Two intertwined agent safety nets that share the same files:
1. --dry-run flag for offline preview of mutation commands
2. Risk: metadata + SetRisk helper for destructive command surfaces
Coverage (19 mutation commands with --dry-run):
kb.create/edit/delete agent.create/edit/delete
doc.create/upload/fetch/delete doc.delete_all (special variant)
session.delete chunk.delete profile.add/remove
auth.refresh/logout link unlink
api.{post,put,patch,delete} (api.get + --dry-run rejected, exit 2)
Envelope additions (omitempty in non-dry-run paths):
meta.dry_run: bool true when --dry-run was used
meta.plan: map {action, args} per the per-command taxonomy
Risk: metadata
--------------
cmdutil.SetRisk(cmd, action) stamps cobra.Annotations with
risk.level=destructive + risk.action=<action> on the 9 destructive
commands. The SetAgentHelp wrapper prepends a "Risk: <action>
(destructive)" line in the default text help path so agents see a clear
warning before parsing Usage. WEKNORA_AGENT_HELP=1 JSON path stays
unchanged — structured agent-help already carries warnings[].
Validation parity with the live path
------------------------------------
Every pure-local validation (flag presence, mutual exclusion, enum
bounds, URL/regex format, ResolveKBLocal for KB resolution that does not
require an SDK call) runs BEFORE the dry-run gate. This matches the
industry-standard "preview shows what live would do" contract:
--dry-run accepts exactly the same invocations the live path accepts and
rejects exactly the same invocations the live path rejects, modulo the
side-effecting work itself.
The side-effecting work (SDK calls, file writes, keyring writes, server-
side name → id resolution) is what --dry-run actually gates. Each
mutation file pairs its RunE validation block with a regression test
under *_dry_run_test.go / dryrun_validation_test.go so future refactors
don't reintroduce the gap.
Helper surface
--------------
- HandleDryRun(cmd, dryRun, plan) extracts the early-return so the
19 RunE call sites stay 3 lines each.
- EmitDryRun routes through FormatOptions.Emit, inheriting _notice /
TTY indent / --jq filtering for free.
- ResolveKBLocal mirrors ResolveKB but never calls the SDK; dry-run
paths use it so the plan reports the raw --kb value (UUID or name)
without a name → id lookup.
Streaming commands (chat, session ask, session continue-stream) are
deliberately excluded: a buffered plan makes no sense for an event
stream.
Lock semantics in the dry-run path:
- destructive + --dry-run: exit 0, no exit-10 confirmation prompt
- --dry-run + -y: byte-identical envelope to --dry-run alone
- --dry-run + --jq: filter applies to the preview envelope normally
162 lines
5.5 KiB
Go
162 lines
5.5 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 {
|
|
Name string // --name: target profile (defaults to current)
|
|
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 current profile
|
|
weknora auth refresh --name staging # 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 := opts.Name
|
|
if name == "" {
|
|
name = cfg.CurrentProfile
|
|
}
|
|
if name == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no current 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)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.Name, "name", "", "Profile to refresh (defaults to the current profile)")
|
|
cmdutil.AddFormatFlag(cmd, authRefreshFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
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 := opts.Name
|
|
if name == "" {
|
|
name = cfg.CurrentProfile
|
|
}
|
|
if name == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no current 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
|
|
}
|