5adcedf170
Cross-cutting findings surfaced by the branch-completion review. Perf bug: - Factory.Client closure was not memoized. Factory.ResolveKB internally calls f.Client() to resolve --kb name → id, then the command's RunE calls f.Client() again. Two SDK clients, two keyring reads, two AuthRetryTransport allocations per name-resolved invocation, with *independent* token state (a refresh in one was invisible to the other). Switched to sync.Once like Secrets already does. Silent bug bait: - cmdutil.NormalizeHost docstring claimed CodeInputMissingFlag for the empty case; code returned CodeInputInvalidArgument. Aligned doc to code (present-but-empty is a bad value, not a missing flag). Agent contract gaps: - Five user-facing subcommands lacked SetAgentHelp: auth login / logout / list / status and chat. Added concise strings with error- code call-outs so agents can branch without parsing human strings. Helper extraction (≥3 callers): - text.KnowledgeDisplayName(fileName, title, id) — byte-identical formatter that was in both cmd/doc/list.go and cmd/search/docs.go. Takes fields directly so internal/text stays SDK-free. - cmdutil.WrapHTTP(cause, fmt, args...) *Error — replaces the `Wrapf(ClassifyHTTPError(err), err, ...)` pattern across 24 SDK call sites. Sed-driven migration; off-pattern shapes in chat.go (used streamErr) and cmdutil/kb.go (in-package) hand-edited. Contract test gains a comment update: post-migration the dominant pattern is WrapHTTP which the AST scanner skips entirely (only NewError/Wrapf selectors inspected); ClassifyHTTPErrorOutputs() bridge still covers the dynamic codes those paths can yield. UX consistency: - cmd/doc/list.go --page-size help now reads "Items per page (1..1000)" matching cmd/session/list.go. The bounds validation already enforced 1..1000; the help text was the last drift. Comment-discipline sweep: - Deleted the WHAT-only "*Options captures `weknora ...` flag state" docstring across 23 files (context, kb, auth, doc, session, search, chat, doctor, link). Where the line carried a real WHY clause (kb/delete, doc/delete, session/delete, kb/edit), kept the WHY and dropped only the leading WHAT phrase. - Stripped third-party project-name attribution from inline comments and one user-visible flag-help string across ~40 files in cli/cmd and cli/internal (plus 4 test-file comments). Removed phrases like "Mirrors `gh X`", "borrowed from lark-cli", "kubectl-style", "gcloud `--project`", "Stripe pattern", and the embedded GitHub URLs pointing at those projects. Behavioral descriptions and the WHY behind each comment are preserved; only the upstream-name attribution is gone. Inspiration / north-star references belong in cli/AGENTS.md (the design doc) and commit messages, not scattered through every file. Triggered by an audit round that surfaced several false / fragile parity claims (e.g. "Mirrors `gh repo edit`" — gh repo edit has no --name flag; "matches gcloud `--project` id-or-name" — gcloud's --project accepts ID only). Rather than fix them one by one, the whole category of in-comment external-project references was stripped uniformly.
145 lines
5.2 KiB
Go
145 lines
5.2 KiB
Go
package contextcmd
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"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`)
|
|
JSONOut bool
|
|
DryRun bool
|
|
}
|
|
|
|
// 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 context remove`. Drops the entry from
|
|
// config.yaml and best-effort clears keyring references. Removing a
|
|
// non-current context is low-friction (no prompt). Removing the *current*
|
|
// context 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 context (drops entry, clears keyring refs)",
|
|
Long: `Deletes the named context from config.yaml and best-effort clears any
|
|
keyring references it owned (matches ` + "`weknora auth logout`" + `).
|
|
|
|
Removing the current context also clears CurrentContext — subsequent commands
|
|
will error until you select another with ` + "`weknora context use <name>`" + ` or pick
|
|
one up via the global ` + "`--context`" + ` flag. Because that change is observable in
|
|
every later command, removing the current context requires explicit -y/--yes
|
|
in scripted / --json invocations (exit code 10; see cli/AGENTS.md).`,
|
|
Example: ` weknora context remove staging # remove non-current → no prompt
|
|
weknora context remove production -y # remove current → confirm`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
opts.Yes, _ = c.Flags().GetBool("yes")
|
|
opts.DryRun = cmdutil.IsDryRun(c)
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runRemove(opts, args[0], store, f.Prompter())
|
|
},
|
|
}
|
|
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
|
agent.SetAgentHelp(cmd, "Removes a context entry. Removing the current context requires -y in non-TTY/--json (exit-10). Always best-effort clears keyring refs.")
|
|
return cmd
|
|
}
|
|
|
|
func runRemove(opts *RemoveOptions, name string, store secrets.Store, p prompt.Prompter) error {
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
ctx, exists := cfg.Contexts[name]
|
|
if !exists {
|
|
return notFoundError(name, cfg)
|
|
}
|
|
wasCurrent := name == cfg.CurrentContext
|
|
risk := riskForRemove(name, wasCurrent)
|
|
|
|
if opts.DryRun {
|
|
return cmdutil.EmitDryRun(opts.JSONOut,
|
|
removeResult{Name: name, Removed: false, WasCurrent: wasCurrent},
|
|
&format.Meta{Context: cfg.CurrentContext},
|
|
risk)
|
|
}
|
|
// Confirmation only fires for removing the current context — non-current
|
|
// remove uses the same low-friction policy as `auth logout`.
|
|
if wasCurrent {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, opts.JSONOut, "current context", 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.Contexts, name)
|
|
if wasCurrent {
|
|
cfg.CurrentContext = ""
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
clearContextSecrets(store, ctx, name)
|
|
|
|
result := removeResult{Name: name, Removed: true, WasCurrent: wasCurrent}
|
|
if opts.JSONOut {
|
|
return format.WriteEnvelope(iostreams.IO.Out, format.SuccessWithRisk(
|
|
result, &format.Meta{Context: cfg.CurrentContext}, risk,
|
|
))
|
|
}
|
|
if wasCurrent {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Removed context %s (current context cleared — run `weknora context use <name>` to pick another)\n", name)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Removed context %s\n", name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// riskForRemove returns the operation risk: high-risk-write only when the
|
|
// target is the currently-active context (subsequent commands will have no
|
|
// default --context until the user picks one).
|
|
func riskForRemove(name string, wasCurrent bool) *format.Risk {
|
|
if wasCurrent {
|
|
return &format.Risk{
|
|
Level: format.RiskHighRiskWrite,
|
|
Action: fmt.Sprintf("remove context %s (the current context — subsequent commands will need a new --context)", name),
|
|
}
|
|
}
|
|
return &format.Risk{Level: format.RiskWrite, Action: fmt.Sprintf("remove context %s", name)}
|
|
}
|
|
|
|
// clearContextSecrets mirrors auth/logout.go: best-effort delete every secret
|
|
// slot the context references. Errors are swallowed so a missing keyring
|
|
// entry doesn't block remove (logout has had the same policy since v0.2).
|
|
func clearContextSecrets(store secrets.Store, c config.Context, name string) {
|
|
if c.TokenRef != "" {
|
|
_ = store.Delete(name, "access")
|
|
}
|
|
if c.RefreshRef != "" {
|
|
_ = store.Delete(name, "refresh")
|
|
}
|
|
if c.APIKeyRef != "" {
|
|
_ = store.Delete(name, "api_key")
|
|
}
|
|
}
|
|
|