feat(browser): Add browserSessionIntegration

Author: Luca Forstner

packages/angular/src/sdk.ts

@@ -2,6 +2,7 @@ import { VERSION } from '@angular/core';
 import type { BrowserOptions } from '@sentry/browser';
 import {
   breadcrumbsIntegration,
+  browserSessionIntegration,
   globalHandlersIntegration,
   httpContextIntegration,
   init as browserInit,
@@ -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`
@@ -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(),
@@ -40,6 +41,12 @@ export function getDefaultIntegrations(): Integration[] {
     dedupeIntegration(),
     httpContextIntegration(),
   ];
+
+  if (options.autoSessionTracking !== false) {
+    integrations.push(browserSessionIntegration());
+  }
+
+  return integrations;
 }
 
 /**

packages/browser/src/index.ts

@@ -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/session';

packages/browser/src/integrations/session.ts

@@ -0,0 +1,32 @@
+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';
+
+export const browserSessionIntegration = defineIntegration(() => {
+  return {
+    name: 'Session',
+    setupOnce() {
+      if (typeof WINDOW.document === 'undefined') {
+        DEBUG_BUILD && logger.warn('Using the sessionIntegration 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 });
+      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();
+        }
+      });
+    },
+  };
+});

packages/browser/src/sdk.ts

@@ -1,6 +1,4 @@
-import { addHistoryInstrumentationHandler } from '@sentry-internal/browser-utils';
 import {
-  captureSession,
   consoleSandbox,
   dedupeIntegration,
   functionToStringIntegration,
@@ -13,7 +11,6 @@ import {
   lastEventId,
   logger,
   stackParserFromStackParserOptions,
-  startSession,
   supportsFetch,
 } from '@sentry/core';
 import type { Client, DsnLike, Integration, Options, UserFeedback } from '@sentry/core';
@@ -26,16 +23,17 @@ import { browserApiErrorsIntegration } from './integrations/browserapierrors';
 import { globalHandlersIntegration } from './integrations/globalhandlers';
 import { httpContextIntegration } from './integrations/httpcontext';
 import { linkedErrorsIntegration } from './integrations/linkederrors';
+import { browserSessionIntegration } from './integrations/session';
 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(),
@@ -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 {
@@ -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);
 }
 
 /**
@@ -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.
  *