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.
108 lines
3.5 KiB
Go
108 lines
3.5 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
"text/tabwriter"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/text"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
type KBSearchOptions struct {
|
|
Query string
|
|
Limit int
|
|
JSONOut bool
|
|
}
|
|
|
|
// KBSearchService is the narrow SDK surface this command depends on.
|
|
// Server has no fuzzy-KB-name endpoint; the CLI filters ListKnowledgeBases
|
|
// client-side. Acceptable because tenants typically have ≪ 1000 KBs.
|
|
type KBSearchService interface {
|
|
ListKnowledgeBases(ctx context.Context) ([]sdk.KnowledgeBase, error)
|
|
}
|
|
|
|
// NewCmdKB builds `weknora search kb "<query>"` — substring + case-insensitive
|
|
// match across KB names and descriptions visible to the active context.
|
|
// Results are sorted by name length (shortest first; usually the closest
|
|
// hit) for deterministic output.
|
|
func NewCmdKB(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &KBSearchOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: `kb "<query>"`,
|
|
Short: "Find knowledge bases by name or description (client-side substring match)",
|
|
Example: ` weknora search kb "marketing"
|
|
weknora search kb "team" --limit 5 --json`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
opts.Query = strings.TrimSpace(args[0])
|
|
if opts.Query == "" {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "query argument cannot be empty")
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runKBSearch(c.Context(), opts, cli)
|
|
},
|
|
}
|
|
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", 20, "Maximum results to return")
|
|
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
|
agent.SetAgentHelp(cmd, "Lists KBs whose name or description contains the query (case-insensitive). Useful to discover --kb identifiers before running search chunks / doc list.")
|
|
return cmd
|
|
}
|
|
|
|
func runKBSearch(ctx context.Context, opts *KBSearchOptions, svc KBSearchService) error {
|
|
items, err := svc.ListKnowledgeBases(ctx)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "list knowledge bases")
|
|
}
|
|
matches := filterKBs(items, opts.Query)
|
|
if opts.Limit > 0 && len(matches) > opts.Limit {
|
|
matches = matches[:opts.Limit]
|
|
}
|
|
|
|
if opts.JSONOut {
|
|
return format.WriteEnvelope(iostreams.IO.Out, format.Success(matches, nil))
|
|
}
|
|
if len(matches) == 0 {
|
|
fmt.Fprintln(iostreams.IO.Out, "(no matches)")
|
|
return nil
|
|
}
|
|
tw := tabwriter.NewWriter(iostreams.IO.Out, 0, 0, 2, ' ', 0)
|
|
fmt.Fprintln(tw, "ID\tNAME\tDOCS")
|
|
for _, kb := range matches {
|
|
name := text.Truncate(50, kb.Name)
|
|
fmt.Fprintf(tw, "%s\t%s\t%s\n", kb.ID, name, text.Pluralize(int(kb.KnowledgeCount), "doc"))
|
|
}
|
|
return tw.Flush()
|
|
}
|
|
|
|
// filterKBs returns the KBs whose name or description contains q (case-
|
|
// insensitive), sorted by name length so the most-likely match shows
|
|
// first. Ties broken alphabetically for determinism.
|
|
func filterKBs(items []sdk.KnowledgeBase, q string) []sdk.KnowledgeBase {
|
|
needle := strings.ToLower(q)
|
|
out := make([]sdk.KnowledgeBase, 0, len(items))
|
|
for _, kb := range items {
|
|
if text.ContainsFold(needle, kb.Name, kb.Description) {
|
|
out = append(out, kb)
|
|
}
|
|
}
|
|
sort.Slice(out, func(i, j int) bool {
|
|
if len(out[i].Name) != len(out[j].Name) {
|
|
return len(out[i].Name) < len(out[j].Name)
|
|
}
|
|
return out[i].Name < out[j].Name
|
|
})
|
|
return out
|
|
}
|