Repository navigation
Description
Summary
Follow-up from the ROCMAI-484 review on #592 (comment: #592 (review)). Two related design points were deliberately deferred from that PR rather than folded in:
-
generate_consolidated_from_reports(reports, inputs)/consolidated_summary_markdown_from_reports(reports, inputs)let their two parameters describe different platform sets. The matrix, per-platform details, and command-coverage table are built fromreports; the expectation grid and scenario-reference sections are built independently frominputs. Nothing enforces that the two stay paired — a caller that filters, reorders, or re-pairs theVec<PlatformReport>returned byload_platform_reportsgets output that silently disagrees with itself (one section describing one platform set, another section describing a different one).from_reports_entry_points_follow_reports_not_inputs(incrates/e2e-report/src/consolidated.rs) demonstrates the mismatch is real today, on purpose. -
The public API grew from 3 items to 7 to add the shared-parsing path without touching any existing caller.
generate_consolidatedandconsolidated_summary_markdownwere kept as thin wrappers around the new_from_reportsentry points so no existing caller/signature had to change. In practice this crate (crates/e2e-report,publish = false, internal-only) has no external consumers to protect: as of e2e-report: share parsed reports between consolidated outputs (ROCMAI-484) #592's b64edb0, bothgenerate_consolidatedandconsolidated_summary_markdownhave zero callers left anywhere outside this crate's own test module (workflow_contract.rs's prior call was migrated toconsolidated_summary_markdown_from_reports(&[], &[])). Keeping the wrapper quartet buys little while doubling the surface area and forcingPlatformReportfrompub(crate)topub, past the encapsulation boundarydocs/architecture.mdcalls deliberate for this crate.
Proposed direction
Address both together rather than separately:
- Replace the
(reports, inputs)pair with one opaque bundle type returned byload_platform_reports(e.g. holding both the parsedreportsand theinputsthey came from), so the two can't drift apart by construction. - Change
generate_consolidated's andconsolidated_summary_markdown's signatures directly to take that bundle, drop the_from_reportswrapper functions, and update the one in-repo caller (xtask/src/e2e_report.rs) and the one test caller (xtask/src/workflow_contract.rs) accordingly. PlatformReportcan then likely go back topub(crate)if the bundle type is the only thing that needs to be public.
Why not fold into #592
#592 scoped itself to the literal duplication the ticket named (the Vec<PlatformReport> build+sort that was verbatim-duplicated between the two top-level functions), and explicitly deferred the Grid-sharing/API-surface questions as follow-ups rather than widening its own diff. This issue tracks that deferred work so it isn't lost.
Activity
e2e-report: deprecate reparsing wrappers, dedup sort-key test helpers
e2e-report: share parsed reports between consolidated outputs (ROCMAI…
fix(e2e-report): use canonical platform label in expectation grid
e2e-report: use canonical platform label in expectation grid (ROCm#706)