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.
40 lines
1.1 KiB
Go
40 lines
1.1 KiB
Go
// Package compat probes server `/system/info` and decides client-server
|
|
// version skew level. Used by `weknora doctor` 的 server_version 检查项。
|
|
//
|
|
// 24h TTL state file cache, three-tier compat semantics
|
|
// (major-mismatch=hard / minor-mismatch=soft / equal=ok).
|
|
package compat
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// Info is the cached server version snapshot.
|
|
type Info struct {
|
|
ServerVersion string `yaml:"server_version"`
|
|
EngineInfo map[string]string `yaml:"engine_info,omitempty"`
|
|
ProbedAt time.Time `yaml:"probed_at"`
|
|
}
|
|
|
|
// ProbeService is the narrow SDK surface compat depends on (testability via
|
|
// fake; mirrors v0.0 service interface pattern).
|
|
type ProbeService interface {
|
|
GetSystemInfo(ctx context.Context) (*sdk.SystemInfo, error)
|
|
}
|
|
|
|
// Probe calls server /system/info and returns a fresh Info snapshot.
|
|
func Probe(ctx context.Context, c ProbeService) (*Info, error) {
|
|
resp, err := c.GetSystemInfo(ctx)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("probe server: %w", err)
|
|
}
|
|
return &Info{
|
|
ServerVersion: resp.Version,
|
|
ProbedAt: time.Now(),
|
|
}, nil
|
|
}
|