@sentry/browser 10.24.0 → 10.26.0

package/build/npm/cjs/prod/tracing/linkedTraces.js

@@ -0,0 +1,227 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const core = require('@sentry/core');
+const debugBuild = require('../debug-build.js');
+const helpers = require('../helpers.js');
+require('@sentry-internal/browser-utils');
+require('../stack-parsers.js');
+require('../integrations/breadcrumbs.js');
+require('../integrations/browserapierrors.js');
+require('../integrations/browsersession.js');
+require('../integrations/globalhandlers.js');
+require('../integrations/httpcontext.js');
+require('../integrations/linkederrors.js');
+require('../integrations/spotlight.js');
+
+// 1h in seconds
+const PREVIOUS_TRACE_MAX_DURATION = 3600;
+
+// session storage key
+const PREVIOUS_TRACE_KEY = 'sentry_previous_trace';
+
+const PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE = 'sentry.previous_trace';
+
+/**
+ * Takes care of linking traces and applying the (consistent) sampling behavoiour based on the passed options
+ * @param options - options for linking traces and consistent trace sampling (@see BrowserTracingOptions)
+ * @param client - Sentry client
+ */
+function linkTraces(
+  client,
+  {
+    linkPreviousTrace,
+    consistentTraceSampling,
+  }
+
+,
+) {
+  const useSessionStorage = linkPreviousTrace === 'session-storage';
+
+  let inMemoryPreviousTraceInfo = useSessionStorage ? getPreviousTraceFromSessionStorage() : undefined;
+
+  client.on('spanStart', span => {
+    if (core.getRootSpan(span) !== span) {
+      return;
+    }
+
+    const oldPropagationContext = core.getCurrentScope().getPropagationContext();
+    inMemoryPreviousTraceInfo = addPreviousTraceSpanLink(inMemoryPreviousTraceInfo, span, oldPropagationContext);
+
+    if (useSessionStorage) {
+      storePreviousTraceInSessionStorage(inMemoryPreviousTraceInfo);
+    }
+  });
+
+  let isFirstTraceOnPageload = true;
+  if (consistentTraceSampling) {
+    /*
+    When users opt into `consistentTraceSampling`, we need to ensure that we propagate
+    the previous trace's sample rate and rand to the current trace. This is necessary because otherwise, span
+    metric extrapolation is inaccurate, as we'd propagate too high of a sample rate for the subsequent traces.
+
+    So therefore, we pretend that the previous trace was the parent trace of the newly started trace. To do that,
+    we mutate the propagation context of the current trace and set the sample rate and sample rand of the previous trace.
+    Timing-wise, it is fine because it happens before we even sample the root span.
+
+    @see https://github.com/getsentry/sentry-javascript/issues/15754
+    */
+    client.on('beforeSampling', mutableSamplingContextData => {
+      if (!inMemoryPreviousTraceInfo) {
+        return;
+      }
+
+      const scope = core.getCurrentScope();
+      const currentPropagationContext = scope.getPropagationContext();
+
+      // We do not want to force-continue the sampling decision if we continue a trace
+      // that was started on the backend. Most prominently, this will happen in MPAs where
+      // users hard-navigate between pages. In this case, the sampling decision of a potentially
+      // started trace on the server takes precedence.
+      // Why? We want to prioritize inter-trace consistency over intra-trace consistency.
+      if (isFirstTraceOnPageload && currentPropagationContext.parentSpanId) {
+        isFirstTraceOnPageload = false;
+        return;
+      }
+
+      scope.setPropagationContext({
+        ...currentPropagationContext,
+        dsc: {
+          ...currentPropagationContext.dsc,
+          sample_rate: String(inMemoryPreviousTraceInfo.sampleRate),
+          sampled: String(spanContextSampled(inMemoryPreviousTraceInfo.spanContext)),
+        },
+        sampleRand: inMemoryPreviousTraceInfo.sampleRand,
+      });
+
+      mutableSamplingContextData.parentSampled = spanContextSampled(inMemoryPreviousTraceInfo.spanContext);
+      mutableSamplingContextData.parentSampleRate = inMemoryPreviousTraceInfo.sampleRate;
+
+      mutableSamplingContextData.spanAttributes = {
+        ...mutableSamplingContextData.spanAttributes,
+        [core.SEMANTIC_ATTRIBUTE_SENTRY_PREVIOUS_TRACE_SAMPLE_RATE]: inMemoryPreviousTraceInfo.sampleRate,
+      };
+    });
+  }
+}
+
+/**
+ * Adds a previous_trace span link to the passed span if the passed
+ * previousTraceInfo is still valid.
+ *
+ * @returns the updated previous trace info (based on the current span/trace) to
+ * be used on the next call
+ */
+function addPreviousTraceSpanLink(
+  previousTraceInfo,
+  span,
+  oldPropagationContext,
+) {
+  const spanJson = core.spanToJSON(span);
+
+  function getSampleRate() {
+    try {
+      return (
+        Number(oldPropagationContext.dsc?.sample_rate) ?? Number(spanJson.data?.[core.SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE])
+      );
+    } catch {
+      return 0;
+    }
+  }
+
+  const updatedPreviousTraceInfo = {
+    spanContext: span.spanContext(),
+    startTimestamp: spanJson.start_timestamp,
+    sampleRate: getSampleRate(),
+    sampleRand: oldPropagationContext.sampleRand,
+  };
+
+  if (!previousTraceInfo) {
+    return updatedPreviousTraceInfo;
+  }
+
+  const previousTraceSpanCtx = previousTraceInfo.spanContext;
+  if (previousTraceSpanCtx.traceId === spanJson.trace_id) {
+    // This means, we're still in the same trace so let's not update the previous trace info
+    // or add a link to the current span.
+    // Once we move away from the long-lived, route-based trace model, we can remove this cases
+    return previousTraceInfo;
+  }
+
+  // Only add the link if the startTimeStamp of the previous trace's root span is within
+  // PREVIOUS_TRACE_MAX_DURATION (1h) of the current root span's startTimestamp
+  // This is done to
+  // - avoid adding links to "stale" traces
+  // - enable more efficient querying for previous/next traces in Sentry
+  if (Date.now() / 1000 - previousTraceInfo.startTimestamp <= PREVIOUS_TRACE_MAX_DURATION) {
+    if (debugBuild.DEBUG_BUILD) {
+      core.debug.log(
+        `Adding previous_trace ${previousTraceSpanCtx} link to span ${{
+          op: spanJson.op,
+          ...span.spanContext(),
+        }}`,
+      );
+    }
+
+    span.addLink({
+      context: previousTraceSpanCtx,
+      attributes: {
+        [core.SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE]: 'previous_trace',
+      },
+    });
+
+    // TODO: Remove this once EAP can store span links. We currently only set this attribute so that we
+    // can obtain the previous trace information from the EAP store. Long-term, EAP will handle
+    // span links and then we should remove this again. Also throwing in a TODO(v11), to remind us
+    // to check this at v11 time :)
+    span.setAttribute(
+      PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE,
+      `${previousTraceSpanCtx.traceId}-${previousTraceSpanCtx.spanId}-${
+        spanContextSampled(previousTraceSpanCtx) ? 1 : 0
+      }`,
+    );
+  }
+
+  return updatedPreviousTraceInfo;
+}
+
+/**
+ * Stores @param previousTraceInfo in sessionStorage.
+ */
+function storePreviousTraceInSessionStorage(previousTraceInfo) {
+  try {
+    helpers.WINDOW.sessionStorage.setItem(PREVIOUS_TRACE_KEY, JSON.stringify(previousTraceInfo));
+  } catch (e) {
+    // Ignore potential errors (e.g. if sessionStorage is not available)
+    debugBuild.DEBUG_BUILD && core.debug.warn('Could not store previous trace in sessionStorage', e);
+  }
+}
+
+/**
+ * Retrieves the previous trace from sessionStorage if available.
+ */
+function getPreviousTraceFromSessionStorage() {
+  try {
+    const previousTraceInfo = helpers.WINDOW.sessionStorage?.getItem(PREVIOUS_TRACE_KEY);
+    // @ts-expect-error - intentionally risking JSON.parse throwing when previousTraceInfo is null to save bundle size
+    return JSON.parse(previousTraceInfo);
+  } catch {
+    return undefined;
+  }
+}
+
+/**
+ * see {@link import('@sentry/core').spanIsSampled}
+ */
+function spanContextSampled(ctx) {
+  return ctx.traceFlags === 0x1;
+}
+
+exports.PREVIOUS_TRACE_KEY = PREVIOUS_TRACE_KEY;
+exports.PREVIOUS_TRACE_MAX_DURATION = PREVIOUS_TRACE_MAX_DURATION;
+exports.PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE = PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE;
+exports.addPreviousTraceSpanLink = addPreviousTraceSpanLink;
+exports.getPreviousTraceFromSessionStorage = getPreviousTraceFromSessionStorage;
+exports.linkTraces = linkTraces;
+exports.spanContextSampled = spanContextSampled;
+exports.storePreviousTraceInSessionStorage = storePreviousTraceInSessionStorage;
+//# sourceMappingURL=linkedTraces.js.map

package/build/npm/cjs/prod/tracing/linkedTraces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linkedTraces.js","sources":["../../../../../src/tracing/linkedTraces.ts"],"sourcesContent":["import type { Client, PropagationContext, Span } from '@sentry/core';\nimport {\n  type SpanContextData,\n  debug,\n  getCurrentScope,\n  getRootSpan,\n  SEMANTIC_ATTRIBUTE_SENTRY_PREVIOUS_TRACE_SAMPLE_RATE,\n  SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,\n  SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE,\n  spanToJSON,\n} from '@sentry/core';\nimport { DEBUG_BUILD } from '../debug-build';\nimport { WINDOW } from '../exports';\n\nexport interface PreviousTraceInfo {\n  /**\n   * Span context of the previous trace's local root span\n   */\n  spanContext: SpanContextData;\n\n  /**\n   * Timestamp in seconds when the previous trace was started\n   */\n  startTimestamp: number;\n\n  /**\n   * sample rate of the previous trace\n   */\n  sampleRate: number;\n\n  /**\n   * The sample rand of the previous trace\n   */\n  sampleRand: number;\n}\n\n// 1h in seconds\nexport const PREVIOUS_TRACE_MAX_DURATION = 3600;\n\n// session storage key\nexport const PREVIOUS_TRACE_KEY = 'sentry_previous_trace';\n\nexport const PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE = 'sentry.previous_trace';\n\n/**\n * Takes care of linking traces and applying the (consistent) sampling behavoiour based on the passed options\n * @param options - options for linking traces and consistent trace sampling (@see BrowserTracingOptions)\n * @param client - Sentry client\n */\nexport function linkTraces(\n  client: Client,\n  {\n    linkPreviousTrace,\n    consistentTraceSampling,\n  }: {\n    linkPreviousTrace: 'session-storage' | 'in-memory';\n    consistentTraceSampling: boolean;\n  },\n): void {\n  const useSessionStorage = linkPreviousTrace === 'session-storage';\n\n  let inMemoryPreviousTraceInfo = useSessionStorage ? getPreviousTraceFromSessionStorage() : undefined;\n\n  client.on('spanStart', span => {\n    if (getRootSpan(span) !== span) {\n      return;\n    }\n\n    const oldPropagationContext = getCurrentScope().getPropagationContext();\n    inMemoryPreviousTraceInfo = addPreviousTraceSpanLink(inMemoryPreviousTraceInfo, span, oldPropagationContext);\n\n    if (useSessionStorage) {\n      storePreviousTraceInSessionStorage(inMemoryPreviousTraceInfo);\n    }\n  });\n\n  let isFirstTraceOnPageload = true;\n  if (consistentTraceSampling) {\n    /*\n    When users opt into `consistentTraceSampling`, we need to ensure that we propagate\n    the previous trace's sample rate and rand to the current trace. This is necessary because otherwise, span\n    metric extrapolation is inaccurate, as we'd propagate too high of a sample rate for the subsequent traces.\n\n    So therefore, we pretend that the previous trace was the parent trace of the newly started trace. To do that,\n    we mutate the propagation context of the current trace and set the sample rate and sample rand of the previous trace.\n    Timing-wise, it is fine because it happens before we even sample the root span.\n\n    @see https://github.com/getsentry/sentry-javascript/issues/15754\n    */\n    client.on('beforeSampling', mutableSamplingContextData => {\n      if (!inMemoryPreviousTraceInfo) {\n        return;\n      }\n\n      const scope = getCurrentScope();\n      const currentPropagationContext = scope.getPropagationContext();\n\n      // We do not want to force-continue the sampling decision if we continue a trace\n      // that was started on the backend. Most prominently, this will happen in MPAs where\n      // users hard-navigate between pages. In this case, the sampling decision of a potentially\n      // started trace on the server takes precedence.\n      // Why? We want to prioritize inter-trace consistency over intra-trace consistency.\n      if (isFirstTraceOnPageload && currentPropagationContext.parentSpanId) {\n        isFirstTraceOnPageload = false;\n        return;\n      }\n\n      scope.setPropagationContext({\n        ...currentPropagationContext,\n        dsc: {\n          ...currentPropagationContext.dsc,\n          sample_rate: String(inMemoryPreviousTraceInfo.sampleRate),\n          sampled: String(spanContextSampled(inMemoryPreviousTraceInfo.spanContext)),\n        },\n        sampleRand: inMemoryPreviousTraceInfo.sampleRand,\n      });\n\n      mutableSamplingContextData.parentSampled = spanContextSampled(inMemoryPreviousTraceInfo.spanContext);\n      mutableSamplingContextData.parentSampleRate = inMemoryPreviousTraceInfo.sampleRate;\n\n      mutableSamplingContextData.spanAttributes = {\n        ...mutableSamplingContextData.spanAttributes,\n        [SEMANTIC_ATTRIBUTE_SENTRY_PREVIOUS_TRACE_SAMPLE_RATE]: inMemoryPreviousTraceInfo.sampleRate,\n      };\n    });\n  }\n}\n\n/**\n * Adds a previous_trace span link to the passed span if the passed\n * previousTraceInfo is still valid.\n *\n * @returns the updated previous trace info (based on the current span/trace) to\n * be used on the next call\n */\nexport function addPreviousTraceSpanLink(\n  previousTraceInfo: PreviousTraceInfo | undefined,\n  span: Span,\n  oldPropagationContext: PropagationContext,\n): PreviousTraceInfo {\n  const spanJson = spanToJSON(span);\n\n  function getSampleRate(): number {\n    try {\n      return (\n        Number(oldPropagationContext.dsc?.sample_rate) ?? Number(spanJson.data?.[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE])\n      );\n    } catch {\n      return 0;\n    }\n  }\n\n  const updatedPreviousTraceInfo = {\n    spanContext: span.spanContext(),\n    startTimestamp: spanJson.start_timestamp,\n    sampleRate: getSampleRate(),\n    sampleRand: oldPropagationContext.sampleRand,\n  };\n\n  if (!previousTraceInfo) {\n    return updatedPreviousTraceInfo;\n  }\n\n  const previousTraceSpanCtx = previousTraceInfo.spanContext;\n  if (previousTraceSpanCtx.traceId === spanJson.trace_id) {\n    // This means, we're still in the same trace so let's not update the previous trace info\n    // or add a link to the current span.\n    // Once we move away from the long-lived, route-based trace model, we can remove this cases\n    return previousTraceInfo;\n  }\n\n  // Only add the link if the startTimeStamp of the previous trace's root span is within\n  // PREVIOUS_TRACE_MAX_DURATION (1h) of the current root span's startTimestamp\n  // This is done to\n  // - avoid adding links to \"stale\" traces\n  // - enable more efficient querying for previous/next traces in Sentry\n  if (Date.now() / 1000 - previousTraceInfo.startTimestamp <= PREVIOUS_TRACE_MAX_DURATION) {\n    if (DEBUG_BUILD) {\n      debug.log(\n        `Adding previous_trace ${previousTraceSpanCtx} link to span ${{\n          op: spanJson.op,\n          ...span.spanContext(),\n        }}`,\n      );\n    }\n\n    span.addLink({\n      context: previousTraceSpanCtx,\n      attributes: {\n        [SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE]: 'previous_trace',\n      },\n    });\n\n    // TODO: Remove this once EAP can store span links. We currently only set this attribute so that we\n    // can obtain the previous trace information from the EAP store. Long-term, EAP will handle\n    // span links and then we should remove this again. Also throwing in a TODO(v11), to remind us\n    // to check this at v11 time :)\n    span.setAttribute(\n      PREVIOUS_TRACE_TMP_SPAN_ATTRIBUTE,\n      `${previousTraceSpanCtx.traceId}-${previousTraceSpanCtx.spanId}-${\n        spanContextSampled(previousTraceSpanCtx) ? 1 : 0\n      }`,\n    );\n  }\n\n  return updatedPreviousTraceInfo;\n}\n\n/**\n * Stores @param previousTraceInfo in sessionStorage.\n */\nexport function storePreviousTraceInSessionStorage(previousTraceInfo: PreviousTraceInfo): void {\n  try {\n    WINDOW.sessionStorage.setItem(PREVIOUS_TRACE_KEY, JSON.stringify(previousTraceInfo));\n  } catch (e) {\n    // Ignore potential errors (e.g. if sessionStorage is not available)\n    DEBUG_BUILD && debug.warn('Could not store previous trace in sessionStorage', e);\n  }\n}\n\n/**\n * Retrieves the previous trace from sessionStorage if available.\n */\nexport function getPreviousTraceFromSessionStorage(): PreviousTraceInfo | undefined {\n  try {\n    const previousTraceInfo = WINDOW.sessionStorage?.getItem(PREVIOUS_TRACE_KEY);\n    // @ts-expect-error - intentionally risking JSON.parse throwing when previousTraceInfo is null to save bundle size\n    return JSON.parse(previousTraceInfo);\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * see {@link import('@sentry/core').spanIsSampled}\n */\nexport function spanContextSampled(ctx: SpanContextData): boolean {\n  return ctx.traceFlags === 0x1;\n}\n"],"names":["getRootSpan","getCurrentScope","SEMANTIC_ATTRIBUTE_SENTRY_PREVIOUS_TRACE_SAMPLE_RATE","spanToJSON","SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE","DEBUG_BUILD","debug","SEMANTIC_LINK_ATTRIBUTE_LINK_TYPE","WINDOW"],"mappings":";;;;;;;;;;;;;;;AAoCA;AACO,MAAM,2BAAA,GAA8B;;AAE3C;AACO,MAAM,kBAAA,GAAqB;;AAE3B,MAAM,iCAAA,GAAoC;;AAEjD;AACA;AACA;AACA;AACA;AACO,SAAS,UAAU;AAC1B,EAAE,MAAM;AACR,EAAE;AACF,IAAI,iBAAiB;AACrB,IAAI,uBAAuB;AAC3B;;AAGE;AACF,EAAQ;AACR,EAAE,MAAM,iBAAA,GAAoB,iBAAA,KAAsB,iBAAiB;;AAEnE,EAAE,IAAI,4BAA4B,iBAAA,GAAoB,kCAAkC,EAAC,GAAI,SAAS;;AAEtG,EAAE,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ;AACjC,IAAI,IAAIA,gBAAW,CAAC,IAAI,CAAA,KAAM,IAAI,EAAE;AACpC,MAAM;AACN,IAAI;;AAEJ,IAAI,MAAM,wBAAwBC,oBAAe,EAAE,CAAC,qBAAqB,EAAE;AAC3E,IAAI,yBAAA,GAA4B,wBAAwB,CAAC,yBAAyB,EAAE,IAAI,EAAE,qBAAqB,CAAC;;AAEhH,IAAI,IAAI,iBAAiB,EAAE;AAC3B,MAAM,kCAAkC,CAAC,yBAAyB,CAAC;AACnE,IAAI;AACJ,EAAE,CAAC,CAAC;;AAEJ,EAAE,IAAI,sBAAA,GAAyB,IAAI;AACnC,EAAE,IAAI,uBAAuB,EAAE;AAC/B;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA,IAAI,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,8BAA8B;AAC9D,MAAM,IAAI,CAAC,yBAAyB,EAAE;AACtC,QAAQ;AACR,MAAM;;AAEN,MAAM,MAAM,KAAA,GAAQA,oBAAe,EAAE;AACrC,MAAM,MAAM,yBAAA,GAA4B,KAAK,CAAC,qBAAqB,EAAE;;AAErE;AACA;AACA;AACA;AACA;AACA,MAAM,IAAI,sBAAA,IAA0B,yBAAyB,CAAC,YAAY,EAAE;AAC5E,QAAQ,sBAAA,GAAyB,KAAK;AACtC,QAAQ;AACR,MAAM;;AAEN,MAAM,KAAK,CAAC,qBAAqB,CAAC;AAClC,QAAQ,GAAG,yBAAyB;AACpC,QAAQ,GAAG,EAAE;AACb,UAAU,GAAG,yBAAyB,CAAC,GAAG;AAC1C,UAAU,WAAW,EAAE,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC;AACnE,UAAU,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;AACpF,SAAS;AACT,QAAQ,UAAU,EAAE,yBAAyB,CAAC,UAAU;AACxD,OAAO,CAAC;;AAER,MAAM,0BAA0B,CAAC,aAAA,GAAgB,kBAAkB,CAAC,yBAAyB,CAAC,WAAW,CAAC;AAC1G,MAAM,0BAA0B,CAAC,gBAAA,GAAmB,yBAAyB,CAAC,UAAU;;AAExF,MAAM,0BAA0B,CAAC,cAAA,GAAiB;AAClD,QAAQ,GAAG,0BAA0B,CAAC,cAAc;AACpD,QAAQ,CAACC,yDAAoD,GAAG,yBAAyB,CAAC,UAAU;AACpG,OAAO;AACP,IAAI,CAAC,CAAC;AACN,EAAE;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,wBAAwB;AACxC,EAAE,iBAAiB;AACnB,EAAE,IAAI;AACN,EAAE,qBAAqB;AACvB,EAAqB;AACrB,EAAE,MAAM,QAAA,GAAWC,eAAU,CAAC,IAAI,CAAC;;AAEnC,EAAE,SAAS,aAAa,GAAW;AACnC,IAAI,IAAI;AACR,MAAM;AACN,QAAQ,MAAM,CAAC,qBAAqB,CAAC,GAAG,EAAE,WAAW,CAAA,IAAK,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAGC,0CAAqC,CAAC;AACvH;AACA,IAAI,EAAE,MAAM;AACZ,MAAM,OAAO,CAAC;AACd,IAAI;AACJ,EAAE;;AAEF,EAAE,MAAM,2BAA2B;AACnC,IAAI,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;AACnC,IAAI,cAAc,EAAE,QAAQ,CAAC,eAAe;AAC5C,IAAI,UAAU,EAAE,aAAa,EAAE;AAC/B,IAAI,UAAU,EAAE,qBAAqB,CAAC,UAAU;AAChD,GAAG;;AAEH,EAAE,IAAI,CAAC,iBAAiB,EAAE;AAC1B,IAAI,OAAO,wBAAwB;AACnC,EAAE;;AAEF,EAAE,MAAM,oBAAA,GAAuB,iBAAiB,CAAC,WAAW;AAC5D,EAAE,IAAI,oBAAoB,CAAC,YAAY,QAAQ,CAAC,QAAQ,EAAE;AAC1D;AACA;AACA;AACA,IAAI,OAAO,iBAAiB;AAC5B,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,IAAI,IAAI,CAAC,GAAG,EAAC,GAAI,IAAA,GAAO,iBAAiB,CAAC,cAAA,IAAkB,2BAA2B,EAAE;AAC3F,IAAI,IAAIC,sBAAW,EAAE;AACrB,MAAMC,UAAK,CAAC,GAAG;AACf,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,cAAc,EAAE;AACtE,UAAU,EAAE,EAAE,QAAQ,CAAC,EAAE;AACzB,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE;AAC/B,SAAS,CAAC,CAAA;AACA,OAAA;AACA,IAAA;;AAEA,IAAA,IAAA,CAAA,OAAA,CAAA;AACA,MAAA,OAAA,EAAA,oBAAA;AACA,MAAA,UAAA,EAAA;AACA,QAAA,CAAAC,sCAAA,GAAA,gBAAA;AACA,OAAA;AACA,KAAA,CAAA;;AAEA;AACA;AACA;AACA;AACA,IAAA,IAAA,CAAA,YAAA;AACA,MAAA,iCAAA;AACA,MAAA,CAAA,EAAA,oBAAA,CAAA,OAAA,CAAA,CAAA,EAAA,oBAAA,CAAA,MAAA,CAAA,CAAA;AACA,QAAA,kBAAA,CAAA,oBAAA,CAAA,GAAA,CAAA,GAAA;AACA,OAAA,CAAA;AACA,KAAA;AACA,EAAA;;AAEA,EAAA,OAAA,wBAAA;AACA;;AAEA;AACA;AACA;AACA,SAAA,kCAAA,CAAA,iBAAA,EAAA;AACA,EAAA,IAAA;AACA,IAAAC,cAAA,CAAA,cAAA,CAAA,OAAA,CAAA,kBAAA,EAAA,IAAA,CAAA,SAAA,CAAA,iBAAA,CAAA,CAAA;AACA,EAAA,CAAA,CAAA,OAAA,CAAA,EAAA;AACA;AACA,IAAAH,sBAAA,IAAAC,UAAA,CAAA,IAAA,CAAA,kDAAA,EAAA,CAAA,CAAA;AACA,EAAA;AACA;;AAEA;AACA;AACA;AACA,SAAA,kCAAA,GAAA;AACA,EAAA,IAAA;AACA,IAAA,MAAA,iBAAA,GAAAE,cAAA,CAAA,cAAA,EAAA,OAAA,CAAA,kBAAA,CAAA;AACA;AACA,IAAA,OAAA,IAAA,CAAA,KAAA,CAAA,iBAAA,CAAA;AACA,EAAA,CAAA,CAAA,MAAA;AACA,IAAA,OAAA,SAAA;AACA,EAAA;AACA;;AAEA;AACA;AACA;AACA,SAAA,kBAAA,CAAA,GAAA,EAAA;AACA,EAAA,OAAA,GAAA,CAAA,UAAA,KAAA,GAAA;AACA;;;;;;;;;;;"}

package/build/npm/cjs/prod/tracing/reportPageLoaded.js

@@ -0,0 +1,18 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const core = require('@sentry/core');
+
+/**
+ * Manually report the end of the page load, resulting in the SDK ending the pageload span.
+ * This only works if {@link BrowserTracingOptions.enableReportPageLoaded} is set to `true`.
+ * Otherwise, the pageload span will end itself based on the {@link BrowserTracingOptions.finalTimeout},
+ * {@link BrowserTracingOptions.idleTimeout} and {@link BrowserTracingOptions.childSpanTimeout}.
+ *
+ * @param client - The client to use. If not provided, the global client will be used.
+ */
+function reportPageLoaded(client = core.getClient()) {
+  client?.emit('endPageloadSpan');
+}
+
+exports.reportPageLoaded = reportPageLoaded;
+//# sourceMappingURL=reportPageLoaded.js.map

package/build/npm/cjs/prod/tracing/reportPageLoaded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportPageLoaded.js","sources":["../../../../../src/tracing/reportPageLoaded.ts"],"sourcesContent":["import type { Client } from '@sentry/core';\nimport { getClient } from '@sentry/core';\n\n/**\n * Manually report the end of the page load, resulting in the SDK ending the pageload span.\n * This only works if {@link BrowserTracingOptions.enableReportPageLoaded} is set to `true`.\n * Otherwise, the pageload span will end itself based on the {@link BrowserTracingOptions.finalTimeout},\n * {@link BrowserTracingOptions.idleTimeout} and {@link BrowserTracingOptions.childSpanTimeout}.\n *\n * @param client - The client to use. If not provided, the global client will be used.\n */\nexport function reportPageLoaded(client: Client | undefined = getClient()): void {\n  client?.emit('endPageloadSpan');\n}\n"],"names":["getClient"],"mappings":";;;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,gBAAgB,CAAC,MAAM,GAAuBA,cAAS,EAAE,EAAQ;AACjF,EAAE,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC;AACjC;;;;"}

package/build/npm/cjs/prod/tracing/request.js

@@ -0,0 +1,342 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const core = require('@sentry/core');
+const browserUtils = require('@sentry-internal/browser-utils');
+const utils = require('./utils.js');
+
+/** Options for Request Instrumentation */
+
+const responseToSpanId = new WeakMap();
+const spanIdToEndTimestamp = new Map();
+
+const defaultRequestInstrumentationOptions = {
+  traceFetch: true,
+  traceXHR: true,
+  enableHTTPTimings: true,
+  trackFetchStreamPerformance: false,
+};
+
+/** Registers span creators for xhr and fetch requests  */
+function instrumentOutgoingRequests(client, _options) {
+  const {
+    traceFetch,
+    traceXHR,
+    trackFetchStreamPerformance,
+    shouldCreateSpanForRequest,
+    enableHTTPTimings,
+    tracePropagationTargets,
+    onRequestSpanStart,
+    onRequestSpanEnd,
+  } = {
+    ...defaultRequestInstrumentationOptions,
+    ..._options,
+  };
+
+  const shouldCreateSpan =
+    typeof shouldCreateSpanForRequest === 'function' ? shouldCreateSpanForRequest : (_) => true;
+
+  const shouldAttachHeadersWithTargets = (url) => shouldAttachHeaders(url, tracePropagationTargets);
+
+  const spans = {};
+
+  const propagateTraceparent = (client ).getOptions().propagateTraceparent;
+
+  if (traceFetch) {
+    // Keeping track of http requests, whose body payloads resolved later than the initial resolved request
+    // e.g. streaming using server sent events (SSE)
+    client.addEventProcessor(event => {
+      if (event.type === 'transaction' && event.spans) {
+        event.spans.forEach(span => {
+          if (span.op === 'http.client') {
+            const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
+            if (updatedTimestamp) {
+              span.timestamp = updatedTimestamp / 1000;
+              spanIdToEndTimestamp.delete(span.span_id);
+            }
+          }
+        });
+      }
+      return event;
+    });
+
+    if (trackFetchStreamPerformance) {
+      core.addFetchEndInstrumentationHandler(handlerData => {
+        if (handlerData.response) {
+          const span = responseToSpanId.get(handlerData.response);
+          if (span && handlerData.endTimestamp) {
+            spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
+          }
+        }
+      });
+    }
+
+    core.addFetchInstrumentationHandler(handlerData => {
+      const createdSpan = core.instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans, {
+        propagateTraceparent,
+        onRequestSpanEnd,
+      });
+
+      if (handlerData.response && handlerData.fetchData.__span) {
+        responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
+      }
+
+      // We cannot use `window.location` in the generic fetch instrumentation,
+      // but we need it for reliable `server.address` attribute.
+      // so we extend this in here
+      if (createdSpan) {
+        const fullUrl = utils.getFullURL(handlerData.fetchData.url);
+        const host = fullUrl ? core.parseUrl(fullUrl).host : undefined;
+        createdSpan.setAttributes({
+          'http.url': fullUrl,
+          'server.address': host,
+        });
+
+        if (enableHTTPTimings) {
+          addHTTPTimings(createdSpan);
+        }
+
+        onRequestSpanStart?.(createdSpan, { headers: handlerData.headers });
+      }
+    });
+  }
+
+  if (traceXHR) {
+    browserUtils.addXhrInstrumentationHandler(handlerData => {
+      const createdSpan = xhrCallback(
+        handlerData,
+        shouldCreateSpan,
+        shouldAttachHeadersWithTargets,
+        spans,
+        propagateTraceparent,
+        onRequestSpanEnd,
+      );
+
+      if (createdSpan) {
+        if (enableHTTPTimings) {
+          addHTTPTimings(createdSpan);
+        }
+
+        onRequestSpanStart?.(createdSpan, {
+          headers: utils.createHeadersSafely(handlerData.xhr.__sentry_xhr_v3__?.request_headers),
+        });
+      }
+    });
+  }
+}
+
+/**
+ * Creates a temporary observer to listen to the next fetch/xhr resourcing timings,
+ * so that when timings hit their per-browser limit they don't need to be removed.
+ *
+ * @param span A span that has yet to be finished, must contain `url` on data.
+ */
+function addHTTPTimings(span) {
+  const { url } = core.spanToJSON(span).data;
+
+  if (!url || typeof url !== 'string') {
+    return;
+  }
+
+  const cleanup = browserUtils.addPerformanceInstrumentationHandler('resource', ({ entries }) => {
+    entries.forEach(entry => {
+      if (utils.isPerformanceResourceTiming(entry) && entry.name.endsWith(url)) {
+        span.setAttributes(browserUtils.resourceTimingToSpanAttributes(entry));
+        // In the next tick, clean this handler up
+        // We have to wait here because otherwise this cleans itself up before it is fully done
+        setTimeout(cleanup);
+      }
+    });
+  });
+}
+
+/**
+ * A function that determines whether to attach tracing headers to a request.
+ * We only export this function for testing purposes.
+ */
+function shouldAttachHeaders(
+  targetUrl,
+  tracePropagationTargets,
+) {
+  // window.location.href not being defined is an edge case in the browser but we need to handle it.
+  // Potentially dangerous situations where it may not be defined: Browser Extensions, Web Workers, patching of the location obj
+  const href = core.getLocationHref();
+
+  if (!href) {
+    // If there is no window.location.origin, we default to only attaching tracing headers to relative requests, i.e. ones that start with `/`
+    // BIG DISCLAIMER: Users can call URLs with a double slash (fetch("//example.com/api")), this is a shorthand for "send to the same protocol",
+    // so we need a to exclude those requests, because they might be cross origin.
+    const isRelativeSameOriginRequest = !!targetUrl.match(/^\/(?!\/)/);
+    if (!tracePropagationTargets) {
+      return isRelativeSameOriginRequest;
+    } else {
+      return core.stringMatchesSomePattern(targetUrl, tracePropagationTargets);
+    }
+  } else {
+    let resolvedUrl;
+    let currentOrigin;
+
+    // URL parsing may fail, we default to not attaching trace headers in that case.
+    try {
+      resolvedUrl = new URL(targetUrl, href);
+      currentOrigin = new URL(href).origin;
+    } catch {
+      return false;
+    }
+
+    const isSameOriginRequest = resolvedUrl.origin === currentOrigin;
+    if (!tracePropagationTargets) {
+      return isSameOriginRequest;
+    } else {
+      return (
+        core.stringMatchesSomePattern(resolvedUrl.toString(), tracePropagationTargets) ||
+        (isSameOriginRequest && core.stringMatchesSomePattern(resolvedUrl.pathname, tracePropagationTargets))
+      );
+    }
+  }
+}
+
+/**
+ * Create and track xhr request spans
+ *
+ * @returns Span if a span was created, otherwise void.
+ */
+function xhrCallback(
+  handlerData,
+  shouldCreateSpan,
+  shouldAttachHeaders,
+  spans,
+  propagateTraceparent,
+  onRequestSpanEnd,
+) {
+  const xhr = handlerData.xhr;
+  const sentryXhrData = xhr?.[browserUtils.SENTRY_XHR_DATA_KEY];
+
+  if (!xhr || xhr.__sentry_own_request__ || !sentryXhrData) {
+    return undefined;
+  }
+
+  const { url, method } = sentryXhrData;
+
+  const shouldCreateSpanResult = core.hasSpansEnabled() && shouldCreateSpan(url);
+
+  // check first if the request has finished and is tracked by an existing span which should now end
+  if (handlerData.endTimestamp && shouldCreateSpanResult) {
+    const spanId = xhr.__sentry_xhr_span_id__;
+    if (!spanId) return;
+
+    const span = spans[spanId];
+    if (span && sentryXhrData.status_code !== undefined) {
+      core.setHttpStatus(span, sentryXhrData.status_code);
+      span.end();
+
+      onRequestSpanEnd?.(span, {
+        headers: utils.createHeadersSafely(browserUtils.parseXhrResponseHeaders(xhr )),
+        error: handlerData.error,
+      });
+
+      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+      delete spans[spanId];
+    }
+    return undefined;
+  }
+
+  const fullUrl = utils.getFullURL(url);
+  const parsedUrl = fullUrl ? core.parseUrl(fullUrl) : core.parseUrl(url);
+
+  const urlForSpanName = core.stripUrlQueryAndFragment(url);
+
+  const hasParent = !!core.getActiveSpan();
+
+  const span =
+    shouldCreateSpanResult && hasParent
+      ? core.startInactiveSpan({
+          name: `${method} ${urlForSpanName}`,
+          attributes: {
+            url,
+            type: 'xhr',
+            'http.method': method,
+            'http.url': fullUrl,
+            'server.address': parsedUrl?.host,
+            [core.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser',
+            [core.SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
+            ...(parsedUrl?.search && { 'http.query': parsedUrl?.search }),
+            ...(parsedUrl?.hash && { 'http.fragment': parsedUrl?.hash }),
+          },
+        })
+      : new core.SentryNonRecordingSpan();
+
+  xhr.__sentry_xhr_span_id__ = span.spanContext().spanId;
+  spans[xhr.__sentry_xhr_span_id__] = span;
+
+  if (shouldAttachHeaders(url)) {
+    addTracingHeadersToXhrRequest(
+      xhr,
+      // 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
+      core.hasSpansEnabled() && hasParent ? span : undefined,
+      propagateTraceparent,
+    );
+  }
+
+  const client = core.getClient();
+  if (client) {
+    client.emit('beforeOutgoingRequestSpan', span, handlerData );
+  }
+
+  return span;
+}
+
+function addTracingHeadersToXhrRequest(
+  xhr,
+  span,
+  propagateTraceparent,
+) {
+  const { 'sentry-trace': sentryTrace, baggage, traceparent } = core.getTraceData({ span, propagateTraceparent });
+
+  if (sentryTrace) {
+    setHeaderOnXhr(xhr, sentryTrace, baggage, traceparent);
+  }
+}
+
+function setHeaderOnXhr(
+  xhr,
+  sentryTraceHeader,
+  sentryBaggageHeader,
+  traceparentHeader,
+) {
+  const originalHeaders = xhr.__sentry_xhr_v3__?.request_headers;
+
+  if (originalHeaders?.['sentry-trace'] || !xhr.setRequestHeader) {
+    // bail if a sentry-trace header is already set
+    return;
+  }
+
+  try {
+    xhr.setRequestHeader('sentry-trace', sentryTraceHeader);
+
+    if (traceparentHeader && !originalHeaders?.['traceparent']) {
+      xhr.setRequestHeader('traceparent', traceparentHeader);
+    }
+
+    if (sentryBaggageHeader) {
+      // only add our headers if
+      // - no pre-existing baggage header exists
+      // - or it is set and doesn't yet contain sentry values
+      const originalBaggageHeader = originalHeaders?.['baggage'];
+      if (!originalBaggageHeader || !utils.baggageHeaderHasSentryValues(originalBaggageHeader)) {
+        // From MDN: "If this method is called several times with the same header, the values are merged into one single request header."
+        // We can therefore simply set a baggage header without checking what was there before
+        // https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader
+        xhr.setRequestHeader('baggage', sentryBaggageHeader);
+      }
+    }
+  } catch {
+    // Error: InvalidStateError: Failed to execute 'setRequestHeader' on 'XMLHttpRequest': The object's state must be OPENED.
+  }
+}
+
+exports.defaultRequestInstrumentationOptions = defaultRequestInstrumentationOptions;
+exports.instrumentOutgoingRequests = instrumentOutgoingRequests;
+exports.shouldAttachHeaders = shouldAttachHeaders;
+//# sourceMappingURL=request.js.map