feat(core): Deprecate scope.getSpan() & scope.setSpan() (#10114)

These APIs are not compatible with OTEL tracing, and thus will not be
public API anymore in v8.

In v8, we'll add new (?) methods to the scope that are "internal", as
for non-node based SDKs we'll still need to keep the active span on the
scope. But these should not be reflected publicly, and not in types'
Scope.

Note that we'll also need to make sure to use types' `Scope` for all
callbacks etc., which we currently don't do.

Author: mydea

MIGRATION.md

@@ -8,6 +8,11 @@ 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.getSpan()` and `scope.setSpan()`
+
+Instead, you can get the currently active span via `Sentry.getActiveSpan()`.
+Setting a span on the scope happens automatically when you use the new performance APIs `startSpan()` and `startSpanManual()`.
+
 ## Deprecate `scope.setTransactionName()`
 
 Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

dev-packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts

@@ -5,6 +5,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';
 export default function handler(req: NextApiRequest, res: NextApiResponse) {
   // eslint-disable-next-line deprecation/deprecation
   const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
+  // eslint-disable-next-line deprecation/deprecation
   Sentry.getCurrentHub().getScope().setSpan(transaction);
 
   // eslint-disable-next-line deprecation/deprecation

dev-packages/node-integration-tests/suites/tracing-new/apollo-graphql/scenario.ts

@@ -30,6 +30,7 @@ const server = new ApolloServer({
 // eslint-disable-next-line deprecation/deprecation
 const transaction = Sentry.startTransaction({ name: 'test_transaction', op: 'transaction' });
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.getCurrentScope().setSpan(transaction);
 
 // eslint-disable-next-line @typescript-eslint/no-floating-promises

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/mongodb/scenario.ts

@@ -22,6 +22,7 @@ async function run(): Promise<void> {
     op: 'transaction',
   });
 
+  // eslint-disable-next-line deprecation/deprecation
   Sentry.getCurrentScope().setSpan(transaction);
 
   try {

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/withConnect/scenario.ts

@@ -25,6 +25,7 @@ const transaction = Sentry.startTransaction({
   name: 'Test Transaction',
 });
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.getCurrentScope().setSpan(transaction);
 
 connection.query('SELECT 1 + 1 AS solution', function () {

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/withoutCallback/scenario.ts

@@ -25,6 +25,7 @@ const transaction = Sentry.startTransaction({
   name: 'Test Transaction',
 });
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.getCurrentScope().setSpan(transaction);
 
 const query = connection.query('SELECT 1 + 1 AS solution');

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/withoutConnect/scenario.ts

@@ -19,6 +19,7 @@ const transaction = Sentry.startTransaction({
   name: 'Test Transaction',
 });
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.getCurrentScope().setSpan(transaction);
 
 connection.query('SELECT 1 + 1 AS solution', function () {

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/pg/scenario.ts

@@ -14,6 +14,7 @@ const transaction = Sentry.startTransaction({
   name: 'Test Transaction',
 });
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.getCurrentScope().setSpan(transaction);
 
 const client = new pg.Client();

dev-packages/node-integration-tests/suites/tracing-new/prisma-orm/scenario.ts

@@ -19,6 +19,7 @@ async function run(): Promise<void> {
     op: 'transaction',
   });
 
+  // eslint-disable-next-line deprecation/deprecation
   Sentry.getCurrentScope().setSpan(transaction);
 
   try {

dev-packages/node-integration-tests/suites/tracing-new/tracePropagationTargets/scenario.ts

@@ -13,6 +13,7 @@ Sentry.init({
 // eslint-disable-next-line deprecation/deprecation
 const transaction = Sentry.startTransaction({ name: 'test_transaction' });
 
+// eslint-disable-next-line deprecation/deprecation
 Sentry.getCurrentScope().setSpan(transaction);
 
 http.get('http://match-this-url.com/api/v0');