Skip to content

feat(js): Update web worker guide with new webWorkerIntegration APIs #14395

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 2 commits into
base: master
Choose a base branch
from

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Jul 17, 2025

DESCRIBE YOUR PR

closes getsentry/sentry-javascript#16977
closes getsentry/sentry-javascript#16974

This PR adds documentation for two new WebWorker-related APIs:

  • Sentry.webWorkerIntegration()
  • Sentry.registerWebWorker()

More details in getsentry/sentry-javascript#16981

I also gave the entire web worker guide a facelift, removed some unnecessary notSupported platforms and added an integration page for the new integration. Also, the guide now includes a paragraph about configuring Vite correctly for worker builds which was raised in getsentry/sentry-javascript-bundler-plugins#755.

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+ (only to be merged after 9.40.0 was released)

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 Jul 17, 2025

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2025 3:27pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 17, 2025 3:27pm

@Lms24 Lms24 requested review from timfish and AbhiPrasad July 17, 2025 12:55
@Lms24 Lms24 self-assigned this Jul 17, 2025
Copy link

codecov bot commented Jul 17, 2025

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.84MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 11.97MB 2.4kB (0.02%) ⬆️

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 881.08kB -0.0%
static/chunks/1831-*.js -3 bytes 423.46kB -0.0%
static/hLbiyLmk-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/hLbiyLmk-*.js (New) 684 bytes 684 bytes 100.0% 🚀
static/PL_pBlecn4JtouY8n5u2B/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/PL_pBlecn4JtouY8n5u2B/_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.67MB -0.0%
../instrumentation.js -3 bytes 999.78kB -0.0%
9523.js -3 bytes 975.72kB -0.0%
../app/[[...path]]/page.js.nft.json 803 bytes 719.23kB 0.11%
../app/platform-redirect/page.js.nft.json 803 bytes 719.15kB 0.11%
../app/sitemap.xml/route.js.nft.json 803 bytes 717.12kB 0.11%

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.

Update docs + document how to configure source maps upload Support and assign debugIds from web worker in main thread
3 participants