Merge branch 'develop' into cg/deprecate-astro-runtime-options

Author: chargome

.github/dependency-review-config.yml

@@ -1,7 +1,9 @@
 fail-on-severity: 'high'
 allow-ghsas:
   # dependency review does not allow specific file exclusions
-  # we use an older version of NextJS in our tests and thus need to 
+  # we use an older version of NextJS in our tests and thus need to
   # exclude this
   # once our minimum supported version is over 14.1.1 this can be removed
   - GHSA-fr5h-rqp8-mj6g
+  # we need this for an E2E test for the minimum required version of Nuxt 3.7.0
+  - GHSA-v784-fjjh-f8r4

dev-packages/e2e-tests/test-applications/nuxt-3-min/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-3-min",
-  "description": "E2E test app for the minimum nuxt 3 version our nuxt SDK supports.",
+  "description": "E2E test app for the minimum Nuxt 3 version our Nuxt SDK supports.",
   "private": true,
   "type": "module",
   "scripts": {
@@ -16,15 +16,15 @@
   },
   "dependencies": {
     "@sentry/nuxt": "latest || *",
-    "nuxt": "3.13.2"
+    "nuxt": "3.7.0"
   },
   "devDependencies": {
     "@nuxt/test-utils": "^3.14.1",
     "@playwright/test": "^1.44.1",
     "@sentry-internal/test-utils": "link:../../../test-utils"
   },
   "overrides": {
-    "nitropack": "2.9.7",
-    "@vercel/nft": "^0.27.4"
+    "nitropack": "2.10.0",
+    "ofetch": "1.4.0"
   }
 }

dev-packages/e2e-tests/test-applications/nuxt-3/package.json

@@ -15,14 +15,11 @@
   },
   "dependencies": {
     "@sentry/nuxt": "latest || *",
-    "nuxt": "^3.13.1"
+    "nuxt": "^3.14.0"
   },
   "devDependencies": {
     "@nuxt/test-utils": "^3.14.1",
     "@playwright/test": "^1.44.1",
     "@sentry-internal/test-utils": "link:../../../test-utils"
-  },
-  "overrides": {
-    "@vercel/nft": "0.27.4"
   }
 }

dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts

@@ -5,7 +5,7 @@ afterAll(() => {
 });
 
 const esmWarning =
-  '[Sentry] You are using Node.js in ESM mode ("import syntax"). The Sentry Node.js SDK is not compatible with ESM in Node.js versions before 18.19.0 or before 20.6.0. Please either build your application with CommonJS ("require() syntax"), or use version 7.x of the Sentry Node.js SDK.';
+  '[Sentry] You are using Node.js in ESM mode ("import syntax"). The Sentry Node.js SDK is not compatible with ESM in Node.js versions before 18.19.0 or before 20.6.0. Please either build your application with CommonJS ("require() syntax"), or upgrade your Node.js version.';
 
 test("warns if using ESM on Node.js versions that don't support `register()`", async () => {
   const nodeMajorVersion = Number(process.versions.node.split('.')[0]);

docs/migration/draft-v9-migration-guide.md

@@ -85,12 +85,14 @@
   });
   ```
 
+## `@sentry/astro`
+
+- Deprecated passing `dsn`, `release`, `environment`, `sampleRate`, `tracesSampleRate`, `replaysSessionSampleRate` to the integration. Use the runtime-specific `Sentry.init()` calls for passing these options instead.
+
 ## Server-side SDKs (`@sentry/node` and all dependents)
 
 - Deprecated `processThreadBreadcrumbIntegration` in favor of `childProcessIntegration`. Functionally they are the same.
 - Deprecated `nestIntegration`. Use the NestJS SDK (`@sentry/nestjs`) instead.
 - Deprecated `setupNestErrorHandler`. Use the NestJS SDK (`@sentry/nestjs`) instead.
-
-## `@sentry/astro`
-
-- Deprecated passing `dsn`, `release`, `environment`, `sampleRate`, `tracesSampleRate`, `replaysSessionSampleRate` to the integration. Use the runtime-specific `Sentry.init()` calls for passing these options instead.
+- Deprecated `registerEsmLoaderHooks.include` and `registerEsmLoaderHooks.exclude`. Set `onlyIncludeInstrumentedModules: true` instead.
+- `registerEsmLoaderHooks` will only accept `true | false | undefined` in the future. The SDK will default to wrapping modules that are used as part of OpenTelemetry Instrumentation.

packages/core/src/utils-hoist/debug-ids.ts

@@ -1,7 +1,12 @@
-import type { DebugImage, StackFrame, StackParser } from '@sentry/types';
+import type { DebugImage, StackParser } from '@sentry/types';
 import { GLOBAL_OBJ } from './worldwide';
 
-const debugIdStackParserCache = new WeakMap<StackParser, Map<string, StackFrame[]>>();
+type StackString = string;
+type CachedResult = [string, string];
+
+let parsedStackResults: Record<StackString, CachedResult> | undefined;
+let lastKeysCount: number | undefined;
+let cachedFilenameDebugIds: Record<string, string> | undefined;
 
 /**
  * Returns a map of filenames to debug identifiers.
@@ -12,38 +17,46 @@ export function getFilenameToDebugIdMap(stackParser: StackParser): Record<string
     return {};
   }
 
-  let debugIdStackFramesCache: Map<string, StackFrame[]>;
-  const cachedDebugIdStackFrameCache = debugIdStackParserCache.get(stackParser);
-  if (cachedDebugIdStackFrameCache) {
-    debugIdStackFramesCache = cachedDebugIdStackFrameCache;
-  } else {
-    debugIdStackFramesCache = new Map<string, StackFrame[]>();
-    debugIdStackParserCache.set(stackParser, debugIdStackFramesCache);
+  const debugIdKeys = Object.keys(debugIdMap);
+
+  // If the count of registered globals hasn't changed since the last call, we
+  // can just return the cached result.
+  if (cachedFilenameDebugIds && debugIdKeys.length === lastKeysCount) {
+    return cachedFilenameDebugIds;
   }
 
+  lastKeysCount = debugIdKeys.length;
+
   // Build a map of filename -> debug_id.
-  return Object.keys(debugIdMap).reduce<Record<string, string>>((acc, debugIdStackTrace) => {
-    let parsedStack: StackFrame[];
+  cachedFilenameDebugIds = debugIdKeys.reduce<Record<string, string>>((acc, stackKey) => {
+    if (!parsedStackResults) {
+      parsedStackResults = {};
+    }
+
+    const result = parsedStackResults[stackKey];
 
-    const cachedParsedStack = debugIdStackFramesCache.get(debugIdStackTrace);
-    if (cachedParsedStack) {
-      parsedStack = cachedParsedStack;
+    if (result) {
+      acc[result[0]] = result[1];
     } else {
-      parsedStack = stackParser(debugIdStackTrace);
-      debugIdStackFramesCache.set(debugIdStackTrace, parsedStack);
-    }
+      const parsedStack = stackParser(stackKey);
 
-    for (let i = parsedStack.length - 1; i >= 0; i--) {
-      const stackFrame = parsedStack[i];
-      const file = stackFrame && stackFrame.filename;
+      for (let i = parsedStack.length - 1; i >= 0; i--) {
+        const stackFrame = parsedStack[i];
+        const filename = stackFrame && stackFrame.filename;
+        const debugId = debugIdMap[stackKey];
 
-      if (stackFrame && file) {
-        acc[file] = debugIdMap[debugIdStackTrace] as string;
-        break;
+        if (filename && debugId) {
+          acc[filename] = debugId;
+          parsedStackResults[stackKey] = [filename, debugId];
+          break;
+        }
       }
     }
+
     return acc;
   }, {});
+
+  return cachedFilenameDebugIds;
 }
 
 /**
@@ -55,6 +68,10 @@ export function getDebugImagesForResources(
 ): DebugImage[] {
   const filenameDebugIdMap = getFilenameToDebugIdMap(stackParser);
 
+  if (!filenameDebugIdMap) {
+    return [];
+  }
+
   const images: DebugImage[] = [];
   for (const path of resource_paths) {
     if (path && filenameDebugIdMap[path]) {

packages/core/src/utils/prepareEvent.ts

@@ -179,7 +179,7 @@ export function applyDebugIds(event: Event, stackParser: StackParser): void {
     event!.exception!.values!.forEach(exception => {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       exception.stacktrace!.frames!.forEach(frame => {
-        if (frame.filename) {
+        if (filenameDebugIdMap && frame.filename) {
           frame.debug_id = filenameDebugIdMap[frame.filename];
         }
       });

packages/core/src/utils/traceData.ts

@@ -44,39 +44,12 @@ export function getTraceData(options: { span?: Span } = {}): SerializedTraceData
     return {};
   }
 
-  const validBaggage = isValidBaggageString(baggage);
-  if (!validBaggage) {
-    logger.warn('Invalid baggage data. Not returning "baggage" value');
-  }
-
   return {
     'sentry-trace': sentryTrace,
-    ...(validBaggage && { baggage }),
+    baggage,
   };
 }
 
-/**
- * Tests string against baggage spec as defined in:
- *
- * - W3C Baggage grammar: https://www.w3.org/TR/baggage/#definition
- * - RFC7230 token definition: https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
- *
- * exported for testing
- */
-export function isValidBaggageString(baggage?: string): boolean {
-  if (!baggage || !baggage.length) {
-    return false;
-  }
-  const keyRegex = "[-!#$%&'*+.^_`|~A-Za-z0-9]+";
-  const valueRegex = '[!#-+-./0-9:<=>?@A-Z\\[\\]a-z{-}]+';
-  const spaces = '\\s*';
-  // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp for readability, no user input
-  const baggageRegex = new RegExp(
-    `^${keyRegex}${spaces}=${spaces}${valueRegex}(${spaces},${spaces}${keyRegex}${spaces}=${spaces}${valueRegex})*$`,
-  );
-  return baggageRegex.test(baggage);
-}
-
 /**
  * Get a sentry-trace header value for the given scope.
  */

packages/core/test/lib/utils/traceData.test.ts

@@ -13,7 +13,6 @@ import {
 import { getAsyncContextStrategy } from '../../../src/asyncContext';
 import { freezeDscOnSpan } from '../../../src/tracing/dynamicSamplingContext';
 
-import { isValidBaggageString } from '../../../src/utils/traceData';
 import type { TestClientOptions } from '../../mocks/client';
 import { TestClient, getDefaultTestClientOptions } from '../../mocks/client';
 
@@ -281,75 +280,3 @@ describe('getTraceData', () => {
     expect(traceData).toEqual({});
   });
 });
-
-describe('isValidBaggageString', () => {
-  it.each([
-    'sentry-environment=production',
-    'sentry-environment=staging,sentry-public_key=key,sentry-trace_id=abc',
-    // @ is allowed in values
-    '[email protected]',
-    // spaces are allowed around the delimiters
-    'sentry-environment=staging ,   sentry-public_key=key  ,[email protected]',
-    'sentry-environment=staging ,   thirdparty=value  ,[email protected]',
-    // these characters are explicitly allowed for keys in the baggage spec:
-    "!#$%&'*+-.^_`|~1234567890abcxyzABCXYZ=true",
-    // special characters in values are fine (except for ",;\ - see other test)
-    'key=(value)',
-    'key=[{(value)}]',
-    'key=some$value',
-    'key=more#value',
-    'key=max&value',
-    'key=max:value',
-    'key=x=value',
-  ])('returns true if the baggage string is valid (%s)', baggageString => {
-    expect(isValidBaggageString(baggageString)).toBe(true);
-  });
-
-  it.each([
-    // baggage spec doesn't permit leading spaces
-    ' sentry-environment=production,sentry-publickey=key,sentry-trace_id=abc',
-    // no spaces in keys or values
-    'sentry-public key=key',
-    'sentry-publickey=my key',
-    // no delimiters ("(),/:;<=>?@[\]{}") in keys
-    'asdf(x=value',
-    'asdf)x=value',
-    'asdf,x=value',
-    'asdf/x=value',
-    'asdf:x=value',
-    'asdf;x=value',
-    'asdf<x=value',
-    'asdf>x=value',
-    'asdf?x=value',
-    'asdf@x=value',
-    'asdf[x=value',
-    'asdf]x=value',
-    'asdf\\x=value',
-    'asdf{x=value',
-    'asdf}x=value',
-    // no ,;\" in values
-    'key=va,lue',
-    'key=va;lue',
-    'key=va\\lue',
-    'key=va"lue"',
-    // baggage headers can have properties but we currently don't support them
-    'sentry-environment=production;prop1=foo;prop2=bar,nextkey=value',
-    // no fishy stuff
-    'absolutely not a valid baggage string',
-    'val"/><script>alert("xss")</script>',
-    'something"/>',
-    '<script>alert("xss")</script>',
-    '/>',
-    '" onblur="alert("xss")',
-  ])('returns false if the baggage string is invalid (%s)', baggageString => {
-    expect(isValidBaggageString(baggageString)).toBe(false);
-  });
-
-  it('returns false if the baggage string is empty', () => {
-    expect(isValidBaggageString('')).toBe(false);
-  });
-
-  it('returns false if the baggage string is empty', () => {
-    expect(isValidBaggageString(undefined)).toBe(false);
-  });
-});

packages/node/src/integrations/anr/index.ts

@@ -1,4 +1,3 @@
-import * as diagnosticsChannel from 'node:diagnostics_channel';
 import { Worker } from 'node:worker_threads';
 import { defineIntegration, getCurrentScope, getGlobalScope, getIsolationScope, mergeScopeData } from '@sentry/core';
 import { GLOBAL_OBJ, getFilenameToDebugIdMap, logger } from '@sentry/core';
@@ -101,13 +100,6 @@ type AnrReturn = (options?: Partial<AnrIntegrationOptions>) => Integration & Anr
 
 export const anrIntegration = defineIntegration(_anrIntegration) as AnrReturn;
 
-function onModuleLoad(callback: () => void): void {
-  // eslint-disable-next-line deprecation/deprecation
-  diagnosticsChannel.channel('module.require.end').subscribe(() => callback());
-  // eslint-disable-next-line deprecation/deprecation
-  diagnosticsChannel.channel('module.import.asyncEnd').subscribe(() => callback());
-}
-
 /**
  * Starts the ANR worker thread
  *
@@ -161,12 +153,6 @@ async function _startWorker(
     }
   }
 
-  let debugImages: Record<string, string> = getFilenameToDebugIdMap(initOptions.stackParser);
-
-  onModuleLoad(() => {
-    debugImages = getFilenameToDebugIdMap(initOptions.stackParser);
-  });
-
   const worker = new Worker(new URL(`data:application/javascript;base64,${base64WorkerScript}`), {
     workerData: options,
     // We don't want any Node args to be passed to the worker
@@ -185,7 +171,7 @@ async function _startWorker(
       // serialized without making it a SerializedSession
       const session = currentSession ? { ...currentSession, toJSON: undefined } : undefined;
       // message the worker to tell it the main event loop is still running
-      worker.postMessage({ session, debugImages });
+      worker.postMessage({ session, debugImages: getFilenameToDebugIdMap(initOptions.stackParser) });
     } catch (_) {
       //
     }