beads/cmd/bd/kv.go
Steve Yegge 387959695d
fix(dolt): pre-pull commit must include config (kv.memory.* pull-wedge) (#4412)
* fix(dolt): pre-pull commit must include config; auto-resolve convergent kv.memory.* config conflicts

bd remember stores persistent memories as kv.memory.* rows in the synced
config table. Commit() deliberately excludes config (GH#2455, to avoid
sweeping a concurrent writer's stale issue_prefix into an unrelated commit),
so the GH#2474 pre-pull auto-commit at pullFromRemote (store.go) and PullFrom
(federation.go) leaves config permanently dirty once any memory exists. The
"clean the working set before merging" step then leaves config dirty and
DOLT_MERGE refuses to start ("cannot merge with uncommitted changes"). Two
correct PRs colliding over config. Diagnosed from a live server-mode repro
(Wyvern wy-71t); see PROPOSAL-pull-config-wedge.md.

Fix (server mode): add commitBeforePull, which stages config explicitly via
DOLT_ADD rather than relying on CommitWithConfig's DOLT_COMMIT('-Am'). The
proposal author observed -Am not staging config reliably under the server-mode
stored-procedure path, and the new embedded test TestEmbeddedConfigCommitStagesConfig
confirms -Am DOES stage config in the embedded engine — so the unreliability is
server-mode-specific and explicit staging is the robust choice. Commit() and
commitBeforePull now share commitWorkingSet(includeConfig bool).

Hardening (both modes): making config a committed/synced table means two clones
editing the same memory key collide on a config merge conflict. Extend
TryAutoResolveMergeConflicts to auto-resolve config conflicts with --theirs ONLY
when every conflicted row is a kv.memory.* key (machine-convergent, same policy
as metadata); any other config key (issue_prefix above all) is left for the
operator. Without this the primary fix would trade a silent pull wedge for an
operator-visible conflict wedge on the exact bd remember workload.

Embedded pre-pull (CommitPending -> -Am) already stages config and is unchanged;
it gains the resolver hardening.

Tests: server-mode pull_config_wedge_test.go (commit-includes-config + resolver
positive/negative, run under Docker in CI) and embedded pull_config_wedge_test.go
(in-process: -Am-stages-config probe + resolver positive/negative, all green).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* docs: add pull-config-wedge diagnosis/proposal (PR #4412)

The diagnosis-and-patch write-up behind this PR: how GH#2455 (Commit excludes
config) and GH#2474 (pre-pull auto-commit) collide over the synced config table,
leaving kv.memory.* rows permanently uncommitted so DOLT_MERGE refuses to start.
Includes the live-DB validation (Wyvern wy-71t) and the rejected alternatives.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(dolt): adopt-pr maintainer fixes for pull/sync config wedge

Maintainer review fixups for PR #4412, squashed into one commit on top of
the contributor's branch.

Pre-merge config wedge (sync): bd federation sync committed with the
config-excluding Commit before its merge while this PR switched the pull
paths to commitBeforePull, so any DB that ran `bd remember` carried dirty
kv.memory.* config rows and hit the "cannot merge with uncommitted changes"
wedge. Sync now uses commitBeforePull too, with a regression test.

Pre-pull auto-commit safety (GH#2455): commitBeforePull no longer stages the
whole config table. It auto-commits only convergent memory rows
(kv.memory.*); if any other config key is dirty (issue_prefix above all) it
refuses with operator guidance instead of sweeping a stale value into the
merge basis, restoring the GH#2455 protection the broad pre-pull staging had
reopened.

Sync --strategy config commit: a config-only conflict resolution committed
through the config-excluding Commit, so it could report success without
creating the merge-resolution commit and re-wedge the next sync. Sync now
commits resolutions through a config-inclusive path (commitMergeResolution).

Embedded sync parity: EmbeddedDoltStore.Sync fetched and merged without the
pre-merge CommitPending guard already used by embedded Pull/PullRemote/PullFrom
and the new server Sync, so the same dirty kv.memory.* working set could still
wedge `bd federation sync` in embedded mode. Sync now commits pending changes
before fetch/merge (embedded Commit is DOLT_COMMIT('-Am'), which stages
config), with an embedded regression test that drives Sync with a dirty
kv.memory.* row.

KV/memory namespace collision: `bd kv set memory.*` stored to kv.memory.*,
indistinguishable from a `bd remember` memory the merge resolver auto-resolves
with --theirs. validateKVKey now reserves the memory. prefix so a generic KV
value can't be silently overridden by the remote on pull.

Shared prefix + tests: centralize the kv.memory. prefix in
internal/storage/kvkeys (used by cmd/bd and the merge resolver) with a
contract test; route the remaining cmd/bd kv. prefix literals (the doctor KV
check, the validateKVKey nested-prefix guard, and the memory listing) through
the kvkeys constants; and strengthen the server-mode non-memory config
conflict test to prove a conflict materialized before the resolver declines it.

Maintainer review fixup for PR #4412.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Eddie the Engineer <ci@beads.test>
2026-06-19 21:31:33 -07:00

256 lines
6.5 KiB
Go

package main
import (
"fmt"
"os"
"sort"
"strings"
"github.com/spf13/cobra"
"github.com/steveyegge/beads/internal/storage/kvkeys"
)
// kvPrefix is prepended to all user keys to separate them from internal config
const kvPrefix = kvkeys.Prefix
// validateKVKey checks if a key is valid for the KV store.
// Returns an error if the key is invalid.
func validateKVKey(key string) error {
if key == "" {
return fmt.Errorf("key cannot be empty")
}
if strings.TrimSpace(key) == "" {
return fmt.Errorf("key cannot be only whitespace")
}
// Prevent keys that would create nested kv.kv.* prefixes
if strings.HasPrefix(key, kvPrefix) {
return fmt.Errorf("key cannot start with 'kv.' (would create nested prefix)")
}
// Reserve the persistent-memory namespace: a generic memory.* key would
// store to kv.memory.*, indistinguishable from a `bd remember` memory, and
// the merge resolver auto-resolves kv.memory.* conflicts with --theirs
// (GH#2474). Without this guard a user's deliberate kv value could be
// silently overridden by a remote on pull. Keep the namespace owned by
// bd remember / bd forget.
if strings.HasPrefix(key, kvkeys.MemoryPrefix) {
return fmt.Errorf("key cannot start with %q (reserved for persistent memories; use 'bd remember' / 'bd forget')", kvkeys.MemoryPrefix)
}
// Prevent keys that look like internal config
if strings.HasPrefix(key, "sync.") || strings.HasPrefix(key, "conflict.") ||
strings.HasPrefix(key, "federation.") || strings.HasPrefix(key, "jira.") ||
strings.HasPrefix(key, "linear.") || strings.HasPrefix(key, "export.") ||
strings.HasPrefix(key, "import.") {
return fmt.Errorf("key cannot start with reserved prefix %q", strings.Split(key, ".")[0]+".")
}
return nil
}
// kvCmd is the parent command for kv subcommands
var kvCmd = &cobra.Command{
Use: "kv",
GroupID: "setup",
Short: "Key-value store commands",
Long: `Commands for working with the beads key-value store.
The key-value store is useful for storing flags, environment variables,
or other user-defined data that persists across sessions.
Examples:
bd kv set mykey myvalue # Set a value
bd kv get mykey # Get a value
bd kv clear mykey # Delete a key
bd kv list # List all key-value pairs`,
}
// kvSetCmd sets a key-value pair
var kvSetCmd = &cobra.Command{
Use: "set <key> <value>",
Short: "Set a key-value pair",
Long: `Set a key-value pair in the beads key-value store.
This is useful for storing flags, environment variables, or other
user-defined data that persists across sessions.
Examples:
bd kv set feature_flag true
bd kv set api_endpoint https://api.example.com
bd kv set max_retries 3`,
Args: cobra.ExactArgs(2),
Run: func(cmd *cobra.Command, args []string) {
CheckReadonly("kv set")
if err := ensureDirectMode("kv set requires direct database access"); err != nil {
FatalError("%v", err)
}
key := args[0]
if err := validateKVKey(key); err != nil {
FatalErrorRespectJSON("invalid key: %v", err)
}
value := args[1]
storageKey := kvPrefix + key
ctx := rootCtx
if err := store.SetConfig(ctx, storageKey, value); err != nil {
FatalErrorRespectJSON("setting key: %v", err)
}
if jsonOutput {
outputJSON(map[string]string{
"key": key,
"value": value,
})
} else {
fmt.Printf("Set %s = %s\n", key, value)
}
},
}
// kvGetCmd gets a value by key
var kvGetCmd = &cobra.Command{
Use: "get <key>",
Short: "Get a value by key",
Long: `Get a value from the beads key-value store.
Examples:
bd kv get feature_flag
bd kv get api_endpoint`,
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
if err := ensureDirectMode("kv get requires direct database access"); err != nil {
FatalError("%v", err)
}
key := args[0]
storageKey := kvPrefix + key
ctx := rootCtx
value, err := store.GetConfig(ctx, storageKey)
if err != nil {
FatalErrorRespectJSON("getting key: %v", err)
}
if jsonOutput {
result := map[string]interface{}{
"key": key,
"value": value,
"found": value != "",
}
outputJSON(result)
if value == "" {
os.Exit(1)
}
} else {
if value == "" {
fmt.Fprintf(os.Stderr, "%s (not set)\n", key)
os.Exit(1)
} else {
fmt.Printf("%s\n", value)
}
}
},
}
// kvClearCmd deletes a key
var kvClearCmd = &cobra.Command{
Use: "clear <key>",
Short: "Delete a key-value pair",
Long: `Delete a key from the beads key-value store.
Examples:
bd kv clear feature_flag
bd kv clear api_endpoint`,
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
CheckReadonly("kv clear")
if err := ensureDirectMode("kv clear requires direct database access"); err != nil {
FatalError("%v", err)
}
key := args[0]
if err := validateKVKey(key); err != nil {
FatalErrorRespectJSON("invalid key: %v", err)
}
storageKey := kvPrefix + key
ctx := rootCtx
if err := store.DeleteConfig(ctx, storageKey); err != nil {
FatalErrorRespectJSON("deleting key: %v", err)
}
if jsonOutput {
outputJSON(map[string]string{
"key": key,
"deleted": "true",
})
} else {
fmt.Printf("Cleared %s\n", key)
}
},
}
// kvListCmd lists all key-value pairs
var kvListCmd = &cobra.Command{
Use: "list",
Short: "List all key-value pairs",
Long: `List all key-value pairs in the beads key-value store.
Examples:
bd kv list
bd kv list --json`,
Run: func(cmd *cobra.Command, args []string) {
if err := ensureDirectMode("kv list requires direct database access"); err != nil {
FatalError("%v", err)
}
ctx := rootCtx
allConfig, err := store.GetAllConfig(ctx)
if err != nil {
FatalErrorRespectJSON("listing keys: %v", err)
}
// Filter for kv.* keys and strip prefix
kvPairs := make(map[string]string)
for k, v := range allConfig {
if strings.HasPrefix(k, kvPrefix) {
userKey := strings.TrimPrefix(k, kvPrefix)
kvPairs[userKey] = v
}
}
if jsonOutput {
outputJSON(kvPairs)
return
}
if len(kvPairs) == 0 {
fmt.Println("No key-value pairs set")
return
}
// Sort keys for consistent output
keys := make([]string, 0, len(kvPairs))
for k := range kvPairs {
keys = append(keys, k)
}
sort.Strings(keys)
fmt.Println("\nKey-Value Store:")
for _, k := range keys {
fmt.Printf(" %s = %s\n", k, kvPairs[k])
}
},
}
func init() {
// Register all kv subcommands under kvCmd
kvCmd.AddCommand(kvSetCmd)
kvCmd.AddCommand(kvGetCmd)
kvCmd.AddCommand(kvClearCmd)
kvCmd.AddCommand(kvListCmd)
// Register kv command
rootCmd.AddCommand(kvCmd)
}