* fix(create): let a remote backend mint the --parent child id
`bd create --parent` always called the raw GetNextChildID first, which the
http backend does not serve, so every child create on a remote workspace
refused before writing anything. The Lifecycle role already mints
<parent>.<n> for a create that carries a ParentID and no id of its own, on
every backend and inside the create's own transaction; conformance
RunIssueOperationsCreateUnderAParentMintsTheNextChildID pins it on every leg,
the served one included (and the bd-enterprise postgres leg the MC server
runs). So the create route needs no new capability token: on a registered
Remote backend the client skips the raw reservation and lets the server mint.
The local route keeps its reservation so its Dolt commit staging is
unchanged, and an explicit --id beside --parent is still refused up front.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(mol): molecule reads, auto-close and close --continue over issueops roles
Over the http backend three molecule paths failed, and two of them
silently:
- `bd mol current` / `bd mol progress` without an id answered "no molecules"
because the in_progress listing (a raw SearchIssues shape) and the parent
walk (raw GetDependencyRecordsForIssues) were refused and the refusal was
swallowed; with an id they refused on raw GetMoleculeProgress.
- The molecule auto-close after `bd close` never ran: findParentMolecules
swallowed the same refused edge read into "not part of a molecule".
- `bd close --continue` claimed the next step in a raw RunInTransaction.
The direct route now reads molecules through roleMolStore, which answers
through roles every backend serves: EdgeReader (batched at the wire's 100
anchors) for the parent walk, BatchGetter for the roots (Get per id where a
server does not publish issues.batchGet), Relations for the step rows (full
rows; the raw dependents read over http is getIssue's shallow projection,
which zeroed step assignees) and the progress counts, and Reader.List for the
in_progress/hooked listings. The auto-close closes the root through
Lifecycle.Close, and the --continue claim is one Lifecycle.Update guarded by
ExpectedStatus=open.
No refusal is swallowed any more: findParentMolecules, the molecule finders
and the hooked scan return their errors; `mol current/progress` report them;
the auto-close stays best effort but warns on stderr; AdvanceToNextStep only
moves on to the next ready step when the claim LOST a race (status mismatch,
not claimable, already claimed) and returns anything else. The one heuristic
still skipped is the id-pattern heal in loadDescendants, and only for an
ErrUnsupported backend that cannot express an id-prefix search; other
failures now surface. `mol current`/`mol progress` leave the
types.IssueFilter forbidigo hole, since they no longer build a filter.
gc does not depend on bd's molecule auto-close: it runs its own
(cmd/gc/molecule_autoclose.go, from the bd on_close hook and the
controller's bead-close events). Its worker prompts do run `bd mol current`.
Served e2e (TestE2E_MoleculesOverHTTP): create --parent mints <root>.1/.2,
mol current <id> is non-empty with the full in-progress step, mol progress
counts, close --continue auto-advances, closing the last step auto-closes
the root. `mol current` without an id now refuses out loud on this stack
(asserted: never an empty list); its non-empty assertion is skipped until
S6c (externaldeps reader passthrough) is underneath.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(mol): list molecule candidates with the four wire knobs, drop the S6c skip
On top of S6c the in_progress listing behind 'bd mol current' (no id)
reaches the v0 wire encoder, which refuses ListRequest.IncludeAllTypes.
Ask for templates, gates, infra and ephemeral rows explicitly, which the
wire publishes, and run the 'mol current without an id' served case.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* feat(issueops): one library entry each for molecule auto-close, advance and reads
The molecule rules lived only in cmd/bd, in copies that disagreed: two
auto-close implementations that closed the root through different
library entries outside the step close's transaction, a `close
--continue` claim that set no assignee and could take a step another
agent held on the direct and http routes, and three progress counts.
Every molecule rule now has one implementation in the public issueops
package, composed over three roles every backend serves (BatchGetter,
Relations, EdgeReader): MoleculeRoots, LoadMolecule, AnalyzeMolecule,
ViewMolecule, ReadMoleculeProgress, ActiveMoleculeIDs,
CompletedMolecule. Membership is the parent-child edge.
Auto-close: CloseRequest.AutoCloseMolecule and
CloseBatchRequest.AutoCloseMolecule (opt-in, so gc's own auto-close is
not doubled) close the molecule root a close completed IN THE SAME
TRANSACTION, unforced and guarded on the root revision read there:
storageissueops.CloseCompletedMoleculeInTx on the store backends (the
role bodies bound to the caller's tx, TxMoleculeReader) and
uow.CloseCompletedMoleculeInUOW on the unit of work. It replays on an
idempotent re-close, reports the root on CloseResult/CloseOutcome
.AutoClosedMolecule, and a root its own close policy refuses stays open
and is reported (MoleculeAutoCloseRefusal) without failing the step.
Advance: a new MoleculeStepper role (storage.DoltStorage accessor,
uow.MoleculeStepperSource) whose one implementation,
issueops.NewMoleculeStepper, claims the next ready step through the
Claimer (Lifecycle.Update's Claim for a wisp step): assignee set, a step
another actor holds skipped, never taken.
HTTP: closeIssue/batchCloseIssues carry auto_close_molecule behind the
issues.close.autoCloseMolecule behavior token, and POST
/v0/beads/issues/{id}:advanceMolecule (issues.advanceMolecule) serves
the stepper. Handlers only decode, call the role and encode. The client
sends the member and dials the operation only where advertised; against
an older server it DEGRADES rather than refuses — it runs the same
library rule over its own roles (issueops.CloseCompletedMolecule after
the close, NewMoleculeStepper for the advance), so the outcome is the
same in more round trips. The capability fallbacks that lived in
cmd/bd move into the client: BatchGetter answers one getIssue per id
without issues.batchGet, and EdgeReader splits past the operation's 100
anchors.
Conformance: RunMolecule* on dolt, embedded, uow and http (the http leg
twice: served, and against a server with the tokens struck out).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* refactor(cmd/bd): molecule commands and create --parent through the library entries
`bd close`, `bd close --continue`, `bd mol current`, `bd mol progress`,
`bd ready --mol` and `bd create --parent` now call the one library entry
for each rule on every route (direct, proxied server, remote):
- close (batch, --if-revision, proxied) sets CloseRequest/
CloseBatchRequest.AutoCloseMolecule and only reports what the library
closed in the step close's transaction. autoCloseCompletedMolecule,
autoCloseProxiedCompletedMolecule and closeCompletedMoleculeRoot are
gone, and so is the separate post-close write.
- --continue is the route's MoleculeStepper role: a real claim (the
assignee is set) that skips a step another actor holds. Before, the
direct and http routes flipped the status only and could take it.
AdvanceToNextStep, ClaimStepIfOpen and its two implementations are
gone.
- mol current / mol progress / ready --mol read through
issueops.ViewMolecule, ReadMoleculeProgress, ActiveMoleculeIDs and
LoadMolecule/AnalyzeMolecule over the route's roles. Over http this
fixes the missing step assignee on `ready --mol` (corpus mark
mc-ready-mol). The proxied route's SearchIssues fallback, the role
store, the third progress count and the cmd/bd copy of the readiness
analysis are deleted; only presentation stays here.
- create --parent asks the create role to mint the child id on every
route (the local CLI reservation is gone) and to inherit the parent's
labels (InheritLabelsFromParent) inside the create. The dry-run
preview still shows the labels, and a failed label read there is
reported, not swallowed.
TestProxiedServerMoleculeLifecycleAgreesOnEveryRoute runs one molecule
lifecycle through the real binary on the direct, proxied and remote
(`bd connect` to `bd serve`) routes and requires the same rows and the
same JSON on all three. The served e2e now also pins the held-step skip,
the claimed step's assignee and the full rows of `ready --mol`.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(httpclient): refuse molecule auto-close and advance before dialing an older server
The client used to DEGRADE against a server without
issues.close.autoCloseMolecule / issues.advanceMolecule: it closed the step
without the member and ran a second, client-side copy of the auto-close
(issueops.CloseCompletedMolecule) in its own transactions, and composed the
stepper over its own roles. That kept two executions of each rule alive.
Now the rule runs in ONE place, the server's library: a close or batch close
that sets AutoCloseMolecule, and an Advance, refuse before anything is dialed
with the typed capability error (storage.ErrUnsupported, Capability naming the
token). The composed single-item batch leg now carries the member too.
- issueops.CloseCompletedMolecule (the role-composed form) is gone.
MoleculeRootClose is the one root close request (unforced, the auto-close
reason, the session, guarded on the root revision read), and both
in-transaction bodies (storage issueops CloseCompletedMoleculeInTx, uow
CloseCompletedMoleculeInUOW) build from it.
- MoleculeView.Ready is `bd ready --mol`'s list (every analysis-ready node,
hydrated), so ready --mol and mol current derive from ViewMolecule alone.
Tests: unit pre-dial refusal and member pins (httpclient molecule_test.go),
TestServedMoleculeRefusesAgainstAnOlderServer (step stays open, nothing
claimed) replacing the degraded contract arm.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(cmd/bd): ask for the molecule auto-close only where the route serves it
The refuse-before-dialing client made every `bd close` over http fail
against a server that does not advertise issues.close.autoCloseMolecule
(an older bd serve, or the MC server shape, whose orchestrator owns the
molecule lifecycle): the CLI always set AutoCloseMolecule.
storage.ServesMoleculeAutoClose answers, through every decorator, whether a
store's closes may carry the flag (MoleculeAutoCloseProber, implemented by
httpclient.Store from its handshake; every local backend serves it). The
direct batch close and the --if-revision close set the flag from it; the
proxied route always serves it. Against a silent server the close goes out
without the member and the server's side owns the auto-close.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* test(backend/http): scope the advertised-policy check to reads before the close
The close policy check is the client-side policy's last chance: it runs
before the close request, so only the reads up to that request count. A
read after the close (the old-server molecule notice reads the closed
step's edges) is not the external-dependency policy.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* test(backend/http/corpus): drop the six marks S16 and S19 retire
With the molecule library entries underneath, mol current (with and
without an id, json and text), mol progress and ready --mol read through
issueops.LoadMolecule over the roles, and create --parent lets the server
mint the child id. Those six shapes pass on the reference profile.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(cmd/bd): never silent against a server without the molecule tokens
Against a server that advertises neither issues.close.autoCloseMolecule
nor issues.advanceMolecule (an older bd serve, or one whose orchestrator
owns the molecule lifecycle):
- `bd close --continue` closed the step and only then found the advance
refused, leaving the step closed and the next step unclaimed. It now
asks storage.ServesMoleculeAdvance (a MoleculeAdvanceProber the http
store answers from its handshake; local backends always serve it)
BEFORE the close and refuses up front, saying nothing was closed.
- `bd close` went out without auto_close_molecule and said nothing. When
the closed step belongs to a molecule (issueops.MoleculeRoot), a notice
on stderr now names the molecule and the missing token: its auto-close
is the server's to run. The batch and --if-revision closes both say it.
The served e2e masks both tokens out of the handshake and checks the
up-front refusal (the step stays open) and the notice; the httpclient
unit test pins ServesMoleculeAdvance to the handshake.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* refactor(cmd/bd): mol show through issueops.LoadMolecule on every route
`bd mol show` still loaded the molecule through cmd/bd's
loadTemplateSubgraph (raw GetIssue, GetDependentsWithMetadata and
GetDependencyRecords, plus an id-pattern child probe), while mol current,
mol progress and ready --mol read through the library. It now loads
through issueops.LoadMolecule over the route's molecule roles (the direct
store's, or the proxied provider's), so membership is the parent-child
edge everywhere and the http route reads through roles the server serves.
The served e2e checks mol show's root and step count.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs: the molecule auto-close fails the step's close on a non-policy error; stale comments
CloseRequest.AutoCloseMolecule and CloseCompletedMoleculeInTx now say what
changed when the auto-close moved into the close's transaction: a root
close the close policy refuses still leaves the root open and is reported,
but any other failure (a storage error, a lost race on the root's revision)
fails the step's close with it, where the CLI used to close the root
afterwards and only warn.
Stale: the advanceMolecule vocabulary entry said the client composes the
stepper over its own roles when unserved (it refuses before dialing), and
the graph-create collision probe called itself best-effort by transport
(the http GetIssue miss is storage.ErrNotFound like every other store's).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(changelog): the molecule tokens and the S16/S19 behaviours
Entries for issues.close.autoCloseMolecule and issues.advanceMolecule, the
issueops molecule entries, the auto-close inside the step's close (and a
non-policy failure of it failing the close), the real claim behind
close --continue, the molecule reads on every route, the notice and the
up-front --continue refusal against a server without the tokens, and
create --parent / mol reads over http.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(httpclient): regenerate unsupported_gen.go for MoleculeStepper
The PR adds MoleculeStepper() to storage.DoltStorage (200 -> 201
methods). httpclient implements it by hand, but the generated shell's
trailer still counted 200, so
//internal/storage/unsupportedgen:unsupportedgen_test
(TestGeneratedShellIsFresh) failed in Bazel / test and
Bazel / integration, turning CI Gate / Required red.
Regenerated with `go generate ./internal/httpclient`; the only change
is the trailer count (143 of 201 methods generated; 58 left).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(molecule): auto-close refusals, write skew, close --json, docs
Review fixes for #7513, numbered as in each iteration's review
synthesis.
Iteration 1:
F1: a close guard's refusal of the root (TemplateReadOnlyError,
PinnedError, CloseNotAssigneeError) is an auto-close refusal, like the
close policy's: the root stays open and is reported, and the step's
close stands. Pinned by the new conformance case
RunMoleculeGuardedRootKeepsTheStepClose on dolt, embedded, uow and the
served http client.
F2: two closes that finish a molecule's last two steps in concurrent
transactions each read the other's step as open, so neither closed the
root and both committed. Every auto-close now rewrites the root's
coordination cell before it decides the root (local_metadata
molecule-coordination/v1/<shard>, the dependency coordination idiom and
sharding with a FreshRowLock value), in both twins
(CloseCompletedMoleculesInTx and CloseCompletedMoleculesInUOW). Two
deciders of one root now conflict at commit (1213), and the retry reads
the winner's close and closes the root. This is the synthesis's option
(c), applied through a coordination cell instead of the root row; it
needs no post-commit second transaction and no engine lock. The
deterministic two-transaction regression fails without the touch and
passes with it on dolt and uow; the concurrent-close tests end with the
root closed in every round, reported by exactly one close.
F3: the auto-close checks the root's eligibility before walking any
step, MoleculeStepsClosed stops at the first open step, and a batch
decides each root once and reports it on the first item under it.
F4: ErrVersionMismatch on the root is not a refusal; it fails the
step's close with it. The classifier unit test pins this. A conformance
case cannot stage that race deterministically through the public roles.
F5: storage.ServesMoleculeAdvance answers (bool, error), and bd close
--continue refuses before closing anything when the handshake cannot be
read.
F6: the CHANGELOG and the stepper and batch-closer doc comments say
what the code does.
F7: the unserved-auto-close notice fires only when the close left an
auto-closing molecule with every step closed and its root open
(issueops.CompletedMolecule): again on a re-close, once per root in a
batch, never for a step under an ordinary epic or an unfinished
molecule. Proxied mol show, mol current and mol progress again report a
read unit of work that cannot be opened as itself, not as a molecule
that was not found.
F8: the write-ledger comment says the close is refused before dialing.
The dead FirstClosed/LastClosed guards in mol progress pre-exist on main
and are left as they are.
Iteration 2:
F1: on the proxied route, bd ready --mol reported a read unit
of work it could not open twice: once as itself, then as "molecule
'<id>' not found", which under --json is a second error document on
stdout. It now returns moleculeNotResolved, as mol show, mol current and
mol progress do. TestProxiedReadyMolReportsAnUnopenableReadOnce drives
runMoleculeReady with a provider whose NewUOW fails and wants one Error:
line, or one JSON document; both subtests fail with the old return.
F2: the coordination cell serializes every concurrent close of a step
under an open auto-closing root, not only the closes that finish the
molecule. That is the price of deciding the root in the step's
transaction, so it is documented (TouchMoleculeCoordinationInTx, the
UOW twin, CloseRequest.AutoCloseMolecule, the CHANGELOG) and pinned on
dolt and uow: two sibling closes with a third step still open conflict
(both commit when the touch is removed, on either twin), and a six-step
fan-out closes every step through the store's retry, with the root
closed and reported by exactly one close. The synthesis's alternative,
a post-commit recheck by any close that read a step open, is not taken:
it is a second, best-effort transaction after the step's commit, the
shape this PR exists to remove.
F3: MoleculeRootClose's doc no longer promises that a step reopened
between the completion read and the root close fails the step's close.
The guard is the root's RowVersion, which a step reopen never writes;
the doc now says what the guard covers and that this race goes
undetected (it is inherited from the CLI's old post-commit auto-close).
F4: the user docs describe the auto-close. docs/workflows/molecules.md
replaces "Closing the last child does not close the molecule root"
with which roots close and which stay open, the refusal warning, the
unserved-server note and the --json members, and documents the claiming
--continue and parent-child step membership;
docs/reference/json-schema.md gains a bd close --json section. These
are main-only behaviors on pages pinned to v1.2.2 (docs/cli-docs.pin):
a maintainer call against §1 of
engdocs/decisions/2026-07-17-docs-release-pin.md, as in #6508, #5855,
#5997 and #5092. The auto-close itself shipped in v1.2.2
(cmd/bd/close.go autoCloseCompletedMolecule), so the old sentence was
already wrong at the pin. docs/cli-reference/ is generated from the
pinned release and is not hand-edited; the bd close and bd mol show
help texts carry the same facts and reach it at the next pin bump.
F5: bd close --json reports the auto-close. The entry of a close that
completed a molecule gains auto_closed_molecule (the root it closed) or
molecule_auto_close_refusal (why the root stayed open), the HTTP API's
names, on the direct, proxied and --if-revision routes. The members sit
beside the issue's own rather than wrapping the output in an object the
way --suggest-next does: an object would change the output's shape
exactly when a close completes a molecule and break every consumer that
reads an array, while members leave each entry decoding as the closed
issue, compose with `closed` under the flag objects, and leave a plain
close's bytes unchanged. Pinned on the embedded and proxied tiers
(TestEmbeddedCloseJSONReportsMoleculeAutoClose, TestProxiedServerClose2B
json_reports_*, and both --if-revision replay tests), all red without
the change.
F6: cmd/bd's BeadsTemplateLabel is issueops.MoleculeTemplateLabel, so
the template commands and molecule membership cannot drift apart.
F7: the UOW twin's revision probe says that it writes nothing,
and the BatchCloseRequest.auto_close_molecule spec description has its
verb back (apigen regenerated, no drift).
Iteration 3:
F1: on the unit-of-work route (bd serve, the proxied CLI), a refused
root's molecule_auto_close_refusal and warning carried the use case's
and repository's wrapping ("close <id>: db:
IssueSQLRepository.CloseChecked <id>: ...") around the refusal, where
the tx twin and the docs give the refusal alone. Both twins now report
it through RefusedMoleculeAutoClose, which answers the refusing guard's
or policy's own sentence. RunMoleculeRefusedRootKeepsTheStepClose,
RunMoleculeGuardedRootKeepsTheStepClose and the embedded and proxied
close --json tests want that exact sentence; the uow conformance leg
and the proxied test fail without the unwrap.
F2: the docs no longer promise ErrVersionMismatch for a write to the
root that races its auto-close. The root's read and its revision check
share one transaction snapshot, so that write conflicts with the root
close at commit and the retry decides the root again; the close fails
only if it still conflicts when its retry budget runs out
(MoleculeRootClose, IsMoleculeAutoCloseRefusal,
CloseRequest.AutoCloseMolecule, the tx twin's comment, the CHANGELOG
and the OpenAPI description, apigen regenerated).
F3: TestEmbeddedCloseJSONReportsMoleculeAutoClose moves above
TestEmbeddedCloseConcurrent's doc comment, which documents its own test
again.
F4: bd mol progress counting direct steps while the auto-close counts
every descendant predates this PR; it is left for a follow-up.
F5: cmd/bd's molReader drops GetMoleculeProgress, which nothing called
once mol progress read through issueops.ReadMoleculeProgress.
Agent-Signature: claude-code-claude-opus-5-5-max on behalf of Gas City Adopt-PR
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
410 lines
18 KiB
Go
410 lines
18 KiB
Go
// Contributed by gascity from bd-enterprise (internal/enterprise/httpstore/batchcloser.go@49d1df2f6)
|
||
// to OSS beads under the MIT license.
|
||
package httpclient
|
||
|
||
import (
|
||
"context"
|
||
"errors"
|
||
"fmt"
|
||
"slices"
|
||
"strings"
|
||
"unicode"
|
||
|
||
"github.com/steveyegge/beads/internal/httpapi/apigen"
|
||
"github.com/steveyegge/beads/internal/httpclient/encode"
|
||
"github.com/steveyegge/beads/internal/httpclient/wire"
|
||
storageops "github.com/steveyegge/beads/internal/storage/issueops"
|
||
"github.com/steveyegge/beads/issueops"
|
||
)
|
||
|
||
// readySortPolicies names the only three sort policies a ClaimNext filter
|
||
// accepts, mirroring internal/workapi.BuildReadyFilter's vocabulary. It is
|
||
// redeclared here rather than imported for the reason list_walk.go, order.go
|
||
// and releaser.go each give: depguard denies internal/workapi to this package.
|
||
//
|
||
// A value outside this list is a deterministic request-validation failure —
|
||
// RunBatchCloserClaimFilterValueFailureIsARequestValidationFailure — and that
|
||
// holds REGARDLESS of whether the v0 wire can carry a ClaimNext at all: a bad
|
||
// sort policy is caught before the capability question is even asked, the same
|
||
// way an empty actor or a blank item id is.
|
||
var readySortPolicies = []string{"hybrid", "oldest", "priority"}
|
||
|
||
// validateReadySortPolicy refuses a ClaimNext filter's sort policy if it names
|
||
// anything outside readySortPolicies. An empty policy is the caller leaving it
|
||
// to the default and is always legal here.
|
||
func validateReadySortPolicy(policy string) error {
|
||
if policy == "" || slices.Contains(readySortPolicies, policy) {
|
||
return nil
|
||
}
|
||
return invalid("invalid sort policy '%s'. Valid values: hybrid, priority, oldest", policy)
|
||
}
|
||
|
||
// maxWireBatchCloseItems is the wire's cap on one batch close: maxBatchCloseItems
|
||
// in internal/httpapi/batch_close.go, redeclared here because importing the
|
||
// server would drag the storage engine into a client. A batch over the bound
|
||
// REFUSES rather than chunking — see ledger row L-close-cap and CloseBatch below.
|
||
const maxWireBatchCloseItems = 100
|
||
|
||
// httpBatchCloser serves issueops.BatchCloser over the v0 wire.
|
||
//
|
||
// WHERE THE WIRE CARRIES issues.batchClose, the whole CloseBatchRequest is one
|
||
// wire call: many items, per-item outcomes, and the atomic ClaimNext included.
|
||
// That is the operation this role was always waiting for — `bd close a b c` is
|
||
// one transaction with at most one history entry, and only a single wire call
|
||
// preserves that where a loop of closeIssue could not.
|
||
//
|
||
// WHERE IT DOES NOT — a server too old to advertise the capability — the role
|
||
// falls back to the ONE shape a bare closeIssue can honestly compose: a single
|
||
// item with no ClaimNext, which is the shape `bd close <id>` issues for the
|
||
// common case. Every other shape refuses in that leg rather than looping, because
|
||
// N sequential closes are N transactions and N history entries where the contract
|
||
// promises one, and ClaimNext runs INSIDE the closes' transaction and can see an
|
||
// unblocking the batch itself produced. See refuseUnservedCloseShape.
|
||
//
|
||
// CLIENT-SIDE VALIDATION happens first on both legs: the role contract calls an
|
||
// empty actor, an empty batch or a blank item id invalid, so they must not
|
||
// consume a write slot to be told so. The item cap is enforced here too, and it
|
||
// refuses — never chunks — for the reason L16's dependency-add cap does.
|
||
type httpBatchCloser struct {
|
||
store *Store
|
||
wire WriteWire
|
||
}
|
||
|
||
var _ issueops.BatchCloser = (*httpBatchCloser)(nil)
|
||
|
||
// CloseBatch closes the batch, on the wire's batchClose operation where the
|
||
// server advertises it and by composing a single closeIssue where it does not.
|
||
func (b *httpBatchCloser) CloseBatch(ctx context.Context, req issueops.CloseBatchRequest) (result issueops.CloseBatchResult, err error) {
|
||
// Write-side parity with reads: decorates a bare *encode.RefusedError into
|
||
// *InexpressibleError so errors.As(err, &unsupported) reaches
|
||
// *storage.ErrUnsupported, same as inexpressible does for a read role.
|
||
defer func() { err = b.store.inexpressible("BatchCloser.CloseBatch", err) }()
|
||
// Request validation first, and all of it client-side. A non-nil error here
|
||
// carries no outcomes, which the method's contract requires.
|
||
if err := requireActor(req.Actor); err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
if len(req.Items) == 0 {
|
||
return issueops.CloseBatchResult{}, invalid("a batch close names no items")
|
||
}
|
||
for i, item := range req.Items {
|
||
if item.IssueID == "" {
|
||
return issueops.CloseBatchResult{}, invalid("items[%d].issue_id is required", i)
|
||
}
|
||
}
|
||
// ClaimNext's OWN request rules run before the capability question is asked,
|
||
// the same ordering ReadyClaimer.ClaimNext uses: a filter that is invalid on
|
||
// every backend (a limit, an offset, a brief projection, or an unknown sort
|
||
// policy) is ErrValidation here, not a refusal of a capability the wire
|
||
// might have had. RunBatchCloserClaimFilterValueFailureIsARequestValidationFailure
|
||
// pins this — the item is real and closeable, so a backend that ran the
|
||
// batch before discovering the bad filter would still have to undo it.
|
||
if req.ClaimNext != nil {
|
||
if err := storageops.ValidateClaimNextRequest(issueops.ClaimNextRequest{Actor: req.Actor, Filter: *req.ClaimNext}); err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
if err := validateReadySortPolicy(req.ClaimNext.Sort); err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
// Past its own validation, ClaimNext still refuses unconditionally: OSS's
|
||
// apigen.BatchCloseRequest and BatchCloseResponse publish no
|
||
// claim_next/claimed_next member at all, so there is no shape — valid or
|
||
// not — for this field to encode into. See ledger row
|
||
// W-CloseBatchRequest.ClaimNext.
|
||
return issueops.CloseBatchResult{}, refuse(encode.OpBatchCloseIssues, "W-CloseBatchRequest.ClaimNext")
|
||
}
|
||
// The wire's item cap, enforced before the dial and NEVER by chunking: a
|
||
// split batch is N transactions where the caller asked for one. L-close-cap.
|
||
if len(req.Items) > maxWireBatchCloseItems {
|
||
return issueops.CloseBatchResult{}, refuse(encode.OpBatchCloseIssues, "L-close-cap")
|
||
}
|
||
|
||
served, err := b.servesBatchClose(ctx)
|
||
if err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
// AutoCloseMolecule rides the member only where the server advertises it;
|
||
// elsewhere the batch is refused before it is dialed (molecule.go).
|
||
if err := b.store.requireAutoCloseMolecule(ctx, "BatchCloser.CloseBatch", req.AutoCloseMolecule); err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
if served {
|
||
return b.serveBatch(ctx, req)
|
||
}
|
||
return b.serveComposedSingle(ctx, req)
|
||
}
|
||
|
||
// servesBatchClose reports whether the server advertises issues.batchClose. It
|
||
// forces the one lazy handshake the store already owns and reads the cached
|
||
// capability list, so the check costs at most one round trip and none once the
|
||
// handshake has run.
|
||
//
|
||
// IT RETURNS THE HANDSHAKE'S ERROR, and servesListSort (list_walk.go) — the
|
||
// same probe against the same snapshot — deliberately swallows its own and
|
||
// reports false. The asymmetry is the design, and neither should be "fixed"
|
||
// into the other: this is a WRITE whose only legs both dial, so a handshake
|
||
// that cannot be obtained means the close cannot be attempted at all and
|
||
// hiding that would turn a transport failure into a silent down-level route.
|
||
// listIssues is a baseline READ whose fallback leg needs no handshake and
|
||
// worked before the capability existed, so propagating there would newly fail
|
||
// a `bd list` that succeeds today.
|
||
func (b *httpBatchCloser) servesBatchClose(ctx context.Context) (bool, error) {
|
||
snap, err := b.store.snapshot(ctx)
|
||
if err != nil {
|
||
return false, err
|
||
}
|
||
if snap == nil {
|
||
return false, nil
|
||
}
|
||
token, _ := wire.CapabilityFor(wire.OpBatchCloseIssues)
|
||
return slices.Contains(snap.Capabilities, token), nil
|
||
}
|
||
|
||
// serveBatch sends the whole request on one issues:batchClose call and reads the
|
||
// per-item outcomes back.
|
||
func (b *httpBatchCloser) serveBatch(ctx context.Context, req issueops.CloseBatchRequest) (issueops.CloseBatchResult, error) {
|
||
body := batchCloseBody(req)
|
||
resp, err := b.wire.BatchCloseIssues(ctx, body)
|
||
if err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
return decodeBatchCloseResult(req, resp)
|
||
}
|
||
|
||
// serveComposedSingle is the down-level fallback: the single-item, no-ClaimNext
|
||
// shape composed onto closeIssue, with every other shape refused citing the
|
||
// missing capability. It is TODAY's serve, reached only when issues.batchClose
|
||
// is absent.
|
||
func (b *httpBatchCloser) serveComposedSingle(ctx context.Context, req issueops.CloseBatchRequest) (issueops.CloseBatchResult, error) {
|
||
if err := b.store.refuseUnservedCloseShape(req); err != nil {
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
item := req.Items[0]
|
||
body := closeBody(req.Actor, item.Reason, req.Session, req.Force)
|
||
if req.AutoCloseMolecule {
|
||
autoClose := true
|
||
body.AutoCloseMolecule = &autoClose
|
||
}
|
||
res, err := b.wire.CloseIssue(ctx, item.IssueID, body)
|
||
if err != nil {
|
||
if outcome, ok := perItemCloseRefusal(item.IssueID, err); ok {
|
||
// A per-item refusal is a RESULT and never the method's error. The
|
||
// batch of one has nothing left to commit, but the caller still reads
|
||
// its answer out of Outcomes like any other batch.
|
||
return issueops.CloseBatchResult{Outcomes: []issueops.CloseOutcome{outcome}}, nil
|
||
}
|
||
return issueops.CloseBatchResult{}, err
|
||
}
|
||
|
||
issue := res.Issue
|
||
return issueops.CloseBatchResult{Outcomes: []issueops.CloseOutcome{{
|
||
IssueID: item.IssueID,
|
||
Issue: &issue,
|
||
Changed: !res.AlreadyClosed,
|
||
OpenChildren: res.OpenChildren,
|
||
AutoClosedMolecule: res.AutoClosedMolecule,
|
||
MoleculeAutoCloseRefusal: derefStringPtr(res.MoleculeAutoCloseRefusal),
|
||
}}}, nil
|
||
}
|
||
|
||
// batchCloseBody projects the role request onto the wire body. Reasons ride per
|
||
// item, and session and force are request-wide. ClaimNext has no member to
|
||
// project onto — CloseBatch refuses it unconditionally before this body is
|
||
// ever built (W-CloseBatchRequest.ClaimNext), so req.ClaimNext is always nil
|
||
// here.
|
||
func batchCloseBody(req issueops.CloseBatchRequest) apigen.BatchCloseRequest {
|
||
items := make([]apigen.BatchCloseItem, len(req.Items))
|
||
for i, item := range req.Items {
|
||
items[i] = apigen.BatchCloseItem{Id: item.IssueID}
|
||
if item.Reason != "" {
|
||
reason := item.Reason
|
||
items[i].Reason = &reason
|
||
}
|
||
}
|
||
body := apigen.BatchCloseRequest{Actor: req.Actor, Items: items}
|
||
if req.Session != "" {
|
||
session := req.Session
|
||
body.Session = &session
|
||
}
|
||
if req.Force {
|
||
force := true
|
||
body.Force = &force
|
||
}
|
||
if req.AutoCloseMolecule {
|
||
autoClose := true
|
||
body.AutoCloseMolecule = &autoClose
|
||
}
|
||
return body
|
||
}
|
||
|
||
// decodeBatchCloseResult reads the wire response back into the role's result.
|
||
//
|
||
// The server's contract is one outcome per item in request order; a length that
|
||
// disagrees is a broken server, which is the METHOD's failure and carries no
|
||
// outcomes rather than a per-item one the caller might trust.
|
||
//
|
||
// The result's ClaimedNext always stays nil: OSS's apigen.BatchCloseResponse
|
||
// publishes no claimed_next member for this client to decode, and CloseBatch
|
||
// refuses any request that asked for one before a body is ever sent (see
|
||
// ledger row W-CloseBatchRequest.ClaimNext), so there is nothing a server
|
||
// could answer here that this client would read.
|
||
func decodeBatchCloseResult(req issueops.CloseBatchRequest, resp *apigen.BatchCloseResponse) (issueops.CloseBatchResult, error) {
|
||
if len(resp.Outcomes) != len(req.Items) {
|
||
return issueops.CloseBatchResult{}, fmt.Errorf(
|
||
"bd serve returned %d batch-close outcomes for %d items", len(resp.Outcomes), len(req.Items))
|
||
}
|
||
outcomes := make([]issueops.CloseOutcome, len(resp.Outcomes))
|
||
for i := range resp.Outcomes {
|
||
outcomes[i] = decodeBatchCloseOutcome(req.Actor, resp.Outcomes[i])
|
||
}
|
||
return issueops.CloseBatchResult{Outcomes: outcomes}, nil
|
||
}
|
||
|
||
// decodeBatchCloseOutcome reads ONE wire outcome.
|
||
//
|
||
// `code` IS THE DISCRIMINATOR, which is the wire's own rule: present means the
|
||
// item refused and nothing was written for it; absent means it succeeded and
|
||
// the snapshot, `already_closed` and `open_children` are all present. The
|
||
// members are FLAT on the outcome rather than nested under an error object, so
|
||
// `open_children` is read from the same field in both branches and means two
|
||
// different things depending on which one — see the schema.
|
||
func decodeBatchCloseOutcome(actor string, item apigen.CloseOutcome) issueops.CloseOutcome {
|
||
out := issueops.CloseOutcome{IssueID: item.IssueId}
|
||
if item.Code != nil {
|
||
out.Err = perItemCloseError(item.IssueId, actor, item)
|
||
return out
|
||
}
|
||
// A successful outcome carries the snapshot; already_closed is the idempotent
|
||
// re-close (Changed false), and open_children is what a forced close observed.
|
||
out.Issue = item.Issue
|
||
if item.OpenChildren != nil {
|
||
out.OpenChildren = *item.OpenChildren
|
||
}
|
||
out.Changed = item.AlreadyClosed == nil || !*item.AlreadyClosed
|
||
out.AutoClosedMolecule = item.AutoClosedMolecule
|
||
if item.MoleculeAutoCloseRefusal != nil {
|
||
out.MoleculeAutoCloseRefusal = *item.MoleculeAutoCloseRefusal
|
||
}
|
||
return out
|
||
}
|
||
|
||
// perItemCloseError is the shared code -> error table that turns a refused wire
|
||
// outcome into the canonical close vocabulary a local batch would have
|
||
// returned, so a caller classifies a remote per-item refusal with the same
|
||
// errors.Is/errors.As arms it already has:
|
||
//
|
||
// not_found -> issueops.ErrNotFound
|
||
// not_closable + open_children -> *issueops.CloseOpenChildrenError
|
||
// not_closable -> issueops.ErrCloseBlocked
|
||
// template_read_only -> *issueops.TemplateReadOnlyError
|
||
// issue_pinned -> *issueops.PinnedError
|
||
// not_assignee + assignee -> *issueops.CloseNotAssigneeError (the
|
||
// closing actor is the request's own)
|
||
// an unknown code -> *wire.UnknownItemCodeError (the generic
|
||
// typed per-item error, so version skew lands
|
||
// as a typed refusal rather than a silent gap)
|
||
//
|
||
// The member-presence discriminator on not_closable is the same one the single
|
||
// close's 409 uses, and it comes from the typed field, never from parsing prose.
|
||
//
|
||
// It is only ever called with a refused outcome — Code non-nil — which the one
|
||
// caller above guarantees.
|
||
func perItemCloseError(issueID, actor string, item apigen.CloseOutcome) error {
|
||
var code string
|
||
if item.Code != nil {
|
||
code = *item.Code
|
||
}
|
||
switch code {
|
||
case codeNotFound:
|
||
return issueops.ErrNotFound
|
||
case codeNotClosable:
|
||
if item.OpenChildren != nil {
|
||
return &issueops.CloseOpenChildrenError{IssueID: issueID, OpenChildren: *item.OpenChildren}
|
||
}
|
||
return issueops.ErrCloseBlocked
|
||
case codeTemplateReadOnly:
|
||
return &issueops.TemplateReadOnlyError{IssueID: issueID}
|
||
case codeIssuePinned:
|
||
return &issueops.PinnedError{IssueID: issueID}
|
||
case codeNotAssignee:
|
||
var assignee string
|
||
if item.Assignee != nil {
|
||
assignee = stripItemControlRunes(*item.Assignee)
|
||
}
|
||
return &issueops.CloseNotAssigneeError{IssueID: issueID, Assignee: assignee, Actor: actor}
|
||
default:
|
||
var detail string
|
||
if item.Detail != nil {
|
||
detail = stripItemControlRunes(*item.Detail)
|
||
}
|
||
return &wire.UnknownItemCodeError{
|
||
IssueID: issueID,
|
||
Code: stripItemControlRunes(code),
|
||
Detail: detail,
|
||
}
|
||
}
|
||
}
|
||
|
||
// The per-item refusal codes this outcome can carry. They are the
|
||
// `Problem.code` spellings, restated here rather than imported because
|
||
// importing the server package would drag the storage engine into a client.
|
||
const (
|
||
codeNotFound = "not_found"
|
||
codeNotClosable = "not_closable"
|
||
codeTemplateReadOnly = "template_read_only"
|
||
codeIssuePinned = "issue_pinned"
|
||
codeNotAssignee = "not_assignee"
|
||
)
|
||
|
||
// stripItemControlRunes removes control runes from a server-controlled per-item
|
||
// string before it becomes a typed error, mirroring the wire problem mapper's
|
||
// own source-layer strip: the unknown-code carrier reaches the same per-id
|
||
// stderr sinks a decoded ProblemError does.
|
||
func stripItemControlRunes(s string) string {
|
||
return strings.Map(func(r rune) rune {
|
||
if unicode.IsControl(r) || r == '
' || r == '
' {
|
||
return -1
|
||
}
|
||
return r
|
||
}, s)
|
||
}
|
||
|
||
// refuseUnservedCloseShape names the shape that refused in the DOWN-LEVEL leg, so
|
||
// the refusal says which of the two reasons it is rather than "batch close is
|
||
// unsupported". It survives only in that leg: where issues.batchClose is
|
||
// advertised, every shape is served on one wire call and nothing reaches here.
|
||
//
|
||
// ClaimNext is not checked here: CloseBatch refuses it unconditionally, on
|
||
// both legs, before either serving method is called (see ledger row
|
||
// W-CloseBatchRequest.ClaimNext), so req.ClaimNext is always nil by the time
|
||
// a request reaches this leg.
|
||
func (s *Store) refuseUnservedCloseShape(req issueops.CloseBatchRequest) error {
|
||
if len(req.Items) > 1 {
|
||
return s.unsupported("BatchCloser.CloseBatch(multi-item)")
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// perItemCloseRefusal separates the close vocabulary an ITEM answers with from
|
||
// the failures the METHOD answers with, for the composed single-item leg.
|
||
//
|
||
// The three it recognizes are exactly what Lifecycle.Close returns, and exactly
|
||
// what the wire's problem mapper reconstructs: not_found becomes ErrNotFound,
|
||
// not_closable carrying open_children becomes *CloseOpenChildrenError, and
|
||
// not_closable without it becomes ErrCloseBlocked. Everything else — a transport
|
||
// failure, a 503, an unknown 4xx — is the method's, because it says nothing about
|
||
// this item and would be a lie as a per-item outcome.
|
||
func perItemCloseRefusal(issueID string, err error) (issueops.CloseOutcome, bool) {
|
||
var openChildren *issueops.CloseOpenChildrenError
|
||
switch {
|
||
case errors.As(err, &openChildren):
|
||
case errors.Is(err, issueops.ErrNotFound):
|
||
case errors.Is(err, issueops.ErrCloseBlocked):
|
||
case errors.Is(err, issueops.ErrTemplateReadOnly):
|
||
case errors.Is(err, issueops.ErrPinned):
|
||
case errors.As(err, new(*issueops.CloseNotAssigneeError)):
|
||
default:
|
||
return issueops.CloseOutcome{}, false
|
||
}
|
||
return issueops.CloseOutcome{IssueID: issueID, Err: err}, true
|
||
}
|