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.
155 lines
5.2 KiB
Go
155 lines
5.2 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
type DownloadOptions struct {
|
|
Output string // --output / -O: target path, "-" for stdout, "" for server-suggested filename
|
|
Clobber bool // --clobber: allow overwrite of an existing file
|
|
}
|
|
|
|
// DownloadService is the narrow SDK surface this command depends on. The
|
|
// CLI calls OpenKnowledgeFile so it can inspect the server-suggested
|
|
// filename and refuse-to-overwrite *before* streaming any bytes.
|
|
type DownloadService interface {
|
|
OpenKnowledgeFile(ctx context.Context, knowledgeID string) (string, io.ReadCloser, error)
|
|
}
|
|
|
|
// NewCmdDownload builds `weknora doc download <id>`. Positional id, output
|
|
// flag, `-` sentinel for stdout. Flags: `-O, --output <file>` for
|
|
// destination, `--clobber` for overwrite control.
|
|
func NewCmdDownload(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &DownloadOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "download <id>",
|
|
Short: "Download a document by ID",
|
|
Long: `Streams the document bytes to disk (or stdout with --output -).
|
|
|
|
Default behavior (no --output): writes to the cwd under the filename the
|
|
server suggests via Content-Disposition. If the server doesn't suggest
|
|
one, the command errors and asks for --output FILE explicitly.
|
|
|
|
Existing files are NOT overwritten unless --clobber is passed.`,
|
|
Example: ` weknora doc download doc_abc # writes ./<server-name>
|
|
weknora doc download doc_abc -O report.pdf
|
|
weknora doc download doc_abc --output - # stream to stdout (binary safe)
|
|
weknora doc download doc_abc -O report.pdf --clobber`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runDownload(c.Context(), opts, cli, args[0])
|
|
},
|
|
}
|
|
cmd.Flags().StringVarP(&opts.Output, "output", "O", "", `Output path; "-" for stdout. Defaults to the server-suggested filename.`)
|
|
cmd.Flags().BoolVar(&opts.Clobber, "clobber", false, "Overwrite the output file if it already exists")
|
|
agent.SetAgentHelp(cmd, "Downloads a document. Agents that pipe the bytes should pass --output - (stdout). The exit code is 0 on success, 1 on resource.not_found, 5 on missing --output when the server didn't supply a filename.")
|
|
return cmd
|
|
}
|
|
|
|
func runDownload(ctx context.Context, opts *DownloadOptions, svc DownloadService, id string) error {
|
|
suggested, body, err := svc.OpenKnowledgeFile(ctx, id)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "download %s", id)
|
|
}
|
|
defer body.Close()
|
|
|
|
dest, err := resolveDownloadDest(opts, suggested)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if dest == "-" {
|
|
_, err := io.Copy(iostreams.IO.Out, body)
|
|
return err
|
|
}
|
|
if err := refuseIfExists(dest, opts.Clobber); err != nil {
|
|
return err
|
|
}
|
|
return streamToFile(body, dest)
|
|
}
|
|
|
|
// resolveDownloadDest returns the final destination ("-" for stdout, an
|
|
// absolute or relative path otherwise) after applying the --output flag
|
|
// and sanitizing the server-suggested name. A server that returns a path-
|
|
// like filename (..\, /etc/foo) is rejected — only the basename is
|
|
// accepted.
|
|
func resolveDownloadDest(opts *DownloadOptions, suggested string) (string, error) {
|
|
if opts.Output == "-" {
|
|
return "-", nil
|
|
}
|
|
if opts.Output != "" {
|
|
return opts.Output, nil
|
|
}
|
|
if suggested == "" {
|
|
return "", &cmdutil.Error{
|
|
Code: cmdutil.CodeInputMissingFlag,
|
|
Message: "server did not supply a filename and --output is unset",
|
|
Hint: "pass --output FILE (or --output - for stdout)",
|
|
}
|
|
}
|
|
base := filepath.Base(suggested)
|
|
if base == "" || base == "." || base == string(filepath.Separator) {
|
|
return "", &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("server returned an unusable filename %q", suggested),
|
|
Hint: "pass --output FILE explicitly",
|
|
}
|
|
}
|
|
return base, nil
|
|
}
|
|
|
|
// refuseIfExists returns CodeInputInvalidArgument when path is present on
|
|
// disk and clobber is false. Missing-file is success.
|
|
func refuseIfExists(path string, clobber bool) error {
|
|
if clobber {
|
|
return nil
|
|
}
|
|
_, err := os.Stat(path)
|
|
if errors.Is(err, os.ErrNotExist) {
|
|
return nil
|
|
}
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "stat %s", path)
|
|
}
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("%s already exists", path),
|
|
Hint: "pass --clobber to overwrite",
|
|
}
|
|
}
|
|
|
|
// streamToFile copies body into a newly-created file at path. On any
|
|
// streaming error the partial file is removed so callers don't see a
|
|
// truncated artifact at the user-visible path.
|
|
func streamToFile(body io.Reader, path string) error {
|
|
f, err := os.Create(path)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "create %s", path)
|
|
}
|
|
if _, err := io.Copy(f, body); err != nil {
|
|
_ = f.Close()
|
|
_ = os.Remove(path)
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "write %s", path)
|
|
}
|
|
if err := f.Close(); err != nil {
|
|
_ = os.Remove(path)
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "close %s", path)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Err, "✓ Saved %s\n", path)
|
|
return nil
|
|
}
|