Skip to content

feat(browser): default browserSessionIntegration lifecycle to page #21245

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

Draft
nehaprasad-dev wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

feat(browser): default browserSessionIntegration lifecycle to page #21245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/sessions/initial-scope/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ window.Sentry = Sentry;
Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '0.1',
integrations: [Sentry.browserSessionIntegration({ lifecycle: 'route' })],
initialScope: {
user: {
id: '1337',
Expand Down
1 change: 0 additions & 1 deletion dev-packages/browser-integration-tests/suites/sessions/page-lifecycle/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ window.Sentry = Sentry;
Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '0.1',
integrations: [Sentry.browserSessionIntegration({ lifecycle: 'page' })],
});
4 changes: 2 additions & 2 deletions dev-packages/browser-integration-tests/suites/sessions/page-lifecycle/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
waitForSession,
} from '../../../utils/helpers';

sentryTest('starts a session on pageload with page lifecycle.', async ({ getLocalTestUrl, page }) => {
sentryTest('starts a session on pageload with page lifecycle (default).', async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

const sessionPromise = waitForSession(page, s => !!s.init && s.status === 'ok');
Expand All @@ -32,7 +32,7 @@ sentryTest('starts a session on pageload with page lifecycle.', async ({ getLoca
});

sentryTest(
"doesn't start a new session on pushState navigation with page lifecycle.",
"doesn't start a new session on pushState navigation with page lifecycle (default).",
async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

Expand Down
1 change: 1 addition & 0 deletions dev-packages/browser-integration-tests/suites/sessions/route-lifecycle/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ window.Sentry = Sentry;
Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '0.1',
integrations: [Sentry.browserSessionIntegration({ lifecycle: 'route' })],
});
2 changes: 1 addition & 1 deletion dev-packages/browser-integration-tests/suites/sessions/route-lifecycle/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { waitForSession } from '../../../utils/helpers';

sentryTest(
'should start new sessions on pushState navigation with route lifecycle (default).',
'should start new sessions on pushState navigation with route lifecycle.',
async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

Expand Down
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/sessions/start-session/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '0.1',
integrations: [Sentry.browserSessionIntegration({ lifecycle: 'route' })],
});
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/sessions/user/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '0.1',
integrations: [Sentry.browserSessionIntegration({ lifecycle: 'route' })],
});
10 changes: 4 additions & 6 deletions packages/browser/src/integrations/browsersession.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ interface BrowserSessionOptions {
/**
* Controls the session lifecycle - when new sessions are created.
*
* - `'route'`: A session is created on page load and on every navigation.
* This is the default behavior.
* - `'page'`: A session is created once when the page is loaded. Session is not
* updated on navigation. This is useful for webviews or single-page apps where
* URL changes should not trigger new sessions.
* updated on navigation. This is the default behavior.
* - `'route'`: A session is created on page load and on every navigation.
*
* @default 'route'
* @default 'page'
*/
lifecycle?: 'route' | 'page';
}
Expand All @@ -25,7 +23,7 @@ interface BrowserSessionOptions {
* Note: In order for session tracking to work, you need to set up Releases: https://docs.sentry.io/product/releases/
*/
export const browserSessionIntegration = defineIntegration((options: BrowserSessionOptions = {}) => {
const lifecycle = options.lifecycle ?? 'route';
const lifecycle = options.lifecycle ?? 'page';

return {
name: 'BrowserSession',
Expand Down
Loading