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>
49 lines
1.6 KiB
Go
49 lines
1.6 KiB
Go
package storage
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/steveyegge/beads/issueops"
|
|
)
|
|
|
|
// BatchCloser returns the inner store's batch-close surface with this
|
|
// decorator's completion hooks layered over it.
|
|
//
|
|
// It recurses instead of delegating, for the reason IssueLifecycle does: a
|
|
// blind delegation would hand back the inner store's closer and silently drop
|
|
// every on_close script the decorator exists to run.
|
|
func (h *HookFiringStore) BatchCloser() (issueops.BatchCloser, error) {
|
|
inner, err := h.inner.BatchCloser()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &hookBatchCloser{inner: inner, hooks: h}, nil
|
|
}
|
|
|
|
type hookBatchCloser struct {
|
|
inner issueops.BatchCloser
|
|
hooks issueOperationHooks
|
|
}
|
|
|
|
// CloseBatch fires the close hook once PER LANDED ITEM, in request order, and
|
|
// fires nothing for an item that refused. Per item rather than once for the
|
|
// batch because a hook script is written against one issue: collapsing N
|
|
// closes into one firing would silently stop reporting N-1 of them.
|
|
//
|
|
// The claim, when one happened, fires the update hook the claim paths fire,
|
|
// after the closes — the same order the transaction applied them in.
|
|
func (o *hookBatchCloser) CloseBatch(ctx context.Context, request issueops.CloseBatchRequest) (issueops.CloseBatchResult, error) {
|
|
result, err := o.inner.CloseBatch(ctx, request)
|
|
if err != nil {
|
|
return result, err
|
|
}
|
|
for _, outcome := range result.Outcomes {
|
|
if outcome.Err == nil {
|
|
o.hooks.CompleteIssueOperationClose(outcome.Issue)
|
|
}
|
|
}
|
|
if result.ClaimedNext != nil {
|
|
o.hooks.CompleteIssueOperationUpdate(result.ClaimedNext.Issue)
|
|
}
|
|
return result, nil
|
|
}
|