Merge branch 'develop' into onur/fix-flaky-remix-e2e-tests

Author: AbhiPrasad

MIGRATION.md

@@ -10,6 +10,16 @@ npx @sentry/migr8@latest
 This will let you select which updates to run, and automatically update your code. Make sure to still review all code
 changes!
 
+## Deprecate transaction-related options to `BrowserTracing`
+
+When configuring the `BrowserTracing` integration, some options have been renamed:
+
+- `startTransactionOnPageLoad` --> `spanOnPageLoad`
+- `startTransactionOnLocationChange` --> `spanOnLocationChange`
+- `markBackgroundTransactions` --> `markBackgroundSpan`
+
+Also, `beforeNavigate` is replaced with a `beforeStartSpan` callback, which receives `StartSpanOptions`.
+
 ## Deprecate using `getClient()` to check if the SDK was initialized
 
 In v8, `getClient()` will stop returning `undefined` if `Sentry.init()` was not called. For cases where this may be used
@@ -36,6 +46,7 @@ The following list shows how integrations should be migrated:
 
 | Old                       | New                              | Packages                                                                                                |
 | ------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `new BrowserTracing()`    | `browserTracingIntegration()`    | `@sentry/browser`                                                                                       |
 | `new InboundFilters()`    | `inboundFiltersIntegration()`    | `@sentry/core`, `@sentry/browser`, `@sentry/node`, `@sentry/deno`, `@sentry/bun`, `@sentry/vercel-edge` |
 | `new FunctionToString()`  | `functionToStringIntegration()`  | `@sentry/core`, `@sentry/browser`, `@sentry/node`, `@sentry/deno`, `@sentry/bun`, `@sentry/vercel-edge` |
 | `new LinkedErrors()`      | `linkedErrorsIntegration()`      | `@sentry/core`, `@sentry/browser`, `@sentry/node`, `@sentry/deno`, `@sentry/bun`, `@sentry/vercel-edge` |

dev-packages/node-integration-tests/package.json

@@ -36,6 +36,7 @@
     "apollo-server": "^3.11.1",
     "axios": "^0.27.2",
     "cors": "^2.8.5",
+    "cron": "^3.1.6",
     "express": "^4.17.3",
     "graphql": "^16.3.0",
     "http-terminator": "^3.2.0",

dev-packages/node-integration-tests/suites/cron/node-cron/scenario.ts

@@ -0,0 +1,9 @@
+import * as Sentry from '@sentry/node';
+import { CronJob } from 'cron';
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const CronJobWithCheckIn = Sentry.cron.instrumentCron(CronJob, 'my-cron-job');
+
+setTimeout(() => {
+  process.exit(0);
+}, 1_000);

dev-packages/node-integration-tests/suites/cron/node-cron/test.ts

@@ -0,0 +1,9 @@
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+afterAll(() => {
+  cleanupChildProcesses();
+});
+
+test('node-cron types should match', done => {
+  createRunner(__dirname, 'scenario.ts').ensureNoErrorOutput().start(done);
+});

dev-packages/node-integration-tests/utils/runner.ts

@@ -70,6 +70,7 @@ export function createRunner(...paths: string[]) {
   const flags: string[] = [];
   const ignored: EnvelopeItemType[] = [];
   let withSentryServer = false;
+  let ensureNoErrorOutput = false;
 
   if (testPath.endsWith('.ts')) {
     flags.push('-r', 'ts-node/register');
@@ -92,6 +93,10 @@ export function createRunner(...paths: string[]) {
       ignored.push(...types);
       return this;
     },
+    ensureNoErrorOutput: function () {
+      ensureNoErrorOutput = true;
+      return this;
+    },
     start: function (done?: (e?: unknown) => void) {
       const expectedEnvelopeCount = expectedEnvelopes.length;
 
@@ -190,8 +195,19 @@ export function createRunner(...paths: string[]) {
 
         CHILD_PROCESSES.add(child);
 
+        if (ensureNoErrorOutput) {
+          child.stderr.on('data', (data: Buffer) => {
+            const output = data.toString();
+            complete(new Error(`Expected no error output but got: '${output}'`));
+          });
+        }
+
         child.on('close', () => {
           hasExited = true;
+
+          if (ensureNoErrorOutput) {
+            complete();
+          }
         });
 
         // Pass error to done to end the test quickly

packages/astro/src/client/sdk.ts

@@ -1,6 +1,6 @@
 import type { BrowserOptions } from '@sentry/browser';
 import {
-  BrowserTracing,
+  browserTracingIntegration,
   getDefaultIntegrations as getBrowserDefaultIntegrations,
   init as initBrowserSdk,
   setTag,
@@ -34,7 +34,7 @@ function getDefaultIntegrations(options: BrowserOptions): Integration[] | undefi
   // in which case everything inside will get treeshaken away
   if (typeof __SENTRY_TRACING__ === 'undefined' || __SENTRY_TRACING__) {
     if (hasTracingEnabled(options)) {
-      return [...getBrowserDefaultIntegrations(options), new BrowserTracing()];
+      return [...getBrowserDefaultIntegrations(options), browserTracingIntegration()];
     }
   }
 

packages/astro/test/client/sdk.test.ts

@@ -1,7 +1,7 @@
-import type { BrowserClient } from '@sentry/browser';
+import type { BrowserClient, BrowserTracing } from '@sentry/browser';
 import { getCurrentScope } from '@sentry/browser';
 import * as SentryBrowser from '@sentry/browser';
-import { BrowserTracing, SDK_VERSION, WINDOW, getClient } from '@sentry/browser';
+import { SDK_VERSION, WINDOW, browserTracingIntegration, getClient } from '@sentry/browser';
 import { vi } from 'vitest';
 
 import { init } from '../../../astro/src/client/sdk';
@@ -103,12 +103,13 @@ describe('Sentry client SDK', () => {
       it('Overrides the automatically default BrowserTracing instance with a a user-provided instance', () => {
         init({
           dsn: 'https://[email protected]/1337',
-          integrations: [new BrowserTracing({ finalTimeout: 10, startTransactionOnLocationChange: false })],
+          integrations: [browserTracingIntegration({ finalTimeout: 10, startTransactionOnLocationChange: false })],
           enableTracing: true,
         });
 
         const integrationsToInit = browserInit.mock.calls[0][0]?.defaultIntegrations;
 
+        // eslint-disable-next-line deprecation/deprecation
         const browserTracing = getClient<BrowserClient>()?.getIntegrationByName('BrowserTracing') as BrowserTracing;
         const options = browserTracing.options;
 

packages/browser/src/index.bundle.feedback.ts

@@ -1,18 +1,27 @@
 // This is exported so the loader does not fail when switching off Replay/Tracing
 import { Feedback, feedbackIntegration } from '@sentry-internal/feedback';
-import { BrowserTracing, Replay, addTracingExtensions, replayIntegration } from '@sentry-internal/integration-shims';
+import {
+  BrowserTracing,
+  Replay,
+  addTracingExtensions,
+  browserTracingIntegration,
+  replayIntegration,
+} from '@sentry-internal/integration-shims';
 
 import * as Sentry from './index.bundle.base';
 
 // TODO (v8): Remove this as it was only needed for backwards compatibility
 // eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.Replay = Replay;
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.BrowserTracing = BrowserTracing;
 
 export * from './index.bundle.base';
 export {
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
+  browserTracingIntegration,
   addTracingExtensions,
   // eslint-disable-next-line deprecation/deprecation
   Replay,

packages/browser/src/index.bundle.replay.ts

@@ -3,6 +3,7 @@ import {
   BrowserTracing,
   Feedback,
   addTracingExtensions,
+  browserTracingIntegration,
   feedbackIntegration,
 } from '@sentry-internal/integration-shims';
 import { Replay, replayIntegration } from '@sentry/replay';
@@ -13,11 +14,14 @@ import * as Sentry from './index.bundle.base';
 // eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.Replay = Replay;
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.BrowserTracing = BrowserTracing;
 
 export * from './index.bundle.base';
 export {
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
+  browserTracingIntegration,
   addTracingExtensions,
   // eslint-disable-next-line deprecation/deprecation
   Replay,

packages/browser/src/index.bundle.tracing.replay.feedback.ts

@@ -1,5 +1,5 @@
 import { Feedback, feedbackIntegration } from '@sentry-internal/feedback';
-import { BrowserTracing, Span, addExtensionMethods } from '@sentry-internal/tracing';
+import { BrowserTracing, Span, addExtensionMethods, browserTracingIntegration } from '@sentry-internal/tracing';
 import { Replay, replayIntegration } from '@sentry/replay';
 
 import * as Sentry from './index.bundle.base';
@@ -10,6 +10,7 @@ import * as Sentry from './index.bundle.base';
 // eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.Replay = Replay;
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.BrowserTracing = BrowserTracing;
 
 // We are patching the global object with our hub extension methods
@@ -22,7 +23,9 @@ export {
   Replay,
   feedbackIntegration,
   replayIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
+  browserTracingIntegration,
   Span,
   addExtensionMethods,
 };

packages/browser/src/index.bundle.tracing.replay.ts

@@ -1,5 +1,5 @@
 import { Feedback, feedbackIntegration } from '@sentry-internal/integration-shims';
-import { BrowserTracing, Span, addExtensionMethods } from '@sentry-internal/tracing';
+import { BrowserTracing, Span, addExtensionMethods, browserTracingIntegration } from '@sentry-internal/tracing';
 import { Replay, replayIntegration } from '@sentry/replay';
 
 import * as Sentry from './index.bundle.base';
@@ -10,6 +10,7 @@ import * as Sentry from './index.bundle.base';
 // eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.Replay = Replay;
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.BrowserTracing = BrowserTracing;
 
 // We are patching the global object with our hub extension methods
@@ -22,7 +23,9 @@ export {
   Replay,
   replayIntegration,
   feedbackIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
+  browserTracingIntegration,
   Span,
   addExtensionMethods,
 };

packages/browser/src/index.bundle.tracing.ts

@@ -1,6 +1,6 @@
 // This is exported so the loader does not fail when switching off Replay
 import { Feedback, Replay, feedbackIntegration, replayIntegration } from '@sentry-internal/integration-shims';
-import { BrowserTracing, Span, addExtensionMethods } from '@sentry-internal/tracing';
+import { BrowserTracing, Span, addExtensionMethods, browserTracingIntegration } from '@sentry-internal/tracing';
 
 import * as Sentry from './index.bundle.base';
 
@@ -10,6 +10,7 @@ import * as Sentry from './index.bundle.base';
 // eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.Replay = Replay;
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.BrowserTracing = BrowserTracing;
 
 // We are patching the global object with our hub extension methods
@@ -22,7 +23,9 @@ export {
   Replay,
   feedbackIntegration,
   replayIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
+  browserTracingIntegration,
   Span,
   addExtensionMethods,
 };

packages/browser/src/index.bundle.ts

@@ -4,6 +4,7 @@ import {
   Feedback,
   Replay,
   addTracingExtensions,
+  browserTracingIntegration,
   feedbackIntegration,
   replayIntegration,
 } from '@sentry-internal/integration-shims';
@@ -14,16 +15,19 @@ import * as Sentry from './index.bundle.base';
 // eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.Replay = Replay;
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.Integrations.BrowserTracing = BrowserTracing;
 
 export * from './index.bundle.base';
 export {
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
   addTracingExtensions,
   // eslint-disable-next-line deprecation/deprecation
   Replay,
   // eslint-disable-next-line deprecation/deprecation
   Feedback,
+  browserTracingIntegration,
   feedbackIntegration,
   replayIntegration,
 };

packages/browser/src/index.ts

@@ -54,7 +54,9 @@ export {
 } from '@sentry-internal/feedback';
 
 export {
+  // eslint-disable-next-line deprecation/deprecation
   BrowserTracing,
+  browserTracingIntegration,
   defaultRequestInstrumentationOptions,
   instrumentOutgoingRequests,
 } from '@sentry-internal/tracing';

packages/browser/test/unit/profiling/integration.test.ts

@@ -44,7 +44,7 @@ describe('BrowserProfilingIntegration', () => {
           send,
         };
       },
-      integrations: [new Sentry.BrowserTracing(), new BrowserProfilingIntegration()],
+      integrations: [Sentry.browserTracingIntegration(), new BrowserProfilingIntegration()],
     });
 
     const client = Sentry.getClient<BrowserClient>();