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.
118 lines
4.0 KiB
Go
118 lines
4.0 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// kbEditFields enumerates the fields surfaced for `--json` discovery on
|
|
// `kb edit`. The result is the updated KnowledgeBase; mirrors the kb
|
|
// top-level json tags.
|
|
var kbEditFields = []string{
|
|
"id", "name", "type", "description",
|
|
"is_temporary", "is_pinned",
|
|
"embedding_model_id", "summary_model_id",
|
|
"knowledge_count", "chunk_count",
|
|
"is_processing", "processing_count",
|
|
"created_at", "updated_at",
|
|
}
|
|
|
|
type EditOptions struct {
|
|
// Name/Description are *string so we can distinguish "unset" from "set to
|
|
// empty". An unset field is omitted from the SDK request — only fields the
|
|
// user passed are sent. Server PUT semantics are "replace everything in the
|
|
// request"; if we always sent both, an `--name` invocation would silently
|
|
// clear the description.
|
|
Name *string
|
|
Description *string
|
|
}
|
|
|
|
// EditService is the narrow SDK surface this command depends on. GetKnowledgeBase
|
|
// is needed for the fetch-then-update flow: the server's UpdateKnowledgeBase
|
|
// endpoint requires Name on the PUT body (UpdateKnowledgeBaseRequest.Name is
|
|
// `string`, not `*string`, and the server validates `required`), so passing
|
|
// only --description without fetching the current Name would 400.
|
|
type EditService interface {
|
|
GetKnowledgeBase(ctx context.Context, id string) (*sdk.KnowledgeBase, error)
|
|
UpdateKnowledgeBase(ctx context.Context, id string, req *sdk.UpdateKnowledgeBaseRequest) (*sdk.KnowledgeBase, error)
|
|
}
|
|
|
|
// NewCmdEdit builds `weknora kb edit <id>`. At least one of --name /
|
|
// --description must be provided.
|
|
func NewCmdEdit(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &EditOptions{}
|
|
var name, desc string
|
|
cmd := &cobra.Command{
|
|
Use: "edit <id>",
|
|
Short: "Edit a knowledge base's name or description",
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if c.Flag("name").Changed {
|
|
opts.Name = &name
|
|
}
|
|
if c.Flag("description").Changed {
|
|
opts.Description = &desc
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runEdit(c.Context(), opts, jopts, cli, args[0])
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&name, "name", "", "New name (omit to leave unchanged)")
|
|
cmd.Flags().StringVar(&desc, "description", "", "New description (omit to leave unchanged)")
|
|
cmdutil.AddJSONFlags(cmd, kbEditFields)
|
|
aiclient.SetAgentHelp(cmd, "Edits a knowledge base. At least one of --name/--description is required. Fields not passed are preserved server-side. Returns the updated KnowledgeBase.")
|
|
return cmd
|
|
}
|
|
|
|
func runEdit(ctx context.Context, opts *EditOptions, jopts *cmdutil.JSONOptions, svc EditService, id string) error {
|
|
if opts.Name == nil && opts.Description == nil {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputMissingFlag,
|
|
Message: "kb edit requires at least one of --name or --description",
|
|
Hint: "pass --name <name> and/or --description <desc>",
|
|
}
|
|
}
|
|
|
|
// Fetch current state so we can fill in fields the user didn't touch.
|
|
// TOCTOU note: another writer could change Name/Description between
|
|
// our Get and Put; matches the same race window kb pin / unpin have.
|
|
current, err := svc.GetKnowledgeBase(ctx, id)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "fetch knowledge base %s", id)
|
|
}
|
|
req := &sdk.UpdateKnowledgeBaseRequest{
|
|
Name: current.Name,
|
|
Description: current.Description,
|
|
}
|
|
if opts.Name != nil {
|
|
req.Name = *opts.Name
|
|
}
|
|
if opts.Description != nil {
|
|
req.Description = *opts.Description
|
|
}
|
|
|
|
updated, err := svc.UpdateKnowledgeBase(ctx, id, req)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "edit knowledge base %s", id)
|
|
}
|
|
if jopts.Enabled() {
|
|
return jopts.Emit(iostreams.IO.Out, updated)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Updated knowledge base %s\n", id)
|
|
return nil
|
|
}
|