ref: Make scope setters on hub only write to isolation scope (#10572)

Author: lforst

packages/astro/test/client/sdk.test.ts

@@ -1,10 +1,11 @@
 import type { BrowserClient } from '@sentry/browser';
 import { getActiveSpan } from '@sentry/browser';
-import { browserTracingIntegration, getCurrentScope } from '@sentry/browser';
+import { browserTracingIntegration } from '@sentry/browser';
 import * as SentryBrowser from '@sentry/browser';
 import { BrowserTracing, SDK_VERSION, WINDOW, getClient } from '@sentry/browser';
 import { vi } from 'vitest';
 
+import { getIsolationScope } from '@sentry/core';
 import { init } from '../../../astro/src/client/sdk';
 
 const browserInit = vi.spyOn(SentryBrowser, 'init');
@@ -38,16 +39,16 @@ describe('Sentry client SDK', () => {
       );
     });
 
-    it('sets the runtime tag on the scope', () => {
-      const currentScope = getCurrentScope();
+    it('sets the runtime tag on the isolation scope', () => {
+      const isolationScope = getIsolationScope();
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({});
+      expect(isolationScope._tags).toEqual({});
 
       init({ dsn: 'https://[email protected]/1337' });
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({ runtime: 'browser' });
+      expect(isolationScope._tags).toEqual({ runtime: 'browser' });
     });
 
     describe('automatically adds integrations', () => {

packages/astro/test/server/sdk.test.ts

@@ -36,16 +36,16 @@ describe('Sentry server SDK', () => {
       );
     });
 
-    it('sets the runtime tag on the scope', () => {
-      const currentScope = SentryNode.getCurrentScope();
+    it('sets the runtime tag on the isolation scope', () => {
+      const isolationScope = SentryNode.getIsolationScope();
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({});
+      expect(isolationScope._tags).toEqual({});
 
       init({ dsn: 'https://[email protected]/1337' });
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({ runtime: 'node' });
+      expect(isolationScope._tags).toEqual({ runtime: 'node' });
     });
   });
 });

packages/core/src/hub.ts

@@ -439,9 +439,6 @@ export class Hub implements HubInterface {
    * @deprecated Use `Sentry.setUser()` instead.
    */
   public setUser(user: User | null): void {
-    // TODO(v8): The top level `Sentry.setUser()` function should write ONLY to the isolation scope.
-    // eslint-disable-next-line deprecation/deprecation
-    this.getScope().setUser(user);
     // eslint-disable-next-line deprecation/deprecation
     this.getIsolationScope().setUser(user);
   }
@@ -451,9 +448,6 @@ export class Hub implements HubInterface {
    * @deprecated Use `Sentry.setTags()` instead.
    */
   public setTags(tags: { [key: string]: Primitive }): void {
-    // TODO(v8): The top level `Sentry.setTags()` function should write ONLY to the isolation scope.
-    // eslint-disable-next-line deprecation/deprecation
-    this.getScope().setTags(tags);
     // eslint-disable-next-line deprecation/deprecation
     this.getIsolationScope().setTags(tags);
   }
@@ -463,9 +457,6 @@ export class Hub implements HubInterface {
    * @deprecated Use `Sentry.setExtras()` instead.
    */
   public setExtras(extras: Extras): void {
-    // TODO(v8): The top level `Sentry.setExtras()` function should write ONLY to the isolation scope.
-    // eslint-disable-next-line deprecation/deprecation
-    this.getScope().setExtras(extras);
     // eslint-disable-next-line deprecation/deprecation
     this.getIsolationScope().setExtras(extras);
   }
@@ -475,9 +466,6 @@ export class Hub implements HubInterface {
    * @deprecated Use `Sentry.setTag()` instead.
    */
   public setTag(key: string, value: Primitive): void {
-    // TODO(v8): The top level `Sentry.setTag()` function should write ONLY to the isolation scope.
-    // eslint-disable-next-line deprecation/deprecation
-    this.getScope().setTag(key, value);
     // eslint-disable-next-line deprecation/deprecation
     this.getIsolationScope().setTag(key, value);
   }
@@ -487,9 +475,6 @@ export class Hub implements HubInterface {
    * @deprecated Use `Sentry.setExtra()` instead.
    */
   public setExtra(key: string, extra: Extra): void {
-    // TODO(v8): The top level `Sentry.setExtra()` function should write ONLY to the isolation scope.
-    // eslint-disable-next-line deprecation/deprecation
-    this.getScope().setExtra(key, extra);
     // eslint-disable-next-line deprecation/deprecation
     this.getIsolationScope().setExtra(key, extra);
   }
@@ -500,9 +485,6 @@ export class Hub implements HubInterface {
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public setContext(name: string, context: { [key: string]: any } | null): void {
-    // TODO(v8): The top level `Sentry.setContext()` function should write ONLY to the isolation scope.
-    // eslint-disable-next-line deprecation/deprecation
-    this.getScope().setContext(name, context);
     // eslint-disable-next-line deprecation/deprecation
     this.getIsolationScope().setContext(name, context);
   }

packages/sveltekit/src/client/sdk.ts

@@ -1,7 +1,7 @@
-import { applySdkMetadata, hasTracingEnabled } from '@sentry/core';
+import { applySdkMetadata, hasTracingEnabled, setTag } from '@sentry/core';
 import type { BrowserOptions, browserTracingIntegration } from '@sentry/svelte';
 import { getDefaultIntegrations as getDefaultSvelteIntegrations } from '@sentry/svelte';
-import { WINDOW, getCurrentScope, init as initSvelteSdk } from '@sentry/svelte';
+import { WINDOW, init as initSvelteSdk } from '@sentry/svelte';
 import type { Integration } from '@sentry/types';
 
 import {
@@ -42,7 +42,7 @@ export function init(options: BrowserOptions): void {
     restoreFetch(actualFetch);
   }
 
-  getCurrentScope().setTag('runtime', 'browser');
+  setTag('runtime', 'browser');
 }
 
 // TODO v8: Remove this again

packages/sveltekit/src/server/sdk.ts

@@ -1,4 +1,4 @@
-import { applySdkMetadata, getCurrentScope } from '@sentry/core';
+import { applySdkMetadata, setTag } from '@sentry/core';
 import type { NodeOptions } from '@sentry/node';
 import { getDefaultIntegrations as getDefaultNodeIntegrations } from '@sentry/node';
 import { init as initNodeSdk } from '@sentry/node';
@@ -19,5 +19,5 @@ export function init(options: NodeOptions): void {
 
   initNodeSdk(opts);
 
-  getCurrentScope().setTag('runtime', 'node');
+  setTag('runtime', 'node');
 }

packages/sveltekit/test/client/sdk.test.ts

@@ -1,4 +1,4 @@
-import { getClient, getCurrentScope } from '@sentry/core';
+import { getClient, getIsolationScope } from '@sentry/core';
 import type { BrowserClient } from '@sentry/svelte';
 import * as SentrySvelte from '@sentry/svelte';
 import { SDK_VERSION, WINDOW, browserTracingIntegration } from '@sentry/svelte';
@@ -38,16 +38,16 @@ describe('Sentry client SDK', () => {
       );
     });
 
-    it('sets the runtime tag on the scope', () => {
-      const currentScope = getCurrentScope();
+    it('sets the runtime tag on the isolation scope', () => {
+      const isolationScope = getIsolationScope();
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({});
+      expect(isolationScope._tags).toEqual({});
 
       init({ dsn: 'https://[email protected]/1337' });
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({ runtime: 'browser' });
+      expect(isolationScope._tags).toEqual({ runtime: 'browser' });
     });
 
     describe('automatically added integrations', () => {

packages/sveltekit/test/server/sdk.test.ts

@@ -36,16 +36,16 @@ describe('Sentry server SDK', () => {
       );
     });
 
-    it('sets the runtime tag on the scope', () => {
-      const currentScope = SentryNode.getCurrentScope();
+    it('sets the runtime tag on the isolation scope', () => {
+      const isolationScope = SentryNode.getIsolationScope();
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({});
+      expect(isolationScope._tags).toEqual({});
 
       init({ dsn: 'https://[email protected]/1337' });
 
       // @ts-expect-error need access to protected _tags attribute
-      expect(currentScope._tags).toEqual({ runtime: 'node' });
+      expect(isolationScope._tags).toEqual({ runtime: 'node' });
     });
 
     it('adds rewriteFramesIntegration by default', () => {