Uh oh!
There was an error while loading. Please reload this page.
fix(replay): Improve error messages when compression worker fails to load - #19008
Conversation
size-limit report 📦
|
| new Error( | ||
| `Failed to load Replay compression worker: ${error instanceof ErrorEvent && error.message ? error.message : 'Unknown error. This can happen due to CSP policy restrictions, network issues, or the worker script failing to load.'}`, | ||
| ), | ||
| ); |
There was a problem hiding this comment.
Missing test for improved error message regression fix
Low Severity · Bugbot Rules
This PR improves error messages when the compression worker fails to load, but no tests were added to verify the improved error messages are actually produced. The existing test at EventBufferProxy.test.ts only checks that the fallback buffer is used when the worker fails, not that the new descriptive Error objects are correctly constructed and rejected with the expected messages. Per the review rules: "When reviewing a fix PR, check if the PR includes at least one unit, integration or e2e test that tests the regression this PR fixes."
Additional Locations (1)
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| 'error', | ||
| error => { | ||
| reject(error); | ||
| DEBUG_BUILD && debug.warn('Failed to load Replay compression worker', error); |
There was a problem hiding this comment.
Redundant debug logging results in duplicate error messages
Low Severity
The new debug.warn calls at lines 36 and 46 are redundant because the caller EventBufferProxy._ensureWorkerIsLoaded() already logs these errors using debug.exception(). Looking at the logger implementation, debug.exception() logs both the message AND the error object to the console. This means when the worker fails to load, the same error appears multiple times in debug output - first as a warning from WorkerHandler, then as error logs from EventBufferProxy. The existing logging in EventBufferProxy provides more useful context (mentioning the fallback behavior), making the new logs unnecessary noise.
Additional Locations (1)
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
2d55530 to
5db8e19CompareCodecov Results 📊✅ 538 passed | ⏭️ 49 skipped | Total: 587 | Pass Rate: 91.65% | Execution Time: 15m 7s All tests are passing successfully. Generated by Codecov Action |
…load
Previously, when the compression worker failed to load (e.g., due to CSP
restrictions, network issues), Sentry captured a generic ErrorEvent with
almost no useful information ("Event: Event `Event` (type=error)").
This change wraps worker errors in descriptive Error objects that explain
what failed and common causes, making debugging significantly easier.
Fixes JAVASCRIPT-337J
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com>
83af4b8 to
a442dd3CompareThere was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'), | ||
| gzip: true, | ||
| limit: '98 KB', | ||
| limit: '99 KB', |
There was a problem hiding this comment.
Bundle size increase in browser package flagged
Low Severity
Per the review rules: "Large bundle size increases in browser packages. Sometimes they're unavoidable but flag them anyway." The size limit for @sentry/browser (incl. Tracing, Replay, Feedback) was bumped from 98 KB to 99 KB. The increase comes from the new descriptive error message strings added to WorkerHandler. This is likely unavoidable given the goal of improving error messages, but worth noting.
Uh oh!
There was an error while loading. Please reload this page.
…#22377) tbh I can't find a URL that says safari is more prone to not load a worker blob if it doesn't have a MIME type, but seems reasonable to add one. ## Slop `getWorkerURL()` builds the Replay compression worker from a `Blob` URL, but the `Blob` was created without a MIME type, so it defaulted to an empty type. Safari (especially on iOS) validates the MIME type before executing a `Blob` as a classic `Worker` and silently rejects a non-JS type — firing a bare `error` event with **no message**, which the SDK surfaces as: > Failed to load Replay compression worker: Unknown error. This can happen due to CSP policy restrictions, network issues, or the worker script failing to load. Blink/Gecko are lenient about the blob MIME type, so this particular failure mode is Safari-specific. Tagging the blob `text/javascript` is the standard cross-browser fix. ```ts const workerBlob = new Blob([workerString], { type: 'text/javascript' }); ``` This is a handled error — recording already falls back to the uncompressed buffer — so there is no user-facing behavior change beyond the worker actually loading on Safari. ## Testing - New `packages/replay-worker/test/unit/getWorkerURL.test.ts` asserts the blob is created with the `text/javascript` MIME type. - `oxlint` + `oxfmt` clean; `replay-worker` suite passes. ## Notes This is the low-risk half of a split. A separate follow-up PR handles the cross-browser (Chrome/Edge/Firefox) occurrences of the same captured error, which come from the worker fetch being aborted during page navigation/teardown rather than from the MIME type. Follow-up to #19008, which introduced the descriptive error message but did not address the load failure itself.
Previously, when the compression worker failed to load (e.g., due to CSP
restrictions, network issues), Sentry captured a generic ErrorEvent with
almost no useful information ("Event: Event
Event(type=error)").This change wraps worker errors in descriptive Error objects that explain
what failed and common causes, making debugging significantly easier.
Fixes JAVASCRIPT-337J
Co-Authored-By: Claude Opus 4.5 noreply@anthropic.com