wip

Author: Lms24

packages/core/src/tracing/span.ts

@@ -105,6 +105,7 @@ export class Span implements SpanInterface {
 
   /**
    * @inheritDoc
+   * @deprecated Use top level `Sentry.getRootSpan()` instead
    */
   public transaction?: Transaction;
 

packages/core/src/utils/spanUtils.ts

@@ -107,3 +107,15 @@ export function spanIsSampled(span: Span): boolean {
   // eslint-disable-next-line no-bitwise
   return Boolean(traceFlags & TRACE_FLAG_SAMPLED);
 }
+
+/**
+ * Returns the root span of a given span.
+ *
+ * As long as we use `Transaction`s internally, the returned root span
+ * will be a `Transaction` but be aware that this might change in the future.
+ *
+ * If the given span has no root span or transaction, `undefined` is returned.
+ */
+export function getRootSpan(span: Span): Span | undefined {
+  return span.transaction;
+}

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

@@ -1,6 +1,7 @@
 import { TRACEPARENT_REGEXP, timestampInSeconds } from '@sentry/utils';
+import { Transaction } from '../../../build/types';
 import { Span, spanToTraceHeader } from '../../../src';
-import { spanIsSampled, spanTimeInputToSeconds, spanToJSON } from '../../../src/utils/spanUtils';
+import { getRootSpan, spanIsSampled, spanTimeInputToSeconds, spanToJSON } from '../../../src/utils/spanUtils';
 
 describe('spanToTraceHeader', () => {
   test('simple', () => {
@@ -127,3 +128,35 @@ describe('spanIsSampled', () => {
     expect(spanIsSampled(span)).toBe(false);
   });
 });
+
+describe('getRootSpan', () => {
+  it('returns the root span of a span (Span)', () => {
+    const root = new Span({ name: 'test' });
+    // @ts-expect-error this is highly illegal and shouldn't happen IRL
+    root.transaction = root;
+
+    // eslint-disable-next-line deprecation/deprecation
+    const childSpan = root.startChild({ name: 'child' });
+    expect(getRootSpan(childSpan)).toBe(root);
+  });
+
+  it('returns the root span of a span (Transaction)', () => {
+    const root = new Transaction({ name: 'test' });
+
+    // eslint-disable-next-line deprecation/deprecation
+    const childSpan = root.startChild({ name: 'child' });
+    expect(getRootSpan(childSpan)).toBe(root);
+  });
+
+  it('returns the span itself if it is a root span', () => {
+    const span = new Transaction({ name: 'test' });
+
+    expect(getRootSpan(span)).toBe(span);
+  });
+
+  it('returns undefined if span has no root span', () => {
+    const span = new Span({ name: 'test' });
+
+    expect(getRootSpan(span)).toBe(undefined);
+  });
+});

packages/types/src/span.ts

@@ -216,6 +216,7 @@ export interface Span extends SpanContext {
 
   /**
    * The transaction containing this span
+   * @deprecated Use top level `Sentry.getRootSpan()` instead
    */
   transaction?: Transaction;