feat: Implement new Async Context Strategy (#10647)

This updates the ACS to not rely on hubs (only) anymore.

Now, instead of the ACS providing only `getCurrentHub` and
`runWithAsyncContext`, this is changed a bit:

1. There is always a strategy, even if running in browser or similar. we
just use the default (=stack) strategy in that case.
2. The ACS always returns a hub/scope/etc, not `undefined` - so the
strategy must take care of falling back to the global hub itself (to
make it easier to implement hub<>scope interop).

The ACS defines the following methods now:

* `getCurrentScope`
* `getIsolationScope`
* `withScope`
* `withSetScope` - a variant that takes a scope and makes it the active
one. I decided to make this a dedicated method on the ACS instead of
overloading `withScope` because the types for that are rather tricky to
repeat in strategies...
* `withIsolationScope`
* `withSetIsolationScope` - not we do not use this yet, but to keep the
door open for us this is already required.
* `getCurrentHub` --> for now, for backwards compatibility

The methods themselves are pretty straightforward now! We basically
always create a new hub, and decide if we want to fork the
current/isolation scope based on what method has been used. We still use
a hub everywhere under the hood for now.

Author: mydea

dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/async-context-edge-endpoint.ts

@@ -5,16 +5,16 @@ export const config = {
 };
 
 export default async function handler() {
-  // Without `runWithAsyncContext` and a working async context strategy the two spans created by `Sentry.startSpan()` would be nested.
+  // Without a working async context strategy the two spans created by `Sentry.startSpan()` would be nested.
 
-  const outerSpanPromise = Sentry.runWithAsyncContext(() => {
+  const outerSpanPromise = Sentry.withIsolationScope(() => {
     return Sentry.startSpan({ name: 'outer-span' }, () => {
       return new Promise<void>(resolve => setTimeout(resolve, 300));
     });
   });
 
   setTimeout(() => {
-    Sentry.runWithAsyncContext(() => {
+    Sentry.withIsolationScope(() => {
       return Sentry.startSpan({ name: 'inner-span' }, () => {
         return new Promise<void>(resolve => setTimeout(resolve, 100));
       });

dev-packages/node-integration-tests/suites/public-api/scopes/isolationScope/scenario.ts

@@ -21,7 +21,7 @@ Sentry.withScope(scope => {
   Sentry.captureMessage('inner');
 });
 
-Sentry.runWithAsyncContext(() => {
+Sentry.withIsolationScope(() => {
   Sentry.getIsolationScope().setExtra('ff', 'ff');
   Sentry.getCurrentScope().setExtra('gg', 'gg');
   Sentry.captureMessage('inner_async_context');

packages/astro/src/server/middleware.ts

@@ -5,8 +5,8 @@ import {
   getActiveSpan,
   getClient,
   getCurrentScope,
-  runWithAsyncContext,
   startSpan,
+  withIsolationScope,
 } from '@sentry/node';
 import type { Client, Scope, Span } from '@sentry/types';
 import { addNonEnumerableProperty, objectify, stripUrlQueryAndFragment } from '@sentry/utils';
@@ -74,7 +74,7 @@ export const handleRequest: (options?: MiddlewareOptions) => MiddlewareResponseH
     if (getActiveSpan()) {
       return instrumentRequest(ctx, next, handlerOptions);
     }
-    return runWithAsyncContext(() => {
+    return withIsolationScope(() => {
       return instrumentRequest(ctx, next, handlerOptions);
     });
   };

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

@@ -2,10 +2,10 @@ import type { BrowserClient } from '@sentry/browser';
 import { getActiveSpan } from '@sentry/browser';
 import { browserTracingIntegration } from '@sentry/browser';
 import * as SentryBrowser from '@sentry/browser';
-import { SDK_VERSION, WINDOW, getClient } from '@sentry/browser';
+import { SDK_VERSION, getClient } from '@sentry/browser';
 import { vi } from 'vitest';
 
-import { getIsolationScope } from '@sentry/core';
+import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
 import { init } from '../../../astro/src/client/sdk';
 
 const browserInit = vi.spyOn(SentryBrowser, 'init');
@@ -14,7 +14,11 @@ describe('Sentry client SDK', () => {
   describe('init', () => {
     afterEach(() => {
       vi.clearAllMocks();
-      WINDOW.__SENTRY__.hub = undefined;
+
+      getCurrentScope().clear();
+      getCurrentScope().setClient(undefined);
+      getIsolationScope().clear();
+      getGlobalScope().clear();
     });
 
     it('adds Astro metadata to the SDK options', () => {

packages/astro/test/server/middleware.test.ts

@@ -260,10 +260,10 @@ describe('sentryMiddleware', () => {
   });
 
   describe('async context isolation', () => {
-    const runWithAsyncContextSpy = vi.spyOn(SentryNode, 'runWithAsyncContext');
+    const withIsolationScopeSpy = vi.spyOn(SentryNode, 'withIsolationScope');
     afterEach(() => {
       vi.clearAllMocks();
-      runWithAsyncContextSpy.mockRestore();
+      withIsolationScopeSpy.mockRestore();
     });
 
     it('starts a new async context if no span is active', async () => {
@@ -279,7 +279,7 @@ describe('sentryMiddleware', () => {
         // this is fine, it's not required to pass in this test
       }
 
-      expect(runWithAsyncContextSpy).toHaveBeenCalledTimes(1);
+      expect(withIsolationScopeSpy).toHaveBeenCalledTimes(1);
     });
 
     it("doesn't start a new async context if a span is active", async () => {
@@ -297,7 +297,7 @@ describe('sentryMiddleware', () => {
         // this is fine, it's not required to pass in this test
       }
 
-      expect(runWithAsyncContextSpy).not.toHaveBeenCalled();
+      expect(withIsolationScopeSpy).not.toHaveBeenCalled();
     });
   });
 });

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

@@ -14,6 +14,7 @@ describe('Sentry server SDK', () => {
       SentryNode.getGlobalScope().clear();
       SentryNode.getIsolationScope().clear();
       SentryNode.getCurrentScope().clear();
+      SentryNode.getCurrentScope().setClient(undefined);
     });
 
     it('adds Astro metadata to the SDK options', () => {

packages/browser/src/exports.ts

@@ -41,7 +41,6 @@ export {
   getGlobalScope,
   Hub,
   // eslint-disable-next-line deprecation/deprecation
-  // eslint-disable-next-line deprecation/deprecation
   makeMain,
   setCurrentClient,
   Scope,

packages/browser/test/unit/index.test.ts

@@ -1,4 +1,4 @@
-import { InboundFilters, SDK_VERSION, getReportDialogEndpoint } from '@sentry/core';
+import { InboundFilters, SDK_VERSION, getGlobalScope, getIsolationScope, getReportDialogEndpoint } from '@sentry/core';
 import type { WrappedFunction } from '@sentry/types';
 import * as utils from '@sentry/utils';
 
@@ -39,7 +39,11 @@ describe('SentryBrowser', () => {
   const beforeSend = jest.fn(event => event);
 
   beforeEach(() => {
-    WINDOW.__SENTRY__ = { hub: undefined, logger: undefined, globalEventProcessors: [] };
+    getGlobalScope().clear();
+    getIsolationScope().clear();
+    getCurrentScope().clear();
+    getCurrentScope().setClient(undefined);
+
     init({
       beforeSend,
       dsn,

packages/bun/src/index.ts

@@ -47,6 +47,7 @@ export {
   // eslint-disable-next-line deprecation/deprecation
   makeMain,
   setCurrentClient,
+  // eslint-disable-next-line deprecation/deprecation
   runWithAsyncContext,
   Scope,
   // eslint-disable-next-line deprecation/deprecation

packages/bun/src/integrations/bunserver.ts

@@ -7,9 +7,9 @@ import {
   convertIntegrationFnToClass,
   defineIntegration,
   getCurrentScope,
-  runWithAsyncContext,
   setHttpStatus,
   startSpan,
+  withIsolationScope,
 } from '@sentry/core';
 import type { IntegrationFn } from '@sentry/types';
 import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
@@ -53,7 +53,7 @@ export function instrumentBunServe(): void {
 function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
   serveOptions.fetch = new Proxy(serveOptions.fetch, {
     apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
-      return runWithAsyncContext(() => {
+      return withIsolationScope(() => {
         const request = fetchArgs[0];
         const upperCaseMethod = request.method.toUpperCase();
         if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {