* feat(stats): count the rows the default listing suppresses
bd status counts the issues table; bd list hides gates and templates on
account of what they are. The two therefore disagree, and nothing
reconciles them: a teardown driven by bd list leaves a gate behind and
status reports a total the operator cannot account for from any listing.
Break the suppressed rows out as their own counts. TotalIssues keeps
counting the database, which is what a command titled "Issue Database
Status" should report; these say how much of that total no default
listing will show. Every backend's statistics path funnels through
ScanIssueCountsInTx, so one query serves all of them.
Infra types need no counterpart here: they live on the wisp plane, which
this query does not read.
* fix(status): disclose the counted rows bd list will not show
bd status reported "Total Issues: 2" for a workspace whose every listing
showed one, because gates and templates are suppressed from a default
bd list. Nothing connected the two numbers, so the remainder read as a
phantom -- most visibly after a teardown driven by bd list, which leaves
its gates behind and then cannot see them.
Report the suppressed rows under the summary they qualify, naming the
flag that reveals each kind. The breakdown is printed rather than a
single hidden-total, since a template gate would otherwise be counted
twice. Nothing is printed when there is nothing suppressed.
Stacked on the statistics counts that make this reportable.
* docs(api): put gate_issues and template_issues on the Statistics schema
The Statistics schema is pinned to types.Statistics, so the two new
counts were on the wire the moment the struct grew them, and
TestWireTagBijection fails the openapi gate until the spec says so:
Go fields with no spec property: [gate_issues template_issues]
Document both as a breakdown of total_issues rather than an addition to
it — they count rows the default `bd list` suppresses, which
total_issues already includes — and warn against summing them, since a
row can be both a gate and a template.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* fix(status): give --assigned the same disclosure, and test the behavior
Three points from review.
1. `bd status --assigned` never printed the line. AssigneeStats does not
go through ScanIssueCountsInTx - it folds one actor's rows through
workapi.FoldStatsAssigneeSummary, which left both new fields zero. That
route's filter sets only Assignee, so IsTemplate stays nil and the
actor's gates and protos really ARE in those rows while
`bd list --assignee` suppresses both: the same reconciliation gap, one
scope down. The fold now counts them, and its doc says they are set
deliberately rather than borrowed from a workspace-wide answer.
2. The infra-type suppression is now explained rather than asserted away,
and the answer is that a durable infra row is NOT unreachable, so the
third breakdown is filed as GH#6439 rather than dismissed. Both the
plane routing and the listing's exclusions read the workspace-configured
types.infra set, and writing that key only invalidates a cache
(dolt/config.go) - it never moves rows already written. So durable rows
created while a type was not infra stay durable once it becomes one, and
a type evicted from the set creates durable rows outright, which the
create contract already pins ("evicted infra type",
issue_operations_contract.go). Counting them needs that configured set,
which ScanIssueCountsInTx - portable SQL with no config seam, called
from six backend sites - cannot reach; guessing with the built-in names
would be wrong in exactly the workspaces where it matters.
suppressedTypeSummary's doc now carries that reasoning.
3. The behavior itself had no test - both existing cases exercised a pure
string formatter, and would pass with the render call site deleted. Now:
- TestRenderStatusEmitsTheSuppressedRowsLine captures renderStatus's
stdout, asserts the line and both parts, and asserts it sits after the
totals it reconciles rather than in the extended block. It fails with
the call site removed ("renderStatus did not emit the disclosure
line"), plus a companion asserting the line is absent when there is
nothing to disclose.
- Three conformance cases in stats_reporter_contract.go, wired into all
three role wirings (dolt, embeddeddolt, uow), so the new SQL is
checked cross-backend rather than at one call site:
BreaksOutTheRowsTheDefaultListingSuppresses (with the negative rows a
loose predicate would also move), BreaksOutAGateThatIsAlsoATemplate
(the two suppressions are independent, so a proto's gate step counts
in both), and AssigneeStatsBreaksOutTheSuppressedRows for the fold.
statsReporterCounts and assertStatsReporterDelta carry the two fields.
All three are behavioral reds against zeroed counts, not compile
errors:
GateIssues moved by 0 (0 -> 0), want 1
TemplateIssues moved by 0 (0 -> 0), want 1
GateIssues = 0, want 1 - the actor's gate is in this answer but
not in `bd list --assignee`
4. Nit: pluralCount takes both spellings instead of appending "s", so a
caller with an irregular plural is not silently mis-served.
Also adds the CHANGELOG entry the behavior change was missing, including
the GH#6439 gap.
Reported-by: bee-ghosttrack
Agent-Signature: claude-code-opus-5-unknown-reasoning on behalf of Harry Miller
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* fix(conformance): declare the new stats cases in the order the table runs them
TestRoleContractCasesCoverEveryContractCase checks more than coverage: the
roleContractCases table has to list cases in the order their contract file
DECLARES them, because that is the order the unit-of-work leg's runners use
and the order its config-writing cases depend on.
I declared all three new cases together, then registered the assignee one
with the other assignee cases in the table, so the two orders disagreed:
roleContractCases is out of declaration order at position 449: table
has RunStatsReporterAStatusOutsideTheTalliesIsCountedOnlyInTotal,
source has RunStatsReporterAssigneeStatsBreaksOutTheSuppressedRows
Fixed by moving the declaration rather than the table entry, since the
assignee case belongs beside the other assignee-scoped ones anyway - the
grouping the table already had was the correct one. Caught by CI because I
ran go vet over backend/conformance but not its tests; both now pass.
Agent-Signature: claude-code-opus-5-unknown-reasoning on behalf of Harry Miller
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* docs(changelog): move this PR's entry under [Unreleased]
The 1.3.0 cut renamed the old [Unreleased] block, so the entry this branch
added there now merges cleanly into the released [1.3.0] section (#6643).
Agent-Signature: claude-code-opus-5-5-unknown-reasoning on behalf of Harry Miller
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* fix(status): complete the disclosure's remedy and pin its population
Maintainer review fixes for PR #5763 (adopt-pr iteration 1). Four of the
five review findings taken; the nit is declined with its measurement.
Finding 2 (minor, gate impact minor) - the printed remedy was incomplete.
The two counters come from the same scan as TotalIssues and are status-blind
with it, but the flags they named lift only the TYPE exclusion, so a CLOSED
gate was counted while `bd list --include-gates` still would not show it.
Gates are closed as the work they guard completes, so that is the ordinary
case rather than an edge.
Took the "complete the hint" arm over the "scope the counters" arm. Every
other field ScanIssueCountsInTx fills is workspace-wide; the disclosure
exists to account for TotalIssues, a database number printed three lines
above it; and scoping these two to the listing's population would leave them
explaining nothing about the total they are broken out of. `--all` "replaces
the status exclusions only" and lifts no type exclusion of its own
(backend/conformance/reader_contract.go:487), so the two flags together are
exactly the remedy. Recorded the population in the types.go field comment,
the status.go doc, and the CHANGELOG, which printed the old example verbatim.
Finding 3 (minor) - the three new conformance cases seeded only open rows,
so a backend counting over every status and one counting only the listing's
population returned identical numbers on all of them. Added a closed gate and
a closed proto to the first case. Proved it now decides the question: scoping
both SQL SUMs with `AND status <> 'closed'` reds exactly that case
("GateIssues moved by 1 (0 -> 1), want 2") while the all-open sibling
BreaksOutAGateThatIsAlsoATemplate stays green.
Finding 4 (minor) - the normative role doc in issueops/statsreporter.go
enumerated only the six prior counts. Added the two to that scan's bullet and
corrected two statements this PR had falsified: the headline "six counts of
one set", and the AssigneeStats bullet's "the fold ... tallies the five
statuses and nothing else", which stopped being true when the fold gained the
two increments.
Finding 1 (minor, gate impact minor) - ran `make bazel-sync`. It proposed
exactly one line, `+ "status_suppressed_test.go"` in cmd/bd/BUILD.bazel, and
nothing else, confirmed by porcelain rather than by bazel-sync-check.
Generator-owned, not hand-edited.
Finding 5 (nit) - declined. The three helpers already in package main
(pluralIssue, pluralize, plural) all DERIVE the "s" and cannot render a
caller-chosen pair; the tree's one two-form helper, pluralWord, is unexported
in internal/storage/issueops, and exporting it so a CLI string could reach it
would add exported surface to a storage role for a cosmetic. Recorded that
trade in pluralCount's doc comment instead.
Validation: `go build ./...` and `go vet` (6 pkgs) clean, gofmt clean,
`git diff --check` clean; cmd/bd 4/4 named PASS, internal/httpapi
TestWireTagBijection|TestSpec* PASS, internal/workapi PASS,
internal/storage/uow TestStatsReporterContract 18/18 subtests PASS. Both new
pins are mutation-proved: reverting `--all` reds all four table cases, both
flag subtests and the render-path pin, while the absence assertion stays
green.
Not done here: the PR body carries the same stale example line
("1 gate (--include-gates)"). Review iterations do not touch the PR surface,
so that correction is stamped for finalize.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: Gas City Adopt-PR <adopt-pr@gascity.local>
161 lines
4.7 KiB
Go
161 lines
4.7 KiB
Go
package main
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/steveyegge/beads/internal/types"
|
|
)
|
|
|
|
func TestSuppressedTypeSummary(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
stats *types.Statistics
|
|
want string
|
|
}{
|
|
{
|
|
name: "nothing suppressed",
|
|
stats: &types.Statistics{TotalIssues: 3},
|
|
want: "",
|
|
},
|
|
{
|
|
name: "one gate",
|
|
stats: &types.Statistics{TotalIssues: 2, GateIssues: 1},
|
|
want: "1 gate (--include-gates --all)",
|
|
},
|
|
{
|
|
name: "gates are pluralized",
|
|
stats: &types.Statistics{TotalIssues: 4, GateIssues: 3},
|
|
want: "3 gates (--include-gates --all)",
|
|
},
|
|
{
|
|
name: "gates and templates",
|
|
stats: &types.Statistics{TotalIssues: 5, GateIssues: 1, TemplateIssues: 2},
|
|
want: "1 gate (--include-gates --all), 2 templates (--include-templates --all)",
|
|
},
|
|
{
|
|
name: "templates only",
|
|
stats: &types.Statistics{TotalIssues: 5, TemplateIssues: 1},
|
|
want: "1 template (--include-templates --all)",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
if got := suppressedTypeSummary(tt.stats); got != tt.want {
|
|
t.Errorf("suppressedTypeSummary() = %q, want %q", got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// The disclosure exists so the operator can account for a total that no listing
|
|
// reproduces; it must name the flags that reveal the rows. Plural, and asserted
|
|
// here rather than left to the table above, because the two suppressions are
|
|
// independent: these counts span every status, while --include-gates lifts only
|
|
// the TYPE exclusion. A Contains check on the type flag alone passes on the
|
|
// incomplete hint, which would reproduce the number only in a workspace whose
|
|
// gates and protos all happen to still be open.
|
|
func TestSuppressedTypeSummaryNamesTheRevealingFlags(t *testing.T) {
|
|
for _, tt := range []struct {
|
|
name string
|
|
stats *types.Statistics
|
|
want string
|
|
}{
|
|
{"gates", &types.Statistics{TotalIssues: 2, GateIssues: 1}, "--include-gates --all"},
|
|
{"templates", &types.Statistics{TotalIssues: 2, TemplateIssues: 1}, "--include-templates --all"},
|
|
} {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
if got := suppressedTypeSummary(tt.stats); !strings.Contains(got, tt.want) {
|
|
t.Errorf("suppressedTypeSummary() = %q, want it to name %q", got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// renderStatusOutput captures what renderStatus writes to stdout.
|
|
func renderStatusOutput(t *testing.T, stats *types.Statistics) string {
|
|
t.Helper()
|
|
|
|
stdioMutex.Lock()
|
|
defer stdioMutex.Unlock()
|
|
|
|
path := filepath.Join(t.TempDir(), "stdout")
|
|
f, err := os.Create(path)
|
|
if err != nil {
|
|
t.Fatalf("create stdout capture: %v", err)
|
|
}
|
|
|
|
oldStdout := os.Stdout
|
|
oldJSON := jsonOutput
|
|
var renderErr error
|
|
func() {
|
|
defer func() {
|
|
os.Stdout = oldStdout
|
|
jsonOutput = oldJSON
|
|
}()
|
|
os.Stdout = f
|
|
jsonOutput = false
|
|
renderErr = renderStatus(stats, nil)
|
|
}()
|
|
|
|
if err := f.Close(); err != nil {
|
|
t.Fatalf("close stdout capture: %v", err)
|
|
}
|
|
if renderErr != nil {
|
|
t.Fatalf("renderStatus: %v", renderErr)
|
|
}
|
|
out, err := os.ReadFile(path)
|
|
if err != nil {
|
|
t.Fatalf("read stdout capture: %v", err)
|
|
}
|
|
return string(out)
|
|
}
|
|
|
|
// The summary formatter being right is not the same as the line reaching the
|
|
// operator: suppressedTypeSummary is a pure function over a hand-built struct,
|
|
// and every assertion above passes with the renderStatus call site deleted.
|
|
func TestRenderStatusEmitsTheSuppressedRowsLine(t *testing.T) {
|
|
blocked, ready := 0, 2
|
|
stats := &types.Statistics{
|
|
TotalIssues: 9,
|
|
OpenIssues: 4,
|
|
BlockedIssues: &blocked,
|
|
ReadyIssues: &ready,
|
|
GateIssues: 2,
|
|
TemplateIssues: 1,
|
|
}
|
|
|
|
out := renderStatusOutput(t, stats)
|
|
|
|
if !strings.Contains(out, "Not shown by bd list:") {
|
|
t.Fatalf("renderStatus did not emit the disclosure line:\n%s", out)
|
|
}
|
|
for _, want := range []string{"2 gates (--include-gates --all)", "1 template (--include-templates --all)"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("renderStatus output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
// The disclosure has to sit with the totals it reconciles, not down in the
|
|
// extended block that only renders when other counters are non-zero.
|
|
if idx, total := strings.Index(out, "Not shown by bd list:"), strings.Index(out, "Total Issues:"); idx < total {
|
|
t.Errorf("disclosure line precedes the totals it reconciles:\n%s", out)
|
|
}
|
|
}
|
|
|
|
// A workspace with neither kind of row must not gain a line that says nothing.
|
|
func TestRenderStatusOmitsTheLineWhenNothingIsSuppressed(t *testing.T) {
|
|
blocked, ready := 0, 1
|
|
stats := &types.Statistics{
|
|
TotalIssues: 3,
|
|
OpenIssues: 1,
|
|
BlockedIssues: &blocked,
|
|
ReadyIssues: &ready,
|
|
}
|
|
|
|
if out := renderStatusOutput(t, stats); strings.Contains(out, "Not shown by bd list") {
|
|
t.Errorf("renderStatus emitted the disclosure with nothing suppressed:\n%s", out)
|
|
}
|
|
}
|