mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-30 16:53:21 +08:00
c87e35b34b
Code-reuse polish (post-implementation review pass): - Extract text.OneLine(maxWidth, s) helper combining preview-row normalization (newline/CR/tab → space) with text.Truncate's UTF-8-safe truncation. Replaces agent/view.go truncate1Line (ASCII '...' + byte-slice CJK-unsafe) and chunk/list.go singleLine. - Lift cmdutil.OpenInput(path) for the '-' = stdin / else os.Open pattern shared across agent create/edit and the api command. Replaces agent/create.go's private openInput. - Strip inline doc-spec parentheticals from source comments — those belong in commit messages and project docs, not in source where they rot. Pre-PR audit fixes: - doc upload: reject `--metadata` paired with `--from-url` as input.invalid_argument up-front (the URL-ingest request type has no metadata field server-side, so the pair would otherwise silently drop). Long help and CHANGELOG updated to call out the asymmetry. - doc upload (file path): map sdk.ErrDuplicateFile sentinel to resource.already_exists. The sentinel arrives with no "HTTP error <n>:" prefix because the SDK short-circuits on file-hash before reading the HTTP status, so the previous WrapHTTP fall-through misclassified it as network.error with a misleading "check base URL reachability" hint. The --from-url branch already handled ErrDuplicateURL this way; this closes the asymmetry. Caught by e2e re-upload of an already-ingested file; regression test added. - README exit-10 enumeration adds `agent delete` and `chunk delete` (these were missing alongside the v0.5 destructive verbs they were meant to gate). Docs sync: - cli/README.md: command tree now includes the chunk subtree; adds agent / chunk lines to the 5-minute quickstart; adds a "Contributing / Reporting issues" section pointing at the repo's SECURITY.md and AGENTS.md; drops third-party CLI parallels from the surface description. - cli/AGENTS.md: "Command surface design SOP" gains the flag-vs-escape-hatch step. "CRUD command flag canon" renamed to the hard-required-flags pattern with the contrast (TTY-prompts-fill) defined inline rather than via opaque shorthand. - cli/CHANGELOG.md: search docs case-sensitivity shift promoted to its own #### Breaking changes subsection. MCP doc_list filter count corrected from 5 to 6. Drops the bogus go.mod yaml.v3 entry (yaml.v3 was already a dependency on main; v0.5 added zero go.mod lines). Replaces internal-Go identifiers (fuzzyTime, NoOptDefVal) with user-language and drops the § section-symbol jargon.
180 lines
5.7 KiB
Go
180 lines
5.7 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io/fs"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// uploadOutcome is one entry in the recursive upload's per-file report.
|
|
type uploadOutcome struct {
|
|
Path string `json:"path"`
|
|
ID string `json:"id,omitempty"`
|
|
Error string `json:"error,omitempty"`
|
|
}
|
|
|
|
// runUploadRecursive walks dir, filters by Glob, and uploads each match
|
|
// sequentially. Per-file errors do NOT abort the walk - they accumulate
|
|
// and the final return aggregates them so the user sees the full picture
|
|
// in one run. Exit semantics: nil error on full success, a typed *cmdutil.Error
|
|
// when ≥1 file failed (the typed code mirrors the first failure's
|
|
// classification so callers can still branch).
|
|
func runUploadRecursive(ctx context.Context, opts *UploadOptions, jopts *cmdutil.JSONOptions, svc UploadService, kbID, dir string) error {
|
|
if opts.Name != "" {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: "--name cannot be combined with --recursive (one name can't apply to N files)",
|
|
Hint: "drop --name or upload files one at a time",
|
|
}
|
|
}
|
|
// URL-mode-only flags are not meaningful for a directory walk;
|
|
// rejectURLOnlyFlags is the single source of truth shared with
|
|
// file-mode upload.
|
|
if err := rejectURLOnlyFlags(opts); err != nil {
|
|
return err
|
|
}
|
|
// Parse --metadata up front so a malformed value aborts before the
|
|
// first SDK call - otherwise a typo in `key=value` would only surface
|
|
// per-file as repeated identical errors.
|
|
meta, err := parseMetadataKV(opts.Metadata)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
info, err := os.Stat(dir)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return cmdutil.Wrapf(cmdutil.CodeUploadFileNotFound, err, "directory not found: %s", dir)
|
|
}
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "stat %s", dir)
|
|
}
|
|
if !info.IsDir() {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("not a directory: %s (drop --recursive to upload a single file)", dir),
|
|
}
|
|
}
|
|
|
|
// Sanity-check the pattern up front so a typo doesn't show up as "no
|
|
// files matched" per-file. Cobra populates --glob; tests pass it
|
|
// explicitly - no in-function default needed.
|
|
if _, err := filepath.Match(opts.Glob, ""); err != nil {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("invalid --glob %q: %v", opts.Glob, err),
|
|
}
|
|
}
|
|
|
|
matches, err := walkMatches(dir, opts.Glob)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "walk %s", dir)
|
|
}
|
|
if len(matches) == 0 {
|
|
if jopts.Enabled() {
|
|
return jopts.Emit(iostreams.IO.Out, recursiveResult{KBID: kbID})
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "(no files matched %q under %s)\n", opts.Glob, dir)
|
|
return nil
|
|
}
|
|
|
|
var uploaded, failed []uploadOutcome
|
|
var firstFailCode cmdutil.ErrorCode
|
|
channel := effectiveChannel(opts)
|
|
for _, p := range matches {
|
|
k, err := svc.CreateKnowledgeFromFile(ctx, kbID, p, meta, opts.EnableMultimodel, "", channel)
|
|
if err != nil {
|
|
code := cmdutil.ClassifyHTTPError(err)
|
|
if firstFailCode == "" {
|
|
firstFailCode = code
|
|
}
|
|
failed = append(failed, uploadOutcome{Path: p, Error: err.Error()})
|
|
// Per-file progress lines are human progress signal; suppress
|
|
// under --json so they don't precede the JSON object on stdout.
|
|
if !jopts.Enabled() {
|
|
fmt.Fprintf(iostreams.IO.Out, "FAIL %s: %v\n", filepath.Base(p), err)
|
|
}
|
|
continue
|
|
}
|
|
id := ""
|
|
if k != nil {
|
|
id = k.ID
|
|
}
|
|
uploaded = append(uploaded, uploadOutcome{Path: p, ID: id})
|
|
if !jopts.Enabled() {
|
|
fmt.Fprintf(iostreams.IO.Out, "OK %s (id: %s)\n", filepath.Base(p), id)
|
|
}
|
|
}
|
|
|
|
if jopts.Enabled() {
|
|
result := recursiveResult{KBID: kbID, Uploaded: uploaded, Failed: failed}
|
|
if err := jopts.Emit(iostreams.IO.Out, result); err != nil {
|
|
return err
|
|
}
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "Uploaded %d, Failed %d\n", len(uploaded), len(failed))
|
|
}
|
|
|
|
if len(failed) > 0 {
|
|
// Silent on the --json path: the success object above already
|
|
// carries per-file uploaded[]/failed[] detail; without Silent the
|
|
// root error handler would print to stderr in addition. ExitCode
|
|
// still walks Code so the typed exit-code-by-class contract holds.
|
|
return &cmdutil.Error{
|
|
Code: firstFailCode,
|
|
Message: fmt.Sprintf("%d of %d uploads failed", len(failed), len(matches)),
|
|
Silent: jopts.Enabled(),
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// recursiveResult is the JSON shape emitted under data when --recursive is
|
|
// combined with --json. Mirrors the human-mode per-file output: a list of
|
|
// successes (Uploaded) and a list of failures (Failed), each with the
|
|
// originating path so agents can re-try only the failed entries.
|
|
type recursiveResult struct {
|
|
KBID string `json:"kb_id"`
|
|
Uploaded []uploadOutcome `json:"uploaded,omitempty"`
|
|
Failed []uploadOutcome `json:"failed,omitempty"`
|
|
}
|
|
|
|
// walkMatches returns every regular file under root whose base name matches
|
|
// pattern. Order is filepath.WalkDir's lexical order (stdlib guarantee on
|
|
// every supported FS), which is deterministic for test assertions.
|
|
func walkMatches(root, pattern string) ([]string, error) {
|
|
var out []string
|
|
err := filepath.WalkDir(root, func(p string, d fs.DirEntry, err error) error {
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if d.IsDir() {
|
|
return nil
|
|
}
|
|
// Skip non-regular files (sockets, devices); the SDK can't upload
|
|
// them and they'd show as opaque server errors.
|
|
info, ierr := d.Info()
|
|
if ierr != nil {
|
|
return ierr
|
|
}
|
|
if !info.Mode().IsRegular() {
|
|
return nil
|
|
}
|
|
ok, merr := filepath.Match(pattern, d.Name())
|
|
if merr != nil {
|
|
return merr
|
|
}
|
|
if ok {
|
|
out = append(out, p)
|
|
}
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return out, nil
|
|
}
|