35c79281c8
Final design-pass audit on the v0.3 surface flagged two real gaps. (A) doc view <id> was missing. Every other resource subtree exposes a view verb (kb view, session view) for inspecting a single record, but doc — which has the richest metadata of the three (title, file name, type, size, parse_status, embedding_model, processed_at, error_message) — had no single-doc surface. Users wanting one doc's metadata had to `doc list | grep`. Implementation mirrors kb view: narrow ViewService(GetKnowledge) interface, --json envelope path, human KEY: VALUE renderer. Optional fields are omitted rather than rendered as "-" so the panel is dense. Tested: human renderer, title fallback when FileName empty, omit-empty contract, JSON envelope shape, 404 classification. (B) link had no counterpart. Once .weknora/project.yaml is written, the only way to clear it was `rm` by hand. Both vercel and netlify ship `unlink` as a top-level verb; not having one was a discoverability gap. Top-level rather than `link --clear` follows the verb-noun convention of the rest of the surface — the verb stands alone and the operation isn't parameterised. unlink walks up from cwd via projectlink.Discover (the same parent-chain logic Factory.ResolveKB uses on the read side), so a user in a subdirectory of a linked project can unlink without cd-ing up. Errors with input.invalid_argument when no link is found anywhere in the chain. Idempotent under racy concurrent removal: os.ErrNotExist on os.Remove falls through to a Success envelope since the post-condition holds either way. projectlink package gained Remove() alongside Save / Load / Discover so unlink doesn't reimplement the idempotent-remove pattern inline. Top-level registration in cmd/root.go, alongside link. cli/AGENTS.md verb canon line adds unlink to the locally-introduced list. cli/CHANGELOG.md gains an Added entry for each. 5 unit tests for view + 4 for unlink (cwd / walk-up / no-link error / JSON envelope). Full suite green. Intentionally deferred: - session edit (rename a session): sessions auto-name from the first prompt; polish rather than a gap. - link --clear as an alternative to unlink: top-level unlink is the documented form; aliases would just multiply the surface.
122 lines
3.9 KiB
Go
122 lines
3.9 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeViewSvc scripts a GetKnowledge response. Tests bypass cobra and call
|
|
// runView directly with this fake injected.
|
|
type fakeViewSvc struct {
|
|
doc *sdk.Knowledge
|
|
err error
|
|
}
|
|
|
|
func (f *fakeViewSvc) GetKnowledge(_ context.Context, _ string) (*sdk.Knowledge, error) {
|
|
return f.doc, f.err
|
|
}
|
|
|
|
func TestView_Human_RendersExpectedFields(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
processed := time.Date(2026, 1, 2, 3, 4, 5, 0, time.UTC)
|
|
svc := &fakeViewSvc{doc: &sdk.Knowledge{
|
|
ID: "doc_abc",
|
|
KnowledgeBaseID: "kb1",
|
|
FileName: "policy.pdf",
|
|
Title: "Policy",
|
|
FileType: "pdf",
|
|
FileSize: 2048,
|
|
ParseStatus: "completed",
|
|
EmbeddingModelID: "text-embedding-3",
|
|
CreatedAt: time.Date(2026, 1, 1, 0, 0, 0, 0, time.UTC),
|
|
UpdatedAt: time.Date(2026, 1, 2, 0, 0, 0, 0, time.UTC),
|
|
ProcessedAt: &processed,
|
|
}}
|
|
if err := runView(context.Background(), &ViewOptions{}, svc, "doc_abc"); err != nil {
|
|
t.Fatalf("runView: %v", err)
|
|
}
|
|
got := out.String()
|
|
for _, want := range []string{
|
|
"ID:", "doc_abc", "NAME:", "policy.pdf", "KB:", "kb1",
|
|
"TYPE:", "pdf", "SIZE:", "STATUS:", "completed",
|
|
"EMBEDDING:", "text-embedding-3", "PROCESSED:",
|
|
} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("missing %q in:\n%s", want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
// A doc with no FileName falls back to Title for the NAME line — same
|
|
// ordering as `doc list` (KnowledgeDisplayName precedence).
|
|
func TestView_Human_TitleFallback(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewSvc{doc: &sdk.Knowledge{ID: "doc_url", Title: "Pasted article", FileName: ""}}
|
|
if err := runView(context.Background(), &ViewOptions{}, svc, "doc_url"); err != nil {
|
|
t.Fatalf("runView: %v", err)
|
|
}
|
|
got := out.String()
|
|
if !strings.Contains(got, "Pasted article") {
|
|
t.Errorf("expected Title fallback in NAME line; got:\n%s", got)
|
|
}
|
|
}
|
|
|
|
// Optional fields (ProcessedAt nil, ErrorMessage empty, EmbeddingModelID
|
|
// empty) must not produce empty KEY: lines — the formatter omits them
|
|
// rather than printing "PROCESSED: -".
|
|
func TestView_Human_OmitsEmptyFields(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewSvc{doc: &sdk.Knowledge{
|
|
ID: "doc_abc",
|
|
FileName: "x.txt",
|
|
}}
|
|
if err := runView(context.Background(), &ViewOptions{}, svc, "doc_abc"); err != nil {
|
|
t.Fatalf("runView: %v", err)
|
|
}
|
|
// Line-prefix match (not substring): "ERROR:" as a substring could
|
|
// also appear inside `STATUS: error` if a future test seeds
|
|
// ParseStatus="error". Splitting by newline pins the assertion to the
|
|
// label column.
|
|
lines := strings.Split(out.String(), "\n")
|
|
for _, prefix := range []string{"PROCESSED:", "EMBEDDING:", "ERROR:"} {
|
|
for _, l := range lines {
|
|
if strings.HasPrefix(l, prefix) {
|
|
t.Errorf("expected no line beginning with %q (empty field), got: %q", prefix, l)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestView_JSON_EmitsEnvelope(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeViewSvc{doc: &sdk.Knowledge{ID: "doc_abc", FileName: "x.txt", KnowledgeBaseID: "kb1"}}
|
|
if err := runView(context.Background(), &ViewOptions{JSONOut: true}, svc, "doc_abc"); err != nil {
|
|
t.Fatalf("runView: %v", err)
|
|
}
|
|
got := out.String()
|
|
for _, want := range []string{`"ok":true`, `"id":"doc_abc"`, `"file_name":"x.txt"`, `"knowledge_base_id":"kb1"`} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("missing %q in:\n%s", want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestView_NotFound_ClassifiedAs404(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeViewSvc{err: errors.New("HTTP error 404: not found")}
|
|
err := runView(context.Background(), &ViewOptions{}, svc, "missing")
|
|
if err == nil {
|
|
t.Fatal("expected error")
|
|
}
|
|
if !cmdutil.IsNotFound(err) {
|
|
t.Errorf("expected resource.not_found, got %v", err)
|
|
}
|
|
}
|