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.7 KiB
Go
162 lines
5.7 KiB
Go
package profilecmd
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
)
|
|
|
|
type RemoveOptions struct {
|
|
Yes bool // sourced from the global -y/--yes persistent flag (matches `kb delete`)
|
|
DryRun bool
|
|
}
|
|
|
|
// profileRemoveFields enumerates the fields surfaced for `--format json` discovery on
|
|
// `profile remove`. The result reports the disposition of the removed entry.
|
|
var profileRemoveFields = []string{
|
|
"name", "removed", "was_current",
|
|
}
|
|
|
|
// removeResult is the typed payload emitted under data on success.
|
|
type removeResult struct {
|
|
Name string `json:"name"`
|
|
Removed bool `json:"removed"`
|
|
WasCurrent bool `json:"was_current"`
|
|
}
|
|
|
|
// NewCmdRemove builds `weknora profile remove`. Drops the entry from
|
|
// config.yaml and best-effort clears keyring references. Removing a
|
|
// non-current profile is low-friction (no prompt). Removing the *current*
|
|
// profile triggers the destructive-write confirmation protocol (exit 10),
|
|
// because subsequent commands will have no default connection target.
|
|
func NewCmdRemove(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &RemoveOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "remove <name>",
|
|
Short: "Remove a profile (drops entry, clears keyring refs)",
|
|
Long: `Deletes the named profile from config.yaml and best-effort clears any
|
|
keyring references it owned (matches ` + "`weknora auth logout`" + `).
|
|
|
|
Removing the current profile also clears CurrentProfile - subsequent commands
|
|
will error until you select another with ` + "`weknora profile use <name>`" + ` or pick
|
|
one up via the global ` + "`--profile`" + ` flag. Because that change is observable in
|
|
every later command, removing the current profile requires explicit -y/--yes
|
|
in scripted / --format json invocations (exit code 10; see cli/README.md).`,
|
|
Example: ` weknora profile remove staging # remove non-current → no prompt
|
|
weknora profile remove production -y # remove current → confirm`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
opts.Yes, _ = c.Flags().GetBool("yes")
|
|
// Pure-local existence check runs before the dry-run gate so
|
|
// --dry-run rejects unknown profile names identically to the live
|
|
// path. Same notFoundError as runRemove (kept there for direct
|
|
// callers).
|
|
cfg, cfgErr := config.Load()
|
|
if cfgErr != nil {
|
|
return cfgErr
|
|
}
|
|
if _, exists := cfg.Profiles[args[0]]; !exists {
|
|
return notFoundError(args[0], cfg)
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "profile.remove",
|
|
Args: map[string]any{
|
|
"name": args[0],
|
|
},
|
|
}); handled {
|
|
return err
|
|
}
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runRemove(opts, fopts, args[0], store, f.Prompter())
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, profileRemoveFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetRisk(cmd, "profile.remove")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "remove a named profile and its stored credentials",
|
|
RequiredFlags: []string{"<name> (positional)"},
|
|
Examples: []string{
|
|
"weknora profile remove staging",
|
|
"weknora profile remove production -y",
|
|
},
|
|
Warnings: []string{
|
|
"Requires explicit user approval (exit 10 / input.confirmation_required); never auto-add -y.",
|
|
"profile remove deletes local credentials + config; the server-side token is not revoked (use 'auth logout' on server instead).",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runRemove(opts *RemoveOptions, fopts *cmdutil.FormatOptions, name string, store secrets.Store, p prompt.Prompter) error {
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
ctx, exists := cfg.Profiles[name]
|
|
if !exists {
|
|
return notFoundError(name, cfg)
|
|
}
|
|
wasCurrent := name == cfg.CurrentProfile
|
|
|
|
jsonOut := fopts.WantsJSON()
|
|
// Confirmation only fires for removing the current profile - non-current
|
|
// remove uses the same low-friction policy as `auth logout`.
|
|
if wasCurrent {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, jsonOut, "current profile", name, "profile.remove", fmt.Sprintf("weknora profile remove %s -y", name)); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// Config first, secrets after: a crash in between leaves an orphan
|
|
// keyring entry but no dangling config ref (same ordering as auth logout).
|
|
delete(cfg.Profiles, name)
|
|
if wasCurrent {
|
|
cfg.CurrentProfile = ""
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
clearProfileSecrets(store, ctx, name)
|
|
|
|
result := removeResult{Name: name, Removed: true, WasCurrent: wasCurrent}
|
|
if jsonOut {
|
|
return fopts.Emit(iostreams.IO.Out, result, nil)
|
|
}
|
|
if wasCurrent {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Removed profile %s (current profile cleared - run `weknora profile use <name>` to pick another)\n", name)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Removed profile %s\n", name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// clearProfileSecrets mirrors auth/logout.go: best-effort delete every secret
|
|
// slot the profile references. Errors are swallowed so a missing keyring
|
|
// entry doesn't block remove (same policy as `auth logout`).
|
|
func clearProfileSecrets(store secrets.Store, c config.Profile, name string) {
|
|
if c.TokenRef != "" {
|
|
_ = store.Delete(name, "access")
|
|
}
|
|
if c.RefreshRef != "" {
|
|
_ = store.Delete(name, "refresh")
|
|
}
|
|
if c.APIKeyRef != "" {
|
|
_ = store.Delete(name, "api_key")
|
|
}
|
|
}
|