Repository navigation
Closed
Closed
Copy link
Description
Split out of #188, which stays as the hosted-platform epic (deployable, upload API, auth, multi-tenancy) and moved to v3.0.
Why this is small
Everything an org rollup needs to aggregate already exists as structured artefacts on disk:
| Source | Artefact |
|---|---|
bowire lint |
findings JSON (rule id, severity, service, method, field) |
bowire contract verify |
.bowire/contract-results/<consumer>__<provider>.json |
bowire bench run / scheduled runs |
k6-summary JSON + .bowire/benchmark-schedules/<id>.runs.json |
bowire scan |
SARIF |
bowire test |
JUnit |
| the PR bot | an assembled per-repo report |
So "what's the state of our APIs?" across N services is a read-and-aggregate problem over files Bowire already writes — the same vertical as the contract matrix (#364): one engine, four surfaces, no new infrastructure.
Scope
bowire report rollup --from <dir|file…>— read every report it finds, emit a per-service rollup: findings by severity, contract pass/fail, latest p95, test pass-rate. Text table plus--json.--fail-on <severity>so a platform pipeline can gate on the rollup, matchinglint,contract matrixandbench run.- Workbench rail rendering the same rollup (rows = services, columns = the signals above), drilling into a service's underlying report.
bowire.report.rollupMCP tool returning the same shape, so an agent can answer the portfolio question.- Shared wire shape between all three surfaces — one projection, as in Contract testing: workbench matrix view (consumer × provider pass/fail) #364, so CLI JSON and API JSON cannot drift.
Explicitly out of scope (that is #188)
- Standalone deployable (Docker image / Helm chart)
- Report-upload endpoint and service-token auth
- Multi-tenancy — depends on Multi-tenant data model + SCIM (Phase B) #28 / Multi-tenant Phase C — SCIM 2.0 provisioning endpoints #96 (v2.6)
- SAML / OIDC org login
- Admin actions: dismiss finding, mark known-issue, file a ticket
- Trends over time (needs retained history, which the upload store provides)
Acceptance
-
bowire report rollup --from <path…>reads lint / contract / bench / scan / test artefacts and prints a per-service rollup -
--jsonemits the shared wire shape;--fail-on <severity>gates non-zero - Workbench rail shows the rollup and drills into a service's source report
-
bowire.report.rollupMCP tool returns the same shape - A missing or malformed report degrades that one row, never the rollup
- Tests covering the readers, the aggregation and the shared shape
Related
- Org-level Bowire dashboard — rollup across services #188 — the hosted platform play this was split from
- Contract testing: workbench matrix view (consumer × provider pass/fail) #364 — the contract matrix whose vertical this follows
- GitHub Action — Bowire PR-comment bot with delta + findings + perf #183 — the PR bot, which produces one of the inputs
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
- StatusShow more project fieldsDone
Activity
feat(report): rollup reader over the artefacts Bowire already writes (#…
feat(report): rollup surfaces — CLI, endpoint, rail and MCP (#587)
test(report): pin the Rollup rail's rendering and its path-input cont…
docs(report): document the rollup across CLI, workbench and MCP (#587)
thomas-stegemann commentedon Aug 20, 2026
Shipped across all four surfaces.
The decision the whole thing rests on: parse the file formats, not the producing packages' types. A rollup answers a question across services, so its inputs come from other repositories, other machines and other Bowire versions. Deserialising into
ContractVerificationReportorBowireBenchmarkScheduleRunwould have required those packages to be loaded in the process doing the reading — which defeats the purpose, and would break the moment an upstream field changed. Format detection goes by content rather than file name, because CI jobs name these things whatever they like and aresults.jsoncould be any of four shapes.An em dash is not a zero. Every count is nullable:
—means there is no such report,0/1means the report exists and one contract failed. Flattening both to 0 would let a service nobody has ever linted read as a clean bill of health — the single most likely way a portfolio view lies to you. In JSON the same distinction isnullversus a number.Attribution needs no configuration. In order: an explicit
--service, then the report's own identity where the format has one — a contract files under its provider, the service under test, not the consumer — then the first path segment that isn't storage layout (so.bowire/contract-results/web__orders.jsondoesn't invent a service calledcontract-results), then the file name. A CI job that collects reports intoreports/<service>/just works.Worst-severity ranks regressions above style. A failing contract, a failing test or a scan error is high; a breached latency budget is medium; lint severities fall below. That ordering is what
--fail-ongates on.Four surfaces, one projection. CLI (
bowire report rollup,--json,--fail-on),POST /api/report/rollup, the Rollup rail, and thebowire.report.rollupMCP tool all emit the same JSON throughBowireRollupPayload— the lesson from #364, where serialising the model directly made the CLI print an enum ordinal while the endpoint printed a string. The endpoint is POST rather than GET because the paths are input, and a rollup over an arbitrary directory tree does not belong in a URL that lands in a log or a browser history.Verified end to end, not only in tests: against a three-service fixture the CLI produced the table above,
--fail-on highexited 1, the live endpoint returned the same shape, the rail rendered the same rows in the browser, and the foreign file was skipped rather than breaking the run.Tests: 27. Twenty over the reader — every format's shape, the aggregation rules, attribution including the mixed-report fallback, and that malformed or foreign files are skipped with a reason while the rest of the portfolio still reports. Seven over the rail, including one that pins the path input: its value is rendered from state on every render, so a keystroke that never reached state would be silently reverted. That test exists because the browser pass could not settle the question — the machine's automation layer froze first — and a test answers it permanently where a retry would not.
Docs:
docs/features/report-rollup.md(+ toc), the MCP tool list, and a release-note highlight.Commits: 6bdc543 (reader), 7adef56 (CLI, endpoint, rail, MCP), 4fd30b6 (rail tests), 9704513 (docs). CI green.
Out of scope and unchanged: uploading reports to a shared store, retained history for trends, org login and admin actions — that is the hosted dashboard, #188, now in v3.0.
docs(release-notes): reset upcoming.md to 2.5 and move v2.4's breakin…