refactor(cli): envelope sweep — Emit shape, batch ops, MCP StructuredContent, api flag cleanup

Sweep every CLI output path through the v0.7 envelope contract.

FormatOptions.Emit signature changes to (w, data, meta *output.Meta)
so list commands surface meta.count / has_more in the wire envelope.
TTY indent decision plumbed via FormatOptions.TTY (set by
ResolveDefault). --format and --jq promoted to persistent root flags
so unknown-subcommand paths still reach the typed-envelope guard
(per-command registration would have rejected --format on unknown
commands as cobra-prose exit 2). WEKNORA_FORMAT env-var fallback
honored before TTY-resolved default. AddFormatFlag retained for the
per-command --jq field-hint Long-text addendum.

~55 production Emit call sites swept across cli/cmd/**: list paths
populate meta.count; mutation paths pass nil meta; envelope.profile
threaded via globalProfile. Existing JSON-shape tests migrated to
decode the envelope wrapper.

Multi-target batch operations get a unified shape via new helpers:
- output.BatchItem + output.WriteBatchEnvelope (§4.5 per-item ok
  pattern; data:[{id, ok, result?|error?}], meta:{count, successes*,
  failures*}; Successes/Failures *int so explicit zero survives
  omitempty in all-fail case).
- cmdutil.RunBatch + cmdutil.EmitBatch + cmdutil.DeletedAtNow +
  cmdutil.ClassifyContextErr collapse the three previously-duplicated
  multi-delete pipelines (doc / chunk / session) into one call site
  pattern. doc upload --recursive uses the same helpers with a per-
  file resultFn. Summary error sets Silent:true so the stderr
  envelope path doesn't duplicate the stdout batch detail (exit 1
  preserved via Code → ExitCode).

ConfirmDestructive / ConfirmDestructiveBatch extended with action +
retryCmd parameters. Every destructive command (kb delete, kb edit,
doc delete, doc delete --all, agent delete, agent edit, session
delete, chunk delete, auth logout, api -X DELETE) now attaches
error.risk.{level:"destructive", action:"<noun.verb>"} +
error.retry_command on the exit-10 envelope. kb edit / agent edit
also gain the destructive guard wiring (CHANGELOG listed them as
gated but they were silently executing without -y).

MCP tool handlers' 31 error paths return CallToolResult with
IsError + Content text fallback + StructuredContent (envelope.error
shape via cmdutil.ErrorToDetail). Handler Out type changed from
typed *sdk.X to any so the go-sdk auto-marshal doesn't overwrite
StructuredContent with a zero-struct on error returns. Success path
manually populates CallToolResult.StructuredContent via successResult
helper.

weknora api cleanup:
- -d/--data flag removed; body via --input <file> or --input -
  (stdin) only. Aligns with gh / curl convention.
- HTTP method whitelist removed; any non-empty method accepted.
- HTTP Retry-After header → cmdutil.Error.RetryAfterSeconds →
  envelope.error.retry_after_seconds.
- runAPIPaginated raw-passthrough fallback now wraps response in
  envelope so --paginate never emits bare JSON to stdout.

Test sweep: ~60 cmd/** tests migrated to decode envelope shape.
9 wire-contract goldens updated under cli/acceptance/testdata/wire/.

Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §4 / §5
This commit is contained in:
nullkey
2026-05-21 18:41:56 +08:00
committed by lyingbug
parent 733bb3aaa1
commit ad150c7126
96 changed files with 2354 additions and 864 deletions
+1 -5
View File
@@ -17,9 +17,7 @@ import (
const chunkLong = `Manage and inspect document chunks.
Chunks are the indexed pieces of a knowledge document (1 doc → many chunks).
Use 'chunk list' to enumerate chunks in stored order (RAG admin / debug).
For relevance-ranked retrieval, use 'search chunks "<query>" --kb <id>'
instead — that runs hybrid vector + keyword scoring across all chunks.`
Use 'chunk list' to enumerate chunks in stored order (RAG admin / debug).`
// NewCmdChunk builds the parent `chunk` command. Called from cli/cmd/root.go.
func NewCmdChunk(f *cmdutil.Factory) *cobra.Command {
@@ -27,8 +25,6 @@ func NewCmdChunk(f *cmdutil.Factory) *cobra.Command {
Use: "chunk <subcommand>",
Short: "Manage document chunks (RAG retrieval debug)",
Long: chunkLong,
Args: cobra.NoArgs,
Run: func(c *cobra.Command, _ []string) { _ = c.Help() },
}
cmd.AddCommand(NewCmdList(f))
cmd.AddCommand(NewCmdView(f))
+27 -59
View File
@@ -3,7 +3,7 @@ package chunkcmd
import (
"context"
"fmt"
"io"
"strings"
"github.com/spf13/cobra"
@@ -13,7 +13,7 @@ import (
)
// chunkDeleteFields enumerates the JSON discovery fields for `chunk delete`.
// Tracks the single-id result struct; multi-id mode emits MultiDeleteResult.
// Tracks the single-id result struct; multi-id mode emits batch envelope.
var chunkDeleteFields = []string{"id", "deleted"}
type DeleteOptions struct {
@@ -33,20 +33,6 @@ type deleteResult struct {
Deleted bool `json:"deleted"`
}
// MultiDeleteResult is the payload for multi-id deletes. All chunks share the
// same --doc parent (server route is DELETE /chunks/{doc}/{id}).
type MultiDeleteResult struct {
OK []string `json:"ok"`
Failed []FailedItem `json:"failed,omitempty"`
}
// FailedItem records an id that failed to delete along with its error message.
type FailedItem struct {
ID string `json:"id"`
Code string `json:"code,omitempty"`
Message string `json:"message"`
}
const chunkDeleteLong = `Permanently delete one or more chunks from a document.
Requires both the chunk id(s) (positional, repeatable) and the parent
@@ -105,12 +91,20 @@ func NewCmdDelete(f *cmdutil.Factory) *cobra.Command {
opts.ChunkID = args[0]
return runDelete(c.Context(), opts, fopts, cli, f.Prompter())
}
res, runErr := runMultiDelete(c.Context(), opts, fopts, cli, f.Prompter(), args)
if err := cmdutil.ConfirmDestructiveBatch(f.Prompter(), opts.Yes, fopts.WantsJSON(), "chunk", len(args), "chunk.delete", "weknora chunk delete "+strings.Join(args, " ")+" --doc "+opts.DocID+" -y"); err != nil {
return err
}
outcomes, runErr := cmdutil.RunBatch(c.Context(), args, func(ctx context.Context, id string) error {
if err := cli.DeleteChunk(ctx, opts.DocID, id); err != nil {
return cmdutil.WrapHTTP(err, "delete chunk %s", id)
}
return nil
})
// Only emit when the operation actually ran. Pre-flight errors
// (e.g. confirmation_required) must leave stdout empty per the
// wire contract in README.md.
if len(res.OK) > 0 || len(res.Failed) > 0 {
if emitErr := emitMultiDelete(res, fopts, iostreams.IO.Out); emitErr != nil {
if len(outcomes) > 0 {
if emitErr := cmdutil.EmitBatch(outcomes, fopts, iostreams.IO.Out, cmdutil.DeletedAtNow); emitErr != nil {
return emitErr
}
}
@@ -120,57 +114,31 @@ func NewCmdDelete(f *cmdutil.Factory) *cobra.Command {
cmd.Flags().StringVar(&opts.DocID, "doc", "", "Parent document id (SDK knowledge_id) the chunks live under")
_ = cmd.MarkFlagRequired("doc")
cmdutil.AddFormatFlag(cmd, chunkDeleteFields...)
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
UsedFor: "permanently delete one or more chunks from a document",
RequiredFlags: []string{"<chunk-id>... (positional, at least one)", "--doc <doc-id>"},
Examples: []string{
"weknora chunk delete chunk_abc --doc doc_xyz -y",
"weknora chunk delete c1 c2 c3 --doc doc_xyz -y",
"weknora chunk delete chunk_abc --doc doc_xyz -y --format json",
},
Warnings: []string{
"chunk delete removes a chunk from a doc permanently. Never auto-add -y unless the user explicitly approves the specific chunk id.",
},
})
return cmd
}
func runDelete(ctx context.Context, opts *DeleteOptions, fopts *cmdutil.FormatOptions, svc DeleteService, p prompt.Prompter) error {
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), "chunk", opts.ChunkID); err != nil {
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), "chunk", opts.ChunkID, "chunk.delete", "weknora chunk delete "+opts.ChunkID+" --doc "+opts.DocID+" -y"); err != nil {
return err
}
if err := svc.DeleteChunk(ctx, opts.DocID, opts.ChunkID); err != nil {
return cmdutil.WrapHTTP(err, "delete chunk %s", opts.ChunkID)
}
if fopts.WantsJSON() {
return fopts.Emit(iostreams.IO.Out, deleteResult{ID: opts.ChunkID, Deleted: true})
return fopts.Emit(iostreams.IO.Out, deleteResult{ID: opts.ChunkID, Deleted: true}, nil)
}
fmt.Fprintf(iostreams.IO.Out, "✓ Deleted chunk %s\n", opts.ChunkID)
return nil
}
// runMultiDelete iterates chunkIDs sequentially under opts.DocID, keep-going
// on error: a single failure does not abort the run.
func runMultiDelete(ctx context.Context, opts *DeleteOptions, fopts *cmdutil.FormatOptions, svc DeleteService, p prompt.Prompter, chunkIDs []string) (*MultiDeleteResult, error) {
if err := cmdutil.ConfirmDestructiveBatch(p, opts.Yes, fopts.WantsJSON(), "chunk", len(chunkIDs)); err != nil {
return &MultiDeleteResult{}, err
}
res := &MultiDeleteResult{}
for _, id := range chunkIDs {
if err := svc.DeleteChunk(ctx, opts.DocID, id); err != nil {
res.Failed = append(res.Failed, FailedItem{ID: id, Message: err.Error()})
continue
}
res.OK = append(res.OK, id)
}
if len(res.Failed) > 0 {
return res, cmdutil.NewError(cmdutil.CodeOperationFailed, fmt.Sprintf("%d/%d delete(s) failed", len(res.Failed), len(chunkIDs)))
}
return res, nil
}
// emitMultiDelete renders per --format. Mirrors doc / session delete.
func emitMultiDelete(res *MultiDeleteResult, fopts *cmdutil.FormatOptions, w io.Writer) error {
switch fopts.Mode {
case cmdutil.FormatJSON, cmdutil.FormatNDJSON:
return fopts.Emit(w, res)
case cmdutil.FormatText, "":
for _, id := range res.OK {
fmt.Fprintf(w, "OK %s\n", id)
}
for _, f := range res.Failed {
fmt.Fprintf(w, "FAIL %s: %s\n", f.ID, f.Message)
}
return nil
default:
return fmt.Errorf("unsupported --format %q for chunk delete", fopts.Mode)
}
}
+88 -17
View File
@@ -1,7 +1,9 @@
package chunkcmd
import (
"bytes"
"context"
"encoding/json"
"errors"
"testing"
@@ -74,7 +76,7 @@ func TestDelete_TTY_ConfirmYes_Calls(t *testing.T) {
p := &testutil.ConfirmPrompter{Answer: true}
require.NoError(t, runDelete(context.Background(),
&DeleteOptions{ChunkID: "c1", DocID: "doc_abc"},
&cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p))
&cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc, p))
assert.True(t, p.Asked)
assert.Equal(t, "c1", svc.gotChunkID)
}
@@ -85,7 +87,7 @@ func TestDelete_TTY_ConfirmNo_Aborts(t *testing.T) {
p := &testutil.ConfirmPrompter{Answer: false}
err := runDelete(context.Background(),
&DeleteOptions{ChunkID: "c1", DocID: "doc_abc"},
&cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, p)
&cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc, p)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
@@ -129,12 +131,20 @@ func (f *fakeMultiChunkDeleteSvc) DeleteChunk(_ context.Context, docID, chunkID
func TestMultiDelete_AllSucceed_SharedDoc(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeMultiChunkDeleteSvc{}
res, err := runMultiDelete(context.Background(),
&DeleteOptions{DocID: "doc_xyz", Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{},
[]string{"c1", "c2", "c3"})
docID := "doc_xyz"
outcomes, err := cmdutil.RunBatch(context.Background(),
[]string{"c1", "c2", "c3"},
func(ctx context.Context, id string) error {
if err := svc.DeleteChunk(ctx, docID, id); err != nil {
return cmdutil.WrapHTTP(err, "delete chunk %s", id)
}
return nil
})
require.NoError(t, err)
assert.Equal(t, []string{"c1", "c2", "c3"}, res.OK)
assert.Empty(t, res.Failed)
require.Len(t, outcomes, 3)
for _, oc := range outcomes {
assert.Nil(t, oc.Err, "expected no error for %s", oc.ID)
}
// All calls observed the same --doc.
for _, d := range svc.docIDs {
assert.Equal(t, "doc_xyz", d)
@@ -144,29 +154,90 @@ func TestMultiDelete_AllSucceed_SharedDoc(t *testing.T) {
func TestMultiDelete_PartialFailure_KeepsGoing(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeMultiChunkDeleteSvc{failOn: map[string]error{"c2": errors.New("HTTP error 404: not found")}}
res, err := runMultiDelete(context.Background(),
&DeleteOptions{DocID: "doc_xyz", Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{},
[]string{"c1", "c2", "c3"})
docID := "doc_xyz"
outcomes, err := cmdutil.RunBatch(context.Background(),
[]string{"c1", "c2", "c3"},
func(ctx context.Context, id string) error {
if err := svc.DeleteChunk(ctx, docID, id); err != nil {
return cmdutil.WrapHTTP(err, "delete chunk %s", id)
}
return nil
})
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeOperationFailed, typed.Code)
assert.Equal(t, []string{"c1", "c3"}, res.OK, "keep-going: c3 still attempted after c2 failed")
assert.Len(t, res.Failed, 1)
assert.Equal(t, "c2", res.Failed[0].ID)
require.Len(t, outcomes, 3, "all three ids must appear in outcomes (argv order preserved)")
assert.Nil(t, outcomes[0].Err, "c1 should succeed")
assert.NotNil(t, outcomes[1].Err, "c2 should fail")
assert.Nil(t, outcomes[2].Err, "c3 should succeed (keep-going)")
assert.Equal(t, "c2", outcomes[1].ID)
}
func TestMultiDelete_NonTTY_NoYes_RequiresConfirmation(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeMultiChunkDeleteSvc{}
res, err := runMultiDelete(context.Background(),
&DeleteOptions{DocID: "doc_xyz"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc, &testutil.ConfirmPrompter{},
[]string{"c1", "c2"})
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}
err := cmdutil.ConfirmDestructiveBatch(&testutil.ConfirmPrompter{}, false, fopts.WantsJSON(), "chunk", 2, "chunk.delete", "")
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
assert.Equal(t, 10, cmdutil.ExitCode(err))
assert.Empty(t, res.OK)
assert.Empty(t, svc.deleted)
}
// TestChunkDelete_MultiID_PartialFailure_BatchEnvelope verifies that the JSON
// output for a multi-id partial failure uses the §4.5 batch envelope shape:
// {ok:false, data:[{id,ok,result?|error?}...], meta:{count,successes,failures}}.
func TestChunkDelete_MultiID_PartialFailure_BatchEnvelope(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeMultiChunkDeleteSvc{failOn: map[string]error{
"c2": errors.New("HTTP error 404: not found"),
}}
docID := "doc_xyz"
outcomes, runErr := cmdutil.RunBatch(context.Background(),
[]string{"c1", "c2", "c3"},
func(ctx context.Context, id string) error {
if err := svc.DeleteChunk(ctx, docID, id); err != nil {
return cmdutil.WrapHTTP(err, "delete chunk %s", id)
}
return nil
})
require.Error(t, runErr)
require.Len(t, outcomes, 3)
var buf bytes.Buffer
require.NoError(t, cmdutil.EmitBatch(outcomes, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, &buf, cmdutil.DeletedAtNow))
var env struct {
OK bool `json:"ok"`
Data []struct {
ID string `json:"id"`
OK bool `json:"ok"`
Error *struct {
Type string `json:"type"`
Message string `json:"message"`
} `json:"error,omitempty"`
} `json:"data"`
Meta struct {
Count int `json:"count"`
Successes int `json:"successes"`
Failures int `json:"failures"`
} `json:"meta"`
}
require.NoError(t, json.Unmarshal(buf.Bytes(), &env), "envelope must be valid JSON")
assert.False(t, env.OK, "top-level ok must be false when any item failed")
assert.Equal(t, 3, env.Meta.Count)
assert.Equal(t, 2, env.Meta.Successes)
assert.Equal(t, 1, env.Meta.Failures)
require.Len(t, env.Data, 3)
assert.Equal(t, "c1", env.Data[0].ID)
assert.True(t, env.Data[0].OK)
assert.Equal(t, "c2", env.Data[1].ID)
assert.False(t, env.Data[1].OK)
assert.NotNil(t, env.Data[1].Error)
assert.Equal(t, "c3", env.Data[2].ID)
assert.True(t, env.Data[2].OK)
}
+6 -1
View File
@@ -10,6 +10,7 @@ import (
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
"github.com/Tencent/WeKnora/cli/internal/iostreams"
"github.com/Tencent/WeKnora/cli/internal/output"
"github.com/Tencent/WeKnora/cli/internal/text"
sdk "github.com/Tencent/WeKnora/client"
)
@@ -121,6 +122,7 @@ func runList(ctx context.Context, opts *ListOptions, fopts *cmdutil.FormatOption
}
var items []sdk.Chunk
truncated := false
if opts.AllPages {
accum := make([]sdk.Chunk, 0)
for page := 1; ; page++ {
@@ -131,6 +133,7 @@ func runList(ctx context.Context, opts *ListOptions, fopts *cmdutil.FormatOption
accum = append(accum, chunks...)
if len(accum) >= opts.Limit {
accum = accum[:opts.Limit]
truncated = true
break
}
if len(chunks) == 0 || int64(len(accum)) >= total {
@@ -150,10 +153,12 @@ func runList(ctx context.Context, opts *ListOptions, fopts *cmdutil.FormatOption
}
if len(items) > opts.Limit {
items = items[:opts.Limit]
truncated = true
}
if fopts.WantsJSON() {
return fopts.Emit(iostreams.IO.Out, items)
meta := &output.Meta{Count: len(items), HasMore: truncated}
return fopts.Emit(iostreams.IO.Out, items, meta)
}
if len(items) == 0 {
+22 -8
View File
@@ -117,8 +117,12 @@ func TestList_AllPages_LimitTruncatesAccumulated(t *testing.T) {
// After page 2: accum=4 >= limit=3 → stop. Third page never requested.
assert.LessOrEqual(t, len(svc.calls), 2, "must not walk past limit-hit point")
// Result must be exactly --limit items (server returned 4, sliced to 3).
var got []sdk.Chunk
require.NoError(t, json.Unmarshal(out.Bytes(), &got))
var env struct {
OK bool `json:"ok"`
Data []sdk.Chunk `json:"data"`
}
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
got := env.Data
assert.Len(t, got, 3, "accumulated must be sliced to exactly --limit")
// IDs preserve order: first 3 from the first 2 pages.
assert.Equal(t, []string{"c1", "c2", "c3"}, []string{got[0].ID, got[1].ID, got[2].ID})
@@ -158,7 +162,7 @@ func TestList_Human_TableHeader(t *testing.T) {
}},
totals: []int64{1}, errs: []error{nil},
}
require.NoError(t, runList(context.Background(), &ListOptions{DocID: "doc_abc", Limit: 50, PageSize: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
require.NoError(t, runList(context.Background(), &ListOptions{DocID: "doc_abc", Limit: 50, PageSize: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
body := out.String()
for _, want := range []string{"CHUNK_ID", "INDEX", "TYPE", "ENABLED", "PREVIEW", "UPDATED", "c1", "text"} {
assert.Contains(t, body, want)
@@ -172,7 +176,7 @@ func TestList_Human_PreviewTruncatedTo80(t *testing.T) {
pages: [][]sdk.Chunk{{{ID: "c1", Content: long, ChunkType: "text", IsEnabled: true}}},
totals: []int64{1}, errs: []error{nil},
}
require.NoError(t, runList(context.Background(), &ListOptions{DocID: "doc_abc", Limit: 50, PageSize: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
require.NoError(t, runList(context.Background(), &ListOptions{DocID: "doc_abc", Limit: 50, PageSize: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
body := out.String()
// 80-col preview means we never see the 100th `a` from the content (only column truncation kicks in).
assert.NotContains(t, body, strings.Repeat("a", 100), "preview must be truncated to ~80 chars")
@@ -187,12 +191,16 @@ func TestList_JSON_BareArray(t *testing.T) {
totals: []int64{1}, errs: []error{nil},
}
require.NoError(t, runList(context.Background(), &ListOptions{DocID: "doc_abc", Limit: 50, PageSize: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
var got []sdk.Chunk
require.NoError(t, json.Unmarshal(out.Bytes(), &got))
var env struct {
OK bool `json:"ok"`
Data []sdk.Chunk `json:"data"`
}
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
got := env.Data
require.Len(t, got, 1)
assert.Equal(t, "doc_abc", got[0].KnowledgeID)
assert.Equal(t, "kb_x", got[0].KnowledgeBaseID)
// Bare SDK keys, not custom CLI envelope.
// SDK snake_case keys must be present.
assert.Contains(t, out.String(), `"knowledge_id":"doc_abc"`)
assert.NotContains(t, out.String(), `"doc_id"`)
}
@@ -201,5 +209,11 @@ func TestList_EmptyResultRendersBareArray(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &fakeListSvc{pages: [][]sdk.Chunk{{}}, totals: []int64{0}, errs: []error{nil}}
require.NoError(t, runList(context.Background(), &ListOptions{DocID: "doc_abc", Limit: 50, PageSize: 50}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
assert.Equal(t, "[]\n", out.String())
var env struct {
OK bool `json:"ok"`
Data []sdk.Chunk `json:"data"`
}
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
assert.True(t, env.OK)
assert.Len(t, env.Data, 0, "expected empty data array")
}
+1 -1
View File
@@ -90,7 +90,7 @@ func runView(ctx context.Context, opts *ViewOptions, fopts *cmdutil.FormatOption
return cmdutil.WrapHTTP(err, "fetch chunk %s", opts.ChunkID)
}
if fopts.WantsJSON() {
return fopts.Emit(iostreams.IO.Out, ch)
return fopts.Emit(iostreams.IO.Out, ch, nil)
}
renderChunk(iostreams.IO.Out, ch)
return nil
+10 -6
View File
@@ -37,7 +37,7 @@ func TestView_Happy_RendersAllFields(t *testing.T) {
CreatedAt: "2026-05-15T11:00:00Z",
UpdatedAt: "2026-05-15T12:00:00Z",
}}
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
body := out.String()
assert.Contains(t, body, "c1")
assert.Contains(t, body, "doc_abc")
@@ -51,7 +51,7 @@ func TestView_HumanLabels_DocAndKB(t *testing.T) {
svc := &fakeViewSvc{resp: &sdk.Chunk{
ID: "c1", KnowledgeID: "doc_abc", KnowledgeBaseID: "kb_abc",
}}
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c1"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
body := out.String()
// Human KV uses friendlier DOC_ID / KB_ID labels (the SDK's
// knowledge_id / knowledge_base_id are kept only in --format json output).
@@ -64,7 +64,7 @@ func TestView_HumanLabels_DocAndKB(t *testing.T) {
func TestView_OmitsZeroOrEmpty(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &fakeViewSvc{resp: &sdk.Chunk{ID: "c_min", Content: "x"}}
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c_min"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc))
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c_min"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc))
body := out.String()
// status / start_at / end_at all zero → must be omitted from the human KV.
assert.NotContains(t, body, "status:")
@@ -81,8 +81,12 @@ func TestView_JSON_BareSDKShape(t *testing.T) {
ID: "c_json", KnowledgeID: "doc_abc", KnowledgeBaseID: "kb_abc",
}}
require.NoError(t, runView(context.Background(), &ViewOptions{ChunkID: "c_json"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}, svc))
var got sdk.Chunk
require.NoError(t, json.Unmarshal(out.Bytes(), &got))
var env struct {
OK bool `json:"ok"`
Data sdk.Chunk `json:"data"`
}
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
got := env.Data
assert.Equal(t, "c_json", got.ID)
assert.Equal(t, "doc_abc", got.KnowledgeID)
// JSON uses SDK snake_case keys (knowledge_id), not human relabel doc_id.
@@ -95,7 +99,7 @@ func TestView_JSON_BareSDKShape(t *testing.T) {
func TestView_404(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeViewSvc{err: errors.New("HTTP error 404: not found")}
err := runView(context.Background(), &ViewOptions{ChunkID: "missing"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, svc)
err := runView(context.Background(), &ViewOptions{ChunkID: "missing"}, &cmdutil.FormatOptions{Mode: cmdutil.FormatHuman}, svc)
require.Error(t, err)
assert.Contains(t, err.Error(), "resource.not_found")
}