beads/internal/configfile/graph_mode_test.go
Julian Knutsen 1fcd715e75
fix(cli): refuse graph_mode workspaces and keep their metadata marker on save (#7671)
* fix(configfile): carry graph_mode and graph_* binding through Save

Graph-preview builds of bd persist a per-workspace format in
metadata.json: "graph_mode": "link" plus graph_scope_url,
graph_authority_id, graph_workspace, graph_schema_version and
graph_ready, beside an ordinary Dolt backend. configfile.Config had no
such fields, so every Save, and Load's config.json -> metadata.json
migration, rewrote the file without them, turning a graph workspace's
metadata into an ordinary Issue workspace's.

Config now carries the marker and the binding as omitempty fields, so
a Save round-trips them unchanged and metadata.json written for an
ordinary workspace is byte-for-byte what it was. GetGraphMode resolves
the marker: absent or "dependency" is the historical default, "link"
is recognized, and any other value is an error rather than a fallback
to the Issue store. Nothing in this build opens a non-default mode;
the CLI refusal follows in the next commit.

Ported from the donnabox fork commit deea8d57df (graph_mode.go,
graph_mode_test.go and the configfile.go fields), without any graph
code. The binding-survives-Save and omitted-from-ordinary-metadata
tests are new.

Co-authored-by: Donna Box <dbox@boxenllc.com>
Agent-Signature: claude-code-claude-opus-5-5-unknown-reasoning on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(cli): refuse graph_mode workspaces before opening them

A workspace whose metadata.json declares a graph_mode other than
"dependency" holds a graph database behind an ordinary Dolt backend,
and nothing else in its metadata says so. bd admitted it like any
current workspace: `bd list` ran the Issue schema initialization
against the graph database (beads_graph_<id>), `bd init --force` wrote
a .gitignore and a .beads/dolt root into it, `bd dolt start` started a
server for it, and `bd doctor` reported on it as an Issue store.

guardLegacyUpgradeWorkspace, the admission check every store-opening
command, store-less command with workspace effects, init, doctor and
bootstrap already run before touching a workspace, now refuses such a
workspace first, before the legacy classifications that would admit
it or report it as a legacy store to migrate. An unknown graph_mode
value is refused the same way. The refusal is a typed error naming the
workspace and the format, rendered with a hint (as JSON under --json)
and exit code 16, ExitUnsupportedWorkspaceFormat, so a wrapper can
tell "needs a different bd build" from a generic failure.
`bd version`, `bd --version`, `bd help` and completion stay exempt, as
they are for legacy workspaces. validateConfiguredBackend refuses the
same metadata, which covers the store-open paths that skip command
admission (routed writes, cross-repository reads, create --repo).

Tests: guard and store-factory unit tests; a subprocess e2e test that
show/list/create/context/where/dolt start/doctor/bootstrap/init are
refused with exit 16 and leave .beads byte-identical (metadata.json and
legacy config.json, link and unknown markers, embedded and server
layouts), and that store-less commands still run; an embedded test
that an ordinary workspace, with the marker absent or "dependency",
still creates and lists issues and keeps the marker through a
metadata.json rewrite.

The guard hunk and graph_mode_admission_e2e_test.go are ported from
the donnabox fork commit deea8d57df; the exit code, rendering, store
factory backstop and remaining tests are new.

Co-authored-by: Donna Box <dbox@boxenllc.com>
Agent-Signature: claude-code-claude-opus-5-5-unknown-reasoning on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* fix(cli): refuse graph workspaces reached outside command admission

Command admission refuses a graph_mode workspace a command runs in, but
bd also reaches workspaces before or without admission: a create --repo
target, the path --db or BEADS_DB names, and the stores the factories
open for routed and cross-repository work. On those paths a workspace
marked only by a legacy config.json was changed before anything refused
it: configfile.Load migrates config.json into metadata.json before the
format check sees the loaded metadata, and create --repo initialized
such a target as a new workspace. Where the refusal did come, create
reported it with exit 1 rather than 16.

- checkDiscoveredWorkspaceFormat checks a workspace's metadata as
  configfile.LoadForDiscovery reads it, which never rewrites it.
  ensureBeadsDirForPath, the dry-run target open and the four store
  factories (cgo and nocgo builds) run it before their own load.
- resolveBeadsDirForDBPath and findDatabaseInBeadsDir locate a
  workspace with LoadForDiscovery, so resolving --db, BEADS_DB or a
  create target no longer migrates it.
- bd create renders a refused target as the workspace refusal, exit 16
  with its hint, on the initializing and both dry-run paths. A dry run
  without --parent opens no target, so it now checks a local one before
  rendering the preview (checkRepoTargetFormat).
- bd bootstrap, when discovery finds no workspace, reads each .beads
  from the working directory up to the repository root without
  migrating it and refuses one in a format this build cannot open, the
  way commands without a workspace already do. A .beads marked only by
  config.json is passed over by discovery, so bootstrap reported "no
  workspace" there instead of exit 16. The walk now returns its
  candidates (undiscoveredWorkspaceCandidates) to both checks: handing
  it the check as a func(string) error made gosec's G702 taint analysis
  connect BEADS_DIR to every func(string) error that runs git.
- backendNameForErrorFraming reads with LoadForDiscovery, and
  loadDoltBackendConfig, bd dolt status and bd dolt show refuse a graph
  workspace before their migrating configfile.Load. Admission refuses
  first on every path that reaches them today; this keeps a new caller
  from migrating a legacy config.json before the refusal.
- The CHANGELOG entry and the configfile comment now claim what holds:
  a routed read fails without touching a graph workspace but not with
  code 16, and a Save keeps only the known graph_* fields, with the
  tags graph-preview builds declare. workspace_gate.go no longer lists
  the pre-gate discovery reads as migrating.
- New e2e rows run create --repo from a workspace and from outside one,
  create --dry-run with and without --parent, --db, BEADS_DB, init
  --proxied-server, bootstrap in a workspace nested in a graph one, and
  the hook shim's bd hooks run pre-commit against every fixture; each
  refusal must exit 16 and name the format and the hint. bootstrap in a
  workspace marked only by config.json now refuses like the other
  commands. The store factory test also runs on a config.json graph
  workspace, TestWorkspaceMetadataReadersLeaveGraphWorkspaceUnchanged
  covers the framing, bd dolt loader and diagnostic reads, and
  TestNocgoStoreFactoriesRefuseGraphWorkspace covers the CGO_ENABLED=0
  factories; bazel.yml's pure lane runs it by name (PURE_CMD_BD_TESTS,
  pinned in scripts/ci_workflow_test.go).

Measured with gocyclo/gocognit: every function this changes stays below
the PR's worst changed function (guardLegacyUpgradeWorkspaceForInit
29/28, resolveBeadsDirForDBPath 26/36); showDoltConfig is 19/31 (was
18/30) and guardUndiscoveredLegacyWorkspace 3/3 (was 9/12).

Agent-Signature: claude-code-claude-opus-5-5-max on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Donna Box <dbox@boxenllc.com>
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-authored-by: Eddie the Engineer <338826946+gascity-eddie[bot]@users.noreply.github.com>
2026-10-20 00:05:39 +00:00

170 lines
5.2 KiB
Go

package configfile
import (
"encoding/json"
"os"
"path/filepath"
"reflect"
"strings"
"testing"
)
func TestGraphModeDiscoveryAndRoundTrip(t *testing.T) {
for _, filename := range []string{ConfigFileName, "config.json"} {
for _, mode := range []string{"", GraphModeDependency, GraphModeLink, "future-format"} {
t.Run(filename+"/"+mode, func(t *testing.T) {
dir := t.TempDir()
input := `{"backend":"dolt","graph_mode":"` + mode + `"}`
path := filepath.Join(dir, filename)
if err := os.WriteFile(path, []byte(input), 0o600); err != nil {
t.Fatal(err)
}
cfg, err := LoadForDiscovery(dir)
if err != nil {
t.Fatal(err)
}
got, err := cfg.GetGraphMode()
if mode == "future-format" {
if err == nil || got != "" {
t.Fatalf("unknown marker resolved to %q, %v", got, err)
}
} else {
want := mode
if want == "" {
want = GraphModeDependency
}
if err != nil || got != want {
t.Fatalf("mode = %q, %v; want %q", got, err, want)
}
}
entries, err := os.ReadDir(dir)
if err != nil || len(entries) != 1 {
t.Fatalf("discovery changed directory: %v, %v", entries, err)
}
after, err := os.ReadFile(path)
if err != nil || string(after) != input {
t.Fatalf("discovery changed metadata: %q, %v", after, err)
}
// Saving otherwise unrelated config must retain the marker,
// including one this client does not understand.
if err := cfg.Save(dir); err != nil {
t.Fatal(err)
}
loaded, err := LoadForDiscovery(dir)
if err != nil || loaded == nil || loaded.GraphMode != mode {
t.Fatalf("marker lost during save: %#v, %v", loaded, err)
}
})
}
}
}
func TestGraphModeAbsentConfigPreservesLegacyDefault(t *testing.T) {
cfg, err := LoadForDiscovery(t.TempDir())
if err != nil || cfg != nil {
t.Fatalf("absent config = %#v, %v", cfg, err)
}
mode, err := cfg.GetGraphMode()
if err != nil || mode != GraphModeDependency {
t.Fatalf("absent config mode = %q, %v", mode, err)
}
}
// graphWorkspaceMetadata is the metadata.json shape a graph_mode link
// workspace carries: the marker, its binding, and ordinary Dolt settings.
const graphWorkspaceMetadata = `{
"database": "",
"backend": "dolt",
"graph_mode": "link",
"graph_scope_url": "https://example.test/scope",
"graph_authority_id": "0123456789abcdef0123456789abcdef",
"graph_workspace": "/work/repo/.beads",
"graph_schema_version": 7,
"graph_ready": true,
"dolt_mode": "embedded",
"dolt_database": "beads_graph_0123456789abcdef0123456789abcdef",
"project_id": "0123456789abcdef0123456789abcdef"
}`
// graphKeys returns every graph_* key of a metadata document with its value.
func graphKeys(t *testing.T, data []byte) map[string]any {
t.Helper()
var doc map[string]any
if err := json.Unmarshal(data, &doc); err != nil {
t.Fatalf("parse metadata %q: %v", data, err)
}
keys := map[string]any{}
for key, value := range doc {
if strings.HasPrefix(key, "graph_") {
keys[key] = value
}
}
return keys
}
// A bd that does not open graph workspaces still rewrites metadata on paths
// that change unrelated settings, and Load itself rewrites a legacy
// config.json as metadata.json. Neither may strip the graph marker or its
// binding: a workspace that lost them would read as an ordinary Issue store.
func TestGraphWorkspaceBindingSurvivesSave(t *testing.T) {
want := graphKeys(t, []byte(graphWorkspaceMetadata))
if len(want) != 6 {
t.Fatalf("fixture carries %d graph_* keys, want 6: %v", len(want), want)
}
t.Run("metadata.json", func(t *testing.T) {
dir := t.TempDir()
if err := os.WriteFile(ConfigPath(dir), []byte(graphWorkspaceMetadata), 0o600); err != nil {
t.Fatal(err)
}
cfg, err := Load(dir)
if err != nil || cfg == nil {
t.Fatalf("Load = %#v, %v", cfg, err)
}
cfg.StaleClosedIssuesDays = 30
if err := cfg.Save(dir); err != nil {
t.Fatal(err)
}
saved, err := os.ReadFile(ConfigPath(dir))
if err != nil {
t.Fatal(err)
}
if got := graphKeys(t, saved); !reflect.DeepEqual(got, want) {
t.Fatalf("Save changed the graph binding:\n got %v\nwant %v\nsaved:\n%s", got, want, saved)
}
})
t.Run("legacy config.json migration", func(t *testing.T) {
dir := t.TempDir()
legacy := filepath.Join(dir, "config.json")
if err := os.WriteFile(legacy, []byte(graphWorkspaceMetadata), 0o600); err != nil {
t.Fatal(err)
}
if _, err := Load(dir); err != nil {
t.Fatal(err)
}
migrated, err := os.ReadFile(ConfigPath(dir))
if err != nil {
t.Fatalf("Load did not migrate config.json: %v", err)
}
if got := graphKeys(t, migrated); !reflect.DeepEqual(got, want) {
t.Fatalf("config.json migration changed the graph binding:\n got %v\nwant %v\nmigrated:\n%s", got, want, migrated)
}
})
}
// The marker and binding are omitempty, so metadata.json written for an
// ordinary workspace is byte-for-byte what it was before they existed.
func TestGraphFieldsOmittedFromOrdinaryMetadata(t *testing.T) {
dir := t.TempDir()
if err := DefaultConfig().Save(dir); err != nil {
t.Fatal(err)
}
data, err := os.ReadFile(ConfigPath(dir))
if err != nil {
t.Fatal(err)
}
if got := graphKeys(t, data); len(got) != 0 {
t.Fatalf("ordinary metadata.json gained graph keys %v:\n%s", got, data)
}
}