rename to setActiveSpanInBrowser

Author: Lms24

dev-packages/browser-integration-tests/suites/tracing/setSpanActive/nested-parentAlwaysRoot/test.ts

@@ -3,7 +3,7 @@ import { sentryTest } from '../../../../utils/fixtures';
 import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../utils/helpers';
 
 sentryTest(
-  'nested calls to setSpanActive with parentSpanIsAlwaysRootSpan=false result in correct parenting',
+  'nested calls to setActiveSpanInBrowser with parentSpanIsAlwaysRootSpan=false result in correct parenting',
   async ({ getLocalTestUrl, page }) => {
     if (shouldSkipTracingTest()) {
       sentryTest.skip();

dev-packages/browser-integration-tests/suites/tracing/setSpanActive/nested/test.ts

@@ -2,48 +2,51 @@ import { expect } from '@playwright/test';
 import { sentryTest } from '../../../../utils/fixtures';
 import { envelopeRequestParser, shouldSkipTracingTest, waitForTransactionRequest } from '../../../../utils/helpers';
 
-sentryTest('nested calls to setSpanActive still parent to root span by default', async ({ getLocalTestUrl, page }) => {
-  if (shouldSkipTracingTest()) {
-    sentryTest.skip();
-  }
-
-  const req = waitForTransactionRequest(page, e => e.transaction === 'checkout-flow');
-  const postCheckoutReq = waitForTransactionRequest(page, e => e.transaction === 'post-checkout');
-
-  const url = await getLocalTestUrl({ testDir: __dirname });
-  await page.goto(url);
-
-  const checkoutEvent = envelopeRequestParser(await req);
-  const postCheckoutEvent = envelopeRequestParser(await postCheckoutReq);
-
-  const checkoutSpanId = checkoutEvent.contexts?.trace?.span_id;
-  const postCheckoutSpanId = postCheckoutEvent.contexts?.trace?.span_id;
-
-  expect(checkoutSpanId).toMatch(/[a-f0-9]{16}/);
-  expect(postCheckoutSpanId).toMatch(/[a-f0-9]{16}/);
-
-  expect(checkoutEvent.spans).toHaveLength(4);
-  expect(postCheckoutEvent.spans).toHaveLength(1);
-
-  const checkoutStep1 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-1');
-  const checkoutStep2 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-2');
-  const checkoutStep21 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-2-1');
-  const checkoutStep3 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-3');
-
-  expect(checkoutStep1).toBeDefined();
-  expect(checkoutStep2).toBeDefined();
-  expect(checkoutStep21).toBeDefined();
-  expect(checkoutStep3).toBeDefined();
-
-  expect(checkoutStep1?.parent_span_id).toBe(checkoutSpanId);
-  expect(checkoutStep2?.parent_span_id).toBe(checkoutSpanId);
-  expect(checkoutStep3?.parent_span_id).toBe(checkoutSpanId);
-
-  // despite 2-1 being called within 2 AND setting 2 as active span, it's still parented to the
-  // root span due to this being default behaviour in browser environments
-  expect(checkoutStep21?.parent_span_id).toBe(checkoutSpanId);
-
-  const postCheckoutStep1 = postCheckoutEvent.spans?.find(s => s.description === 'post-checkout-1');
-  expect(postCheckoutStep1).toBeDefined();
-  expect(postCheckoutStep1?.parent_span_id).toBe(postCheckoutSpanId);
-});
+sentryTest(
+  'nested calls to setActiveSpanInBrowser still parent to root span by default',
+  async ({ getLocalTestUrl, page }) => {
+    if (shouldSkipTracingTest()) {
+      sentryTest.skip();
+    }
+
+    const req = waitForTransactionRequest(page, e => e.transaction === 'checkout-flow');
+    const postCheckoutReq = waitForTransactionRequest(page, e => e.transaction === 'post-checkout');
+
+    const url = await getLocalTestUrl({ testDir: __dirname });
+    await page.goto(url);
+
+    const checkoutEvent = envelopeRequestParser(await req);
+    const postCheckoutEvent = envelopeRequestParser(await postCheckoutReq);
+
+    const checkoutSpanId = checkoutEvent.contexts?.trace?.span_id;
+    const postCheckoutSpanId = postCheckoutEvent.contexts?.trace?.span_id;
+
+    expect(checkoutSpanId).toMatch(/[a-f0-9]{16}/);
+    expect(postCheckoutSpanId).toMatch(/[a-f0-9]{16}/);
+
+    expect(checkoutEvent.spans).toHaveLength(4);
+    expect(postCheckoutEvent.spans).toHaveLength(1);
+
+    const checkoutStep1 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-1');
+    const checkoutStep2 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-2');
+    const checkoutStep21 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-2-1');
+    const checkoutStep3 = checkoutEvent.spans?.find(s => s.description === 'checkout-step-3');
+
+    expect(checkoutStep1).toBeDefined();
+    expect(checkoutStep2).toBeDefined();
+    expect(checkoutStep21).toBeDefined();
+    expect(checkoutStep3).toBeDefined();
+
+    expect(checkoutStep1?.parent_span_id).toBe(checkoutSpanId);
+    expect(checkoutStep2?.parent_span_id).toBe(checkoutSpanId);
+    expect(checkoutStep3?.parent_span_id).toBe(checkoutSpanId);
+
+    // despite 2-1 being called within 2 AND setting 2 as active span, it's still parented to the
+    // root span due to this being default behaviour in browser environments
+    expect(checkoutStep21?.parent_span_id).toBe(checkoutSpanId);
+
+    const postCheckoutStep1 = postCheckoutEvent.spans?.find(s => s.description === 'post-checkout-1');
+    expect(postCheckoutStep1).toBeDefined();
+    expect(postCheckoutStep1?.parent_span_id).toBe(postCheckoutSpanId);
+  },
+);

packages/browser/src/index.bundle.tracing.replay.feedback.ts

@@ -22,7 +22,7 @@ export {
   startBrowserTracingNavigationSpan,
   startBrowserTracingPageLoadSpan,
 } from './tracing/browserTracingIntegration';
-export { setSpanActive } from './tracing/setSpanActive';
+export { setActiveSpanInBrowser } from './tracing/setActiveSpanInBrowser';
 
 export { reportPageLoaded } from './tracing/reportPageLoaded';
 

packages/browser/src/index.bundle.tracing.replay.ts

@@ -23,7 +23,7 @@ export {
   startBrowserTracingPageLoadSpan,
 } from './tracing/browserTracingIntegration';
 export { reportPageLoaded } from './tracing/reportPageLoaded';
-export { setSpanActive } from './tracing/setSpanActive';
+export { setActiveSpanInBrowser } from './tracing/setActiveSpanInBrowser';
 
 export { feedbackIntegrationShim as feedbackAsyncIntegration, feedbackIntegrationShim as feedbackIntegration };
 

packages/browser/src/index.bundle.tracing.ts

@@ -22,7 +22,7 @@ export {
   startBrowserTracingNavigationSpan,
   startBrowserTracingPageLoadSpan,
 } from './tracing/browserTracingIntegration';
-export { setSpanActive } from './tracing/setSpanActive';
+export { setActiveSpanInBrowser } from './tracing/setActiveSpanInBrowser';
 
 export { reportPageLoaded } from './tracing/reportPageLoaded';
 

packages/browser/src/index.ts

@@ -40,7 +40,7 @@ export {
   startBrowserTracingPageLoadSpan,
 } from './tracing/browserTracingIntegration';
 export { reportPageLoaded } from './tracing/reportPageLoaded';
-export { setSpanActive } from './tracing/setSpanActive';
+export { setActiveSpanInBrowser } from './tracing/setActiveSpanInBrowser';
 
 export type { RequestInstrumentationOptions } from './tracing/request';
 export {

packages/browser/src/tracing/setSpanActive.ts renamed to packages/browser/src/tracing/setActiveSpan.ts

@@ -22,7 +22,7 @@ import { _INTERNAL_setSpanForScope, getActiveSpan, getCurrentScope } from '@sent
  *
  * on('checkoutStarted', () => {
  *  checkoutSpan = Sentry.startInactiveSpan({ name: 'checkout-flow' });
- *  Sentry.setSpanActive(checkoutSpan);
+ *  Sentry.setActiveSpanInBrowser(checkoutSpan);
  * })
  *
  * // during this time, any spans started will be children of `checkoutSpan`:
@@ -37,11 +37,11 @@ import { _INTERNAL_setSpanForScope, getActiveSpan, getCurrentScope } from '@sent
  *
  * @param span - the span to set active
  */
-export function setSpanActive(span: Span): void {
+export function setActiveSpanInBrowser(span: Span): void {
   const maybePreviousActiveSpan = getActiveSpan();
 
   // If the span is already active, there's no need to double-patch or set it again.
-  // This also guards against users (for whatever reason) calling setSpanActive on SDK-started
+  // This also guards against users (for whatever reason) calling setActiveSpanInBrowser on SDK-started
   // idle spans like pageload or navigation spans. These will already be handled correctly by the SDK.
   // For nested situations, we have to double-patch to ensure we restore the correct previous span (see tests)
   if (maybePreviousActiveSpan === span) {

packages/browser/test/tracing/setActiveSpan.test.ts

@@ -0,0 +1,90 @@
+import { getActiveSpan, SentrySpan } from '@sentry/core';
+import { describe, expect, it } from 'vitest';
+import { setActiveSpanInBrowser } from '../../src';
+
+describe('setActiveSpanInBrowser', () => {
+  it('sets the passed span active the current scope', () => {
+    const span = new SentrySpan({ name: 'test' });
+    setActiveSpanInBrowser(span);
+    expect(getActiveSpan()).toBe(span);
+
+    span.end();
+    expect(getActiveSpan()).toBeUndefined();
+  });
+
+  it('handles multiple calls to setActiveSpanInBrowser', () => {
+    const span = new SentrySpan({ name: 'test' });
+    setActiveSpanInBrowser(span);
+    setActiveSpanInBrowser(span);
+    setActiveSpanInBrowser(span);
+    expect(getActiveSpan()).toBe(span);
+
+    span.end();
+    expect(getActiveSpan()).toBeUndefined();
+  });
+
+  it('handles changing active span while span is running', () => {
+    const span = new SentrySpan({ name: 'test' });
+    setActiveSpanInBrowser(span);
+
+    expect(getActiveSpan()).toBe(span);
+
+    const span2 = new SentrySpan({ name: 'test2' });
+    setActiveSpanInBrowser(span2);
+    expect(getActiveSpan()).toBe(span2);
+
+    span2.end();
+    expect(getActiveSpan()).toBe(span);
+
+    span.end();
+    expect(getActiveSpan()).toBeUndefined();
+  });
+
+  it('handles multiple span.end calls', () => {
+    const span = new SentrySpan({ name: 'test' });
+    setActiveSpanInBrowser(span);
+    setActiveSpanInBrowser(span);
+
+    expect(getActiveSpan()).toBe(span);
+
+    const span2 = new SentrySpan({ name: 'test2' });
+    setActiveSpanInBrowser(span2);
+    expect(getActiveSpan()).toBe(span2);
+
+    span2.end();
+    span2.end();
+    span2.end();
+    expect(getActiveSpan()).toBe(span);
+
+    span.end();
+    span.end();
+    expect(getActiveSpan()).toBeUndefined();
+  });
+
+  it('handles nested activation of the same span', () => {
+    const span1 = new SentrySpan({ name: 'test1', sampled: true });
+    const span2 = new SentrySpan({ name: 'test2', sampled: true });
+    expect(span1.isRecording()).toBe(true);
+    expect(span2.isRecording()).toBe(true);
+
+    setActiveSpanInBrowser(span1);
+    expect(getActiveSpan()).toBe(span1);
+
+    setActiveSpanInBrowser(span2);
+    expect(getActiveSpan()).toBe(span2);
+
+    setActiveSpanInBrowser(span1);
+    expect(getActiveSpan()).toBe(span1);
+
+    span2.end();
+    expect(getActiveSpan()).toBe(span1);
+    expect(span2.isRecording()).toBe(false);
+    expect(span1.isRecording()).toBe(true);
+
+    span1.end();
+    expect(getActiveSpan()).toBeUndefined();
+
+    expect(span1.isRecording()).toBe(false);
+    expect(span2.isRecording()).toBe(false);
+  });
+});