apply review feedback

Author: Lms24

packages/browser/src/integrations/spanstreaming.ts

@@ -24,7 +24,7 @@ export const spanStreamingIntegration = defineIntegration(() => {
     },
 
     setup(client) {
-      const initialMessage = 'spanStreamingIntegration requires';
+      const initialMessage = 'SpanStreaming integration requires';
       const fallbackMsg = 'Falling back to static trace lifecycle.';
 
       if (!hasSpanStreamingEnabled(client)) {
@@ -37,7 +37,8 @@ export const spanStreamingIntegration = defineIntegration(() => {
       // using an incompatible beforeSendSpan callback, we fall back to the static trace lifecycle.
       if (beforeSendSpan && !isStreamedBeforeSendSpanCallback(beforeSendSpan)) {
         client.getOptions().traceLifecycle = 'static';
-        debug.warn(`${initialMessage} a beforeSendSpan callback using \`withStreamSpan\`! ${fallbackMsg}`);
+        DEBUG_BUILD &&
+          debug.warn(`${initialMessage} a beforeSendSpan callback using \`withStreamedSpan\`! ${fallbackMsg}`);
         return;
       }
 

packages/browser/test/integrations/spanstreaming.test.ts

@@ -59,7 +59,7 @@ describe('spanStreamingIntegration', () => {
     client.init();
 
     expect(debugSpy).toHaveBeenCalledWith(
-      'spanStreamingIntegration requires `traceLifecycle` to be set to "stream"! Falling back to static trace lifecycle.',
+      'SpanStreaming integration requires `traceLifecycle` to be set to "stream"! Falling back to static trace lifecycle.',
     );
     debugSpy.mockRestore();
 
@@ -80,14 +80,14 @@ describe('spanStreamingIntegration', () => {
     client.init();
 
     expect(debugSpy).toHaveBeenCalledWith(
-      'spanStreamingIntegration requires a beforeSendSpan callback using `withStreamSpan`! Falling back to static trace lifecycle.',
+      'SpanStreaming integration requires a beforeSendSpan callback using `withStreamedSpan`! Falling back to static trace lifecycle.',
     );
     debugSpy.mockRestore();
 
     expect(client.getOptions().traceLifecycle).toBe('static');
   });
 
-  it('enqueues a span into the buffer when the span ends', () => {
+  it('does nothing if traceLifecycle set to "stream"', () => {
     const client = new BrowserClient({
       ...getDefaultBrowserClientOptions(),
       dsn: 'https://username@domain/123',
@@ -98,6 +98,19 @@ describe('spanStreamingIntegration', () => {
     SentryCore.setCurrentClient(client);
     client.init();
 
+    expect(client.getOptions().traceLifecycle).toBe('stream');
+  });
+
+  it('enqueues a span into the buffer when the span ends', () => {
+    const client = new BrowserClient({
+      ...getDefaultBrowserClientOptions(),
+      dsn: 'https://username@domain/123',
+      integrations: [spanStreamingIntegration()],
+    });
+
+    SentryCore.setCurrentClient(client);
+    client.init();
+
     const span = new SentryCore.SentrySpan({ name: 'test' });
     client.emit('afterSpanEnd', span);
 

packages/core/src/client.ts

@@ -621,13 +621,13 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
    * Register a callback for after a span is ended and the `spanEnd` hook has run.
    * NOTE: The span cannot be mutated anymore in this callback.
    */
-  public on(hook: 'afterSpanEnd', callback: (span: Span) => void): () => void;
+  public on(hook: 'afterSpanEnd', callback: (immutableSegmentSpan: Readonly<Span>) => void): () => void;
 
   /**
    * Register a callback for after a segment span is ended and the `segmentSpanEnd` hook has run.
    * NOTE: The segment span cannot be mutated anymore in this callback.
    */
-  public on(hook: 'afterSegmentSpanEnd', callback: (segmentSpan: Span) => void): () => void;
+  public on(hook: 'afterSegmentSpanEnd', callback: (immutableSegmentSpan: Readonly<Span>) => void): () => void;
 
   /**
    * Register a callback for when a span JSON is processed, to add some data to the span JSON.
@@ -912,14 +912,14 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
   public emit(hook: 'spanEnd', span: Span): void;
 
   /**
-   * Fire a hook event when a span ends.
+   * Fire a hook event after a span ends and the `spanEnd` hook has run.
    */
-  public emit(hook: 'afterSpanEnd', span: Span): void;
+  public emit(hook: 'afterSpanEnd', immutableSpan: Readonly<Span>): void;
 
   /**
-   * Fire a hook event when a segment span ends.
+   * Fire a hook event after a segment span ends and the `spanEnd` hook has run.
    */
-  public emit(hook: 'afterSegmentSpanEnd', segmentSpan: Span): void;
+  public emit(hook: 'afterSegmentSpanEnd', immutableSegmentSpan: Readonly<Span>): void;
 
   /**
    * Fire a hook event when a span JSON is processed, to add some data to the span JSON.

packages/core/src/tracing/spans/captureSpan.ts

@@ -51,7 +51,7 @@ export function captureSpan(span: Span, client: Client): SerializedStreamedSpanW
 
   applyCommonSpanAttributes(spanJSON, serializedSegmentSpan, client, finalScopeData);
 
-  if (span === segmentSpan) {
+  if (spanJSON.is_segment) {
     applyScopeToSegmentSpan(spanJSON, finalScopeData);
     // Allow hook subscribers to mutate the segment span JSON
     client.emit('processSegmentSpan', spanJSON);

…re/test/lib/utils/beforeSendSpan.test.ts …lib/tracing/spans/beforeSendSpan.test.tspackages/core/test/lib/utils/beforeSendSpan.test.ts renamed to packages/core/test/lib/tracing/spans/beforeSendSpan.test.ts packages/core/test/lib/utils/beforeSendSpan.test.ts renamed to packages/core/test/lib/tracing/spans/beforeSendSpan.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it, vi } from 'vitest';
-import { withStreamedSpan } from '../../../src';
-import { isStreamedBeforeSendSpanCallback } from '../../../src/tracing/spans/beforeSendSpan';
+import { withStreamedSpan } from '../../../../src';
+import { isStreamedBeforeSendSpanCallback } from '../../../../src/tracing/spans/beforeSendSpan';
 
 describe('beforeSendSpan for span streaming', () => {
   describe('withStreamedSpan', () => {