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.
86 lines
3.1 KiB
Go
86 lines
3.1 KiB
Go
// Package xdg consolidates the XDG-rooted file path lookup and atomic-write
|
||
// idioms used by config / compat / secrets / future stores.
|
||
//
|
||
// Before extraction these patterns were copy-pasted across cli/internal/{config,
|
||
// compat, secrets}; reuse review surfaced 3× duplication of Path and 2× of the
|
||
// tmp+rename atomic-write recipe. Centralizing here means a single place to fix
|
||
// behavior (mode bits, fallback dirs, mkdir order, error wrapping) and one less
|
||
// thing to copy when v0.2 adds project-link / state stores.
|
||
package xdg
|
||
|
||
import (
|
||
"fmt"
|
||
"os"
|
||
"path/filepath"
|
||
|
||
"gopkg.in/yaml.v3"
|
||
)
|
||
|
||
// Path resolves an XDG-rooted file. envVar is one of "XDG_CONFIG_HOME" /
|
||
// "XDG_CACHE_HOME" / "XDG_DATA_HOME". fallbackDir is the dot-prefixed dir
|
||
// under $HOME used when the env var is unset (".config" / ".cache" / etc.).
|
||
// parts join under "weknora/" inside the chosen root.
|
||
//
|
||
// Honors the XDG vars on every OS, even macOS — where os.UserConfigDir
|
||
// would otherwise return ~/Library/Application Support.
|
||
func Path(envVar, fallbackDir string, parts ...string) (string, error) {
|
||
if x := os.Getenv(envVar); x != "" {
|
||
return filepath.Join(append([]string{x, "weknora"}, parts...)...), nil
|
||
}
|
||
home, err := os.UserHomeDir()
|
||
if err != nil {
|
||
return "", fmt.Errorf("locate home dir: %w", err)
|
||
}
|
||
return filepath.Join(append([]string{home, fallbackDir, "weknora"}, parts...)...), nil
|
||
}
|
||
|
||
// WriteAtomicYAML marshals v to YAML and writes it atomically at p with mode
|
||
// 0600 (user-only). Creates parent dirs with mode 0700. Atomicity via
|
||
// CreateTemp + chmod + rename so partial writes never expose a half-baked
|
||
// file and concurrent writers never trample each other's tmp.
|
||
//
|
||
// 0600 is the appropriate floor even for non-secret stores (cache, project
|
||
// link) since they may sit alongside secrets in the same dir tree.
|
||
//
|
||
// On any failure after the tmp is created, the tmp is cleaned up so we don't
|
||
// litter the dir with `*.tmp.NNNN` artifacts on crash / cross-device errors.
|
||
func WriteAtomicYAML(p string, v any) error {
|
||
dir := filepath.Dir(p)
|
||
if err := os.MkdirAll(dir, 0o700); err != nil {
|
||
return fmt.Errorf("mkdir %s: %w", dir, err)
|
||
}
|
||
data, err := yaml.Marshal(v)
|
||
if err != nil {
|
||
return fmt.Errorf("marshal: %w", err)
|
||
}
|
||
// CreateTemp picks a unique name in dir so concurrent calls never collide
|
||
// on a shared `<p>.tmp`. Pattern reserves the suffix slot.
|
||
tmp, err := os.CreateTemp(dir, filepath.Base(p)+".tmp.*")
|
||
if err != nil {
|
||
return fmt.Errorf("create tmp in %s: %w", dir, err)
|
||
}
|
||
tmpName := tmp.Name()
|
||
// Best-effort cleanup on any failure path; no-op once Rename succeeds.
|
||
committed := false
|
||
defer func() {
|
||
if !committed {
|
||
_ = os.Remove(tmpName)
|
||
}
|
||
}()
|
||
if _, err := tmp.Write(data); err != nil {
|
||
_ = tmp.Close()
|
||
return fmt.Errorf("write %s: %w", tmpName, err)
|
||
}
|
||
if err := tmp.Close(); err != nil {
|
||
return fmt.Errorf("close %s: %w", tmpName, err)
|
||
}
|
||
if err := os.Chmod(tmpName, 0o600); err != nil {
|
||
return fmt.Errorf("chmod %s: %w", tmpName, err)
|
||
}
|
||
if err := os.Rename(tmpName, p); err != nil {
|
||
return fmt.Errorf("rename %s -> %s: %w", tmpName, p, err)
|
||
}
|
||
committed = true
|
||
return nil
|
||
}
|