feat(core): Deprecate getActiveTransaction() & scope.getTransaction() (#10098)

A lot to refactor for us... but for now, let's deprecate this.

Author: mydea

MIGRATION.md

@@ -8,6 +8,10 @@ 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 `scope.getTransaction()` and `getActiveTransaction()`
+
+Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
+
 ## Deprecate arguments for `startSpan()` APIs
 
 In v8, the API to start a new span will be reduced from the currently available options.

dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/server.ts

@@ -26,6 +26,7 @@ app.use(Sentry.Handlers.tracingHandler());
 app.use(cors());
 
 app.get('/test/express', (_req, res) => {
+  // eslint-disable-next-line deprecation/deprecation
   const transaction = Sentry.getCurrentHub().getScope().getTransaction();
   if (transaction) {
     // eslint-disable-next-line deprecation/deprecation

dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts

@@ -29,6 +29,7 @@ app.use(Sentry.Handlers.tracingHandler());
 app.use(cors());
 
 app.get('/test/express', (_req, res) => {
+  // eslint-disable-next-line deprecation/deprecation
   const transaction = Sentry.getCurrentHub().getScope().getTransaction();
   if (transaction) {
     // eslint-disable-next-line deprecation/deprecation

packages/angular-ivy/README.md

@@ -215,33 +215,22 @@ export class FooterComponent implements OnInit {
 }
 ```
 
-You can also add your own custom spans by attaching them to the current active transaction using `getActiveTransaction`
-helper. For example, if you'd like to track the duration of Angular boostraping process, you can do it as follows:
+You can also add your own custom spans via `startSpan()`. For example, if you'd like to track the duration of Angular boostraping process, you can do it as follows:
 
 ```javascript
 import { enableProdMode } from '@angular/core';
 import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
-import { init, getActiveTransaction } from '@sentry/angular-ivy';
+import { init, startSpan } from '@sentry/angular';
 
 import { AppModule } from './app/app.module';
 
 // ...
-
-const activeTransaction = getActiveTransaction();
-const boostrapSpan =
-  activeTransaction &&
-  activeTransaction.startChild({
-    description: 'platform-browser-dynamic',
-    op: 'ui.angular.bootstrap',
-  });
-
-platformBrowserDynamic()
-  .bootstrapModule(AppModule)
-  .then(() => console.log(`Bootstrap success`))
-  .catch(err => console.error(err));
-  .finally(() => {
-    if (bootstrapSpan) {
-      boostrapSpan.finish();
-    }
-  })
+startSpan({
+  name: 'platform-browser-dynamic',
+  op: 'ui.angular.bootstrap'
+  },
+  async () => {
+    await platformBrowserDynamic().bootstrapModule(AppModule);
+  }
+);
 ```

packages/angular/README.md

@@ -215,33 +215,22 @@ export class FooterComponent implements OnInit {
 }
 ```
 
-You can also add your own custom spans by attaching them to the current active transaction using `getActiveTransaction`
-helper. For example, if you'd like to track the duration of Angular boostraping process, you can do it as follows:
+You can also add your own custom spans via `startSpan()`. For example, if you'd like to track the duration of Angular boostraping process, you can do it as follows:
 
 ```javascript
 import { enableProdMode } from '@angular/core';
 import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
-import { init, getActiveTransaction } from '@sentry/angular';
+import { init, startSpan } from '@sentry/angular';
 
 import { AppModule } from './app/app.module';
 
 // ...
-
-const activeTransaction = getActiveTransaction();
-const boostrapSpan =
-  activeTransaction &&
-  activeTransaction.startChild({
-    description: 'platform-browser-dynamic',
-    op: 'ui.angular.bootstrap',
-  });
-
-platformBrowserDynamic()
-  .bootstrapModule(AppModule)
-  .then(() => console.log(`Bootstrap success`))
-  .catch(err => console.error(err));
-  .finally(() => {
-    if (bootstrapSpan) {
-      boostrapSpan.finish();
-    }
-  })
+startSpan({
+  name: 'platform-browser-dynamic',
+  op: 'ui.angular.bootstrap'
+  },
+  async () => {
+    await platformBrowserDynamic().bootstrapModule(AppModule);
+  }
+);
 ```

packages/angular/src/index.ts

@@ -5,6 +5,7 @@ export * from '@sentry/browser';
 export { init } from './sdk';
 export { createErrorHandler, SentryErrorHandler } from './errorhandler';
 export {
+  // eslint-disable-next-line deprecation/deprecation
   getActiveTransaction,
   // TODO `instrumentAngularRouting` is just an alias for `routingInstrumentation`; deprecate the latter at some point
   instrumentAngularRouting, // new name

packages/angular/src/tracing.ts

@@ -47,9 +47,12 @@ export function routingInstrumentation(
 export const instrumentAngularRouting = routingInstrumentation;
 
 /**
- * Grabs active transaction off scope
+ * Grabs active transaction off scope.
+ *
+ * @deprecated You should not rely on the transaction, but just use `startSpan()` APIs instead.
  */
 export function getActiveTransaction(): Transaction | undefined {
+  // eslint-disable-next-line deprecation/deprecation
   return getCurrentScope().getTransaction();
 }
 
@@ -69,6 +72,7 @@ export class TraceService implements OnDestroy {
       }
 
       const strippedUrl = stripUrlQueryAndFragment(navigationEvent.url);
+      // eslint-disable-next-line deprecation/deprecation
       let activeTransaction = getActiveTransaction();
 
       if (!activeTransaction && stashedStartTransactionOnLocationChange) {
@@ -116,6 +120,7 @@ export class TraceService implements OnDestroy {
         (event.state as unknown as RouterState & { root: ActivatedRouteSnapshot }).root,
       );
 
+      // eslint-disable-next-line deprecation/deprecation
       const transaction = getActiveTransaction();
       // TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
       if (transaction && transaction.metadata.source === 'url') {
@@ -182,6 +187,7 @@ export class TraceDirective implements OnInit, AfterViewInit {
       this.componentName = UNKNOWN_COMPONENT;
     }
 
+    // eslint-disable-next-line deprecation/deprecation
     const activeTransaction = getActiveTransaction();
     if (activeTransaction) {
       // eslint-disable-next-line deprecation/deprecation
@@ -225,6 +231,7 @@ export function TraceClassDecorator(): ClassDecorator {
     const originalOnInit = target.prototype.ngOnInit;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     target.prototype.ngOnInit = function (...args: any[]): ReturnType<typeof originalOnInit> {
+      // eslint-disable-next-line deprecation/deprecation
       const activeTransaction = getActiveTransaction();
       if (activeTransaction) {
         // eslint-disable-next-line deprecation/deprecation
@@ -263,6 +270,7 @@ export function TraceMethodDecorator(): MethodDecorator {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     descriptor.value = function (...args: any[]): ReturnType<typeof originalMethod> {
       const now = timestampInSeconds();
+      // eslint-disable-next-line deprecation/deprecation
       const activeTransaction = getActiveTransaction();
       if (activeTransaction) {
         // eslint-disable-next-line deprecation/deprecation

packages/astro/src/index.server.ts

@@ -22,6 +22,7 @@ export {
   createTransport,
   // eslint-disable-next-line deprecation/deprecation
   extractTraceparentData,
+  // eslint-disable-next-line deprecation/deprecation
   getActiveTransaction,
   getHubFromCarrier,
   getCurrentHub,

packages/browser/src/index.ts

@@ -46,6 +46,7 @@ export {
   setMeasurement,
   // eslint-disable-next-line deprecation/deprecation
   extractTraceparentData,
+  // eslint-disable-next-line deprecation/deprecation
   getActiveTransaction,
   spanStatusfromHttpCode,
   // eslint-disable-next-line deprecation/deprecation

packages/browser/src/profiling/integration.ts

@@ -24,6 +24,7 @@ const browserProfilingIntegration: IntegrationFn = () => {
     setup(client) {
       const scope = getCurrentScope();
 
+      // eslint-disable-next-line deprecation/deprecation
       const transaction = scope.getTransaction();
 
       if (transaction && isAutomatedPageLoadTransaction(transaction)) {