beads/internal/storage/issueops/batchget.go
Julian Knutsen dbaa4631ca
feat(roles): BatchGetter role and POST issues:batchGet (#7248)
* feat(roles): BatchGetter role and issues:batchGet route (S7)

Adds BatchGetter.GetMany(ids) -> {Issues, Missing}, a one-snapshot,
order-preserving, deduped, 1000-id-capped batch read, wired through all
three library legs (dolt, embedded dolt, uow) behind the existing
hook/telemetry decorator chain, plus the POST /v0/beads/issues:batchGet
HTTP route (spec, apigen, wire-shape golden, issues.batchGet capability
token). Conformance contract (RunBatchGetter*, 12 cases) passes on all
three legs against real backends. No HTTP client leg yet (waits on the
generator / PR #7247); left as a documented seam on BatchGetter's doc
comment.

CLI GetIssuesByIDs call sites are left unmigrated this slice and marked
with TODO(batchgetter) comments: every call site reads an unbounded id
list today, and GetMany's 1000-id cap has no chunking/fallback in any
caller yet, so swapping them in now would add a new, unhandled failure
mode to already-shipped CLI paths (export, import, molecule port,
ready-explain, wisp sweep).

Verified via three live-mutate guards against
internal/storage/issueops/batchget.go (disabling the cap check, dropping
the Missing append, and replacing ordered iteration with map iteration):
each turns the embedded-dolt contract red, confirming the cap, Missing
reporting, and order-preservation assertions actually catch a break.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix(roles): close S7 review gaps — revision on wire, BUILD sync, handler tests

Addresses the S7 Opus review's FIX-FIRST items on BatchGetter/issues:batchGet:

HIGH
- batchGetResponse now projects apigen.BatchGetIssue (types.BatchGetIssue +
  NewBatchGetIssue), carrying `revision` per issue the way IssueDetails does;
  spec, apigen and the wire-shape golden regenerated (additive, no
  wire_revision bump).
- make bazel-sync: the 12 files missing from BUILD.bazel srcs are back in
  sync across 9 BUILD.bazel files.
- New internal/httpapi/batch_get_test.go: success incl. revision, missing
  ids, empty arrays not null, unknown member refused, missing/null ids
  refused, query parameter refused, 1001 ids refused with the full request
  reaching the role, 1000 ids accepted.

MED
- RunBatchGetterAcceptsExactlyTheCap pins the cap boundary (> vs >=).
- RunBatchGetterHydratesLabels pins Labels survive projection.
- RunBatchGetterReadsOneSnapshot renamed to
  RunBatchGetterSharesOneReadStructurally with a doc that no longer
  overclaims atomicity; a real interleaving test needs a hook on the frozen
  roleFixtureKit, out of scope here.
- Doc comments across ExecuteGetMany, GetManyResult.Issues and the
  BatchGetter interface now say hydration is labels only.

LOW
- failBatchGetErr's doc no longer claims blank entries are "already caught".
- PR #7247 references kept.

Re-ran build/vet/gofmt/lint, make api-check, make bazel-sync(-check), the
full internal/httpapi suite, and all three conformance legs (dolt via the
pinned local server, embeddeddolt, uow) plus targeted cmd/bd serve tests —
all green. Live-mutate-guard reverified: cap >=, dropping Missing from the
response, and clearing Labels each now fail the relevant test.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix(roles): sync client vocabulary and repo gates with issues:batchGet

The S7 route landed on the server without the sibling tables that hold
the rest of the tree set-equal with the server's surface, so five
tests and two manifest gates went red on the PR head:

- httpclient/wire: mirror batchGetIssues into the client vocabulary,
  CLASSIFIED, not wired, the way the wire wave and #7250's
  issues.count.scope landed: OpBatchGetIssues, its issues.batchGet
  token on opCapability, its identity row, and the first-slice skew
  dimension 35 -> 36 (TestCapabilityTableMatchesTheServerRouteTable).
- httpclient/wire: BatchGetIssue is the first golden.json schema with
  a `revision` member that needs no legacy-integer tolerance — the
  route postdates #6053 and types.BatchGetIssue declares Revision a
  string, and a pre-#6053 server never advertises issues.batchGet, so
  Preflight refuses before any body is decoded. Exempt it with that
  reason in a new revisionSchemaExempt table rather than adding an
  issues[] rewrite no legacy server can reach; the gate refuses an
  entry that is both covered and exempt, a stale exemption, and an
  empty reason.
- httpclient/encode: give the oracle's role set a BatchGetter stub —
  httpapi.Listen requires the whole set, so all three oracle tests
  failed to bind.
- storage/uow: exempt IssueUseCase.GetMany from the notifying-parity
  partition as a read, the reason hook_batch_getter.go gives.
- shard manifest: place TestBatchGetterContract in the 15-shard
  embedded storage block (generator --write, incremental).

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

* test(roles): pin the BatchGetter pure tier and the spec ids caps

Review fixes, iteration 1. The review approved with no blocker or major
finding and three minors, and this commit takes all three. It changes
tests and one comment only, and every new assertion was mutation-probed
with go test -overlay.

- storage/issueops: add batchget_test.go, the database-free tier that
  FinishGetMany's doc already claimed ("pinned without a database") but
  that no test supplied. It pins:
  - the cap is checked before the blank scan (an over-cap request with
    a blank at position 0 answers *TooManyIDsError);
  - the bound is inclusive;
  - dedupe keeps the first mention, does not trim, and never writes
    through the caller's slice;
  - Issues and Missing both follow request order;
  - both slices are never nil;
  - ExecuteGetMany refuses one id repeated past the cap before any
    query (a sqlmock with no expectations).
  Ten mutants were each killed by exactly their intended test, with the
  rest of the package green: last-mention, sort, trim, in-place dedupe,
  blank-before-cap, >=, nil Missing, nil Issues, dedupe-before-validate
  and validate-after-query.
- httpapi: TestSpecDefaultsMatchSharedConstants now checks ids.maxItems
  against the enforced bound on the two request bodies that carry an
  `ids` list: batchGetIssues against issueops.MaxGetManyIDs, and
  deleteIssues against maxDeleteIDs. Each body is reached through its
  operation's own requestBody $ref. Setting either constant to 999 turns
  only this test red. The spec's other list caps (batch
  create/close/apply items, dependency edge lists) stay ungated, as
  before.
- cmd/bd/serve.go: the batchGetter field comment said its accessor
  "does NOT recurse through the hook decorator". HookFiringStore.
  BatchGetter does recurse to the inner getter; it just doesn't wrap
  the result. The comment now says that.

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

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-05 12:09:18 -07:00

107 lines
4.2 KiB
Go

package issueops
import (
"context"
"fmt"
"github.com/steveyegge/beads/internal/storage"
publicops "github.com/steveyegge/beads/issueops"
)
// ValidateGetManyRequest applies the request rules every BatchGetter
// implementation shares.
//
// THE CAP IS CHECKED FIRST, against the request AS SENT, before
// deduplication: the obligation it bounds is reading the request apart (and,
// below the role, holding one snapshot open long enough to resolve it), not
// reading the rows the ids resolve to, so a caller cannot dodge it by
// repeating one id 1,500 times. The per-entry blank check that follows tells a
// caller's mistake from a legitimately empty request, exactly as
// ValidateEdgeCountRequest's does for EdgeCountRequest.IDs.
func ValidateGetManyRequest(request publicops.GetManyRequest) error {
if len(request.IDs) > publicops.MaxGetManyIDs {
return &publicops.TooManyIDsError{Requested: len(request.IDs), Cap: publicops.MaxGetManyIDs}
}
for i, id := range request.IDs {
if id == "" {
return fmt.Errorf("%w: get many id at position %d is empty", storage.ErrValidation, i)
}
}
return nil
}
// DedupeGetManyIDs collapses duplicates, keeping the caller's FIRST mention of
// each id. Unlike NormalizeDeleteIDs's sibling, it does NOT trim whitespace:
// GetManyRequest.IDs are exact ids, and a caller that padded one with
// whitespace gets that id back in Missing rather than a silently corrected
// lookup, the same exactness RunGraphCounterResolvesIDsExactly pins for
// EdgeCountRequest.IDs.
func DedupeGetManyIDs(ids []string) []string {
seen := make(map[string]struct{}, len(ids))
out := make([]string, 0, len(ids))
for _, id := range ids {
if _, ok := seen[id]; ok {
continue
}
seen[id] = struct{}{}
out = append(out, id)
}
return out
}
// FinishGetMany assembles the ordered answer from the ids a caller asked for
// (already deduplicated) and the issues a read actually found, keyed by id.
//
// It is a pure function beside the body for ExecuteEdgeCount's reason: the
// part that decides what the answer MEANS — an id not in found is Missing, and
// Issues/Missing both preserve the caller's order — is pinned without a
// database, and the conformance contract is left to assert what only a real
// backend can show.
func FinishGetMany(ids []string, found map[string]*publicops.Issue) publicops.GetManyResult {
result := publicops.GetManyResult{
Issues: make([]*publicops.Issue, 0, len(ids)),
Missing: make([]string, 0),
}
for _, id := range ids {
if issue, ok := found[id]; ok {
result.Issues = append(result.Issues, issue)
continue
}
result.Missing = append(result.Missing, id)
}
return result
}
// ExecuteGetMany returns the issues named by request.IDs from tx, in ONE
// snapshot. It is the body behind the BatchGetter accessor on ALL THREE legs:
// the two stores wrap it in their own read transaction, and the unit-of-work
// provider reaches it through the domain repository, whose runner publishes
// exactly the DBTX method set GetIssuesByIDsInTx takes.
//
// VALIDATION HAPPENS HERE, for ExecuteEdgeCount's reason: this body is the
// only body, so a leg that forgot to validate would be answering a different
// contract, and there is no second implementation for the check to belong to.
// It runs before the transaction's one query, so a request over MaxGetManyIDs
// never reaches storage.
//
// HYDRATION IS LABELS ONLY, because that is all GetIssuesByIDsInTx fills: no
// dependencies, dependents or comments. A caller that needs those reads
// Reader.Get instead, one id at a time.
func ExecuteGetMany(ctx context.Context, tx DBTX, request publicops.GetManyRequest) (publicops.GetManyResult, error) {
if err := ValidateGetManyRequest(request); err != nil {
return publicops.GetManyResult{}, err
}
ids := DedupeGetManyIDs(request.IDs)
if len(ids) == 0 {
return publicops.GetManyResult{Issues: []*publicops.Issue{}, Missing: []string{}}, nil
}
issues, err := GetIssuesByIDsInTx(ctx, tx, ids, nil)
if err != nil {
return publicops.GetManyResult{}, fmt.Errorf("get many: %w", err)
}
found := make(map[string]*publicops.Issue, len(issues))
for _, issue := range issues {
found[issue.ID] = issue
}
return FinishGetMany(ids, found), nil
}