4a5449233d
Seven bugs surfaced via two audit rounds — parallel reviewer agents
plus a real-server end-to-end demo. Each fix arrives with a
regression test.
1. doc upload --recursive --json corrupted the envelope stream.
Per-file FAIL/OK plain lines printed unconditionally to stdout,
then a Success envelope, then on partial failure a typed error
that the root handler turned into a SECOND Failure envelope —
three outputs where one was expected. Fix: gate the plain lines
behind !opts.JSONOut, and add cmdutil.Error.Silent so the JSON-
path partial-failure preserves its typed exit code without
triggering PrintErrorEnvelope's default Failure-envelope write.
2. auth refresh / AuthRetryTransport misclassified HTTP failures as
network.error. RefreshAndPersist wrapped every refresher error
with CodeNetworkError, but the SDK emits "HTTP error 401: ..."
for a rejected refresh token — which should surface as
auth.token_expired. Switched to WrapHTTP for proper status-
derived classification. Affects both `auth refresh` and the
transport's refresh closure.
3. doc download accepted ".." as a server-suggested filename. The
rejection list covered "" / "." / filepath.Separator but not
bare ".." — filepath.Base("..") is "..", which slipped through
to os.Create and produced a confusing local.file_io wrap. Added
to the rejection set.
4. search chunks / docs / kb / sessions had no lower bound on
--limit. `-L 0` / `-L -1` was forwarded to the server with
undefined behavior. Added a 1..1000 bound at the RunE boundary
across all four (matching doc list / session list page-size
bounds). Internal callers in tests can still pass Limit==0 for
the "no client-side cap" runChunks path — the bound only applies
at the user-input layer.
5. cli/AGENTS.md ADR-3 verb-canon summary listed only v0.2 verbs as
"gh-canonical" and missed v0.3 additions (edit, pin, unpin,
download — all gh-canonical) plus locally-introduced ones
(empty, refresh, add, remove, link). Rewritten as an explicit
gh-canonical / locally-introduced split.
6. kb pin returned 404. Server registers /knowledge-bases/{id}/pin
as PUT (router.go:292); SDK was using POST. gin's router silently
404s on method-mismatch (treats it as path-not-found, not 405),
so the CLI classified the response as resource.not_found and
masked the real failure mode. Switched the SDK to http.MethodPut.
The asymmetry that hid this past round 1: kb unpin on a freshly-
created KB hits the no-op branch in cmd/kb/pin.go that skips the
SDK call entirely, so unpin "worked" without ever exercising the
broken path. Only the real-server demo, where kb pin actually
fires, surfaced it.
7. kb edit clobbered current Name when only --description was
passed. EditOptions used *string to distinguish "unset" from
"set to empty", but sdk.UpdateKnowledgeBaseRequest declares both
fields as plain string (no omitempty), so the JSON body always
carried `"name": ""`. Server requires Name → 400. Fix: runEdit
does fetch-then-update — GetKnowledgeBase first, build the PUT
body with current values, then overlay user-set fields. Same
TOCTOU window as kb pin / unpin.
Audit-flagged items intentionally NOT changed:
- kb pin / unpin check-then-toggle TOCTOU: documented; the clean
fix would be a server-side setter and belongs in a separate API
change.
- AuthRetryTransport singleflight test gap for one concurrency
scenario; v0.4 polish.
- cli/README.md:50 "once v0.2 ships" and CHANGELOG.md:8
"10 top-level commands": v0.2-PR artifacts, not v0.3-introduced.
- kb edit / kb pin are v0.3-new commands, so neither bug needs a
cli/CHANGELOG.md Fixed entry — the v0.3 release ships them
working as the Added bullets advertise.
111 lines
3.6 KiB
Go
111 lines
3.6 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")
|
|
}
|
|
if opts.Limit < 1 || opts.Limit > 1000 {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "--limit must be between 1 and 1000")
|
|
}
|
|
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
|
|
}
|