e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
193 lines
6.7 KiB
Go
193 lines
6.7 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
type fakeChunksSvc struct {
|
|
results []*sdk.SearchResult
|
|
err error
|
|
gotKB string
|
|
gotQ string
|
|
}
|
|
|
|
func (f *fakeChunksSvc) HybridSearch(_ context.Context, kbID string, p *sdk.SearchParams) ([]*sdk.SearchResult, error) {
|
|
f.gotKB = kbID
|
|
f.gotQ = p.QueryText
|
|
return f.results, f.err
|
|
}
|
|
|
|
func TestRunSearch_HumanOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{
|
|
{Score: 0.92, Content: "first chunk", KnowledgeID: "doc-1", MatchType: sdk.MatchTypeVector},
|
|
{Score: 0.81, Content: "second chunk", KnowledgeID: "doc-2", MatchType: sdk.MatchTypeKeyword},
|
|
}}
|
|
opts := &ChunksOptions{Query: "hello", KBID: "kb_abc", Limit: 5}
|
|
require.NoError(t, runChunks(context.Background(), opts, nil, svc))
|
|
|
|
assert.Equal(t, "kb_abc", svc.gotKB)
|
|
assert.Equal(t, "hello", svc.gotQ)
|
|
got := out.String()
|
|
assert.Contains(t, got, "2 result(s) from kb=kb_abc")
|
|
assert.Contains(t, got, "first chunk")
|
|
assert.Contains(t, got, "doc-1")
|
|
}
|
|
|
|
// JSON output must surface match_type so machine consumers / agents can
|
|
// reason about retrieval channels without re-implementing the wire format.
|
|
// (Human renderer keeps default minimal — diagnostic info opt-in via --json.)
|
|
func TestRunSearch_JSONIncludesMatchType(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{
|
|
{Score: 0.9, Content: "x", MatchType: sdk.MatchTypeKeyword},
|
|
}}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, &cmdutil.JSONOptions{}, svc))
|
|
assert.Contains(t, out.String(), `"match_type":1`)
|
|
}
|
|
|
|
func TestRunSearch_JSONOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{{Score: 0.9, Content: "x"}}}
|
|
opts := &ChunksOptions{Query: "q", KBID: "kb1", Limit: 1}
|
|
require.NoError(t, runChunks(context.Background(), opts, &cmdutil.JSONOptions{}, svc))
|
|
got := out.String()
|
|
assert.True(t, strings.HasPrefix(strings.TrimSpace(got), "["), "expected bare JSON array, got: %q", got)
|
|
assert.NotContains(t, got, `"ok":`)
|
|
assert.Contains(t, got, `"score":0.9`)
|
|
}
|
|
|
|
func TestRunSearch_EmptyResults(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: nil}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, nil, svc))
|
|
assert.Contains(t, out.String(), "(no results)")
|
|
}
|
|
|
|
// Server returns primary matches plus parent/related/nearby enrichment chunks,
|
|
// so the wire response can exceed Limit. CLI must trim to honor the user's
|
|
// hard-limit contract.
|
|
func TestRunSearch_LimitHardCap(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{results: []*sdk.SearchResult{
|
|
{Score: 0.9, Content: "primary 1"},
|
|
{Score: 0.8, Content: "primary 2"},
|
|
{Score: 0.7, Content: "primary 3"},
|
|
{Score: 0, Content: "enrichment parent"}, // server-padded
|
|
{Score: 0, Content: "enrichment nearby"}, // server-padded
|
|
}}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1", Limit: 3}, nil, svc))
|
|
got := out.String()
|
|
assert.Contains(t, got, "3 result(s)")
|
|
assert.NotContains(t, got, "enrichment parent")
|
|
assert.NotContains(t, got, "enrichment nearby")
|
|
}
|
|
|
|
func TestRunSearch_BothChannelsDisabled(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1", NoVector: true, NoKeyword: true}, nil, &fakeChunksSvc{})
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
func TestRunSearch_ServiceError_Transport(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{err: assert.AnError}
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, nil, svc)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeNetworkError, typed.Code,
|
|
"non-HTTP-shaped errors classify as network.error so IsTransient picks them up")
|
|
}
|
|
|
|
func TestRunSearch_ServiceError_HTTPNotFound(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
svc := &fakeChunksSvc{err: errors.New("HTTP error 404: knowledge base not found")}
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "missing"}, nil, svc)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func TestIndent(t *testing.T) {
|
|
assert.Equal(t, " foo\n bar", indent("foo\nbar", " "))
|
|
assert.Equal(t, "", indent("", " "))
|
|
}
|
|
|
|
func TestRunSearch_NilService(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
err := runChunks(context.Background(), &ChunksOptions{Query: "q", KBID: "kb1"}, nil, nil)
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "server.error")
|
|
}
|
|
|
|
func TestNewCmdChunks_RequiresQuery(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
cmd := NewCmdChunks(&cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
})
|
|
cmd.SetArgs([]string{}) // no query
|
|
cmd.SilenceErrors = true
|
|
cmd.SilenceUsage = true
|
|
err := cmd.Execute()
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestNewCmdChunks_RejectsEmptyQuery(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
cmd := NewCmdChunks(&cmdutil.Factory{
|
|
Client: func() (*sdk.Client, error) { return nil, nil },
|
|
})
|
|
cmd.SetArgs([]string{" ", "--kb", "kb1"})
|
|
cmd.SilenceErrors = true
|
|
cmd.SilenceUsage = true
|
|
err := cmd.Execute()
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
func TestRunSearch_NoVectorPassedThrough(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
var got *sdk.SearchParams
|
|
svc := &capturingChunksSvc{capture: func(p *sdk.SearchParams) { got = p }}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{
|
|
Query: "q", KBID: "kb1", NoVector: true,
|
|
}, nil, svc))
|
|
require.NotNil(t, got)
|
|
assert.True(t, got.DisableVectorMatch)
|
|
assert.False(t, got.DisableKeywordsMatch)
|
|
}
|
|
|
|
func TestRunSearch_NoKeywordPassedThrough(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
var got *sdk.SearchParams
|
|
svc := &capturingChunksSvc{capture: func(p *sdk.SearchParams) { got = p }}
|
|
require.NoError(t, runChunks(context.Background(), &ChunksOptions{
|
|
Query: "q", KBID: "kb1", NoKeyword: true,
|
|
}, nil, svc))
|
|
require.NotNil(t, got)
|
|
assert.True(t, got.DisableKeywordsMatch)
|
|
assert.False(t, got.DisableVectorMatch)
|
|
}
|
|
|
|
type capturingChunksSvc struct {
|
|
capture func(*sdk.SearchParams)
|
|
}
|
|
|
|
func (c *capturingChunksSvc) HybridSearch(_ context.Context, _ string, p *sdk.SearchParams) ([]*sdk.SearchResult, error) {
|
|
c.capture(p)
|
|
return nil, nil
|
|
}
|