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
feat(vue): Check if SDK is initialized before app is mounted #6227
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import { createApp } from 'vue'; | ||
|
|
||
| import * as Sentry from './../../src'; | ||
|
|
||
| describe('Sentry.init', () => { | ||
| let _consoleWarn: any; | ||
| let warnings: string[] = []; | ||
|
|
||
| beforeEach(() => { | ||
| warnings = []; | ||
| // eslint-disable-next-line no-console | ||
| _consoleWarn = console.warn; | ||
| // eslint-disable-next-line no-console | ||
| console.warn = jest.fn((message: string) => { | ||
| warnings.push(message); | ||
| }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| // eslint-disable-next-line no-console | ||
| console.warn = _consoleWarn; | ||
| }); | ||
|
|
||
| it('does not warn when correctly setup (Vue 3)', () => { | ||
| const el = document.createElement('div'); | ||
| const app = createApp({ | ||
| template: '<div>hello</div>', | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| app, | ||
| defaultIntegrations: false, | ||
| }); | ||
|
|
||
| app.mount(el); | ||
|
|
||
| expect(warnings).toEqual([]); | ||
| }); | ||
|
|
||
| it('does not warn when correctly setup (Vue 2)', () => { | ||
| const el = document.createElement('div'); | ||
| const app = createApp({ | ||
| template: '<div>hello</div>', | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| // this is a bit "hacky", but good enough to test what we want | ||
| Vue: app, | ||
| defaultIntegrations: false, | ||
| }); | ||
|
|
||
| app.mount(el); | ||
|
|
||
| expect(warnings).toEqual([]); | ||
| }); | ||
|
|
||
| it('warns when mounting before SDK init', () => { | ||
| const el = document.createElement('div'); | ||
| const app = createApp({ | ||
| template: '<div>hello</div>', | ||
| }); | ||
|
|
||
| app.mount(el); | ||
|
|
||
| Sentry.init({ | ||
| app, | ||
| defaultIntegrations: false, | ||
| }); | ||
|
|
||
| expect(warnings).toEqual([ | ||
| '[@sentry/vue]: Misconfigured SDK. Vue app is already mounted. Make sure to call `app.mount()` after `Sentry.init()`.', | ||
| ]); | ||
| }); | ||
|
|
||
| it('warns when not passing app & Vue', () => { | ||
| const el = document.createElement('div'); | ||
| const app = createApp({ | ||
| template: '<div>hello</div>', | ||
| }); | ||
|
|
||
| Sentry.init({ | ||
| defaultIntegrations: false, | ||
| }); | ||
|
|
||
| app.mount(el); | ||
|
|
||
| expect(warnings).toEqual([ | ||
| `[@sentry/vue]: Misconfigured SDK. Vue specific errors will not be captured. | ||
| Update your \`Sentry.init\` call with an appropriate config option: | ||
| \`app\` (Application Instance - Vue 3) or \`Vue\` (Vue Constructor - Vue 2).`, | ||
| ]); | ||
| }); | ||
| }); |
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
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.
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.
l: I'm probably missing something obvious but are we using the Vue dependency somewhere? AFICT, we're still importing the
Vuetype from our type definition.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.
we use it in the test now :)
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.
Ahh makes sense :D