Uh oh!
There was an error while loading. Please reload this page.
feat(browser): Add browserSessionIntegration#14551
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,39 @@ | ||
| import { addHistoryInstrumentationHandler } from '@sentry-internal/browser-utils'; | ||
| import { captureSession, defineIntegration, logger, startSession } from '@sentry/core'; | ||
| import { DEBUG_BUILD } from '../debug-build'; | ||
| import { WINDOW } from '../helpers'; | ||
| /** | ||
| * When added, automatically creates sessions which allow you to track adoption and crashes (crash free rate) in your Releases in Sentry. | ||
| * More information: https://docs.sentry.io/product/releases/health/ | ||
| * | ||
| * Note: In order for session tracking to work, you need to set up Releases: https://docs.sentry.io/product/releases/ | ||
| */ | ||
| export const browserSessionIntegration = defineIntegration(() => { | ||
| return { | ||
| name: 'BrowserSession', | ||
| setupOnce() { | ||
| if (typeof WINDOW.document === 'undefined') { | ||
| DEBUG_BUILD && | ||
| logger.warn('Using the `browserSessionIntegration` in non-browser environments is not supported.'); | ||
| return; | ||
| } | ||
| // The session duration for browser sessions does not track a meaningful | ||
| // concept that can be used as a metric. | ||
| // Automatically captured sessions are akin to page views, and thus we | ||
| // discard their duration. | ||
| startSession({ ignoreDuration: true }); | ||
Member There was a problem hiding this comment. Should we adjust the Then again all of this is kind of global, so maybe this does not help anyhow 🤔 ContributorAuthor There was a problem hiding this comment. I had the same thoughts. I am actually extremely unsure on how to proceed. It all depends on how we would want sessions to work. If we want there to be multiple at once, it would make sense, however I would err towards the exact opposite. I think always only having one session active per page makes the most sense. Even in MFEs. I would even go so far to lock down the API down even more in v9, simply because it makes wrapping your head around the concept easier. All of this is just thinking out loud though. In general I didn't want this PR to be behaviorally significant. That's why I chose this route. Member There was a problem hiding this comment. I agree, let's leave it at one "global" session per page. | ||
| captureSession(); | ||
| // We want to create a session for every navigation as well | ||
| addHistoryInstrumentationHandler(({ from, to }) => { | ||
| // Don't create an additional session for the initial route or if the location did not change | ||
| if (from !== undefined && from !== to) { | ||
| startSession({ ignoreDuration: true }); | ||
| captureSession(); | ||
| } | ||
| }); | ||
| }, | ||
| }; | ||
| }); | ||
This file contains hidden or 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: any reason to loosen the assertions?
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.
I personally found it to be very annoying that the ordering needed to be exact. Lmk if you want me to change it back.
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.
ah I see, the ordering is annoying, agreed. Though these tests wouldn't fail additionally added integrations, unless I'm completely missing something. So that opens the test up to more behaviour change than previously. I don't think this is the end of the world but it'd be good to have at least one test that fails if we add a new integration by default. We should be aware of stuff like this.