beads/issueops/counter.go
Julian Knutsen 4af58c97fd
feat(count): Counter scope — ParentID, NoParent, ExcludeTypes, ExcludeStatus (issues.count.scope) (#7199)
* feat(httpapi): wire-shape signal — wire_revision, floor header, golden digest, param tokens

S0 of the HTTP role-parity program: give a client a single place to learn
whether this build's wire shape has moved under it, and give CI a gate that
catches an undocumented move.

- GET /v0/beads/context reports wire_revision (bumps only on a non-additive
  response-shape change) and min_client_wire_revision. An optional
  Bd-Wire-Revision request header lets a client declare the revision it was
  built for; checkWireRevision refuses a declared revision below the floor
  with 400 invalid_argument/reason=wire_revision_unsupported and a
  min_wire_revision field, on every route but /healthz (wireRevisionExempt) —
  including the identity handshake, where catching the mismatch is cheapest.
  Absent header is today's behavior; malformed value is invalid_value, never
  wire_revision_unsupported. The floor lives in Server.minClientWireRevision
  (defaulting to the MinClientWireRevision constant) so a test can raise it.
- internal/httpapi/wireshape: a golden digest over every response's every
  content-type schema (including application/problem+json) across the whole
  spec, keyed by schema+member. TestWireShapeDigest fails closed when a
  member's JSON name or type changes without wire_revision bumping to match;
  regenerate with `go run ./internal/httpapi/wireshape/cmd/gendigest`.
- GET /v0/beads/issues' `sort` parameter now carries the issues.listSort
  capability token, the same convention `capabilities` entries use.
  TestNewParameterOnExistingOperationHasABehaviorToken requires every new
  parameter on an existing operation to carry one, checked against a
  write-once grandfather baseline (testdata/pretoken_parameters.json) of
  parameters that predate the rule; TestUntokenedParameterRuleFires proves
  the checker itself against a synthetic fixture.
- Docs: engdocs/design/bd-serve-v0.md gets a "The wire-shape signal" section;
  CHANGELOG.md gets an Added entry.

Live-mutated and reverted three RED demonstrations during development:
retyping api_version in the spec failed TestWireShapeDigest; short-circuiting
checkWireRevision's floor comparison failed
TestWireRevisionBelowFloorRefusesEveryEnforcedRoute; adding an untokened
query parameter to listIssues failed
TestNewParameterOnExistingOperationHasABehaviorToken. All three now pass
against the unmutated tree.

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

* fix(httpapi): rename issues.listSort to issues.list.sort, harden token rule

Opus review of 12c5144ca (HIGH-1, MEDIUM-5):

- Rename the capability token issues.listSort -> issues.list.sort to match
  bd-enterprise's client (httpstore/wire/handshake.go:121, DESIGN.txt S4e),
  and widen capabilityToken to accept an optional third segment.
- untokenedParameters() now requires the extracted token to be one
  Capabilities() actually serves, not just backtick-shaped text. This
  catches real false positives that existed in the spec already
  (workapi.DefaultReadyLimit, status.custom) which only shape-matched the
  old regex; they're added to the pretoken baseline as genuinely
  pre-existing untokened parameters.
- Extend the rule to request body members (new
  testdata/pretoken_request_body_members.json baseline) and exempt
  brand-new operations via a frozen testdata/pretoken_operations.json
  snapshot.
- Add TestPretokenBaselinesNeverGrow pinning all three baseline sizes so
  a future change can't hand-add an exemption instead of a token.
- Update spec prose for the widened rule scope.

go test ./internal/httpapi/... and the reviewer's pmut.py all pass as
expected: plain/bogus modes go RED, reuse (real-but-unrelated token) stays
green, matching the review's literal ask ("a token must be one advertised
by Capabilities()").

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

* fix(wireshape): close four digest-coverage gaps, add gendigest write guard

Opus review of 12c5144ca (HIGH-2, MEDIUM-4). The digest only tracked
Type/Format/Enum/Required on direct properties, missing:

- nullable: true (never read at all)
- array item shape (Issue.labels items string->integer was invisible;
  only object-shaped items got recursed into)
- additionalProperties value shape (IssueCount.groups)
- request bodies entirely (Compute() only walked responses, so
  DeleteIssuesRequest.expected_version string->integer, the other half
  of #6053, was invisible)

Also added defensive oneOf flattening alongside the existing allOf merge
(dormant today -- grep confirms this spec uses oneOf nowhere -- but no
longer silently invisible if that changes).

Extracted the golden-vs-computed comparison into wireshape.Compare(),
shared by TestWireShapeDigest and the new wireshape.SafeToWrite(), which
gendigest now calls before writing: it refuses to overwrite golden.json
with changed/removed entries unless the candidate's wire_revision is
strictly greater than the existing golden's. Pure additions always write.
TestSafeToWrite exercises both guard directions.

golden.json is regenerated. This single regen is a one-time exception to
the new guard, done by writing the digest directly rather than through
gendigest: confirmed via a throwaway diff (not checked in) that every one
of the 57 "changed" entries differs only in the NEW fields the wider walk
now populates (ItemType/ItemFormat/Nullable/AdditionalProps*) -- every
pre-existing Type/Format/Required/Enum value is byte-identical. Nothing on
the wire changed; the measurement got more precise. Bumping
CurrentWireRevision for this would have written a false "the protocol
changed here" entry into the revision history table. Going forward, any
REAL change the guard now reports uses the normal bump-then-regenerate
path, same as before.

Verified against the reviewer's mut.py: nested_type, nullable,
nullable_issue, array_items, addlprops, request_body and format all go RED
on TestWireShapeDigest, each reverted after confirming.

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

* fix(httpapi): make bd_version wire_revision inference advisory

Opus review of 12c5144ca (HIGH-3). The spec told a client inferring
wire_revision from bd_version to use the release cutoff >= 1.3.0, and said
nothing about what happens when that inference is wrong -- which it
demonstrably is for real builds already in the field:

- main builds up to commit b3ef65c85 report bd_version 1.2.2 (below any
  1.3.0 cutoff) while already sending the string-typed revision/
  expected_version shape (#6053).
- 1.3.0-rc.N pre-release builds sort BELOW the release cutoff 1.3.0 under
  plain string comparison despite already carrying the string shape.
- The bd-enterprise compatibility line at d3ab32773462 reports bd_version
  1.1.0 while also sending strings.

Moved the cutoff to >= 1.3.0-rc.1 (compared as semver-with-prerelease,
which at least captures the rc builds), documented both named exceptions
inline, and made the whole inference explicitly ADVISORY: a client must
accept revision/expected_version as either a string or a number whenever
wire_revision is absent (or probe directly) rather than let the inferred
value choose a decoder, and must never refuse solely because the inferred
revision is 0. Mirrored into engdocs/design/bd-serve-v0.md.

This is spec/doc prose only -- there is no server-side inference code to
change, since this server always sends wire_revision directly; the
inference is guidance for clients reading a pre-signal server's response
(this server, past builds, or an unrelated implementation).

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

* fix(httpapi): LOW-7/8/9/10 review follow-ups for wire-revision signal

LOW-7: WireRevisionUnsupported now also sets Problem.wire_revision (this
server's CurrentWireRevision) and Problem.bd_version on the
wire_revision_unsupported refusal, alongside the existing
min_wire_revision, so a client logging the refusal has this server's
full self-description without a second /v0/beads/context call.

LOW-8: gazelle + make bazel-sync add the BUILD.bazel entries the prior
commits were missing: wire_revision.go/wire_revision_test.go in
internal/httpapi's srcs, new BUILD.bazel files for wireshape and
wireshape/cmd/gendigest, and a testdata glob on httpapi's go_test so
the pretoken_*.json baselines are visible under `bazel test`. Verified
with `bazel build //internal/httpapi/...` and
`bazel test //internal/httpapi/... --test_env=BEADS_TEST_SKIP=dolt`
(both green) and `python3 tools/bazel/go_srcs.py --check` (clean).

LOW-9: narrowed CHANGELOG.md and engdocs/design/bd-serve-v0.md to
describe the digest's actual final coverage (format/enum/required/
nullable, array items, additionalProperties, request bodies, $ref/
allOf/oneOf recursion, the SafeToWrite revision-bump guard) and the
token rule's actual final shape (three pinned baselines, request-body
members, Capabilities()-membership validation, new-operation
exemption) instead of the original, narrower claims.

LOW-10: Bd-Wire-Revision now parses via a strict decimal-only
parseStrictNonNegativeInt (no leading '+', no leading zero except a
bare "0") instead of strconv.Atoi alone, so two different header
bytes can no longer name the same revision. New malformed-header test
cases: "+1", "01", "007".

Regenerated apigen/types.gen.go (make api-gen) for the new Problem
fields and wireshape/testdata/golden.json (go run
.../wireshape/cmd/gendigest) for the two new additive Problem members;
the latter wrote cleanly through SafeToWrite itself, since both are
pure additions.

go test ./... and bazel test //internal/httpapi/... both green.

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

* fix(httpapi): re-review LOW follow-ups — retirement test, gendigest -init, docs

1. TestRetiredRevisionsStayBelowTheFloor pins the PRESENCE guarantee the
   wire_revision property doc relies on: CurrentWireRevision >= 2 (so 0
   and 1 stay permanently retired) and MinClientWireRevision <=
   CurrentWireRevision (so this build's own floor never refuses every
   request against itself).

2. gendigest now refuses to create a golden.json that does not exist yet
   unless run with -init. Previously a missing file (moved testdata,
   wrong path, accidental delete) was indistinguishable from a real first
   run and silently wrote a fresh golden with no revision history checked
   against anything. writeGolden() is extracted out of main() so this is
   covered directly: TestWriteGoldenRequiresInitWhenMissing,
   TestWriteGoldenInitCreatesWhenMissing,
   TestWriteGoldenIgnoresInitWhenGoldenExists (the existing-golden path is
   still governed only by SafeToWrite, -init or not).

3. Narrowed the two remaining stale claims that still described the
   digest's original, narrower coverage: the wire_revision property's
   prose in openapi.v0.yaml (regenerated into apigen/types.gen.go via
   make api-gen) and wireshape/doc.go now both list nullable, array item
   shape, additionalProperties value shape, request bodies, and
   $ref/allOf/oneOf recursion, plus the new -init guard.

go test ./internal/httpapi/... and make api-check both green;
bazel test //internal/httpapi/... (httpapi, wireshape, and the new
gendigest test target) green; python3 tools/bazel/go_srcs.py --check
clean.

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

* feat(wireshape): cover operation parameters in the wire-shape digest

The digest previously walked only response and request-body schemas, so a
type, enum, required, or removal change on one of the spec's 138 operation
parameters (123 query, 14 path, 1 header) passed the gate silently — the
open item from PR review on #7182.

Each parameter is now recorded as its own Entry, keyed by
"param:"+operationId / location+":"+name (operation-scoped, not
schema-scoped, since two operations' same-named parameter are independent
wire contracts), capturing type, array item shape, enum, required, style,
explode and default. Adding a parameter stays additive; removing,
retyping, narrowing its enum, or changing required/style/explode/default
now trips SafeToWrite exactly like a response or request-body change.

Verified against the live spec: retyping listIssues' `limit` query
parameter from integer to string now fails TestWireShapeDigest (confirmed
red, then reverted — not part of this commit). golden.json regenerated via
gendigest; the new parameter entries are a pure addition, no wire_revision
bump needed. Added TestParameterMutationsAreCaught (remove/retype/narrow-
enum against real golden entries) and updated wireshape's doc.go, the
`wire_revision` spec prose, and the CHANGELOG to describe the new
coverage.

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

* fix(wireshape): review fixes — stale-golden and lowered-revision arms, effective param serialization, digest boundary

Maintainer fixup from the adopt-pr review loop (iterations 1 and 2), on
top of e17ba924f.

- goldenDrift (A, I): TestWireShapeDigest's comparison moves into a
  goldenDrift helper. An addition alongside a moved wire_revision no
  longer passes with a stale golden: it asks for a regenerate, as a
  changed or removed entry after a bump already did. Every message now
  names response/request-body members AND parameters, and TestGoldenDrift
  pins each arm. This takes only the test half of the stranded fixup
  (adopt-pr/bd-47kdge/stranded-fixup-528cd6095); its doc half, which says
  parameters are outside the digest, is false since e17ba924f and is not
  replayed (J).
- Lowered wire_revision (D): a CurrentWireRevision LOWER than the
  golden's is a wrong constant, not a stale golden, so goldenDrift says to
  restore it instead of regenerating, and SafeToWrite (so gendigest)
  refuses any write at a lower revision, whatever the entries.
- Effective style/explode (B): walkParam records style and explode with
  OpenAPI 3.0's defaults filled in (form for query/cookie, simple for
  path/header; explode defaults to style == form). Adding `explode: false`
  to a query array that relied on form's implicit explode is now a
  changed entry, while spelling out a default changes nothing.
  testdata/golden.json is regenerated with -init: 111 parameter entries
  change only in style/explode (96 to form/true, 15 to simple), 828
  entries before and after, wire_revision stays 2. The golden is new in
  this PR and unreleased, so this needs no bump.
- TestWalkParam (H): a package-internal table test
  (wireshape_internal_test.go) pins every field walkParam extracts,
  through a computeFrom(document, revision) seam that Compute now wraps:
  per-location defaults, $ref'd parameters and items, format, nullable and
  default, content parameters, and the nil returns.
  TestEffectiveSerializationIsCompared pins B end to end through Compare
  and SafeToWrite. BUILD.bazel embeds the library in the go_test, which is
  gazelle's own output.
- Required inputs and the digest boundary (C, E, F; docs only): all five
  prose surfaces (openapi.v0.yaml's wire_revision description and the
  regenerated apigen/types.gen.go, wireshape/doc.go, CHANGELOG.md,
  engdocs/design/bd-serve-v0.md) now say that a new REQUIRED request
  input is recorded as an ordinary addition and needs its own review,
  that value constraints and member-level composition are outside the
  digest, and that object and content parameters are recorded only as
  their container. bd-serve-v0.md also gains the parameter coverage it
  was missing.
- G: a brand-new operation is permanently exempt from the
  capability-token rule; its own review decides its capability story.
- Iteration 2 (nit): walkParam's comment now says that the location
  default it records as a `content` parameter's style and explode is a
  placeholder, since OpenAPI 3.0 applies style and explode only to a
  parameter described by `schema`. All 138 operation parameters in the
  spec use `schema`, so the golden does not change.

Validated: go test ./internal/httpapi/... (gms_pure_go), make api-check,
go vet for linux/windows/darwin, gofmt, git diff --check, gazelle on the
package (no drift), make bazel-sync-check, and bazel test
//internal/httpapi/wireshape/... in the local processwrapper sandbox
(2 of 2 pass). Overlay mutation probes: dropping the added-after-bump
arm, the lowered-revision arm, SafeToWrite's lowered check, or the
effective-default fill each turns the new tests red.
Iteration 2 changes only that comment; go test
./internal/httpapi/wireshape/... (gms_pure_go), go vet, gofmt and git
diff --check pass again.

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>

* feat(count): add Counter scope fields (S8) — ParentID, NoParent, ExcludeTypes, ExcludeStatus

Extends issueops.CountRequest with ParentID, NoParent, ExcludeTypes and
ExcludeStatus, closing the gap where bd count could not express the
filters bd list already has, forcing downstream consumers like gc to
fall back to listing everything just to get a count.

- issueops.Counter: four new CountRequest fields, documented against the
  List equivalents they mirror (ParentID/ExcludeTypes) or newly define
  (NoParent, ExcludeStatus has no List counterpart). Status "all" is
  pinned as equivalent to unset, matching BuildListFilter's own "all" and
  preserving count/list cardinality parity (the role's reason to exist).
- internal/workapi.BuildCountFilter: maps the four fields onto the one
  types.IssueFilter builder all three storage legs (dolt, embeddeddolt,
  uow) already share via internal/storage/issueops and sqlbuild, so no
  per-leg storage code was needed.
- cmd/bd: --parent, --no-parent, --exclude-type, --exclude-status flags.
- HTTP: adds parent/no_parent/exclude_type/exclude_status to GET
  /v0/beads/issues:count, behind the new issues.count.scope behavior
  token (routes.go), wired in reads.go's countFilters, documented in
  openapi.v0.yaml with per-parameter tokens and an extended capabilities
  description. gendigest confirms a byte-identical golden.json: query
  parameters are outside the wire-shape digest's scope, so this is a
  zero-diff, no-revision-bump change as expected.
- backend/conformance: four new Counter contract cases (ParentID scoping,
  NoParent's edge-only semantics vs ParentID's edge-or-dotted-id match,
  ExcludeTypes composing with include_infra's own exclusions, and
  ExcludeStatus), run identically against all three storage legs via a
  new CounterFixture.AddDependency hook shared with ReaderFixture.

Verified: go build ./...; go test ./internal/httpapi/... ./internal/workapi/...
./issueops/... and the Counter contract on all three legs (dolt via
testcontainers, embeddeddolt, uow via local dolt binary); make api-gen
(additive-only apigen diff) and make api-check; go vet and golangci-lint
clean; gofmt clean; gazelle diff empty (no new files/imports). Mutation
testing: dropping issues.count.scope from behaviorCapabilities turns
TestCapabilitiesAdvertiseEveryImplementedOperation,
TestSpecCapabilityVocabularyMatchesTheRouteTable and
TestNewParameterOnExistingOperationHasABehaviorToken red; no-op'ing
ExcludeStatus in BuildCountFilter turns
TestBuildCountFilterExcludeStatusTakesNamesAsWritten and the
embeddeddolt ExcludeStatusNarrowsThePredicate conformance case red. Both
reverted and reconfirmed green.

Deviation: DESIGN.txt's literal text would make count --status all an
ErrValidation; shipped behind a test and a doc comment instead, since
"all" already means "every status" on both count and list and rejecting
it would break the count/list parity this role exists to guarantee.

S3/S4 note: no OSS HTTP client exists yet to enforce capability-token
skew. A doc comment on CapIssuesCountScope in routes.go specifies the
required behavior once one lands: check issues.count.scope against the
cached handshake capabilities and refuse locally with a typed
ErrUnsupported{Capability} before sending any of the four new params to
an older server.

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

* fix(count): S8 review follow-ups — refusal parity, exclude-status validation, doc fixes, parity tests

Addresses the Opus review's six required changes for S8 (bd count scope
fields):

1. BuildCountFilter now refuses ParentID+NoParent together as ErrValidation,
   matching bd list's CLI refusal wording; wired through the role, the CLI,
   and invalid_argument classification in internal/httpapi/reads.go.
2. Status:"all" is documented in DESIGN.txt as every status, matching List's
   no-filter reading (count/list cardinality parity) — a coordinator decision
   recorded in beads-design/DESIGN.txt, outside this worktree.
3. ExcludeStatus names are now validated against the workspace vocabulary
   (built-in statuses plus workspace-custom ones); an unknown name is
   ErrValidation instead of a silent no-op, since a typo here would overcount.
4. Fixed openapi.v0.yaml and issueops/reader.go doc claims about bd list
   --parent's default tree-walk vs. the one-level role answer that bd count
   --parent agrees with (confirmed by tracing list_show_filter_modes.go); fixed
   an Oxford-comma nit in routes.go and the spec.
5. Added storage-level count == len(List) parity tests for ParentID, NoParent
   and ExcludeTypes (List has no ExcludeStatus counterpart), plus wisp-child
   and closed-child contract cases, across all three backends (dolt,
   embeddeddolt, uow). CounterFixture gained a List hook for this.
6. Extended the routes.go skew note: gc's ErrCountUnsupported fallback to List
   is now named explicitly, with a note that S3/S4 must add a skew test that
   masks the token and asserts the fallback fires.

Also fixed RunCounterExcludeStatusNarrowsThePredicate's now-stale "unrecognized
status excludes nothing" assertion to expect ErrValidation instead.

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

* fix(count): PR #7199 review follow-ups — exclude-status config load, ParentID doc swap

Addresses bee's REQUEST-CHANGES on gastownhall/beads#7199 (S8):

1. BLOCKER: storecounter.filter and uow.countFilter only loaded the
   workspace list config when IncludeInfra was set, so BuildCountFilter's
   ExcludeStatus validation refused a workspace's own custom status unless
   the caller also passed the unrelated IncludeInfra flag. Both legs now
   load the config when IncludeInfra OR len(ExcludeStatus) > 0, with
   comments corrected to say so. Added leg-level regression tests (the
   conformance fixture cannot drive a workspace-configured custom status)
   on embeddeddolt and uow, reproducing the reviewer's CLI repro directly,
   plus an HTTP-level probe in cmd/bd's real-Dolt proxied count test.
2. issueops.ReadyRequest.ParentID's comment had been overwritten with the
   one-level direct-children wording that belongs to ListRequest.ParentID;
   Ready actually walks all descendants via GetDescendantIDsInTx (GH#3396).
   Restored the descendants comment on ReadyRequest.ParentID and moved the
   one-level explanation to ListRequest.ParentID, which had none.

Verified: make api-check; dolt-server, embeddeddolt and uow Counter
contract legs (BEADS_TEST_DOLT_SERVER=local with a pinned dolt binary for
uow; Docker for the dolt-server leg); the new proxied HTTP exclude_status
probe (BEADS_TEST_PROXIED_SERVER=1).

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

* chore(wireshape): add the countIssues scope parameters to the wire-shape golden

#7182 now digests operation parameters. The four new issues:count parameters
(parent, no_parent, exclude_type, exclude_status) are additive entries, so no
wire_revision bump is needed; regenerated with gendigest.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

* test(conformance): register the S8 count-scope cases with RunRoleContracts (adopt-pr #7199)

The PR adds nine RunCounter* contract cases to counter_contract.go and wires
them into the three in-tree TestCounterContract legs, but not into the
Counter row of roleContractCases. TestRoleContractCasesCoverEveryContractCase
derives the expected set from source, so it fails on the PR head, and an
external backend running RunRoleContracts would never see the new cases.

Register them in source-declaration order (after
RunCounterAnUnknownStatusMatchesNothing), which the same guard enforces.

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

* docs(count): correct the S8 scope docs the review found wrong (adopt-pr #7199)

Comment and spec-description fixes only; no behavior change. Review-loop
iterations 1 and 2 of the #7199 relaunch.

- ListRequest.ParentID (issueops/reader.go) said "DIRECT children only
  ... the same one-level clause". The sqlbuild clause has two arms and
  neither walks: the parent-child edge arm stops at one level, but the
  dotted-prefix arm (`id LIKE CONCAT(?, '.%')` for rows with no
  parent-child edge) reaches every edge-less dotted id at any depth, which
  RunReaderListParentReachesEveryDescendantAndOnlyItsOwn pins with an
  edge-less X.1.1. State both arms, and say the CLI tree view re-runs the
  clause against the store once per level (findAllDescendants calls
  SearchIssues, not the role). Document ListRequest.NoParent, which had no
  doc. The contributor's ReadyRequest.ParentID text is kept; only its
  cross-reference to this field changes from "one-level" to "non-walking".
- CountRequest.NoParent (issueops/counter.go) and the count flag comment
  (cmd/bd/count.go) said NoParent counts rows with "neither" an edge nor a
  dotted prefix. Its SQL checks only the edge table, so an edge-less X.1
  is counted by both --parent X and --no-parent, as bd list lists it.
- RunCounterExcludeStatusNarrowsThePredicate's header said an
  unrecognized name "excludes nothing rather than failing" while its body
  asserts ErrValidation. The header now matches the body.
- The OpCountIssues entry in problem.go's operationCodes said the role has
  "exactly one reachable refusal". It has three: an invalid metadata key,
  an unrecognized exclude_status name, and parent with no_parent (named
  no_parent), all classified by invalidFilterParam. The code set is
  unchanged.
- BuildCountFilter's header said cfg is "only read under IncludeInfra".
  It is also read to validate ExcludeStatus against the workspace's
  custom statuses, which is why both callers load it when ExcludeStatus is
  non-empty.
- The countIssues `parent` description in openapi.v0.yaml carried the
  same one-level claim as ListRequest.ParentID; it now states both arms.
  types.gen.go is regenerated (make api-gen); make api-check passes.

Review fixes (iteration 2), still comment and spec text only:
- The iteration-1 problem.go rewrite called all three count refusals
  ErrValidation. Only the exclude_status and parent-with-no_parent
  refusals wrap issueops.ErrValidation (internal/workapi/count.go). The
  metadata-key refusal is ValidateMetadataFilters' plain fmt.Errorf
  chain, so errors.Is(err, ErrValidation) is false for it; it reaches the
  wire as a 400 only because invalidFilterParam matches message prefixes.
  The comment now says that, so a later move to typed errors cannot trust
  it and demote the metadata-key refusal to a 500. The sentinel itself is
  not added here: ValidateMetadataFilters is shared with the list and
  ready builders.
- invalidFilterParam's comment on the count rows pointed at the
  metadata-key rows as "above"; they come after it in the switch.
- The countIssues `parent` description said the CLI tree mode walks
  "every edge-linked descendant". findAllDescendants re-runs the full
  two-arm predicate per level, so it also descends through edge-less
  dotted ids; it now says "every descendant reachable through either
  arm". types.gen.go is regenerated; make api-check passes.

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>

* chore(wireshape): re-record the count scope params under the base's param digest (adopt-pr #7199)

The base branch (feat/wire-revision-signal, #7182 be1f0bad72) now digests
the effective style/explode of scalar query parameters. This PR's golden
entries for countIssues query:parent and query:no_parent were written by
the old algorithm, so after the base refresh TestWireShapeDigest reported
them as "changed without a wire_revision bump".

No bump is owed: all four count-scope entries (parent, no_parent,
exclude_type, exclude_status) are additions this PR introduces and are
absent from the base golden. golden.json was reset to the base copy and
regenerated with `go run ./internal/httpapi/wireshape/cmd/gendigest`. The
result is four pure additions against the base (+35/-0); parent and
no_parent gain "style": "form" and "explode": true, and wire_revision
stays 2.

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>

* ci: place the PR's new embedded counter test in the shard manifest

TestCounterExcludeStatusAcceptsAWorkspaceCustomStatusWithoutIncludeInfra,
added to internal/storage/embeddeddolt in f23bf5ddbf, is a new top-level
embedded storage test. The 15-shard block of
.github/scripts/embedded-storage-test-shards.txt must list every
discovered test exactly once. Without the entry,
TestStorageEmbeddedShardManifestGeneratorNotStale (scripts/) fails, both
on the reviewed head 89a387de6c and on the merge. CI never ran the check
on this PR: pr.yml runs only for PRs based on main, release/** or
hotfix/**, and this PR was based on feat/wire-revision-signal until the
retarget.

Generated with
`python3 scripts/ci/gen_embedded_storage_shard_manifest.py 15 --weights=duration --write`.
The incremental write adds this one line, in shard 4, and moves no other
test.

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 Sonnet 5 <noreply@anthropic.com>
Co-authored-by: Eddie the Engineer <adopt-pr@gascity.com>
Co-authored-by: Eddie the Engineer <adopt-pr@gascity.local>
2026-10-05 02:57:14 -07:00

329 lines
17 KiB
Go

package issueops
import (
"context"
"time"
)
// CountGroup names a bucketing dimension for a grouped count. The set is
// closed: a value outside it is ErrValidation rather than an empty answer,
// because a caller that misspelled a dimension and got zero buckets back has
// no way to tell that from a store with nothing in it.
type CountGroup string
const (
CountGroupStatus CountGroup = "status"
CountGroupPriority CountGroup = "priority"
CountGroupType CountGroup = "type"
CountGroupAssignee CountGroup = "assignee"
CountGroupLabel CountGroup = "label"
)
// CountRequest describes one issue-count query: the predicate, and nothing
// about a page.
//
// It is a HIGH-LEVEL request in the sense ReadyRequest and ListRequest are —
// label normalization, id splitting and the wisp-tier policy all happen inside
// — but it is NOT a ListRequest with the paging fields removed, and the
// difference is the whole reason this is a separate type. A default `bd list`
// hides closed, pinned, template and gate rows; a default `bd count` hides
// none of them and answers for every durable row that matches. Sharing
// ListRequest would have made the two questions look interchangeable at the
// call site while their answers differed by every one of those exclusions.
//
// THERE IS NO Limit AND NO Offset, deliberately. A count is a cardinality:
// bounding the scan would answer "how many of the first N" and there is no
// front door that wants that. The storage seam ignores both fields on the
// count path, so accepting them here would be accepting two knobs that do
// nothing.
//
// THERE IS NO FREE-TEXT QUERY either. The count seam takes one — the same
// full-text argument search does — and both front doors have always passed the
// empty string. A field no caller sets is a field whose behavior nothing
// checks, so it is left off rather than published untested; TitleSearch and
// the three *Contains fields are the substring matches that ARE reachable.
type CountRequest struct {
// Status restricts to one stored status. Empty and the literal "all" both
// mean every status, which is what makes a bare count answer for closed
// rows as well as open ones.
//
// It is NOT validated against the workspace vocabulary and NOT a
// comma-separated OR set: an unrecognized name matches nothing and returns
// zero rather than failing, exactly as ReadyRequest.IssueType does. That is
// the shipped behavior of both front doors and it is stated here rather
// than quietly tightened, because a scripted caller that counts a status
// its workspace has since dropped currently reads 0 and would start reading
// an error.
//
// "all" is this field's one well-defined non-literal spelling, and it is
// NOT ErrValidation: it is equivalent to leaving Status empty, and
// BuildListFilter treats its own "all" selector identically (the no-filter
// spelling), so `bd count --status all <predicate>` and `bd list --status
// all <predicate> --all` already agree on cardinality for the shared part
// of the predicate. Rejecting it here would break that count/list parity
// (the whole point of this role, GH#4387) for every caller already
// spelling it, and there is no caller-visible ambiguity it would resolve:
// "no status" is a filter that excludes every row, which "all" has never
// meant on either front door.
Status string
// IssueType restricts the type, with the same match-nothing-rather-than-fail
// treatment Status gets and no alias expansion at all.
//
// It has a SECOND effect under IncludeInfra: an infra type routes the count
// to the ephemeral tier. See that field.
IssueType string
// Assignee restricts to one actor's rows; NoAssignee restricts to rows with
// none. Setting both is not refused — they are handed to the filter as
// written and answer with the empty intersection.
Assignee string
// ParentID restricts to one issue's children, spelled as
// ListRequest.ParentID spells it: a parent-child dependency edge, OR (for
// an issue with no such edge) a dotted-id prefix match. NoParent restricts
// to rows with no parent-child dependency edge. It does not consult the
// dotted-id convention, so an edge-less dotted-id child (X.1) still counts
// as top-level — it is counted by BOTH ParentID X and NoParent, as it is
// listed by both `bd list --parent X --flat` and `bd list --no-parent`.
//
// Setting both IS refused, as ErrValidation, UNLIKE Assignee/NoAssignee
// above: `bd list`'s CLI already refuses `--parent` with `--no-parent`
// (cmd/bd/list_input.go) with this same wording, and a caller reaching
// this role directly — over HTTP, or through a future client that skips
// the primary CLI's flag parser — gets the identical refusal rather than
// a silent empty-intersection answer the primary CLI would never have let
// it ask for.
ParentID string
NoParent bool
// Priority is an exact priority; PriorityMin and PriorityMax bound a range
// inclusively. All three are pointers because 0 is a real priority, for the
// reason ReadyRequest.Priority gives.
Priority *int
PriorityMin *int
PriorityMax *int
// Labels must ALL be present; LabelsAny requires at least one. Both are
// raw: entries are trimmed and de-duplicated INSIDE, and a slice whose
// entries are all blank is the same as an unset one.
Labels []string
LabelsAny []string
// TitleSearch is a case-insensitive substring match on the title.
TitleSearch string
// IDFilter is a comma-separated id set. Splitting, trimming and
// de-duplication happen inside, so a caller passes the string it was given
// rather than a slice it had to prepare.
IDFilter string
// ExcludeTypes names types to exclude, spelled as ListRequest.ExcludeTypes
// spells it: entries may be comma-separated, splitting and normalization
// happen inside, and an entry is NOT validated against the workspace
// vocabulary — an unrecognized type excludes nothing rather than failing.
// It composes with IncludeInfra's own "gate" exclusion rather than
// replacing it: both contribute to the same exclusion set.
ExcludeTypes []string
// ExcludeStatus names statuses to exclude. Unlike Status, this has no
// List counterpart — ListRequest computes its default status exclusions
// internally from workspace configuration and exposes no caller-facing
// knob for them. Here it is a new, Count-only capability (behavior token
// `issues.count.scope`): entries may be comma-separated, and — UNLIKE
// Status and ExcludeTypes above — each name IS validated against the
// workspace vocabulary (built-in statuses plus the workspace's own custom
// ones). An unrecognized name is ErrValidation rather than excluding
// nothing: a caller building an exclusion list by hand gets a loud failure
// on a typo instead of a silently wider, overcounted answer.
ExcludeStatus []string
// TitleContains, DescContains and NotesContains are substring matches on
// the three long fields, spelled as ListRequest spells them so the two
// requests cannot drift apart in naming while meaning the same thing.
TitleContains string
DescContains string
NotesContains string
// MetadataFields requires equality for every top-level key/value pair and
// HasMetadataKey is a top-level key-presence filter, spelled as
// ListRequest and ReadyRequest spell them. Keys are validated inside.
MetadataFields map[string]string
HasMetadataKey string
CreatedAfter *time.Time
CreatedBefore *time.Time
UpdatedAfter *time.Time
UpdatedBefore *time.Time
ClosedAfter *time.Time
ClosedBefore *time.Time
// EmptyDesc, NoAssignee and NoLabels restrict to rows missing each of those.
EmptyDesc bool
NoAssignee bool
NoLabels bool
// IncludeInfra switches the count from the durable plane to the cardinality
// of `bd list --include-infra --all`, which is FOUR changes at once and not
// one (GH#4387):
//
// - the ephemeral wisps tier is merged in, picking up both wisps and the
// no_history beads that are durable work stored in that tier;
// - template molecules are excluded, which a default count includes;
// - gate beads are excluded, unless IssueType asks for gates by name;
// - an IssueType the workspace calls infra routes the count to the
// ephemeral tier instead of the durable one.
//
// The infra vocabulary is the WORKSPACE's, read from configuration inside
// the implementation. A caller does not supply it and cannot: that is the
// config load this role exists to keep off both front doors.
//
// Unset — and with IncludeEphemeral also unset — the count is durable-plane
// only and applies none of those four: the historical `bd count` answer,
// kept exactly so a scripted caller reads the same number it read yesterday.
IncludeInfra bool
// IncludeEphemeral admits the EPHEMERAL PLANE — the wisps TABLE — and
// admits nothing else. It is the plane knob on its own: exactly the first
// of IncludeInfra's four changes, with none of the other three.
//
// It exists because there was no way to ask for that one thing. The write
// path routes on STORAGE CLASS, not type (dolt's useWispsTable is
// `Ephemeral || NoHistory || WispType != "" || IsInfraType`), so a
// no_history task lives in the wisps table while remaining ordinary durable
// work. Counting it needed IncludeInfra, which ALSO drops template rows of
// the named type — a silent undercount traded for a silent undercount.
//
// Same meaning as ListRequest.IncludeEphemeral (see issueops/reader.go):
// both admit the same PLANE under the same filters. It does NOT promise the
// two answers are equal — a count and a listing already differ on TEMPLATES
// without this flag, and still do with it. A count includes template rows
// unless IncludeInfra excludes them; a listing excludes them unless
// IncludeTemplates admits them. That predates this field and is unchanged by
// it; only IncludeInfra sets out to reconcile cardinality, and it pays for
// that with three changes beyond the plane.
//
// Unset — and with IncludeInfra also unset — the count is durable-plane
// only: the historical answer, unchanged.
IncludeEphemeral bool
}
// CountResult is the cardinality of the matching set.
type CountResult struct {
// Total is the number of matching rows. It is an int64 because the storage
// seam counts in one, not because a workspace is expected to hold four
// billion beads.
Total int64
}
// CountByGroupRequest describes one bucketed count.
type CountByGroupRequest struct {
// Filter is the same predicate a scalar count takes, so the two questions
// cannot be asked of different sets. It is embedded by NAME rather than
// anonymously: a grouped count is a scalar count plus a dimension, and
// spelling the dimension beside the whole filter says that, where promoted
// fields would have made GroupBy look like one more predicate.
Filter CountRequest
// GroupBy is the bucketing dimension and must be one of the five
// CountGroup constants. An empty or unknown value is ErrValidation, not a
// scalar count in disguise: a caller that wanted a number calls Count.
GroupBy CountGroup
}
// CountByGroupResult is one bucketed count.
type CountByGroupResult struct {
// Groups maps each bucket's DISPLAY key to its cardinality. The keys are
// normalized, and the normalization is part of this contract because both
// front doors print them unmodified:
//
// - a priority bucket is "P" followed by the number, so priority 1 is
// "P1";
// - the assignee bucket for unassigned rows is "(unassigned)", never the
// empty string, which would be indistinguishable from a store whose
// assignee column holds one;
// - the label bucket for rows carrying no label at all is "(no labels)",
// and it is ABSENT rather than zero when every matching row has one;
// - status and type buckets are the stored value verbatim.
//
// A dimension with no matching rows yields an empty map, never nil.
Groups map[string]int
// Total is the cardinality of the whole matching set — the SAME number a
// scalar Count of Filter returns, and NOT the sum of Groups.
//
// The two differ for exactly one dimension, and it is the reason this field
// exists rather than being left to the caller to add up: label buckets
// OVERLAP. An issue carrying three labels is one row in Total and one row
// in each of three buckets, so a caller that summed them would report a
// workspace three times its size. Every front door that prints a grouped
// count prints a total above it, and deriving that total is a decision this
// role makes once instead of each surface making it again.
//
// It is NOT promised to be one snapshot with Groups. The store-backed
// implementation runs the scalar and the grouped query separately, so a
// concurrent write between them can leave Total disagreeing with the
// buckets by that write. Nothing here is transactional across the two, and
// a caller reconciling them under load should not expect it to be.
Total int64
}
// Counter describes counting issues: the operation `bd count` performs, and —
// like Lifecycle, Reader, ReadyClaimer, BatchCloser, DependencyEditor,
// Commenter and Relations — a role with its own accessor. A new capability
// gets a new role interface and its own accessor; never append a method here.
//
// IT IS ITS OWN ROLE RATHER THAN A COUNTED VARIANT OF Reader because it
// answers a different question. Reader answers with PAGES OF ISSUES: its
// requests carry a limit, an offset, a keyset position, a sort and a has-more
// verdict, and every one of those describes which rows come back and in what
// order. A count has no rows and therefore no order, no page and no cursor —
// it is a number about a set. Folding it into Reader would have meant a
// request type carrying paging fields that a count must ignore, which is the
// shape that makes a caller believe `--limit 10` bounded the answer.
//
// BOTH METHODS BELONG TO THE ONE ROLE, and that is not the rule bending. The
// governing rule forbids APPENDING to an existing role, not a role being born
// with the two shapes of one question: a scalar count and a bucketed count ask
// the same predicate of the same set and differ only in whether the answer is
// one number or a number per bucket. They also cannot be separated in
// practice — a grouped answer carries the scalar Total, because label buckets
// overlap and the sum is wrong (see CountByGroupResult.Total) — so splitting
// them would put one role's promise inside another role's result.
//
// WHAT IS NOT HERE. `bd status` and its `bd stats` alias look like counts and
// are not: their numbers are dependency-aware (ready work, blocked work,
// staleness) and are not expressible as a predicate over one table, so they
// get a role of their own rather than a sixth CountGroup. The count of READY
// work is likewise a different question — the ready predicate is not a filter
// this request can describe — and is its own role for the same reason.
//
// Implementations never mutate caller-owned request values, snapshot the
// request at method entry, and apply normalization only to attempt-local
// clones. That promise is load-bearing here and not merely conventional:
// CountRequest carries two slices, and label normalization is the step that
// would otherwise write through them.
//
// Counting is a READ. Nothing here records a history entry, fires a completion
// hook or changes a row, and a refusal changes nothing either. Deterministic
// request-validation failures match ErrValidation; result values are
// unspecified when error is non-nil.
//
// THE PER-ROLE COST of adding a role like this one — the accessor, the two
// decorator wrappers, the unit-of-work source and the three conformance
// wirings — is written down in engdocs/ADDING_AN_ISSUEOPS_ROLE.md. Counter is
// the role that checklist was derived from.
type Counter interface {
// Count returns how many issues match the request. An empty request counts
// every durable row in the workspace, including closed ones: a count
// applies none of the listing's default exclusions.
//
// A predicate that matches nothing is 0 and a nil error. That is the whole
// of the "not found" story for this role — there is no ErrNotFound here,
// because a question about a set has an answer even when the set is empty,
// and a caller polling for work would otherwise have to classify an error
// to read a zero.
Count(ctx context.Context, req CountRequest) (CountResult, error)
// CountByGroup returns the same count bucketed by one dimension, plus the
// scalar Total of the whole matching set.
//
// An unknown GroupBy is ErrValidation. Buckets with no rows are absent
// rather than present at zero: the dimensions are open-ended (any assignee,
// any label, any custom status), so there is no closed set of keys to
// enumerate and a caller reads absence as zero.
CountByGroup(ctx context.Context, req CountByGroupRequest) (CountByGroupResult, error)
}