nullkey
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.
55 lines
2.0 KiB
Go
55 lines
2.0 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"regexp"
|
|
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// uuidPattern matches the canonical 8-4-4-4-12 UUID form. WeKnora's KB ids
|
|
// are uuid.New().String() output stored as varchar(36); names are arbitrary
|
|
// user-supplied strings, so format-detection is unambiguous.
|
|
var uuidPattern = regexp.MustCompile(`^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`)
|
|
|
|
// IsKBID reports whether s looks like a KB id. Used by Factory.ResolveKB and
|
|
// any caller that accepts a single id-or-name selector value (id vs name
|
|
// auto-detection).
|
|
func IsKBID(s string) bool { return uuidPattern.MatchString(s) }
|
|
|
|
// KBLister is the narrow SDK surface ResolveKBNameToID depends on. The
|
|
// production *sdk.Client satisfies it; tests inject fakes without standing
|
|
// up an HTTP server.
|
|
type KBLister interface {
|
|
ListKnowledgeBases(ctx context.Context) ([]sdk.KnowledgeBase, error)
|
|
}
|
|
|
|
// ResolveKBFlag interprets a raw --kb value (id or name) and returns the
|
|
// canonical id. Pass-through when raw already looks like an id; otherwise
|
|
// list and match by name. Shared by every command that takes a --kb flag
|
|
// directly (search chunks/docs, doc download, link …) so the id-or-name
|
|
// policy never drifts.
|
|
func ResolveKBFlag(ctx context.Context, lister KBLister, raw string) (string, error) {
|
|
if IsKBID(raw) {
|
|
return raw, nil
|
|
}
|
|
return ResolveKBNameToID(ctx, lister, raw)
|
|
}
|
|
|
|
// ResolveKBNameToID looks up a knowledge base by name and returns its ID.
|
|
// Used by `link` and `Factory.ResolveKB` — a single lookup so the match
|
|
// policy (currently exact case-sensitive) lives in one place.
|
|
func ResolveKBNameToID(ctx context.Context, lister KBLister, name string) (string, error) {
|
|
kbs, err := lister.ListKnowledgeBases(ctx)
|
|
if err != nil {
|
|
return "", WrapHTTP(err, "list knowledge bases")
|
|
}
|
|
for _, kb := range kbs {
|
|
if kb.Name == name {
|
|
return kb.ID, nil
|
|
}
|
|
}
|
|
return "", NewError(CodeKBNotFound, fmt.Sprintf("knowledge base not found: %s", name))
|
|
}
|