refactor(cli): v0.3 cross-cutting cleanup
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.
This commit is contained in:
@@ -13,7 +13,6 @@ import (
|
||||
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
||||
)
|
||||
|
||||
// AddOptions captures `weknora context add` flag state.
|
||||
type AddOptions struct {
|
||||
Host string
|
||||
User string
|
||||
@@ -31,11 +30,9 @@ type addResult struct {
|
||||
// NewCmdAdd builds `weknora context add`. Registers a *credentialless*
|
||||
// connection target — host + optional user only. Credentials for the new
|
||||
// context are attached separately with `weknora auth login --name <n>`,
|
||||
// reflecting gh's separation of "where" the CLI talks to (the host) and
|
||||
// "how" it authenticates (the credential). kubectl's `config set-context`
|
||||
// covers the same operation under a different surface convention. If you
|
||||
// want one command for both, run `weknora auth login --name <n> --host
|
||||
// <h>` instead.
|
||||
// separating "where" the CLI talks to (the host) and "how" it authenticates
|
||||
// (the credential). If you want one command for both, run
|
||||
// `weknora auth login --name <n> --host <h>` instead.
|
||||
func NewCmdAdd(f *cmdutil.Factory) *cobra.Command {
|
||||
opts := &AddOptions{}
|
||||
cmd := &cobra.Command{
|
||||
@@ -56,7 +53,7 @@ adds leave the current context untouched.`,
|
||||
},
|
||||
}
|
||||
cmd.Flags().StringVar(&opts.Host, "host", "", "Server base URL, e.g. https://kb.example.com (required)")
|
||||
cmd.Flags().StringVar(&opts.User, "user", "", "Account email shown in `context list` (optional, cosmetic only)")
|
||||
cmd.Flags().StringVar(&opts.User, "user", "", "Account email shown in 'context list' (optional, cosmetic only)")
|
||||
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
||||
_ = cmd.MarkFlagRequired("host")
|
||||
agent.SetAgentHelp(cmd, "Adds a context. First context added auto-becomes current. Errors with resource.already_exists if name collides; input.invalid_argument if --host is not an absolute http(s) URL.")
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
// Package contextcmd holds `weknora context` command tree
|
||||
// (list / add / remove / use). Uses the gh-style `<noun> <verb>` shape
|
||||
// consistent with the rest of this CLI. kubectl exposes the same set
|
||||
// of operations as flat hyphenated subcommands (`config get-contexts /
|
||||
// set-context / delete-context / use-context`) — a different idiom we
|
||||
// don't adopt because it would make `context` an outlier in our tree.
|
||||
// (list / add / remove / use). Uses the `<noun> <verb>` shape
|
||||
// consistent with the rest of this CLI.
|
||||
//
|
||||
// Package name `contextcmd` (not `context`) to avoid shadowing stdlib context.
|
||||
// The cobra Use: string is "context" — this is what users type.
|
||||
|
||||
@@ -14,12 +14,10 @@ import (
|
||||
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
||||
)
|
||||
|
||||
// ListOptions captures `weknora context list` flag state.
|
||||
type ListOptions struct {
|
||||
JSONOut bool
|
||||
}
|
||||
|
||||
// listEntry is one row in the rendered table / one element of envelope.data.
|
||||
type listEntry struct {
|
||||
Name string `json:"name"`
|
||||
Host string `json:"host"`
|
||||
@@ -27,11 +25,8 @@ type listEntry struct {
|
||||
Current bool `json:"current"`
|
||||
}
|
||||
|
||||
// NewCmdList builds `weknora context list`. Same listing shape as gh
|
||||
// `auth status` (per-host enumeration with an active marker). The kubectl
|
||||
// equivalent is `config get-contexts` — same data, different surface
|
||||
// convention (kubectl uses hyphenated subcommands; we use noun-verb).
|
||||
// Reads only config.yaml — no network, no keyring touch.
|
||||
// NewCmdList builds `weknora context list`. Per-host enumeration with an
|
||||
// active marker. Reads only config.yaml — no network, no keyring touch.
|
||||
func NewCmdList(f *cmdutil.Factory) *cobra.Command {
|
||||
opts := &ListOptions{}
|
||||
cmd := &cobra.Command{
|
||||
|
||||
@@ -14,10 +14,8 @@ import (
|
||||
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
||||
)
|
||||
|
||||
// RemoveOptions captures `weknora context remove` flag state. Yes is sourced
|
||||
// from the global -y/--yes persistent flag (matches `kb delete`).
|
||||
type RemoveOptions struct {
|
||||
Yes bool
|
||||
Yes bool // sourced from the global -y/--yes persistent flag (matches `kb delete`)
|
||||
JSONOut bool
|
||||
DryRun bool
|
||||
}
|
||||
@@ -30,12 +28,10 @@ type removeResult struct {
|
||||
}
|
||||
|
||||
// NewCmdRemove builds `weknora context remove`. Drops the entry from
|
||||
// config.yaml and best-effort clears keyring references. The kubectl
|
||||
// equivalent is `config delete-context`; we use the noun-verb form
|
||||
// instead. Removing a non-current context is low-friction (no prompt).
|
||||
// Removing the *current* context triggers the lark-cli exit-10
|
||||
// confirmation protocol because subsequent commands will have no
|
||||
// default connection target.
|
||||
// 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{
|
||||
@@ -48,7 +44,7 @@ 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-10 protocol; AGENTS.md).`,
|
||||
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),
|
||||
@@ -86,7 +82,7 @@ func runRemove(opts *RemoveOptions, name string, store secrets.Store, p prompt.P
|
||||
risk)
|
||||
}
|
||||
// Confirmation only fires for removing the current context — non-current
|
||||
// remove matches `auth logout`'s low-friction policy.
|
||||
// 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
|
||||
@@ -133,7 +129,7 @@ func riskForRemove(name string, wasCurrent bool) *format.Risk {
|
||||
|
||||
// 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 had the same policy from v0.2).
|
||||
// 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")
|
||||
|
||||
Reference in New Issue
Block a user