Merge branch 'lms/feat-span-first' into lms/span-first-pr7-span-serialization

Author: Lms24

.size-limit.js

@@ -103,7 +103,7 @@ module.exports = [
     path: 'packages/browser/build/npm/esm/prod/index.js',
     import: createImport('init', 'sendFeedback'),
     gzip: true,
-    limit: '31 KB',
+    limit: '32 KB',
   },
   {
     name: '@sentry/browser (incl. FeedbackAsync)',
@@ -171,14 +171,14 @@ module.exports = [
     path: 'packages/svelte/build/esm/index.js',
     import: createImport('init'),
     gzip: true,
-    limit: '25.5 KB',
+    limit: '26 KB',
   },
   // Browser CDN bundles
   {
     name: 'CDN Bundle',
     path: createCDNPath('bundle.min.js'),
     gzip: true,
-    limit: '28 KB',
+    limit: '28.5 KB',
   },
   {
     name: 'CDN Bundle (incl. Tracing)',

packages/core/src/client.ts

@@ -34,6 +34,7 @@ import type { SeverityLevel } from './types-hoist/severity';
 import type { Span, SpanAttributes, SpanContextData, SpanJSON } from './types-hoist/span';
 import type { StartSpanOptions } from './types-hoist/startSpanOptions';
 import type { Transport, TransportMakeRequestResponse } from './types-hoist/transport';
+import { isStreamedBeforeSendSpanCallback } from './utils/beforeSendSpan';
 import { createClientReportEnvelope } from './utils/clientreport';
 import { debug } from './utils/debug-logger';
 import { dsnToString, makeDsn } from './utils/dsn';
@@ -1498,7 +1499,9 @@ function processBeforeSend(
   event: Event,
   hint: EventHint,
 ): PromiseLike<Event | null> | Event | null {
-  const { beforeSend, beforeSendTransaction, beforeSendSpan, ignoreSpans } = options;
+  const { beforeSend, beforeSendTransaction, ignoreSpans } = options;
+  const beforeSendSpan = !isStreamedBeforeSendSpanCallback(options.beforeSendSpan) && options.beforeSendSpan;
+
   let processedEvent = event;
 
   if (isErrorEvent(processedEvent) && beforeSend) {

packages/core/src/envelope.ts

@@ -18,6 +18,7 @@ import type { Event } from './types-hoist/event';
 import type { SdkInfo } from './types-hoist/sdkinfo';
 import type { SdkMetadata } from './types-hoist/sdkmetadata';
 import type { Session, SessionAggregates } from './types-hoist/session';
+import { isStreamedBeforeSendSpanCallback } from './utils/beforeSendSpan';
 import { dsnToString } from './utils/dsn';
 import {
   createEnvelope,
@@ -152,7 +153,7 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
   const convertToSpanJSON = beforeSendSpan
     ? (span: SentrySpan) => {
         const spanJson = spanToJSON(span);
-        const processedSpan = beforeSendSpan(spanJson);
+        const processedSpan = !isStreamedBeforeSendSpanCallback(beforeSendSpan) ? beforeSendSpan(spanJson) : spanJson;
 
         if (!processedSpan) {
           showSpanDropWarning();

packages/core/src/index.ts

@@ -67,6 +67,7 @@ export { prepareEvent } from './utils/prepareEvent';
 export type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
 export { createCheckInEnvelope } from './checkin';
 export { hasSpansEnabled } from './utils/hasSpansEnabled';
+export { withStreamedSpan } from './utils/beforeSendSpan';
 export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
 export { handleCallbackErrors } from './utils/handleCallbackErrors';
 export { parameterize, fmt } from './utils/parameterize';

packages/core/src/types-hoist/options.ts

@@ -6,7 +6,7 @@ import type { Log } from './log';
 import type { Metric } from './metric';
 import type { TracesSamplerSamplingContext } from './samplingcontext';
 import type { SdkMetadata } from './sdkmetadata';
-import type { SpanJSON } from './span';
+import type { SpanJSON, StreamedSpanJSON } from './span';
 import type { StackLineParser, StackParser } from './stacktrace';
 import type { TracePropagationTargets } from './tracing';
 import type { BaseTransportOptions, Transport } from './transport';
@@ -500,6 +500,14 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
    */
   strictTraceContinuation?: boolean;
 
+  /**
+   * The trace lifecycle, determining whether spans are sent statically when the entire local span tree is complete,
+   * or streamed in batches, following interval- and action-based triggers.
+   *
+   * @default 'static'
+   */
+  traceLifecycle?: 'static' | 'stream';
+
   /**
    * The organization ID for your Sentry project.
    *
@@ -579,11 +587,14 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
   /**
    * This function can be defined to modify a child span before it's sent.
    *
+   * When using `traceLifecycle: 'stream'`, wrap your callback with {@link withStreamedSpan}
+   * to receive and return {@link StreamedSpanJSON} instead.
+   *
    * @param span The span generated by the SDK.
    *
    * @returns The modified span payload that will be sent.
    */
-  beforeSendSpan?: (span: SpanJSON) => SpanJSON;
+  beforeSendSpan?: ((span: SpanJSON) => SpanJSON) | BeforeSendStramedSpanCallback;
 
   /**
    * An event-processing callback for transaction events, guaranteed to be invoked after all other event
@@ -615,6 +626,19 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
   beforeBreadcrumb?: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => Breadcrumb | null;
 }
 
+/**
+ * A callback for processing streamed spans before they are sent.
+ *
+ * @see {@link StreamedSpanJSON} for the streamed span format used with `traceLifecycle: 'stream'`
+ */
+export type BeforeSendStramedSpanCallback = ((span: StreamedSpanJSON) => StreamedSpanJSON) & {
+  /**
+   * When true, indicates this callback is designed to handle the {@link StreamedSpanJSON} format
+   * used with `traceLifecycle: 'stream'`. Set this by wrapping your callback with `withStreamedSpan`.
+   */
+  _streamed?: true;
+};
+
 /** Base configuration options for every SDK. */
 export interface CoreOptions<TO extends BaseTransportOptions = BaseTransportOptions>
   extends Omit<Partial<ClientOptions<TO>>, 'integrations' | 'transport' | 'stackParser'> {

packages/core/src/utils/beforeSendSpan.ts

@@ -0,0 +1,41 @@
+import type { BeforeSendStramedSpanCallback, ClientOptions } from '../types-hoist/options';
+import type { StreamedSpanJSON } from '../types-hoist/span';
+import { addNonEnumerableProperty } from './object';
+
+/**
+ * A wrapper to use the new span format in your `beforeSendSpan` callback.
+ *
+ * When using `traceLifecycle: 'stream'`, wrap your callback with this function
+ * to receive and return {@link StreamedSpanJSON} instead of the standard {@link SpanJSON}.
+ *
+ * @example
+ *
+ * Sentry.init({
+ *   traceLifecycle: 'stream',
+ *   beforeSendSpan: withStreamedSpan((span) => {
+ *     // span is of type StreamedSpanJSON
+ *     return span;
+ *   }),
+ * });
+ *
+ * @param callback - The callback function that receives and returns a {@link StreamedSpanJSON}.
+ * @returns A callback that is compatible with the `beforeSendSpan` option when using `traceLifecycle: 'stream'`.
+ */
+export function withStreamedSpan(
+  callback: (span: StreamedSpanJSON) => StreamedSpanJSON,
+): BeforeSendStramedSpanCallback {
+  addNonEnumerableProperty(callback, '_streamed', true);
+  return callback;
+}
+
+/**
+ * Typesafe check to identify if a `beforeSendSpan` callback expects the streamed span JSON format.
+ *
+ * @param callback - The `beforeSendSpan` callback to check.
+ * @returns `true` if the callback was wrapped with {@link withStreamedSpan}.
+ */
+export function isStreamedBeforeSendSpanCallback(
+  callback: ClientOptions['beforeSendSpan'],
+): callback is BeforeSendStramedSpanCallback {
+  return !!callback && '_streamed' in callback && !!callback._streamed;
+}

packages/core/test/lib/utils/beforeSendSpan.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it, vi } from 'vitest';
+import { withStreamedSpan } from '../../../src';
+import { isStreamedBeforeSendSpanCallback } from '../../../src/utils/beforeSendSpan';
+
+describe('beforeSendSpan for span streaming', () => {
+  describe('withStreamedSpan', () => {
+    it('should be able to modify the span', () => {
+      const beforeSendSpan = vi.fn();
+      const wrapped = withStreamedSpan(beforeSendSpan);
+      expect(wrapped._streamed).toBe(true);
+    });
+  });
+
+  describe('isStreamedBeforeSendSpanCallback', () => {
+    it('returns true if the callback is wrapped with withStreamedSpan', () => {
+      const beforeSendSpan = vi.fn();
+      const wrapped = withStreamedSpan(beforeSendSpan);
+      expect(isStreamedBeforeSendSpanCallback(wrapped)).toBe(true);
+    });
+
+    it('returns false if the callback is not wrapped with withStreamedSpan', () => {
+      const beforeSendSpan = vi.fn();
+      expect(isStreamedBeforeSendSpanCallback(beforeSendSpan)).toBe(false);
+    });
+  });
+});