move addTracingHeadersToFetchRequest back to tracing-internal

Author: Lms24

packages/sveltekit/src/client/load.ts

@@ -1,11 +1,11 @@
+import { addTracingHeadersToFetchRequest } from '@sentry-internal/tracing';
 import type { BaseClient } from '@sentry/core';
 import { getCurrentHub, trace } from '@sentry/core';
 import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
 import { captureException } from '@sentry/svelte';
 import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
 import {
   addExceptionMechanism,
-  addTracingHeadersToFetchRequest,
   getSanitizedUrlString,
   objectify,
   parseFetchArgs,

packages/tracing-internal/src/browser/index.ts

@@ -3,4 +3,8 @@ export * from '../exports';
 export type { RequestInstrumentationOptions } from './request';
 
 export { BrowserTracing, BROWSER_TRACING_INTEGRATION_ID } from './browsertracing';
-export { instrumentOutgoingRequests, defaultRequestInstrumentationOptions } from './request';
+export {
+  instrumentOutgoingRequests,
+  defaultRequestInstrumentationOptions,
+  addTracingHeadersToFetchRequest,
+} from './request';

packages/tracing-internal/src/browser/request.ts

@@ -1,11 +1,11 @@
 /* eslint-disable max-lines */
 import { getCurrentHub, hasTracingEnabled } from '@sentry/core';
-import type { Span } from '@sentry/types';
+import type { DynamicSamplingContext, Span } from '@sentry/types';
 import {
   addInstrumentationHandler,
-  addTracingHeadersToFetchRequest,
   BAGGAGE_HEADER_NAME,
   dynamicSamplingContextToSentryBaggageHeader,
+  isInstanceOf,
   stringMatchesSomePattern,
 } from '@sentry/utils';
 
@@ -210,6 +210,81 @@ export function fetchCallback(
   }
 }
 
+type PolymorphicRequestHeaders =
+  | Record<string, string | undefined>
+  | Array<[string, string]>
+  // the below is not preicsely the Header type used in Request, but it'll pass duck-typing
+  | {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      [key: string]: any;
+      append: (key: string, value: string) => void;
+      get: (key: string) => string;
+    };
+
+export function addTracingHeadersToFetchRequest(
+  request: string | Request,
+  dynamicSamplingContext: Partial<DynamicSamplingContext>,
+  span: Span,
+  options: {
+    headers?:
+      | {
+          [key: string]: string[] | string | undefined;
+        }
+      | Request['headers'];
+  },
+): PolymorphicRequestHeaders {
+  const sentryBaggageHeader = dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext);
+  const sentryTraceHeader = span.toTraceparent();
+
+  const headers =
+    typeof Request !== 'undefined' && isInstanceOf(request, Request) ? (request as Request).headers : options.headers;
+
+  if (!headers) {
+    return { 'sentry-trace': sentryTraceHeader, baggage: sentryBaggageHeader };
+  } else if (typeof Headers !== 'undefined' && isInstanceOf(headers, Headers)) {
+    const newHeaders = new Headers(headers as Headers);
+
+    newHeaders.append('sentry-trace', sentryTraceHeader);
+
+    if (sentryBaggageHeader) {
+      // If the same header is appended miultiple times the browser will merge the values into a single request header.
+      // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
+      newHeaders.append(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
+    }
+
+    return newHeaders as PolymorphicRequestHeaders;
+  } else if (Array.isArray(headers)) {
+    const newHeaders = [...headers, ['sentry-trace', sentryTraceHeader]];
+
+    if (sentryBaggageHeader) {
+      // If there are multiple entries with the same key, the browser will merge the values into a single request header.
+      // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
+      newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
+    }
+
+    return newHeaders;
+  } else {
+    const existingBaggageHeader = 'baggage' in headers ? headers.baggage : undefined;
+    const newBaggageHeaders: string[] = [];
+
+    if (Array.isArray(existingBaggageHeader)) {
+      newBaggageHeaders.push(...existingBaggageHeader);
+    } else if (existingBaggageHeader) {
+      newBaggageHeaders.push(existingBaggageHeader);
+    }
+
+    if (sentryBaggageHeader) {
+      newBaggageHeaders.push(sentryBaggageHeader);
+    }
+
+    return {
+      ...(headers as Exclude<typeof headers, Headers>),
+      'sentry-trace': sentryTraceHeader,
+      baggage: newBaggageHeaders.length > 0 ? newBaggageHeaders.join(',') : undefined,
+    };
+  }
+}
+
 /**
  * Create and track xhr request spans
  */

packages/tracing-internal/src/index.ts

@@ -17,6 +17,7 @@ export {
   BROWSER_TRACING_INTEGRATION_ID,
   instrumentOutgoingRequests,
   defaultRequestInstrumentationOptions,
+  addTracingHeadersToFetchRequest,
 } from './browser';
 
 export type { RequestInstrumentationOptions } from './browser';

packages/utils/src/tracing.ts

@@ -1,7 +1,4 @@
-import type { DynamicSamplingContext, Span, TraceparentData } from '@sentry/types';
-
-import { BAGGAGE_HEADER_NAME, dynamicSamplingContextToSentryBaggageHeader } from './baggage';
-import { isInstanceOf } from './is';
+import type { TraceparentData } from '@sentry/types';
 
 export const TRACEPARENT_REGEXP = new RegExp(
   '^[ \\t]*' + // whitespace
@@ -39,81 +36,3 @@ export function extractTraceparentData(traceparent: string): TraceparentData | u
     parentSpanId: matches[2],
   };
 }
-
-export type PolymorphicRequestHeaders =
-  | Record<string, string | undefined>
-  | Array<[string, string]>
-  // the below is not preicsely the Header type used in Request, but it'll pass duck-typing
-  | {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      [key: string]: any;
-      append: (key: string, value: string) => void;
-      get: (key: string) => string;
-    };
-
-/**
- * Add `sentry-trace` and `baggage` headers to a given fetch request
- */
-export function addTracingHeadersToFetchRequest(
-  request: string | Request,
-  dynamicSamplingContext: Partial<DynamicSamplingContext>,
-  span: Span,
-  options: {
-    headers?:
-      | {
-          [key: string]: string[] | string | undefined;
-        }
-      | Request['headers'];
-  },
-): PolymorphicRequestHeaders {
-  const sentryBaggageHeader = dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext);
-  const sentryTraceHeader = span.toTraceparent();
-
-  const headers =
-    typeof Request !== 'undefined' && isInstanceOf(request, Request) ? (request as Request).headers : options.headers;
-
-  if (!headers) {
-    return { 'sentry-trace': sentryTraceHeader, baggage: sentryBaggageHeader };
-  } else if (typeof Headers !== 'undefined' && isInstanceOf(headers, Headers)) {
-    const newHeaders = new Headers(headers as Headers);
-
-    newHeaders.append('sentry-trace', sentryTraceHeader);
-
-    if (sentryBaggageHeader) {
-      // If the same header is appended miultiple times the browser will merge the values into a single request header.
-      // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
-      newHeaders.append(BAGGAGE_HEADER_NAME, sentryBaggageHeader);
-    }
-
-    return newHeaders as PolymorphicRequestHeaders;
-  } else if (Array.isArray(headers)) {
-    const newHeaders = [...headers, ['sentry-trace', sentryTraceHeader]];
-
-    if (sentryBaggageHeader) {
-      // If there are multiple entries with the same key, the browser will merge the values into a single request header.
-      // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header.
-      newHeaders.push([BAGGAGE_HEADER_NAME, sentryBaggageHeader]);
-    }
-
-    return newHeaders;
-  } else {
-    const existingBaggageHeader = 'baggage' in headers ? headers.baggage : undefined;
-    const newBaggageHeaders: string[] = [];
-
-    if (Array.isArray(existingBaggageHeader)) {
-      newBaggageHeaders.push(...existingBaggageHeader);
-    } else if (existingBaggageHeader) {
-      newBaggageHeaders.push(existingBaggageHeader);
-    }
-
-    if (sentryBaggageHeader) {
-      newBaggageHeaders.push(sentryBaggageHeader);
-    }
-
-    return {
-      ...(headers as Exclude<typeof headers, Headers>),
-      'sentry-trace': sentryTraceHeader,
-      baggage: newBaggageHeaders.length > 0 ? newBaggageHeaders.join(',') : undefined,
-    };
-  }
-}