Deep-link the report gallery at the hosted report viewer - #242
Merged
Conversation
The gallery published report.html — the legacy WASM report, ~8MB per slug — while report-interactive.html sat unused in every artifact. Publish each session's archive instead and point the cards at report-viewer/?zip=, so the showcase runs through the same viewer we ship for everyone else's archives.
README's three showcase tiles linked report-assets/<slug>/report.html, which this branch stops publishing — and unlike session.zip, nothing would ever republish it, so the repo front page would 404 permanently. Point them at the viewer. Also drops the reports.md admonition and CORS section that still described the gallery as linking exported HTML files.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs landing page and Report Gallery link
report-assets/<slug>/report.html— which is the legacy WASM report, the format being deleted within the week. Meanwhilereport-interactive.htmlhas been produced and uploaded in every artifact and thrown away, because the Pages workflow's copy list is hardcoded to three filenames.Measured on the latest
docs-report-clockartifact:report.html(legacy WASM)report-interactive.htmlstoryboard.webpsummary.jsonSo the gallery is ~24 MB of a format that's about to stop existing.
This publishes each showcase session's archive and points the cards at the hosted viewer instead:
Both live on
block.github.io, so the fetch is same-origin — the CORS caveat documented for?zip=doesn't apply, and the gallery becomes the one place that path is guaranteed to work. Each slug also keeps a secondary link toreport-interactive.htmlfor the self-contained-file story.Producing the archive needs no new tooling: a plain
zip -rfrom the logs root yields exactly the<session-id>/<file>layout the viewer's ZIP reader expects — the same shape the daemon's/api/session/{id}/export.zipemits.Both
trailblaze reportinvocations now pass--no-wasm-report, so this job neither builds nor publishes the WASM report and survives its removal untouched. Follow-up for whoever lands that removal:build-uber-jarstill passes-Ptrailblaze.wasm=trueto bundle the WASM template, which this workflow no longer needs.No stand-in is generated for a missing
session.zip. The deep-link resolves againstreport-viewer/index.html, which always exists, so--strictis satisfied; a fabricated archive would render as a broken report instead of an honest "couldn't download that" with the drop zone still offered.Expected transient: no
session.zipexists yet, so the first deploy after merge has cards whose archive 404s — the viewer shows its download error with the drop zone live, and the secondary link works. It self-heals on the next completed clock / ios-contacts / wikipedia run (all trigger on push to main), the same one-cycle lag the gallery assets already document.Test plan
mkdocs build --strictpasses with no report assets present (the worst case) — query-string deep-links don't trip link validation?zip=…&tab=lightboxopens straight on the Lightbox, so the deep-link carrier surviveszip -routput layout matches whatzip-report-core.jsparses