feat(sveltekit): Switch to Otel-based @sentry/node package (#11075)

This PR switches the underlying Node SDK from
`@sentry/node-experimental` (aka the "legacy" v7 Node SDK) to the new
OpenTelemetry-based `@sentry/node` package.

Author: Lms24

dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts

@@ -98,7 +98,7 @@ const DEPENDENTS: Dependent[] = [
   },
   {
     package: '@sentry/sveltekit',
-    compareWith: nodeExperimentalExports,
+    compareWith: nodeExports,
     exports: Object.keys(SentrySvelteKit),
   },
 ];

packages/sveltekit/package.json

@@ -39,7 +39,8 @@
   "dependencies": {
     "@sentry-internal/tracing": "8.0.0-alpha.2",
     "@sentry/core": "8.0.0-alpha.2",
-    "@sentry/node-experimental": "8.0.0-alpha.2",
+    "@sentry/node": "8.0.0-alpha.2",
+    "@sentry/opentelemetry": "8.0.0-alpha.2",
     "@sentry/svelte": "8.0.0-alpha.2",
     "@sentry/types": "8.0.0-alpha.2",
     "@sentry/utils": "8.0.0-alpha.2",
@@ -68,7 +69,7 @@
     "fix": "eslint . --format stylish --fix",
     "lint": "eslint . --format stylish",
     "test": "yarn test:unit",
-    "test:unit": "vitest run",
+    "test:unit": "vitest run --outputDiffMaxLines=2000",
     "test:watch": "vitest --watch",
     "yalc:publish": "ts-node ../../scripts/prepack.ts && yalc publish build --push --sig"
   },

packages/sveltekit/src/index.types.ts

@@ -36,17 +36,20 @@ export declare function handleErrorWithSentry<T extends HandleClientError | Hand
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export declare function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T): T;
 
-// We export a merged Integrations object so that users can (at least typing-wise) use all integrations everywhere.
-// eslint-disable-next-line deprecation/deprecation
-export declare const Integrations: typeof clientSdk.Integrations & typeof serverSdk.Integrations;
-
 export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
 export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;
 
 export declare const getDefaultIntegrations: (options: Options) => Integration[];
 export declare const defaultStackParser: StackParser;
 
+export declare const getClient: typeof clientSdk.getClient;
+// eslint-disable-next-line deprecation/deprecation
+export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
+// eslint-disable-next-line deprecation/deprecation
+export declare const makeMain: typeof clientSdk.makeMain;
 export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
 export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;
 
+export declare const continueTrace: typeof clientSdk.continueTrace;
+
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;

packages/sveltekit/src/server/handle.ts

@@ -1,20 +1,20 @@
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
-  continueTrace,
   getActiveSpan,
-  getDynamicSamplingContextFromSpan,
   getRootSpan,
   setHttpStatus,
   spanToTraceHeader,
   withIsolationScope,
 } from '@sentry/core';
 import { startSpan } from '@sentry/core';
-import { captureException } from '@sentry/node-experimental';
+import { captureException, continueTrace } from '@sentry/node';
 import type { Span } from '@sentry/types';
 import { dynamicSamplingContextToSentryBaggageHeader, objectify } from '@sentry/utils';
 import type { Handle, ResolveOptions } from '@sveltejs/kit';
 
+import { getDynamicSamplingContextFromSpan } from '@sentry/opentelemetry';
+
 import { isHttpError, isRedirect } from '../common/utils';
 import { flushIfServerless, getTracePropagationData } from './utils';
 
@@ -149,9 +149,10 @@ export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
   };
 
   const sentryRequestHandler: Handle = input => {
-    // if there is an active transaction, we know that this handle call is nested and hence
-    // we don't create a new domain for it. If we created one, nested server calls would
-    // create new transactions instead of adding a child span to the currently active span.
+    // if there is an active span, we know that this handle call is nested and hence
+    // we don't create a new execution context for it.
+    // If we created one, nested server calls would create new root span instead
+    // of adding a child span to the currently active span.
     if (getActiveSpan()) {
       return instrumentHandle(input, options);
     }
@@ -181,6 +182,7 @@ async function instrumentHandle(
           attributes: {
             [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.sveltekit',
             [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: event.route?.id ? 'route' : 'url',
+            'http.method': event.request.method,
           },
           name: `${event.request.method} ${event.route?.id || event.url.pathname}`,
         },

packages/sveltekit/src/server/handleError.ts

@@ -1,4 +1,4 @@
-import { captureException } from '@sentry/node-experimental';
+import { captureException } from '@sentry/node';
 import type { HandleServerError } from '@sveltejs/kit';
 
 import { flushIfServerless } from './utils';

packages/sveltekit/src/server/index.ts

@@ -1,11 +1,9 @@
 // Node SDK exports
-// Unfortunately, we cannot `export * from '@sentry/node-experimental'` because in prod builds,
+// Unfortunately, we cannot `export * from '@sentry/node'` because in prod builds,
 // Vite puts these exports into a `default` property (Sentry.default) rather than
 // on the top - level namespace.
 // Hence, we export everything from the Node SDK explicitly:
 export {
-  // eslint-disable-next-line deprecation/deprecation
-  addGlobalEventProcessor,
   addEventProcessor,
   addBreadcrumb,
   addIntegration,
@@ -15,10 +13,6 @@ export {
   captureCheckIn,
   withMonitor,
   createTransport,
-  // eslint-disable-next-line deprecation/deprecation
-  getActiveTransaction,
-  // eslint-disable-next-line deprecation/deprecation
-  getCurrentHub,
   getClient,
   isInitialized,
   getCurrentScope,
@@ -41,7 +35,6 @@ export {
   setHttpStatus,
   withScope,
   withIsolationScope,
-  autoDiscoverNodePerformanceMonitoringIntegrations,
   makeNodeTransport,
   getDefaultIntegrations,
   defaultStackParser,
@@ -51,7 +44,6 @@ export {
   addRequestDataToEvent,
   DEFAULT_USER_INCLUDES,
   extractRequestData,
-  Integrations,
   consoleIntegration,
   onUncaughtExceptionIntegration,
   onUnhandledRejectionIntegration,
@@ -63,7 +55,6 @@ export {
   functionToStringIntegration,
   inboundFiltersIntegration,
   linkedErrorsIntegration,
-  Handlers,
   setMeasurement,
   getActiveSpan,
   getRootSpan,
@@ -75,16 +66,15 @@ export {
   cron,
   parameterize,
   createGetModuleFromFilename,
-  hapiErrorPlugin,
   metrics,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
-} from '@sentry/node-experimental';
+} from '@sentry/node';
 
 // We can still leave this for the carrier init and type exports
-export * from '@sentry/node-experimental';
+export * from '@sentry/node';
 
 // -------------------------
 // SvelteKit SDK exports:

packages/sveltekit/src/server/load.ts

@@ -1,10 +1,10 @@
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  captureException,
   continueTrace,
   startSpan,
-} from '@sentry/core';
-import { captureException } from '@sentry/node-experimental';
+} from '@sentry/node';
 import { addNonEnumerableProperty, objectify } from '@sentry/utils';
 import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
 

packages/sveltekit/src/server/sdk.ts

@@ -1,7 +1,7 @@
 import { applySdkMetadata, setTag } from '@sentry/core';
-import type { NodeOptions } from '@sentry/node-experimental';
-import { getDefaultIntegrations as getDefaultNodeIntegrations } from '@sentry/node-experimental';
-import { init as initNodeSdk } from '@sentry/node-experimental';
+import type { NodeOptions } from '@sentry/node';
+import { getDefaultIntegrations as getDefaultNodeIntegrations } from '@sentry/node';
+import { init as initNodeSdk } from '@sentry/node';
 
 import { rewriteFramesIntegration } from './rewriteFramesIntegration';
 

packages/sveltekit/src/server/utils.ts

@@ -1,4 +1,4 @@
-import { flush } from '@sentry/node-experimental';
+import { flush } from '@sentry/node';
 import { logger } from '@sentry/utils';
 import type { RequestEvent } from '@sveltejs/kit';
 

packages/sveltekit/src/vite/sourceMaps.ts

@@ -1,7 +1,7 @@
 import * as child_process from 'child_process';
 import * as fs from 'fs';
 import * as path from 'path';
-import { getSentryRelease } from '@sentry/node-experimental';
+import { getSentryRelease } from '@sentry/node';
 import { escapeStringForRegex, uuid4 } from '@sentry/utils';
 import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
 import { sentryVitePlugin } from '@sentry/vite-plugin';

packages/sveltekit/test/server/handle.test.ts

@@ -6,9 +6,9 @@ import {
   spanIsSampled,
   spanToJSON,
 } from '@sentry/core';
-import { NodeClient, setCurrentClient } from '@sentry/node-experimental';
-import * as SentryNode from '@sentry/node-experimental';
-import type { Span } from '@sentry/types';
+import { NodeClient, setCurrentClient } from '@sentry/node';
+import * as SentryNode from '@sentry/node';
+import type { EventEnvelopeHeaders, Span } from '@sentry/types';
 import type { Handle } from '@sveltejs/kit';
 import { redirect } from '@sveltejs/kit';
 import { vi } from 'vitest';
@@ -43,6 +43,7 @@ function mockEvent(override: Record<string, unknown> = {}): Parameters<Handle>[0
     isDataRequest: false,
 
     ...override,
+    isSubRequest: false,
   };
 
   return event;
@@ -103,7 +104,7 @@ beforeEach(() => {
   mockCaptureException.mockClear();
 });
 
-describe('handleSentry', () => {
+describe('sentryHandle', () => {
   describe.each([
     // isSync, isError, expectedResponse
     [Type.Sync, true, undefined],
@@ -117,6 +118,7 @@ describe('handleSentry', () => {
         response = await sentryHandle()({ event: mockEvent(), resolve: resolve(type, isError) });
       } catch (e) {
         expect(e).toBeInstanceOf(Error);
+        // @ts-expect-error - this is fine
         expect(e.message).toEqual(type);
       }
 
@@ -197,7 +199,7 @@ describe('handleSentry', () => {
       );
     });
 
-    it('creates a transaction from sentry-trace header', async () => {
+    it("creates a transaction from sentry-trace header but doesn't populate a new DSC", async () => {
       const event = mockEvent({
         request: {
           headers: {
@@ -219,6 +221,11 @@ describe('handleSentry', () => {
         }
       });
 
+      let envelopeHeaders: EventEnvelopeHeaders | undefined = undefined;
+      client.on('beforeEnvelope', env => {
+        envelopeHeaders = env[0] as EventEnvelopeHeaders;
+      });
+
       try {
         await sentryHandle()({ event, resolve: resolve(type, isError) });
       } catch (e) {
@@ -229,6 +236,7 @@ describe('handleSentry', () => {
       expect(_span!.spanContext().traceId).toEqual('1234567890abcdef1234567890abcdef');
       expect(spanToJSON(_span!).parent_span_id).toEqual('1234567890abcdef');
       expect(spanIsSampled(_span!)).toEqual(true);
+      expect(envelopeHeaders!.trace).toEqual({});
     });
 
     it('creates a transaction with dynamic sampling context from baggage header', async () => {
@@ -261,14 +269,19 @@ describe('handleSentry', () => {
         }
       });
 
+      let envelopeHeaders: EventEnvelopeHeaders | undefined = undefined;
+      client.on('beforeEnvelope', env => {
+        envelopeHeaders = env[0] as EventEnvelopeHeaders;
+      });
+
       try {
         await sentryHandle()({ event, resolve: resolve(type, isError) });
       } catch (e) {
         //
       }
 
       expect(_span!).toBeDefined();
-      expect(_span.metadata.dynamicSamplingContext).toEqual({
+      expect(envelopeHeaders!.trace).toEqual({
         environment: 'production',
         release: '1.0.0',
         public_key: 'dogsarebadatkeepingsecrets',
@@ -312,6 +325,7 @@ describe('handleSentry', () => {
         await sentryHandle()({ event, resolve: mockResolve });
       } catch (e) {
         expect(e).toBeInstanceOf(Error);
+        // @ts-expect-error - this is fine
         expect(e.message).toEqual(type);
       }
 

packages/sveltekit/test/server/handleError.test.ts

@@ -1,4 +1,4 @@
-import * as SentryNode from '@sentry/node-experimental';
+import * as SentryNode from '@sentry/node';
 import type { HandleServerError, RequestEvent } from '@sveltejs/kit';
 import { vi } from 'vitest';