feat(browser): Include culture context with events (#19148)

logaretm · web-flow · commit a3cb664bc968 · 2026-02-06T16:40:27.000+01:00
This PR includes the `culture` context containing the `locale`, `timeZone` and `calendar` information as outlined by the [Contexts interface doc](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/#culture-context). I had this lying in my stash since the last Triage, just got some time to tidy it up and PR it. closes #18801
diff --git a/.size-limit.js b/.size-limit.js
@@ -8,7 +8,7 @@ module.exports = [
     path: 'packages/browser/build/npm/esm/prod/index.js',
     import: createImport('init'),
     gzip: true,
-    limit: '25.5 KB',
+    limit: '26 KB',
   },
   {
     name: '@sentry/browser - with treeshaking flags',
@@ -148,7 +148,7 @@ module.exports = [
     import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
     ignore: ['react/jsx-runtime'],
     gzip: true,
-    limit: '44.6 KB',
+    limit: '45 KB',
   },
   // Vue SDK (ESM)
   {
@@ -163,22 +163,22 @@ module.exports = [
     path: 'packages/vue/build/esm/index.js',
     import: createImport('init', 'browserTracingIntegration'),
     gzip: true,
-    limit: '44.1 KB',
+    limit: '45 KB',
   },
   // Svelte SDK (ESM)
   {
     name: '@sentry/svelte',
     path: 'packages/svelte/build/esm/index.js',
     import: createImport('init'),
     gzip: true,
-    limit: '25.5 KB',
+    limit: '26 KB',
   },
   // Browser CDN bundles
   {
     name: 'CDN Bundle',
     path: createCDNPath('bundle.min.js'),
     gzip: true,
-    limit: '28 KB',
+    limit: '29 KB',
   },
   {
     name: 'CDN Bundle (incl. Tracing)',
@@ -234,7 +234,7 @@ module.exports = [
     path: createCDNPath('bundle.min.js'),
     gzip: false,
     brotli: false,
-    limit: '82 KB',
+    limit: '83 KB',
   },
   {
     name: 'CDN Bundle (incl. Tracing) - uncompressed',
diff --git a/dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts b/dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts
@@ -39,6 +39,11 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
     type: 'feedback',
     breadcrumbs: expect.any(Array),
     contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
       feedback: {
         contact_email: 'janedoe@example.org',
         message: 'my example feedback',
diff --git a/dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts b/dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts
@@ -37,6 +37,11 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
     type: 'feedback',
     breadcrumbs: expect.any(Array),
     contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
       feedback: {
         contact_email: 'janedoe@example.org',
         message: 'my example feedback',
diff --git a/dev-packages/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts b/dev-packages/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts
@@ -72,6 +72,11 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
     type: 'feedback',
     breadcrumbs: expect.any(Array),
     contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
       feedback: {
         contact_email: 'janedoe@example.org',
         message: 'my example feedback',
diff --git a/dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts b/dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts
@@ -37,6 +37,11 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
     type: 'feedback',
     breadcrumbs: expect.any(Array),
     contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
       feedback: {
         contact_email: 'janedoe@example.org',
         message: 'my example feedback',
diff --git a/dev-packages/browser-integration-tests/suites/integrations/cultureContext/init.js b/dev-packages/browser-integration-tests/suites/integrations/cultureContext/init.js
@@ -0,0 +1,20 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+const integrations = Sentry.getDefaultIntegrations({}).filter(
+  defaultIntegration => defaultIntegration.name === 'CultureContext',
+);
+
+const client = new Sentry.BrowserClient({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  transport: Sentry.makeFetchTransport,
+  stackParser: Sentry.defaultStackParser,
+  integrations: integrations,
+});
+
+const scope = new Sentry.Scope();
+scope.setClient(client);
+client.init();
+
+window._sentryScope = scope;
diff --git a/dev-packages/browser-integration-tests/suites/integrations/cultureContext/subject.js b/dev-packages/browser-integration-tests/suites/integrations/cultureContext/subject.js
@@ -0,0 +1 @@
+window._sentryScope.captureException(new Error('test error'));
diff --git a/dev-packages/browser-integration-tests/suites/integrations/cultureContext/test.ts b/dev-packages/browser-integration-tests/suites/integrations/cultureContext/test.ts
@@ -0,0 +1,18 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/core';
+import { sentryTest } from '../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest } from '../../../utils/helpers';
+
+sentryTest('cultureContextIntegration captures locale, timezone, and calendar', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
+
+  const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);
+
+  expect(eventData.exception?.values).toHaveLength(1);
+
+  expect(eventData.contexts?.culture).toEqual({
+    locale: expect.any(String),
+    timezone: expect.any(String),
+    calendar: expect.any(String),
+  });
+});
diff --git a/dev-packages/browser-integration-tests/suites/public-api/debug/test.ts b/dev-packages/browser-integration-tests/suites/public-api/debug/test.ts
@@ -33,6 +33,7 @@ sentryTest('logs debug messages correctly', async ({ getLocalTestUrl, page }) =>
           'Sentry Logger [log]: Integration installed: LinkedErrors',
           'Sentry Logger [log]: Integration installed: Dedupe',
           'Sentry Logger [log]: Integration installed: HttpContext',
+          'Sentry Logger [log]: Integration installed: CultureContext',
           'Sentry Logger [warn]: Discarded session because of missing or non-string release',
           'Sentry Logger [log]: Integration installed: BrowserSession',
           'test log',
diff --git a/dev-packages/browser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts b/dev-packages/browser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts
@@ -83,7 +83,7 @@ sentryTest(
     });
 
     expect(transactionEnvelopeItem).toEqual({
-      contexts: {
+      contexts: expect.objectContaining({
         trace: {
           data: {
             'sentry.origin': 'manual',
@@ -94,7 +94,7 @@ sentryTest(
           span_id: parentSpanId,
           trace_id: traceId,
         },
-      },
+      }),
       environment: 'production',
       event_id: expect.any(String),
       platform: 'javascript',
diff --git a/dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts b/dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts
@@ -32,6 +32,13 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
     replay_type: 'session',
     event_id: expect.stringMatching(/\w{32}/),
     environment: 'production',
+    contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
+    },
     sdk: {
       integrations: expect.arrayContaining([
         'InboundFilters',
@@ -73,6 +80,13 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
     replay_type: 'session',
     event_id: expect.stringMatching(/\w{32}/),
     environment: 'production',
+    contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
+    },
     sdk: {
       integrations: expect.arrayContaining([
         'InboundFilters',
diff --git a/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts b/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts
@@ -32,6 +32,13 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
     replay_type: 'session',
     event_id: expect.stringMatching(/\w{32}/),
     environment: 'production',
+    contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
+    },
     sdk: {
       integrations: expect.arrayContaining([
         'InboundFilters',
@@ -73,6 +80,13 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
     replay_type: 'session',
     event_id: expect.stringMatching(/\w{32}/),
     environment: 'production',
+    contexts: {
+      culture: {
+        locale: expect.any(String),
+        timezone: expect.any(String),
+        calendar: expect.any(String),
+      },
+    },
     sdk: {
       integrations: expect.arrayContaining([
         'InboundFilters',
diff --git a/dev-packages/browser-integration-tests/utils/replayEventTemplates.ts b/dev-packages/browser-integration-tests/utils/replayEventTemplates.ts
@@ -15,6 +15,13 @@ const DEFAULT_REPLAY_EVENT = {
   replay_type: 'session',
   event_id: expect.stringMatching(/\w{32}/),
   environment: 'production',
+  contexts: {
+    culture: {
+      locale: expect.any(String),
+      timezone: expect.any(String),
+      calendar: expect.any(String),
+    },
+  },
   sdk: {
     integrations: expect.arrayContaining([
       'InboundFilters',
@@ -25,6 +32,7 @@ const DEFAULT_REPLAY_EVENT = {
       'LinkedErrors',
       'Dedupe',
       'HttpContext',
+      'CultureContext',
       'BrowserSession',
       'Replay',
     ]),
diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/transactions.test.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/transactions.test.ts
@@ -21,7 +21,7 @@ test('Sends a pageload transaction', async ({ page }) => {
       transaction: '/',
       transaction_info: { source: 'url' },
       type: 'transaction',
-      contexts: {
+      contexts: expect.objectContaining({
         react: {
           version: expect.any(String),
         },
@@ -40,7 +40,7 @@ test('Sends a pageload transaction', async ({ page }) => {
             'sentry.source': 'url',
           }),
         },
-      },
+      }),
       request: {
         headers: {
           'User-Agent': expect.any(String),
diff --git a/dev-packages/e2e-tests/test-applications/nextjs-pages-dir/tests/transactions.test.ts b/dev-packages/e2e-tests/test-applications/nextjs-pages-dir/tests/transactions.test.ts
@@ -21,7 +21,7 @@ test('Sends a pageload transaction', async ({ page }) => {
       transaction: '/',
       transaction_info: { source: 'route' },
       type: 'transaction',
-      contexts: {
+      contexts: expect.objectContaining({
         react: {
           version: expect.any(String),
         },
@@ -40,7 +40,7 @@ test('Sends a pageload transaction', async ({ page }) => {
             'sentry.source': 'route',
           }),
         },
-      },
+      }),
       request: {
         headers: {
           'User-Agent': expect.any(String),
@@ -70,7 +70,7 @@ test('Sends a navigation transaction', async ({ page }) => {
       transaction: '/user/[id]',
       transaction_info: { source: 'route' },
       type: 'transaction',
-      contexts: {
+      contexts: expect.objectContaining({
         react: {
           version: expect.any(String),
         },
@@ -98,7 +98,7 @@ test('Sends a navigation transaction', async ({ page }) => {
             },
           ],
         },
-      },
+      }),
       request: {
         headers: {
           'User-Agent': expect.any(String),
diff --git a/packages/angular/src/sdk.ts b/packages/angular/src/sdk.ts
@@ -3,6 +3,7 @@ import type { BrowserOptions } from '@sentry/browser';
 import {
   breadcrumbsIntegration,
   browserSessionIntegration,
+  cultureContextIntegration,
   globalHandlersIntegration,
   httpContextIntegration,
   init as browserInit,
@@ -43,6 +44,7 @@ export function getDefaultIntegrations(_options: BrowserOptions = {}): Integrati
     linkedErrorsIntegration(),
     dedupeIntegration(),
     httpContextIntegration(),
+    cultureContextIntegration(),
     browserSessionIntegration(),
   ];
 }
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -75,6 +75,7 @@ export type { Span, FeatureFlagsIntegration } from '@sentry/core';
 export { makeBrowserOfflineTransport } from './transports/offline';
 export { browserProfilingIntegration } from './profiling/integration';
 export { spotlightBrowserIntegration } from './integrations/spotlight';
+export { cultureContextIntegration } from './integrations/culturecontext';
 export { browserSessionIntegration } from './integrations/browsersession';
 export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
 export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
diff --git a/packages/browser/src/integrations/culturecontext.ts b/packages/browser/src/integrations/culturecontext.ts
@@ -0,0 +1,60 @@
+import type { CultureContext, IntegrationFn } from '@sentry/core';
+import { defineIntegration } from '@sentry/core';
+import { WINDOW } from '../helpers';
+
+const INTEGRATION_NAME = 'CultureContext';
+
+const _cultureContextIntegration = (() => {
+  return {
+    name: INTEGRATION_NAME,
+    preprocessEvent(event) {
+      const culture = getCultureContext();
+
+      if (culture) {
+        event.contexts = {
+          ...event.contexts,
+          culture: { ...culture, ...event.contexts?.culture },
+        };
+      }
+    },
+  };
+}) satisfies IntegrationFn;
+
+/**
+ * Captures culture context from the browser.
+ *
+ * Enabled by default.
+ *
+ * @example
+ * ```js
+ * import * as Sentry from '@sentry/browser';
+ *
+ * Sentry.init({
+ *   integrations: [Sentry.cultureContextIntegration()],
+ * });
+ * ```
+ */
+export const cultureContextIntegration = defineIntegration(_cultureContextIntegration);
+
+/**
+ * Returns the culture context from the browser's Intl API.
+ */
+function getCultureContext(): CultureContext | undefined {
+  try {
+    const intl = (WINDOW as { Intl?: typeof Intl }).Intl;
+    if (!intl) {
+      return undefined;
+    }
+
+    const options = intl.DateTimeFormat().resolvedOptions();
+
+    return {
+      locale: options.locale,
+      timezone: options.timeZone,
+      calendar: options.calendar,
+    };
+  } catch {
+    // Ignore errors
+    return undefined;
+  }
+}
diff --git a/packages/browser/src/sdk.ts b/packages/browser/src/sdk.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+window._sentryScope.captureException(new Error('test error'));`