feat(browser): Prevent initialization in browser extensions #10844
Conversation
This file contains 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
s1gr1d
changed the title
s1gr1d
force-pushed
the
sig-prevent-init-in-extension
branch
from
8e2fa68 to
1b85c6b
Compare
mydea
reviewed
Feb 28, 2024
packages/browser/src/sdk.ts
Outdated
| consoleSandbox(() => { | ||
| // eslint-disable-next-line no-console | ||
| console.error( | ||
| '[Sentry] You cannot run Sentry this way in an extension, check: https://docs.sentry.io/platforms/javascript/troubleshooting/#setting-up-sentry-in-shared-environments-eg-browser-extensions', |
There was a problem hiding this comment.
Suggested change
| '[Sentry] You cannot run Sentry this way in an extension, check: https://docs.sentry.io/platforms/javascript/troubleshooting/#setting-up-sentry-in-shared-environments-eg-browser-extensions', | |
| '[Sentry] You cannot run Sentry this way in a browser extension, check: https://docs.sentry.io/platforms/javascript/troubleshooting/#setting-up-sentry-in-shared-environments-eg-browser-extensions', |
maybe a bit clearer, wording wise? 🤔
mydea
reviewed
Feb 28, 2024
| it('should log a browser extension error if executed inside a Chrome extension', () => { | ||
| const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {}); | ||
|
|
||
| Object.defineProperty(WINDOW, 'chrome', { |
There was a problem hiding this comment.
I would add an afterEach block that resets this back to undefined, to ensure we don't leak this into other tests!
There was a problem hiding this comment.
I added this block to reset it and I also added the test for the regular browser environment at last to make sure this fails directly if browser or chrome is still part of the globals.
size-limit report 📦
|
s1gr1d
force-pushed
the
sig-prevent-init-in-extension
branch
from
1b85c6b to
6516bc9
Compare
mydea
approved these changes
Feb 29, 2024
| import * as Sentry from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
| window.browser = { runtime: { id: 'mock-extension-id' } }; |
There was a problem hiding this comment.
Suggested change
| window.browser = { runtime: { id: 'mock-extension-id' } }; | |
| // We mock this here to simulate a browser extension | |
| window.browser = { runtime: { id: 'mock-extension-id' } }; |
maybe leave a comment here for our future selves to know why this exists xD
| import * as Sentry from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
| window.chrome = { runtime: { id: 'mock-extension-id' } }; |
There was a problem hiding this comment.
Suggested change
| window.chrome = { runtime: { id: 'mock-extension-id' } }; | |
| // We mock this here to simulate a browser extension | |
| window.chrome = { runtime: { id: 'mock-extension-id' } }; |
s1gr1d
force-pushed
the
sig-prevent-init-in-extension
branch
from
6516bc9 to
8c5ebc0
Compare
3 tasks
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.
Prevents initialization inside chrome.* and browser.* extension environments.
Also refactored init() in browser because of eslint warning about too much complexity.
Fixes #10632