feat(core): Deprecate configureScope

Instead, users should directly access the current scope via `getCurrentScope()`.
getsentry · Dec 18, 2023 · 5f52d9c · 5f52d9c
1 parent e1d3633
commit 5f52d9c
Show file tree

Hide file tree

Showing 16 changed files with 26 additions and 0 deletions.
diff --git a/MIGRATION.md b/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.

diff --git a/packages/astro/src/index.server.ts b/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

diff --git a/packages/browser/src/exports.ts b/packages/browser/src/exports.ts
@@ -30,6 +30,7 @@ export {
   captureEvent,
   captureMessage,
   close,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   flush,

diff --git a/packages/bun/src/index.ts b/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

diff --git a/packages/core/src/exports.ts b/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);
 }
 

diff --git a/packages/core/src/hub.ts b/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();

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -14,6 +14,7 @@ export {
   captureEvent,
   captureMessage,
   close,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   flush,
   lastEventId,

diff --git a/packages/deno/src/index.ts b/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

diff --git a/packages/hub/src/index.ts b/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;
 
 /**

diff --git a/packages/node-experimental/src/index.ts b/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

diff --git a/packages/node/src/index.ts b/packages/node/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

diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts
@@ -20,6 +20,7 @@ export {
   captureException,
   captureEvent,
   captureMessage,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   // eslint-disable-next-line deprecation/deprecation

diff --git a/packages/serverless/src/index.ts b/packages/serverless/src/index.ts
@@ -24,6 +24,7 @@ export {
   captureMessage,
   captureCheckIn,
   withMonitor,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   getActiveTransaction,

diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -14,6 +14,7 @@ export {
   captureMessage,
   captureCheckIn,
   withMonitor,
+  // eslint-disable-next-line deprecation/deprecation
   configureScope,
   createTransport,
   // eslint-disable-next-line deprecation/deprecation

diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -171,6 +171,7 @@ export interface Hub {
    * Callback to set context information onto the scope.
    *
    * @param callback Callback function that receives Scope.
+   * @deprecated Use `getScope()` directly.
    */
   configureScope(callback: (scope: Scope) => void): void;
 

diff --git a/packages/vercel-edge/src/index.ts b/packages/vercel-edge/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