feat(core): Deprecate configureScope

Instead, users should directly access the current scope via `getCurrentScope()`.

Author: mydea

MIGRATION.md

@@ -8,6 +8,14 @@ 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 `configureScope` in favor of using `getCurrentScope()`
+
+Instead of updating the scope in a callback via `configureScope()`, you should access it via `getCurrentScope()` and configure it directly:
+
+```js
+Sentry.getCurrentScope().setTag('xx', 'yy');
+```
+
 ## Deprecate `addGlobalEventProcessor` in favor of `addEventProcessor`
 
 Instead of using `addGlobalEventProcessor`, you should use `addEventProcessor` which does not add the event processor globally, but to the current client.

packages/astro/src/index.server.ts

@@ -17,6 +17,7 @@ export {
   captureMessage,
   captureCheckIn,
   withMonitor,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   // eslint-disable-next-line deprecation/deprecation

packages/browser/src/exports.ts

@@ -30,6 +30,7 @@ export {
   captureEvent,
   captureMessage,
   close,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   flush,

packages/bun/src/index.ts

@@ -33,6 +33,7 @@ export {
   captureEvent,
   captureMessage,
   close,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   // eslint-disable-next-line deprecation/deprecation

packages/core/src/exports.ts

@@ -78,8 +78,11 @@ export function captureEvent(event: Event, hint?: EventHint): ReturnType<Hub['ca
 /**
  * Callback to set context information onto the scope.
  * @param callback Callback function that receives Scope.
+ *
+ * @deprecated Use getCurrentScope() directly.
  */
 export function configureScope(callback: (scope: Scope) => void): ReturnType<Hub['configureScope']> {
+  // eslint-disable-next-line deprecation/deprecation
   getCurrentHub().configureScope(callback);
 }
 

packages/core/src/hub.ts

@@ -335,6 +335,8 @@ export class Hub implements HubInterface {
 
   /**
    * @inheritDoc
+   *
+   * @deprecated Use `getScope()` directly.
    */
   public configureScope(callback: (scope: Scope) => void): void {
     const { scope, client } = this.getStackTop();

packages/core/src/index.ts

@@ -14,6 +14,7 @@ export {
   captureEvent,
   captureMessage,
   close,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   flush,
   lastEventId,

packages/deno/src/index.ts

@@ -31,6 +31,7 @@ export {
   captureEvent,
   captureMessage,
   close,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   // eslint-disable-next-line deprecation/deprecation

packages/e2e-tests/test-applications/node-hapi-app/event-proxy-server.ts

@@ -1,5 +1,3 @@
-import type { Envelope, EnvelopeItem, Event } from '@sentry/types';
-import { parseEnvelope } from '@sentry/utils';
 import * as fs from 'fs';
 import * as http from 'http';
 import * as https from 'https';
@@ -8,6 +6,8 @@ import * as os from 'os';
 import * as path from 'path';
 import * as util from 'util';
 import * as zlib from 'zlib';
+import type { Envelope, EnvelopeItem, Event } from '@sentry/types';
+import { parseEnvelope } from '@sentry/utils';
 
 const readFile = util.promisify(fs.readFile);
 const writeFile = util.promisify(fs.writeFile);

packages/e2e-tests/test-applications/node-hapi-app/tests/server.test.ts

@@ -1,4 +1,4 @@
-import { test, expect } from '@playwright/test';
+import { expect, test } from '@playwright/test';
 import axios, { AxiosError, AxiosResponse } from 'axios';
 import { waitForError, waitForTransaction } from '../event-proxy-server';