Function sentryHandle

packages/sveltekit/src/server-common/handle.ts:244–293

(handlerOptions?: SentryHandleOptions)

 * ```
 */
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
  const { handleUnknownRoutes, ...rest } = handlerOptions ?? {};
  const options = {
    handleUnknownRoutes: handleUnknownRoutes ?? false,
    ...rest,
  };

  const sentryRequestHandler: Handle = input => {
    const backwardsForwardsCompatibleEvent = input.event as typeof input.event & BackwardsForwardsCompatibleEvent;

    // Escape hatch to suppress request isolation and trace continuation (see initCloudflareSentryHandle)
    const skipIsolation =
      '_sentrySkipRequestIsolation' in backwardsForwardsCompatibleEvent.locals &&
      backwardsForwardsCompatibleEvent.locals._sentrySkipRequestIsolation;

    // In case of a same-origin `fetch` call within a server`load` function,
    // SvelteKit will actually just re-enter the `handle` function and set `isSubRequest`
    // to `true` so that no additional network call is made.
    // We want the `http.server` span of that nested call to be a child span of the
    // currently active span instead of a new root span to correctly reflect this
    // behavior.
    if (skipIsolation || input.event.isSubRequest) {
      return instrumentHandle(input, {
        ...options,
      });
    }

    return withIsolationScope(isolationScope => {
      // We only call continueTrace in the initial top level request to avoid
      // creating a new root span for the sub request.
      isolationScope.setSDKProcessingMetadata({
        // We specifically avoid cloning the request here to avoid double read errors.
        // We only read request headers so we're not consuming the body anyway.
        // Note to future readers: This sounds counter-intuitive but please read
        // https://github.com/getsentry/sentry-javascript/issues/14583
        normalizedRequest: winterCGRequestToRequestData(input.event.request),
      });

      if (backwardsForwardsCompatibleEvent.tracing?.enabled) {
        // if sveltekit tracing is enabled (since 2.31.0), trace continuation is handled by
        // kit before our hook is executed. No noeed to call `continueTrace` from our end
        return instrumentHandle(input, options);
      }

      return continueTrace(getTracePropagationData(input.event), () => instrumentHandle(input, options));
    });
  };

  return sentryRequestHandler;
}