ref: Use getTraceData instead

Author: mydea

packages/browser/src/tracing/request.ts

@@ -9,8 +9,7 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SentryNonRecordingSpan,
   getActiveSpan,
-  getClient,
-  getSentryHeaders,
+  getTraceData,
   hasTracingEnabled,
   instrumentFetchRequest,
   setHttpStatus,
@@ -396,12 +395,9 @@ export function xhrCallback(
   xhr.__sentry_xhr_span_id__ = span.spanContext().spanId;
   spans[xhr.__sentry_xhr_span_id__] = span;
 
-  const client = getClient();
-
-  if (xhr.setRequestHeader && shouldAttachHeaders(sentryXhrData.url) && client) {
+  if (xhr.setRequestHeader && shouldAttachHeaders(sentryXhrData.url)) {
     addTracingHeadersToXhrRequest(
       xhr,
-      client,
       // If performance is disabled (TWP) or there's no active root span (pageload/navigation/interaction),
       // we do not want to use the span as base for the trace headers,
       // which means that the headers will be generated from the scope and the sampling decision is deferred
@@ -412,10 +408,12 @@ export function xhrCallback(
   return span;
 }
 
-function addTracingHeadersToXhrRequest(xhr: SentryWrappedXMLHttpRequest, client: Client, span?: Span): void {
-  const { sentryTrace, baggage } = getSentryHeaders({ span, client });
+function addTracingHeadersToXhrRequest(xhr: SentryWrappedXMLHttpRequest, span?: Span): void {
+  const { 'sentry-trace': sentryTrace, baggage } = getTraceData({ span });
 
-  setHeaderOnXhr(xhr, sentryTrace, baggage);
+  if (sentryTrace) {
+    setHeaderOnXhr(xhr, sentryTrace, baggage);
+  }
 }
 
 function setHeaderOnXhr(

packages/core/src/fetch.ts

@@ -1,11 +1,11 @@
 import type { Client, HandlerDataFetch, Scope, Span, SpanOrigin } from '@sentry/types';
 import { BAGGAGE_HEADER_NAME, SENTRY_BAGGAGE_KEY_PREFIX, isInstanceOf, parseUrl } from '@sentry/utils';
-import { getClient, getCurrentScope } from './currentScopes';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
-import { SPAN_STATUS_ERROR, getSentryHeaders, setHttpStatus, startInactiveSpan } from './tracing';
+import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
 import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
 import { hasTracingEnabled } from './utils/hasTracingEnabled';
 import { getActiveSpan } from './utils/spanUtils';
+import { getTraceData } from './utils/traceData';
 
 type PolymorphicRequestHeaders =
   | Record<string, string | undefined>
@@ -50,9 +50,6 @@ export function instrumentFetchRequest(
     return undefined;
   }
 
-  const scope = getCurrentScope();
-  const client = getClient();
-
   const { method, url } = handlerData.fetchData;
 
   const fullUrl = getFullURL(url);
@@ -79,7 +76,7 @@ export function instrumentFetchRequest(
   handlerData.fetchData.__span = span.spanContext().spanId;
   spans[span.spanContext().spanId] = span;
 
-  if (shouldAttachHeaders(handlerData.fetchData.url) && client) {
+  if (shouldAttachHeaders(handlerData.fetchData.url)) {
     const request: string | Request = handlerData.args[0];
 
     // In case the user hasn't set the second argument of a fetch call we default it to `{}`.
@@ -88,10 +85,10 @@ export function instrumentFetchRequest(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const options: { [key: string]: any } = handlerData.args[1];
 
-    options.headers = addTracingHeadersToFetchRequest(
+    options.headers = _addTracingHeadersToFetchRequest(
       request,
-      client,
-      scope,
+      undefined,
+      undefined,
       options,
       // If performance is disabled (TWP) or there's no active root span (pageload/navigation/interaction),
       // we do not want to use the span as base for the trace headers,
@@ -104,12 +101,19 @@ export function instrumentFetchRequest(
 }
 
 /**
- * Adds sentry-trace and baggage headers to the various forms of fetch headers
+ * Adds sentry-trace and baggage headers to the various forms of fetch headers.
+ *
+ * @deprecated This function will not be exported anymore in v9.
+ */
+export const addTracingHeadersToFetchRequest = _addTracingHeadersToFetchRequest;
+
+/**
+ * Adds sentry-trace and baggage headers to the various forms of fetch headers.
  */
-export function addTracingHeadersToFetchRequest(
+function _addTracingHeadersToFetchRequest(
   request: string | unknown, // unknown is actually type Request but we can't export DOM types from this package,
-  client: Client,
-  scope: Scope,
+  _client: Client | undefined,
+  _scope: Scope | undefined,
   fetchOptionsObj: {
     headers?:
       | {
@@ -119,18 +123,22 @@ export function addTracingHeadersToFetchRequest(
   },
   span?: Span,
 ): PolymorphicRequestHeaders | undefined {
-  const { sentryTrace, baggage } = getSentryHeaders({ span, client, scope });
+  const traceHeaders = getTraceData({ span });
+  const sentryTrace = traceHeaders['sentry-trace'];
+  const baggage = traceHeaders.baggage;
 
   const headers =
     fetchOptionsObj.headers ||
     (typeof Request !== 'undefined' && isInstanceOf(request, Request) ? (request as Request).headers : undefined);
 
   if (!headers) {
-    return { 'sentry-trace': sentryTrace, baggage };
+    return { ...traceHeaders };
   } else if (typeof Headers !== 'undefined' && isInstanceOf(headers, Headers)) {
     const newHeaders = new Headers(headers as Headers);
 
-    newHeaders.set('sentry-trace', sentryTrace);
+    if (sentryTrace) {
+      newHeaders.set('sentry-trace', sentryTrace);
+    }
 
     if (baggage) {
       const prevBaggageHeader = newHeaders.get(BAGGAGE_HEADER_NAME);

packages/core/src/index.ts

@@ -110,7 +110,11 @@ export type { MetricData } from '@sentry/types';
 export { metricsDefault } from './metrics/exports-default';
 export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
 export { getMetricSummaryJsonForSpan } from './metrics/metric-summary';
-export { addTracingHeadersToFetchRequest, instrumentFetchRequest } from './fetch';
+export {
+  // eslint-disable-next-line deprecation/deprecation
+  addTracingHeadersToFetchRequest,
+  instrumentFetchRequest,
+} from './fetch';
 export { trpcMiddleware } from './trpc';
 export { captureFeedback } from './feedback';
 

packages/core/src/tracing/index.ts

@@ -28,4 +28,3 @@ export {
 export { setMeasurement, timedEventsToMeasurements } from './measurement';
 export { sampleSpan } from './sampling';
 export { logSpanEnd, logSpanStart } from './logSpans';
-export { getSentryHeaders } from './sentryHeaders';

packages/core/src/tracing/sentryHeaders.ts

@@ -1,11 +1,20 @@
-import type { SerializedTraceData } from '@sentry/types';
-import { TRACEPARENT_REGEXP, logger } from '@sentry/utils';
+import type { SerializedTraceData, Span } from '@sentry/types';
+import {
+  TRACEPARENT_REGEXP,
+  dynamicSamplingContextToSentryBaggageHeader,
+  generateSentryTraceHeader,
+  logger,
+} from '@sentry/utils';
 import { getAsyncContextStrategy } from '../asyncContext';
 import { getMainCarrier } from '../carrier';
-import { getClient } from '../currentScopes';
+import { getClient, getCurrentScope } from '../currentScopes';
 import { isEnabled } from '../exports';
-import { getSentryHeaders } from '../tracing';
-import { getActiveSpan } from './spanUtils';
+import type { Scope } from '../scope';
+import {
+  getDynamicSamplingContextFromScope,
+  getDynamicSamplingContextFromSpan,
+} from '../tracing/dynamicSamplingContext';
+import { getActiveSpan, spanToTraceHeader } from './spanUtils';
 
 /**
  * Extracts trace propagation data from the current span or from the client's scope (via transaction or propagation
@@ -18,7 +27,7 @@ import { getActiveSpan } from './spanUtils';
  * @returns an object with the tracing data values. The object keys are the name of the tracing key to be used as header
  * or meta tag name.
  */
-export function getTraceData(): SerializedTraceData {
+export function getTraceData(options: { span?: Span } = {}): SerializedTraceData {
   const client = getClient();
   if (!isEnabled() || !client) {
     return {};
@@ -27,11 +36,14 @@ export function getTraceData(): SerializedTraceData {
   const carrier = getMainCarrier();
   const acs = getAsyncContextStrategy(carrier);
   if (acs.getTraceData) {
-    return acs.getTraceData();
+    return acs.getTraceData(options);
   }
 
-  const span = getActiveSpan();
-  const { sentryTrace, baggage } = getSentryHeaders({ span, client });
+  const scope = getCurrentScope();
+  const span = options.span || getActiveSpan();
+  const sentryTrace = span ? spanToTraceHeader(span) : scopeToTraceHeader(scope);
+  const dsc = span ? getDynamicSamplingContextFromSpan(span) : getDynamicSamplingContextFromScope(client, scope);
+  const baggage = dynamicSamplingContextToSentryBaggageHeader(dsc);
 
   const isValidSentryTraceHeader = TRACEPARENT_REGEXP.test(sentryTrace);
   if (!isValidSentryTraceHeader) {
@@ -71,3 +83,11 @@ export function isValidBaggageString(baggage?: string): boolean {
   );
   return baggageRegex.test(baggage);
 }
+
+/**
+ * Get a sentry-trace header value for the given scope.
+ */
+function scopeToTraceHeader(scope: Scope): string {
+  const { traceId, sampled, spanId } = scope.getPropagationContext();
+  return generateSentryTraceHeader(traceId, spanId, sampled);
+}