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.
198 lines
6.8 KiB
Go
198 lines
6.8 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
)
|
|
|
|
// ExitCode maps an error to the documented CLI exit code (spec §2.4 + ADR-3).
|
|
// - 0 success
|
|
// - 1 generic / unknown typed error — fallback for: resource.already_exists,
|
|
// resource.locked, local.* (config_corrupt / keychain_denied / file_io /
|
|
// context_not_found / kb_id_required / kb_not_found / projectlink_corrupt /
|
|
// user_aborted / upload_file_not_found), mcp.*, server.session_create_failed,
|
|
// sse.stream_aborted, and any code outside the named buckets below
|
|
// - 2 flag / argument problem (cobra parse / unknown subcommand)
|
|
// - 3 auth.*
|
|
// - 4 resource.not_found
|
|
// - 5 input.* (other than confirmation_required)
|
|
// - 6 server.rate_limited
|
|
// - 7 server.* (other than rate_limited/session_create_failed) / network.*
|
|
// - 10 input.confirmation_required — high-risk write needs explicit -y
|
|
// (see cli/AGENTS.md)
|
|
// - 130 SIGINT (handled by Go runtime, not this function)
|
|
func ExitCode(err error) int {
|
|
if err == nil {
|
|
return 0
|
|
}
|
|
var fe *FlagError
|
|
if errors.As(err, &fe) {
|
|
return 2
|
|
}
|
|
if errors.Is(err, SilentError) {
|
|
return 1
|
|
}
|
|
if matchCode(err, CodeInputConfirmationRequired) {
|
|
return 10
|
|
}
|
|
if IsAuthError(err) {
|
|
return 3
|
|
}
|
|
if IsNotFound(err) {
|
|
return 4
|
|
}
|
|
if matchPrefix(err, "input.") {
|
|
return 5
|
|
}
|
|
if matchCode(err, CodeServerRateLimited) {
|
|
return 6
|
|
}
|
|
if matchPrefix(err, "server.") || matchPrefix(err, "network.") {
|
|
return 7
|
|
}
|
|
return 1
|
|
}
|
|
|
|
// PrintError writes err to w in human-readable form. The envelope-aware
|
|
// JSON formatter is in `internal/format`; this helper is the human path used
|
|
// when no command produced its own output.
|
|
//
|
|
// Typed *Error values surface their Hint as a second line so users see the
|
|
// actionable next-step (matches envelope.error.hint visibility in --json).
|
|
// Falls through to defaultHint when caller didn't set one.
|
|
func PrintError(w io.Writer, err error) {
|
|
if err == nil || errors.Is(err, SilentError) {
|
|
return
|
|
}
|
|
fmt.Fprintln(w, err.Error())
|
|
var typed *Error
|
|
if errors.As(err, &typed) {
|
|
hint := typed.Hint
|
|
if hint == "" {
|
|
hint = defaultHint(typed.Code)
|
|
}
|
|
if hint != "" {
|
|
fmt.Fprintf(w, "hint: %s\n", hint)
|
|
}
|
|
}
|
|
}
|
|
|
|
// PrintErrorEnvelope writes err as a JSON envelope on w. Used in agent mode /
|
|
// --json / --format=json output so failures stay machine-parseable. When the
|
|
// error carries an OperationRisk (destructive write paths), it's surfaced as
|
|
// the envelope-level Risk field so agents can decide whether to surface the
|
|
// failure differently to the user.
|
|
func PrintErrorEnvelope(w io.Writer, err error) {
|
|
if err == nil || errors.Is(err, SilentError) {
|
|
return
|
|
}
|
|
env := format.Failure(ToErrorBody(err))
|
|
if r := operationRiskOf(err); r != nil {
|
|
env.Risk = &format.Risk{Level: format.RiskLevel(r.Level), Action: r.Action}
|
|
}
|
|
_ = format.WriteEnvelope(w, env)
|
|
}
|
|
|
|
// operationRiskOf extracts an OperationRisk from a typed *Error chain, or nil.
|
|
func operationRiskOf(err error) *OperationRisk {
|
|
var typed *Error
|
|
if errors.As(err, &typed) {
|
|
return typed.OperationRisk
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ToErrorBody projects err into the canonical envelope ErrorBody. Exposed so
|
|
// other emit paths (planned: MCP) reuse the same projection rather than
|
|
// reimplementing the typed-error → wire-shape mapping.
|
|
func ToErrorBody(err error) *format.ErrorBody {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
body := &format.ErrorBody{Message: err.Error()}
|
|
var typed *Error
|
|
if errors.As(err, &typed) {
|
|
body.Code = string(typed.Code)
|
|
body.Message = typed.Message
|
|
body.Hint = typed.Hint
|
|
if body.Hint == "" {
|
|
body.Hint = defaultHint(typed.Code)
|
|
}
|
|
body.Retryable = typed.Retryable
|
|
// Surface the wrapped cause so agents see the actual server / SDK
|
|
// error string, not just the wrap message ("hybrid search"). The
|
|
// human's printed line and the JSON envelope both end with the
|
|
// underlying problem.
|
|
if typed.Cause != nil {
|
|
body.Message = typed.Message + ": " + typed.Cause.Error()
|
|
}
|
|
return body
|
|
}
|
|
var fe *FlagError
|
|
if errors.As(err, &fe) {
|
|
body.Code = string(CodeInputInvalidArgument)
|
|
return body
|
|
}
|
|
// Unclassified error; consumers see the message but no stable code.
|
|
body.Code = string(CodeServerError)
|
|
return body
|
|
}
|
|
|
|
// defaultHint returns a canonical actionable hint for known error codes when
|
|
// the call site didn't set one. Spec §1.4 zero-config matrix mandates
|
|
// `auth.unauthenticated` envelopes carry "run weknora auth login" — this
|
|
// fallback covers the broad surface (auth status / kb list / kb get / search)
|
|
// without per-command hint plumbing.
|
|
//
|
|
// Empty string for codes without a stable canonical hint.
|
|
func defaultHint(code ErrorCode) string {
|
|
switch code {
|
|
case CodeAuthUnauthenticated, CodeAuthBadCredential:
|
|
return "run `weknora auth login`"
|
|
case CodeAuthTokenExpired:
|
|
return "your session expired; run `weknora auth login` to re-authenticate"
|
|
case CodeAuthForbidden:
|
|
return "active context lacks permission for this resource"
|
|
case CodeAuthCrossTenantBlocked, CodeAuthTenantMismatch:
|
|
return "verify tenant context with `weknora auth status`"
|
|
case CodeNetworkError:
|
|
return "check base URL reachability with `weknora doctor`"
|
|
case CodeServerIncompatibleVersion:
|
|
return "run `weknora doctor` to see version skew details"
|
|
case CodeServerRateLimited:
|
|
return "rate-limited; retry after a few seconds"
|
|
case CodeServerTimeout:
|
|
return "request timed out; retry, or run `weknora doctor` to check connectivity"
|
|
case CodeResourceNotFound:
|
|
return "verify the resource ID; list available with `weknora kb list`"
|
|
case CodeInputInvalidArgument, CodeInputMissingFlag:
|
|
return "see `weknora <command> --help` for valid usage"
|
|
case CodeInputConfirmationRequired:
|
|
return "high-risk write — re-run with -y/--yes after the user explicitly approves"
|
|
case CodeLocalKeychainDenied:
|
|
return "verify keyring access; falls back to file storage"
|
|
case CodeLocalConfigCorrupt:
|
|
return "remove ~/.config/weknora/config.yaml and re-run `weknora auth login`"
|
|
case CodeLocalFileIO:
|
|
return "check file permissions under $XDG_CONFIG_HOME/weknora/"
|
|
case CodeKBIDRequired:
|
|
return "run `weknora link` to bind this directory to a knowledge base, or pass --kb"
|
|
case CodeKBNotFound:
|
|
return "list available with `weknora kb list`"
|
|
case CodeProjectLinkCorrupt:
|
|
return "remove .weknora/project.yaml and run `weknora link` again"
|
|
case CodeUserAborted:
|
|
return "no action taken; pass -y/--yes to skip the confirmation prompt"
|
|
case CodeUploadFileNotFound:
|
|
return "verify the path is correct and readable"
|
|
case CodeSSEStreamAborted:
|
|
return "the streaming answer was cut off mid-flight; retry, or pass --no-stream to buffer the full response"
|
|
case CodeSessionCreateFailed:
|
|
return "could not create a chat session; pass --session-id to reuse an existing session"
|
|
}
|
|
return ""
|
|
}
|