-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 2.59kB (0.01%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
docs/platforms/javascript/common/best-practices/web-workers.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/best-practices/web-workers.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/best-practices/web-workers.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/best-practices/web-workers.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/best-practices/web-workers.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/configuration/integrations/webworker.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/configuration/integrations/webworker.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/configuration/integrations/webworker.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/configuration/integrations/webworker.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some feedback, overall looks good, thanks for adding!
Co-authored-by: Alex Krawiec <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Incorrect Plugin Configuration Causes Runtime Error
The worker.plugins
configuration incorrectly uses the spread operator (...sentryPlugin
) on sentryPlugin
, which is a single, non-iterable plugin object. This will cause a runtime error. The correct usage is [sentryPlugin]
.
docs/platforms/javascript/common/best-practices/web-workers.mdx#L175-L176
sentry-docs/docs/platforms/javascript/common/best-practices/web-workers.mdx
Lines 175 to 176 in ccbd7a1
// Vite plugin for worker bundle | |
plugins: () => [...sentryPlugin], |
Was this report helpful? Give feedback by reacting with 👍 or 👎
lol Cursor, do you even read bro? |
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.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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