nullkey
6d8c8650cd
Two intertwined agent safety nets that share the same files:
1. --dry-run flag for offline preview of mutation commands
2. Risk: metadata + SetRisk helper for destructive command surfaces
Coverage (19 mutation commands with --dry-run):
kb.create/edit/delete agent.create/edit/delete
doc.create/upload/fetch/delete doc.delete_all (special variant)
session.delete chunk.delete profile.add/remove
auth.refresh/logout link unlink
api.{post,put,patch,delete} (api.get + --dry-run rejected, exit 2)
Envelope additions (omitempty in non-dry-run paths):
meta.dry_run: bool true when --dry-run was used
meta.plan: map {action, args} per the per-command taxonomy
Risk: metadata
--------------
cmdutil.SetRisk(cmd, action) stamps cobra.Annotations with
risk.level=destructive + risk.action=<action> on the 9 destructive
commands. The SetAgentHelp wrapper prepends a "Risk: <action>
(destructive)" line in the default text help path so agents see a clear
warning before parsing Usage. WEKNORA_AGENT_HELP=1 JSON path stays
unchanged — structured agent-help already carries warnings[].
Validation parity with the live path
------------------------------------
Every pure-local validation (flag presence, mutual exclusion, enum
bounds, URL/regex format, ResolveKBLocal for KB resolution that does not
require an SDK call) runs BEFORE the dry-run gate. This matches the
industry-standard "preview shows what live would do" contract:
--dry-run accepts exactly the same invocations the live path accepts and
rejects exactly the same invocations the live path rejects, modulo the
side-effecting work itself.
The side-effecting work (SDK calls, file writes, keyring writes, server-
side name → id resolution) is what --dry-run actually gates. Each
mutation file pairs its RunE validation block with a regression test
under *_dry_run_test.go / dryrun_validation_test.go so future refactors
don't reintroduce the gap.
Helper surface
--------------
- HandleDryRun(cmd, dryRun, plan) extracts the early-return so the
19 RunE call sites stay 3 lines each.
- EmitDryRun routes through FormatOptions.Emit, inheriting _notice /
TTY indent / --jq filtering for free.
- ResolveKBLocal mirrors ResolveKB but never calls the SDK; dry-run
paths use it so the plan reports the raw --kb value (UUID or name)
without a name → id lookup.
Streaming commands (chat, session ask, session continue-stream) are
deliberately excluded: a buffered plan makes no sense for an event
stream.
Lock semantics in the dry-run path:
- destructive + --dry-run: exit 0, no exit-10 confirmation prompt
- --dry-run + -y: byte-identical envelope to --dry-run alone
- --dry-run + --jq: filter applies to the preview envelope normally
47 lines
1.6 KiB
Go
47 lines
1.6 KiB
Go
// Package-level note:
|
|
//
|
|
// SetRisk attaches risk metadata to a destructive cobra command via cobra
|
|
// annotations. The SetAgentHelp wrapper in agenthelp.go reads these
|
|
// annotations and prepends a "Risk: <action> (<level>)" line at the top
|
|
// of human help output.
|
|
//
|
|
// envelope.error.risk.action is emitted separately by the
|
|
// ConfirmDestructive callsite argument and does NOT read these annotations.
|
|
package cmdutil
|
|
|
|
import "github.com/spf13/cobra"
|
|
|
|
// RiskDestructive is the only level value currently emitted. The annotation
|
|
// key reserves "read" / "write" for future use.
|
|
const RiskDestructive = "destructive"
|
|
|
|
// SetRisk writes risk metadata to a cobra command's annotations.
|
|
// Idempotent: re-calling with the same action overwrites cleanly.
|
|
//
|
|
// nil-map guard: cobra.Command.Annotations is `map[string]string` and
|
|
// defaults to nil. Writing to a nil map panics, so we allocate first.
|
|
func SetRisk(cmd *cobra.Command, action string) {
|
|
if cmd.Annotations == nil {
|
|
cmd.Annotations = make(map[string]string)
|
|
}
|
|
cmd.Annotations["risk.level"] = RiskDestructive
|
|
cmd.Annotations["risk.action"] = action
|
|
}
|
|
|
|
// GetRisk reads risk metadata. Returns (level, action, ok). ok=false when
|
|
// either the annotations map is nil or risk.action key is missing.
|
|
//
|
|
// Reading from a nil map is safe in Go (returns zero value); we still
|
|
// check map-existence explicitly for clarity.
|
|
func GetRisk(cmd *cobra.Command) (level, action string, ok bool) {
|
|
if cmd.Annotations == nil {
|
|
return "", "", false
|
|
}
|
|
action, ok = cmd.Annotations["risk.action"]
|
|
if !ok {
|
|
return "", "", false
|
|
}
|
|
level = cmd.Annotations["risk.level"]
|
|
return level, action, true
|
|
}
|