beads/internal/storage/embeddeddolt/issue_operations_contract_test.go
Julian Knutsen d801ec43dc
feat(issueops): put every issue capability behind one library surface
Beads had two implementations of most issue verbs: one for the direct route
(the CLI talking to a store it opened itself) and one for the proxied-server
route (the CLI talking through a unit of work over a running Dolt server).
They drifted — different commit messages, different transaction boundaries,
different refusals, occasionally different answers.

Seven role interfaces now live in the leaf package issueops: Lifecycle,
Reader, ReadyClaimer, BatchCloser, DependencyEditor, Commenter and Relations.
Each is reached only through a store accessor, never a constructor, because
the accessor is where the hook and telemetry decorators add their layers.
Three implementations back every role — dolt, embeddeddolt, and the
unit-of-work provider the proxied route uses. Both routes call the same role
for close, dep add/remove/list, comment, ready --claim and update.

A depguard rule (httpapi-domain-boundary) denies internal/storage/domain from
internal/httpapi, so a handler cannot reach uw.IssueUseCase() past the roles
and open a second front door one lint-clean commit at a time.

Behaviour users will notice, all in the CHANGELOG:
  - bd close a b c is one Dolt commit, not three, and --claim-next moved
    inside that transaction so it fires only when something landed
  - the open-children guard moved into the transaction and its hand-rolled
    cmd/bd copy is gone, removing a read-then-write window that made
    bd close <child> <parent> depend on argument order
  - bd dep add --file honours deferred version commit
  - embedded bd comment writes the role's message and author
  - dep verb commit messages are the role's on the direct route

Wisp-sourced dependency edges are restored. Moving bd dep add onto the role
had pinned an edge's SOURCE to the issues plane, and the two routes did not
even fail alike: direct refused with "issue <id> not found", proxied threw an
fk_dep_issue violation. The comment justifying the pin claimed the issues
plane was "the only one its unit-of-work sibling can reach" — that was false;
domain.DependencyUseCase declared a full set of wisp twins with no production
caller. All three implementations now route per edge by the edge's own
source. A mixed request stays one transaction: parent-child-first ordering
and the whole-graph cycle gate span both planes, and a refusal rolls back
both. Behind the role, three bulk add verbs collapsed into one source-routed
AddDependencies, so no plane-pinned variant is left to reach for by mistake.

Six Provenance fields with no production caller were deleted rather than
wired — CloseRequest, CloseBatchRequest, ClaimNextRequest, AddCommentRequest,
AddDependenciesRequest, RemoveDependencyRequest. Each role already composes an
id-bearing message, so a caller could only restate the default and make it
unreachable from production. Two are not caller-settable even in principle:
CloseBatchCommitMessage names what LANDED and ClaimNextCommitMessage names the
id the claim WON. UpdateRequest and ReopenRequest keep theirs; commit messages
users see are unchanged.

Verified: build, vet and gofmt clean; golangci-lint 0 issues; protocol corpus
byte-identical under BEADS_PROTOCOL_REQUIRE_DOLT=1; all twelve
DependencyEditor conformance wirings green (four contract functions against
each implementation); TestEmbeddedDepAddWispSource runs bd dep add <wisp-id>
at the front door and was demonstrated RED against the pinned routing first.
Three internal/storage/dolt failures reproduce on pristine origin/main.

Known gaps are enumerated in the PR description rather than left to be found:
comment listing is on no role, bd dep tree and bd dep cycles have no role,
bd create and bd reopen are on Lifecycle only on the direct route, per-edge
line attribution is lost in bd dep add --file, multi-store bd close
--claim-next rides only the first store's batch, and the is_blocked staging gap
(bd-2y9ke, predates this change). Seven of the eight role interfaces now have a
shared conformance contract in backend/conformance, run at all three
implementations; main's Claimer, added in parallel by #5334, is the eighth and
has none yet.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-04 12:27:56 -07:00

149 lines
5.8 KiB
Go

//go:build cgo
package embeddeddolt_test
import (
"context"
"testing"
"github.com/steveyegge/beads/backend/conformance"
"github.com/steveyegge/beads/internal/storage/embeddeddolt"
)
func TestEmbeddedIssueOperationsCreateRoutesInfraTypesToWisps(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "infra")
ctx := t.Context()
conformance.RunIssueOperationsCreateRoutesInfraTypesToWisps(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "infra"))
}
func TestEmbeddedIssueOperationsCreateRejectsMissingDependencyTargets(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "skipdep")
ctx := t.Context()
conformance.RunIssueOperationsCreateRejectsMissingDependencyTargets(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "skipdep"))
}
func TestEmbeddedIssueOperationsUpdateFoldsMetadataIntoOneEvent(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "metaevent")
ctx := t.Context()
conformance.RunIssueOperationsUpdateFoldsMetadataIntoOneEvent(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "metaevent"))
}
func TestEmbeddedIssueOperationsUpdateClosePolicy(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "closepol")
ctx := t.Context()
conformance.RunIssueOperationsUpdateClosePolicy(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "closepol"))
}
func TestEmbeddedIssueOperationsUpdateAssigneeTransferFence(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "xferfence")
ctx := t.Context()
conformance.RunIssueOperationsUpdateAssigneeTransferFence(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "xferfence"))
}
func TestEmbeddedIssueOperationsUpdateClosedFieldsMatchClose(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "closedfields")
ctx := t.Context()
conformance.RunIssueOperationsUpdateClosedFieldsMatchClose(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "closedfields"))
}
func TestEmbeddedIssueOperationsUpdateClaimConflictCarriesTheLosingState(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "claimconflict")
ctx := t.Context()
conformance.RunIssueOperationsUpdateClaimConflictCarriesTheLosingState(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "claimconflict"))
}
func TestEmbeddedIssueOperationsUpdateClaimHonorsConfiguredActiveStatuses(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "customclaim")
ctx := t.Context()
conformance.RunIssueOperationsUpdateClaimHonorsConfiguredActiveStatuses(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "customclaim"))
}
func TestEmbeddedIssueOperationsUpdateIssuePlaneOnlyRefusesWisps(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "planeonly")
ctx := t.Context()
conformance.RunIssueOperationsUpdateIssuePlaneOnlyRefusesWisps(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "planeonly"))
}
func TestEmbeddedIssueOperationsUpdateLabelPatchOrdering(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "labelpatch")
ctx := t.Context()
conformance.RunIssueOperationsUpdateLabelPatchOrdering(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "labelpatch"))
}
func TestEmbeddedIssueOperationsUpdateLabelPatchValueRules(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "labelvalues")
ctx := t.Context()
conformance.RunIssueOperationsUpdateLabelPatchValueRules(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "labelvalues"))
}
func TestEmbeddedIssueOperationsUpdateParentIDReplacesTheParentEdge(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "reparent")
ctx := t.Context()
conformance.RunIssueOperationsUpdateParentIDReplacesTheParentEdge(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "reparent"))
}
func TestEmbeddedIssueOperationsUpdateParentIDReplacesEveryParent(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "multiparent")
ctx := t.Context()
conformance.RunIssueOperationsUpdateParentIDReplacesEveryParent(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "multiparent"))
}
func TestEmbeddedIssueOperationsUpdateMetadataReplaceClearsAndValidates(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "metareplace")
ctx := t.Context()
conformance.RunIssueOperationsUpdateMetadataReplaceClearsAndValidates(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "metareplace"))
}
func TestEmbeddedIssueOperationsRequestValuesAreNotMutated(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "detach")
ctx := t.Context()
conformance.RunIssueOperationsRequestValuesAreNotMutated(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "detach"))
}
func TestEmbeddedIssueOperationsUpdateProvenanceLabelsHistory(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "provenance")
ctx := t.Context()
conformance.RunIssueOperationsUpdateProvenanceLabelsHistory(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "provenance"))
}
func TestEmbeddedIssueOperationsUpdatePersistentPreservesUnversionedClass(t *testing.T) {
skipUnlessEmbeddedDolt(t)
te := newTestEnv(t, "unversioned")
ctx := t.Context()
conformance.RunIssueOperationsUpdatePersistentPreservesUnversionedClass(t, ctx, newEmbeddedIssueOperationsFixture(t, ctx, te, "unversioned"))
}
func newEmbeddedIssueOperationsFixture(t *testing.T, ctx context.Context, te *testEnv, prefix string) conformance.IssueOperationsStagingFixture {
t.Helper()
operations, err := embeddeddolt.NewIssueOperations(te.store)
if err != nil {
t.Fatalf("NewIssueOperations: %v", err)
}
return conformance.IssueOperationsStagingFixture{
IssuePrefix: prefix,
Operations: operations,
CreateIssue: te.store.CreateIssue,
SetConfig: te.store.SetConfig,
UpdateRaw: te.store.UpdateIssue,
QueryScalar: func(ctx context.Context, query string, args []any, dest ...any) error {
te.queryScalar(t, ctx, query, args, dest...)
return nil
},
}
}