Skip to content
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.

Sign up for GitHub

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(browser): Add browserSessionIntegration #14551

Merged
merged 7 commits into from
Dec 4, 2024
Merged

feat(browser): Add browserSessionIntegration #14551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
98db1ca
feat(browser): Add `browserSessionIntegration`
lforst Dec 3, 2024
2a0986e
jsdoc, comment, name
lforst Dec 3, 2024
02cd633
docs
lforst Dec 3, 2024
816692e
angular test
lforst Dec 3, 2024
3781003
tests
lforst Dec 3, 2024
d1fa96a
weird but ok
lforst Dec 3, 2024
40cefac
rename file
lforst Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dev-packages/browser-integration-tests/suites/public-api/debug/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ sentryTest('logs debug messages correctly', async ({ getLocalTestUrl, page }) =>
'Sentry Logger [log]: Integration installed: Dedupe',
'Sentry Logger [log]: Integration installed: HttpContext',
'Sentry Logger [warn]: Discarded session because of missing or non-string release',
'Sentry Logger [log]: Integration installed: BrowserSession',
'test log',
]
: ['[Sentry] Cannot initialize SDK with `debug` option using a non-debug bundle.', 'test log'],
Expand Down
10 changes: 6 additions & 4 deletions dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
sdk: {
integrations: [
integrations: expect.arrayContaining([
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

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.

'InboundFilters',
'FunctionToString',
'BrowserApiErrors',
Expand All @@ -43,8 +43,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
'LinkedErrors',
'Dedupe',
'HttpContext',
'BrowserSession',
'Replay',
],
]),
version: SDK_VERSION,
name: 'sentry.javascript.browser',
},
Expand All @@ -71,7 +72,7 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
sdk: {
integrations: [
integrations: expect.arrayContaining([
'InboundFilters',
'FunctionToString',
'BrowserApiErrors',
Expand All @@ -80,8 +81,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
'LinkedErrors',
'Dedupe',
'HttpContext',
'BrowserSession',
'Replay',
],
]),
version: SDK_VERSION,
name: 'sentry.javascript.browser',
},
Expand Down
10 changes: 6 additions & 4 deletions dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
sdk: {
integrations: [
integrations: expect.arrayContaining([
'InboundFilters',
'FunctionToString',
'BrowserApiErrors',
Expand All @@ -43,8 +43,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
'LinkedErrors',
'Dedupe',
'HttpContext',
'BrowserSession',
'Replay',
],
]),
version: SDK_VERSION,
name: 'sentry.javascript.browser',
},
Expand All @@ -71,7 +72,7 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
sdk: {
integrations: [
integrations: expect.arrayContaining([
'InboundFilters',
'FunctionToString',
'BrowserApiErrors',
Expand All @@ -80,8 +81,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
'LinkedErrors',
'Dedupe',
'HttpContext',
'BrowserSession',
'Replay',
],
]),
version: SDK_VERSION,
name: 'sentry.javascript.browser',
},
Expand Down
5 changes: 3 additions & 2 deletions dev-packages/browser-integration-tests/utils/replayEventTemplates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const DEFAULT_REPLAY_EVENT = {
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
sdk: {
integrations: [
integrations: expect.arrayContaining([
'InboundFilters',
'FunctionToString',
'BrowserApiErrors',
Expand All @@ -25,8 +25,9 @@ const DEFAULT_REPLAY_EVENT = {
'LinkedErrors',
'Dedupe',
'HttpContext',
'BrowserSession',
'Replay',
],
]),
version: SDK_VERSION,
name: 'sentry.javascript.browser',
},
Expand Down
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/astro-4/tests/errors.client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ test.describe('client-side errors', () => {
'LinkedErrors',
'Dedupe',
'HttpContext',
'BrowserSession',
'BrowserTracing',
]),
name: 'sentry.javascript.astro',
Expand Down
11 changes: 9 additions & 2 deletions packages/angular/src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { VERSION } from '@angular/core';
import type { BrowserOptions } from '@sentry/browser';
import {
breadcrumbsIntegration,
browserSessionIntegration,
globalHandlersIntegration,
httpContextIntegration,
init as browserInit,
Expand All @@ -22,7 +23,7 @@ import { IS_DEBUG_BUILD } from './flags';
/**
* Get the default integrations for the Angular SDK.
*/
export function getDefaultIntegrations(): Integration[] {
export function getDefaultIntegrations(options: BrowserOptions = {}): Integration[] {
// Don't include the BrowserApiErrors integration as it interferes with the Angular SDK's `ErrorHandler`:
// BrowserApiErrors would catch certain errors before they reach the `ErrorHandler` and
// thus provide a lower fidelity error than what `SentryErrorHandler`
Expand All @@ -31,7 +32,7 @@ export function getDefaultIntegrations(): Integration[] {
// see:
// - https://github.com/getsentry/sentry-javascript/issues/5417#issuecomment-1453407097
// - https://github.com/getsentry/sentry-javascript/issues/2744
return [
const integrations = [
inboundFiltersIntegration(),
functionToStringIntegration(),
breadcrumbsIntegration(),
Expand All @@ -40,6 +41,12 @@ export function getDefaultIntegrations(): Integration[] {
dedupeIntegration(),
httpContextIntegration(),
];

if (options.autoSessionTracking !== false) {
integrations.push(browserSessionIntegration());
}

return integrations;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/test/sdk.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ describe('init', () => {
});

it('does not include the BrowserApiErrors integration', () => {
const browserDefaultIntegrationsWithoutBrowserApiErrors = SentryBrowser.getDefaultIntegrations()
const browserDefaultIntegrationsWithoutBrowserApiErrors = SentryBrowser.getDefaultIntegrations({})
.filter(i => i.name !== 'BrowserApiErrors')
.map(i => i.name)
.sort();
Expand Down
1 change: 1 addition & 0 deletions packages/browser/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,4 @@ export type { Span } from '@sentry/core';
export { makeBrowserOfflineTransport } from './transports/offline';
export { browserProfilingIntegration } from './profiling/integration';
export { spotlightBrowserIntegration } from './integrations/spotlight';
export { browserSessionIntegration } from './integrations/browsersession';
39 changes: 39 additions & 0 deletions packages/browser/src/integrations/browsersession.ts
View file
Open in desktop
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 });
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we adjust the startSession syntax to allow to optionally pass a client directly, and run all of this on setup(client) instead of setupOnce()? 🤔

Then again all of this is kind of global, so maybe this does not help anyhow 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this makes sense to me!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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();
}
});
},
};
});
48 changes: 10 additions & 38 deletions packages/browser/src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
import { addHistoryInstrumentationHandler } from '@sentry-internal/browser-utils';
import {
captureSession,
consoleSandbox,
dedupeIntegration,
functionToStringIntegration,
Expand All @@ -13,7 +11,6 @@ import {
lastEventId,
logger,
stackParserFromStackParserOptions,
startSession,
supportsFetch,
} from '@sentry/core';
import type { Client, DsnLike, Integration, Options, UserFeedback } from '@sentry/core';
Expand All @@ -23,19 +20,20 @@ import { DEBUG_BUILD } from './debug-build';
import { WINDOW } from './helpers';
import { breadcrumbsIntegration } from './integrations/breadcrumbs';
import { browserApiErrorsIntegration } from './integrations/browserapierrors';
import { browserSessionIntegration } from './integrations/browsersession';
import { globalHandlersIntegration } from './integrations/globalhandlers';
import { httpContextIntegration } from './integrations/httpcontext';
import { linkedErrorsIntegration } from './integrations/linkederrors';
import { defaultStackParser } from './stack-parsers';
import { makeFetchTransport } from './transports/fetch';

/** Get the default integrations for the browser SDK. */
export function getDefaultIntegrations(_options: Options): Integration[] {
export function getDefaultIntegrations(options: Options): Integration[] {
/**
* Note: Please make sure this stays in sync with Angular SDK, which re-exports
* `getDefaultIntegrations` but with an adjusted set of integrations.
*/
return [
const integrations = [
inboundFiltersIntegration(),
functionToStringIntegration(),
browserApiErrorsIntegration(),
Expand All @@ -45,6 +43,12 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
dedupeIntegration(),
httpContextIntegration(),
];

if (options.autoSessionTracking !== false) {
integrations.push(browserSessionIntegration());
}

return integrations;
}

function applyDefaultOptions(optionsArg: BrowserOptions = {}): BrowserOptions {
Expand Down Expand Up @@ -187,13 +191,7 @@ export function init(browserOptions: BrowserOptions = {}): Client | undefined {
transport: options.transport || makeFetchTransport,
};

const client = initAndBind(BrowserClient, clientOptions);

if (options.autoSessionTracking) {
startSessionTracking();
}

return client;
return initAndBind(BrowserClient, clientOptions);
}

/**
Expand Down Expand Up @@ -308,32 +306,6 @@ export function onLoad(callback: () => void): void {
callback();
}

/**
* Enable automatic Session Tracking for the initial page load.
*/
function startSessionTracking(): void {
if (typeof WINDOW.document === 'undefined') {
DEBUG_BUILD && logger.warn('Session tracking in non-browser environment with @sentry/browser 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 });
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();
}
});
}

/**
* Captures user feedback and sends it to Sentry.
*
Expand Down
Loading