2f8681b48e
Roadmap items 3-5 (session) and 3-6/7/8 (kb manage).
cli/cmd/session/ (new package; sessioncmd to avoid shadowing stdlib):
- session list: paginated table (ID/TITLE/UPDATED). --page / --page-size
with 1..1000 validation. _meta.has_more from page*size < total.
- session view <id>: prints metadata; non-empty fields only. Server
timestamps arrive as strings; parsed best-effort as RFC3339.
- session delete <id>: high-risk-write; exit-10 confirmation in non-
TTY/--json paths; --dry-run emits envelope.risk + dry_run:true.
cli/cmd/kb (extended):
- kb edit <id> [--name N] [--description D]: at least one flag required;
*string options so unset fields stay unset in the PUT body. SDK
UpdateKnowledgeBaseRequest has no embedding_model field, so the
roadmap's --embedding-model dropped.
- kb pin <id> / kb unpin <id>: direct parity with gh issue pin /
gh issue unpin (verified against gh manual). Idempotent: GetKnowledgeBase
reads IsPinned, TogglePinKnowledgeBase fires only on state change.
SDK KnowledgeBase struct gained the IsPinned field (server already
returned it; SDK just hadn't modeled it — non-breaking additive).
- kb empty <id>: high-risk-write; exit-10 confirmation;
--dry-run. Returns deleted_count from the async clear response.
weknora-specific operation; no mainstream parallel.
Golden envelopes for kb_list and kb_view updated to include the new
is_pinned field — strict-additive change.
Cleanups surfaced by the post-commit reviewer round:
- ConfirmPrompter promoted to cli/internal/testutil/ (4-copy threshold
reached: context/remove, kb/delete, kb/empty, session/delete).
kb/delete_test.go's pre-existing local copy left untouched per the
upstream-respect convention.
- kb pin/unpin idempotent no-op path no longer emits a write-class
envelope. Added _meta.warnings "already {un}pinned — no server
call made" and dropped the risk classification on the no-op branch.
- doc list --page-size was unbounded while session list enforces
1..1000. Same validation added to doc list.
18 + 18 unit tests; e2e exit codes verified.
Roadmap: 3-5, 3-6, 3-7, 3-8.
114 lines
3.7 KiB
Go
114 lines
3.7 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// PinOptions captures `weknora kb pin / unpin` flag state.
|
|
type PinOptions struct {
|
|
JSONOut bool
|
|
DryRun bool
|
|
}
|
|
|
|
// PinService is the narrow SDK surface this command depends on. The CLI
|
|
// reads current state before toggling so `pin`/`unpin` are idempotent —
|
|
// the server endpoint is only a non-idempotent toggle.
|
|
type PinService interface {
|
|
GetKnowledgeBase(ctx context.Context, id string) (*sdk.KnowledgeBase, error)
|
|
TogglePinKnowledgeBase(ctx context.Context, id string) (*sdk.KnowledgeBase, error)
|
|
}
|
|
|
|
// NewCmdPin builds `weknora kb pin <id>`.
|
|
func NewCmdPin(f *cmdutil.Factory) *cobra.Command {
|
|
return newPinCmd(f, "pin", true, "Pin a knowledge base to the top of the list")
|
|
}
|
|
|
|
// NewCmdUnpin builds `weknora kb unpin <id>`.
|
|
func NewCmdUnpin(f *cmdutil.Factory) *cobra.Command {
|
|
return newPinCmd(f, "unpin", false, "Unpin a knowledge base")
|
|
}
|
|
|
|
func newPinCmd(f *cmdutil.Factory, use string, want bool, short string) *cobra.Command {
|
|
opts := &PinOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: use + " <id>",
|
|
Short: short,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
opts.DryRun = cmdutil.IsDryRun(c)
|
|
if opts.DryRun {
|
|
return runPin(c.Context(), opts, nil, args[0], want)
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runPin(c.Context(), opts, cli, args[0], want)
|
|
},
|
|
}
|
|
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
|
agent.SetAgentHelp(cmd, fmt.Sprintf("Idempotent %s: reads current pin state, toggles only if different. No-op when already in the requested state.", use))
|
|
return cmd
|
|
}
|
|
|
|
func runPin(ctx context.Context, opts *PinOptions, svc PinService, id string, want bool) error {
|
|
verb := "pin"
|
|
if !want {
|
|
verb = "unpin"
|
|
}
|
|
risk := &format.Risk{Level: format.RiskWrite, Action: fmt.Sprintf("%s knowledge base %s", verb, id)}
|
|
|
|
if opts.DryRun {
|
|
// Dry-run can't introspect state without a network call by design (see
|
|
// kb/delete.go for the same convention). Report what *would* run if
|
|
// state diverged; agents can disambiguate via a subsequent `kb view`.
|
|
return cmdutil.EmitDryRun(opts.JSONOut, struct {
|
|
ID string `json:"id"`
|
|
Want bool `json:"want_pinned"`
|
|
}{id, want}, &format.Meta{KBID: id}, risk)
|
|
}
|
|
|
|
current, err := svc.GetKnowledgeBase(ctx, id)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.ClassifyHTTPError(err), err, "get knowledge base %s", id)
|
|
}
|
|
if current.IsPinned == want {
|
|
state := "pinned"
|
|
if !want {
|
|
state = "unpinned"
|
|
}
|
|
// No-op path: tell agents what happened. The risk-write classification
|
|
// was the *requested* operation, not what occurred — surface it via a
|
|
// _meta.warning so audit logs don't count a write that wasn't made.
|
|
if opts.JSONOut {
|
|
meta := &format.Meta{KBID: id, Warnings: []string{fmt.Sprintf("already %s — no server call made", state)}}
|
|
return format.WriteEnvelope(iostreams.IO.Out, format.Success(current, meta))
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ %s is already %s\n", id, state)
|
|
return nil
|
|
}
|
|
|
|
updated, err := svc.TogglePinKnowledgeBase(ctx, id)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.ClassifyHTTPError(err), err, "%s knowledge base %s", verb, id)
|
|
}
|
|
if opts.JSONOut {
|
|
return format.WriteEnvelope(iostreams.IO.Out, format.SuccessWithRisk(updated, &format.Meta{KBID: id}, risk))
|
|
}
|
|
state := "pinned"
|
|
if !updated.IsPinned {
|
|
state = "unpinned"
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ %s %s\n", id, state)
|
|
return nil
|
|
}
|