ref(sveltekit): Update trace propagation & span options

mydea · mydea · commit 929f39ab3c40 · 2024-02-28T10:48:16.000Z
diff --git a/packages/sveltekit/src/client/load.ts b/packages/sveltekit/src/client/load.ts
@@ -94,7 +94,6 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)
             [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: routeId ? 'route' : 'url',
           },
           name: routeId ? routeId : event.url.pathname,
-          status: 'ok',
         },
         () => handleCallbackErrors(() => wrappingTarget.apply(thisArg, [patchedEvent]), sendErrorToSentry),
       );
diff --git a/packages/sveltekit/src/server/handle.ts b/packages/sveltekit/src/server/handle.ts
@@ -1,16 +1,15 @@
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
+  continueTrace,
   getActiveSpan,
-  getCurrentScope,
   getDynamicSamplingContextFromSpan,
   setHttpStatus,
   spanToTraceHeader,
   withIsolationScope,
 } from '@sentry/core';
 import { getActiveTransaction, startSpan } from '@sentry/core';
 import { captureException } from '@sentry/node-experimental';
-/* eslint-disable @sentry-internal/sdk/no-optional-chaining */
 import type { Span } from '@sentry/types';
 import { dynamicSamplingContextToSentryBaggageHeader, objectify } from '@sentry/utils';
 import type { Handle, ResolveOptions } from '@sveltejs/kit';
@@ -171,39 +170,35 @@ async function instrumentHandle(
     return resolve(event);
   }
 
-  const { dynamicSamplingContext, traceparentData, propagationContext } = getTracePropagationData(event);
-  getCurrentScope().setPropagationContext(propagationContext);
-
-  try {
-    const resolveResult = await startSpan(
-      {
-        op: 'http.server',
-        attributes: {
-          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.sveltekit',
-          [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: event.route?.id ? 'route' : 'url',
+  const { sentryTrace, baggage } = getTracePropagationData(event);
+
+  return continueTrace({ sentryTrace, baggage }, async () => {
+    try {
+      const resolveResult = await startSpan(
+        {
+          op: 'http.server',
+          attributes: {
+            [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.sveltekit',
+            [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: event.route?.id ? 'route' : 'url',
+          },
+          name: `${event.request.method} ${event.route?.id || event.url.pathname}`,
         },
-        name: `${event.request.method} ${event.route?.id || event.url.pathname}`,
-        status: 'ok',
-        ...traceparentData,
-        metadata: {
-          dynamicSamplingContext: traceparentData && !dynamicSamplingContext ? {} : dynamicSamplingContext,
+        async (span?: Span) => {
+          const res = await resolve(event, {
+            transformPageChunk: addSentryCodeToPage(options),
+          });
+          if (span) {
+            setHttpStatus(span, res.status);
+          }
+          return res;
         },
-      },
-      async (span?: Span) => {
-        const res = await resolve(event, {
-          transformPageChunk: addSentryCodeToPage(options),
-        });
-        if (span) {
-          setHttpStatus(span, res.status);
-        }
-        return res;
-      },
-    );
-    return resolveResult;
-  } catch (e: unknown) {
-    sendErrorToSentry(e);
-    throw e;
-  } finally {
-    await flushIfServerless();
-  }
+      );
+      return resolveResult;
+    } catch (e: unknown) {
+      sendErrorToSentry(e);
+      throw e;
+    } finally {
+      await flushIfServerless();
+    }
+  });
 }
diff --git a/packages/sveltekit/src/server/load.ts b/packages/sveltekit/src/server/load.ts
@@ -1,15 +1,13 @@
-/* eslint-disable @sentry-internal/sdk/no-optional-chaining */
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
-  getCurrentScope,
+  continueTrace,
   startSpan,
 } from '@sentry/core';
 import { captureException } from '@sentry/node-experimental';
 import { addNonEnumerableProperty, objectify } from '@sentry/utils';
 import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
 
-import type { TransactionContext } from '@sentry/types';
 import type { SentryWrappedFlag } from '../common/utils';
 import { isHttpError, isRedirect } from '../common/utils';
 import { flushIfServerless, getTracePropagationData } from './utils';
@@ -70,19 +68,19 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)
 
       const routeId = event.route && event.route.id;
 
-      const traceLoadContext: TransactionContext = {
-        op: 'function.sveltekit.load',
-        attributes: {
-          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
-          [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: routeId ? 'route' : 'url',
-        },
-        name: routeId ? routeId : event.url.pathname,
-        status: 'ok',
-      };
-
       try {
         // We need to await before returning, otherwise we won't catch any errors thrown by the load function
-        return await startSpan(traceLoadContext, () => wrappingTarget.apply(thisArg, args));
+        return await startSpan(
+          {
+            op: 'function.sveltekit.load',
+            attributes: {
+              [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
+              [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: routeId ? 'route' : 'url',
+            },
+            name: routeId ? routeId : event.url.pathname,
+          },
+          () => wrappingTarget.apply(thisArg, args),
+        );
       } catch (e) {
         sendErrorToSentry(e);
         throw e;
@@ -134,35 +132,30 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
       // https://github.com/sveltejs/kit/blob/e133aba479fa9ba0e7f9e71512f5f937f0247e2c/packages/kit/src/runtime/server/page/load_data.js#L111C3-L124
       const routeId = event.route && (Object.getOwnPropertyDescriptor(event.route, 'id')?.value as string | undefined);
 
-      const { dynamicSamplingContext, traceparentData, propagationContext } = getTracePropagationData(event);
-      getCurrentScope().setPropagationContext(propagationContext);
-
-      const traceLoadContext: TransactionContext = {
-        op: 'function.sveltekit.server.load',
-        attributes: {
-          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
-          [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: routeId ? 'route' : 'url',
-        },
-        name: routeId ? routeId : event.url.pathname,
-        status: 'ok',
-        metadata: {
-          dynamicSamplingContext: traceparentData && !dynamicSamplingContext ? {} : dynamicSamplingContext,
-        },
-        data: {
-          'http.method': event.request.method,
-        },
-        ...traceparentData,
-      };
-
-      try {
-        // We need to await before returning, otherwise we won't catch any errors thrown by the load function
-        return await startSpan(traceLoadContext, () => wrappingTarget.apply(thisArg, args));
-      } catch (e: unknown) {
-        sendErrorToSentry(e);
-        throw e;
-      } finally {
-        await flushIfServerless();
-      }
+      const { sentryTrace, baggage } = getTracePropagationData(event);
+
+      return continueTrace({ sentryTrace, baggage }, async () => {
+        try {
+          // We need to await before returning, otherwise we won't catch any errors thrown by the load function
+          return await startSpan(
+            {
+              op: 'function.sveltekit.server.load',
+              attributes: {
+                [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.sveltekit',
+                [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: routeId ? 'route' : 'url',
+                'http.method': event.request.method,
+              },
+              name: routeId ? routeId : event.url.pathname,
+            },
+            () => wrappingTarget.apply(thisArg, args),
+          );
+        } catch (e: unknown) {
+          sendErrorToSentry(e);
+          throw e;
+        } finally {
+          await flushIfServerless();
+        }
+      });
     },
   });
 }
diff --git a/packages/sveltekit/src/server/utils.ts b/packages/sveltekit/src/server/utils.ts
@@ -1,5 +1,5 @@
 import { flush } from '@sentry/node-experimental';
-import { logger, tracingContextFromHeaders } from '@sentry/utils';
+import { logger } from '@sentry/utils';
 import type { RequestEvent } from '@sveltejs/kit';
 
 import { DEBUG_BUILD } from '../common/debug-build';
@@ -10,12 +10,11 @@ import { DEBUG_BUILD } from '../common/debug-build';
  *
  * Sets propagation context as a side effect.
  */
-// eslint-disable-next-line deprecation/deprecation
-export function getTracePropagationData(event: RequestEvent): ReturnType<typeof tracingContextFromHeaders> {
-  const sentryTraceHeader = event.request.headers.get('sentry-trace') || '';
-  const baggageHeader = event.request.headers.get('baggage');
-  // eslint-disable-next-line deprecation/deprecation
-  return tracingContextFromHeaders(sentryTraceHeader, baggageHeader);
+export function getTracePropagationData(event: RequestEvent): { sentryTrace: string; baggage: string | null } {
+  const sentryTrace = event.request.headers.get('sentry-trace') || '';
+  const baggage = event.request.headers.get('baggage');
+
+  return { sentryTrace, baggage };
 }
 
 /** Flush the event queue to ensure that events get sent to Sentry before the response is finished and the lambda ends */
