Skip to content

fix(wasm): document support and adoption of build_id section #14597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

supervacuus
Copy link
Collaborator

@supervacuus supervacuus commented Aug 8, 2025

DESCRIBE YOUR PR

This is a follow-up to #14591.

The current state of the docs (across platforms) does not reflect:

  • that thebuild_id section is officially part of the WASM tooling conventions
  • that this section is adopted by tooling other than Sentry (in particular, LLVM and thus emscripten supports it since version 17)
  • how wasm-split still fits in this landscape

This PR tries to rectify this.

Open topics:

  • It is obvious that file-formats and identifiers are duplicates across all platforms with WASM support. Of course, these could be extracted into includes, but I am no longer sure what the current approach in docs is regarding deduplication of sections.
  • I am not sure if the statement regarding WASM source maps (the text above my changes in the file-formats section) still holds, but we can fix those in another PR.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Aug 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
sentry-docs 🛑 Canceled Aug 12, 2025 10:01am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored Preview Aug 12, 2025 10:01am

@codeowner-assignment codeowner-assignment bot requested review from a team August 8, 2025 15:00
Copy link

codecov bot commented Aug 8, 2025

Bundle Report

Changes will increase total bundle size by 1.35kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.85MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.38MB 1.36kB (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/HR6gFxCHn57q64Baon0Wx/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/HR6gFxCHn57q64Baon0Wx/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/Y_Ge8RttZxzBllCkofes7/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/Y_Ge8RttZxzBllCkofes7/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.77MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 455 bytes 744.91kB 0.06%
../app/platform-redirect/page.js.nft.json 455 bytes 744.83kB 0.06%
../app/sitemap.xml/route.js.nft.json 455 bytes 742.3kB 0.06%

Copy link
Member

@JoshuaMoelans JoshuaMoelans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a recurring typo that slipped through. Not sure if the suggestion is exactly how you wanted to write it, so feel free to adjust :)

@codeowner-assignment codeowner-assignment bot requested a review from a team August 12, 2025 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants