4a5449233d
Seven bugs surfaced via two audit rounds — parallel reviewer agents
plus a real-server end-to-end demo. Each fix arrives with a
regression test.
1. doc upload --recursive --json corrupted the envelope stream.
Per-file FAIL/OK plain lines printed unconditionally to stdout,
then a Success envelope, then on partial failure a typed error
that the root handler turned into a SECOND Failure envelope —
three outputs where one was expected. Fix: gate the plain lines
behind !opts.JSONOut, and add cmdutil.Error.Silent so the JSON-
path partial-failure preserves its typed exit code without
triggering PrintErrorEnvelope's default Failure-envelope write.
2. auth refresh / AuthRetryTransport misclassified HTTP failures as
network.error. RefreshAndPersist wrapped every refresher error
with CodeNetworkError, but the SDK emits "HTTP error 401: ..."
for a rejected refresh token — which should surface as
auth.token_expired. Switched to WrapHTTP for proper status-
derived classification. Affects both `auth refresh` and the
transport's refresh closure.
3. doc download accepted ".." as a server-suggested filename. The
rejection list covered "" / "." / filepath.Separator but not
bare ".." — filepath.Base("..") is "..", which slipped through
to os.Create and produced a confusing local.file_io wrap. Added
to the rejection set.
4. search chunks / docs / kb / sessions had no lower bound on
--limit. `-L 0` / `-L -1` was forwarded to the server with
undefined behavior. Added a 1..1000 bound at the RunE boundary
across all four (matching doc list / session list page-size
bounds). Internal callers in tests can still pass Limit==0 for
the "no client-side cap" runChunks path — the bound only applies
at the user-input layer.
5. cli/AGENTS.md ADR-3 verb-canon summary listed only v0.2 verbs as
"gh-canonical" and missed v0.3 additions (edit, pin, unpin,
download — all gh-canonical) plus locally-introduced ones
(empty, refresh, add, remove, link). Rewritten as an explicit
gh-canonical / locally-introduced split.
6. kb pin returned 404. Server registers /knowledge-bases/{id}/pin
as PUT (router.go:292); SDK was using POST. gin's router silently
404s on method-mismatch (treats it as path-not-found, not 405),
so the CLI classified the response as resource.not_found and
masked the real failure mode. Switched the SDK to http.MethodPut.
The asymmetry that hid this past round 1: kb unpin on a freshly-
created KB hits the no-op branch in cmd/kb/pin.go that skips the
SDK call entirely, so unpin "worked" without ever exercising the
broken path. Only the real-server demo, where kb pin actually
fires, surfaced it.
7. kb edit clobbered current Name when only --description was
passed. EditOptions used *string to distinguish "unset" from
"set to empty", but sdk.UpdateKnowledgeBaseRequest declares both
fields as plain string (no omitempty), so the JSON body always
carried `"name": ""`. Server requires Name → 400. Fix: runEdit
does fetch-then-update — GetKnowledgeBase first, build the PUT
body with current values, then overlay user-set fields. Same
TOCTOU window as kb pin / unpin.
Audit-flagged items intentionally NOT changed:
- kb pin / unpin check-then-toggle TOCTOU: documented; the clean
fix would be a server-side setter and belongs in a separate API
change.
- AuthRetryTransport singleflight test gap for one concurrency
scenario; v0.4 polish.
- cli/README.md:50 "once v0.2 ships" and CHANGELOG.md:8
"10 top-level commands": v0.2-PR artifacts, not v0.3-introduced.
- kb edit / kb pin are v0.3-new commands, so neither bug needs a
cli/CHANGELOG.md Fixed entry — the v0.3 release ships them
working as the Added bullets advertise.
132 lines
4.5 KiB
Go
132 lines
4.5 KiB
Go
package kb
|
|
|
|
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"
|
|
)
|
|
|
|
// fakeEditSvc captures the (id, request) pair handed to UpdateKnowledgeBase
|
|
// and scripts the GetKnowledgeBase fetch used by the fetch-then-update path.
|
|
type fakeEditSvc struct {
|
|
current *sdk.KnowledgeBase // returned by GetKnowledgeBase
|
|
currentErr error
|
|
gotID string
|
|
gotReq *sdk.UpdateKnowledgeBaseRequest
|
|
resp *sdk.KnowledgeBase
|
|
err error
|
|
}
|
|
|
|
func (f *fakeEditSvc) GetKnowledgeBase(_ context.Context, id string) (*sdk.KnowledgeBase, error) {
|
|
if f.currentErr != nil {
|
|
return nil, f.currentErr
|
|
}
|
|
if f.current != nil {
|
|
return f.current, nil
|
|
}
|
|
return &sdk.KnowledgeBase{ID: id}, nil
|
|
}
|
|
|
|
func (f *fakeEditSvc) UpdateKnowledgeBase(_ context.Context, id string, req *sdk.UpdateKnowledgeBaseRequest) (*sdk.KnowledgeBase, error) {
|
|
f.gotID = id
|
|
f.gotReq = req
|
|
return f.resp, f.err
|
|
}
|
|
|
|
func TestEdit_RequiresAtLeastOneFlag(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{}
|
|
err := runEdit(context.Background(), &EditOptions{}, svc, "kb_abc")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code)
|
|
assert.Contains(t, typed.Hint, "--name")
|
|
assert.Contains(t, typed.Hint, "--description")
|
|
}
|
|
|
|
// When only --name is passed, the request must carry the user's new name
|
|
// AND the current Description (preserved via the fetch). Sending Description=""
|
|
// would clobber the server-side value because UpdateKnowledgeBaseRequest
|
|
// fields are `string`, not `*string`.
|
|
func TestEdit_OnlyName_PreservesCurrentDescription(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{
|
|
current: &sdk.KnowledgeBase{ID: "kb_abc", Name: "old", Description: "keep me"},
|
|
resp: &sdk.KnowledgeBase{ID: "kb_abc", Name: "new", Description: "keep me"},
|
|
}
|
|
opts := &EditOptions{}
|
|
opts.Name = stringPtr("new")
|
|
require.NoError(t, runEdit(context.Background(), opts, svc, "kb_abc"))
|
|
|
|
assert.Equal(t, "kb_abc", svc.gotID)
|
|
require.NotNil(t, svc.gotReq)
|
|
assert.Equal(t, "new", svc.gotReq.Name)
|
|
assert.Equal(t, "keep me", svc.gotReq.Description, "Description must be preserved from fetch when not in --description")
|
|
assert.Contains(t, out.String(), "kb_abc")
|
|
}
|
|
|
|
// Symmetric: only --description must preserve current Name. The server's
|
|
// `Name required` validation made this case fail without the fetch.
|
|
func TestEdit_OnlyDescription_PreservesCurrentName(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{
|
|
current: &sdk.KnowledgeBase{ID: "kb_abc", Name: "keep me", Description: "old"},
|
|
resp: &sdk.KnowledgeBase{ID: "kb_abc"},
|
|
}
|
|
opts := &EditOptions{}
|
|
opts.Description = stringPtr("new desc")
|
|
require.NoError(t, runEdit(context.Background(), opts, svc, "kb_abc"))
|
|
|
|
require.NotNil(t, svc.gotReq)
|
|
assert.Equal(t, "new desc", svc.gotReq.Description)
|
|
assert.Equal(t, "keep me", svc.gotReq.Name, "Name must be preserved from fetch when not in --name")
|
|
}
|
|
|
|
func TestEdit_BothFlags(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeEditSvc{resp: &sdk.KnowledgeBase{ID: "kb_abc"}}
|
|
opts := &EditOptions{}
|
|
opts.Name = stringPtr("renamed")
|
|
opts.Description = stringPtr("new desc")
|
|
require.NoError(t, runEdit(context.Background(), opts, svc, "kb_abc"))
|
|
assert.Equal(t, "renamed", svc.gotReq.Name)
|
|
assert.Equal(t, "new desc", svc.gotReq.Description)
|
|
}
|
|
|
|
func TestEdit_DryRun_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
opts := &EditOptions{DryRun: true, JSONOut: true}
|
|
opts.Name = stringPtr("preview")
|
|
require.NoError(t, runEdit(context.Background(), opts, nil, "kb_abc"))
|
|
|
|
body := out.String()
|
|
assert.True(t, strings.HasPrefix(body, `{"ok":true`))
|
|
assert.Contains(t, body, `"dry_run":true`)
|
|
assert.Contains(t, body, `"write"`)
|
|
}
|
|
|
|
func TestEdit_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
// 404 must come from the GetKnowledgeBase pre-fetch in the fetch-then-
|
|
// update flow — that's the first server roundtrip when the id is bad.
|
|
svc := &fakeEditSvc{currentErr: errors.New("HTTP error 404: not found")}
|
|
opts := &EditOptions{}
|
|
opts.Name = stringPtr("x")
|
|
err := runEdit(context.Background(), opts, svc, "kb_missing")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func stringPtr(s string) *string { return &s }
|