feat(core): Deprecate configureScope (getsentry#9887)

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/hub/src/index.ts

@@ -112,6 +112,7 @@ export const captureMessage = captureMessageCore;
 /**
  * @deprecated This export has moved to @sentry/core. The @sentry/hub package will be removed in v8.
  */
+// eslint-disable-next-line deprecation/deprecation
 export const configureScope = configureScopeCore;
 
 /**

packages/node-experimental/src/index.ts

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