replace usages/add eslint ignores in core

Author: Lms24

packages/core/src/scope.ts

@@ -334,6 +334,9 @@ export class Scope implements ScopeInterface {
     // Often, this span (if it exists at all) will be a transaction, but it's not guaranteed to be. Regardless, it will
     // have a pointer to the currently-active transaction.
     const span = this._span;
+    // Cannot replace with getRootSpan because getRootSpan returns a span, not a transaction
+    // Also, this method will be removed anyway.
+    // eslint-disable-next-line deprecation/deprecation
     return span && span.transaction;
   }
 

packages/core/src/server-runtime-client.ts

@@ -26,7 +26,7 @@ import {
   getDynamicSamplingContextFromClient,
   getDynamicSamplingContextFromSpan,
 } from './tracing';
-import { spanToTraceContext } from './utils/spanUtils';
+import { getRootSpan, spanToTraceContext } from './utils/spanUtils';
 
 export interface ServerRuntimeClientOptions extends ClientOptions<BaseTransportOptions> {
   platform?: string;
@@ -262,7 +262,7 @@ export class ServerRuntimeClient<
     // eslint-disable-next-line deprecation/deprecation
     const span = scope.getSpan();
     if (span) {
-      const samplingContext = span.transaction ? getDynamicSamplingContextFromSpan(span) : undefined;
+      const samplingContext = getRootSpan(span) ? getDynamicSamplingContextFromSpan(span) : undefined;
       return [samplingContext, spanToTraceContext(span)];
     }
 

packages/core/src/tracing/dynamicSamplingContext.ts

@@ -3,7 +3,7 @@ import { dropUndefinedKeys } from '@sentry/utils';
 
 import { DEFAULT_ENVIRONMENT } from '../constants';
 import { getClient, getCurrentScope } from '../exports';
-import { spanIsSampled, spanToJSON } from '../utils/spanUtils';
+import { getRootSpan, spanIsSampled, spanToJSON } from '../utils/spanUtils';
 
 /**
  * Creates a dynamic sampling context from a client.
@@ -54,9 +54,8 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<
   // passing emit=false here to only emit later once the DSC is actually populated
   const dsc = getDynamicSamplingContextFromClient(spanToJSON(span).trace_id || '', client, getCurrentScope());
 
-  // As long as we use `Transaction`s internally, this should be fine.
-  // TODO: We need to replace this with a `getRootSpan(span)` function though
-  const txn = span.transaction as TransactionWithV7FrozenDsc | undefined;
+  // TODO (v8): Remove v7FrozenDsc as a Transaction will no longer have _frozenDynamicSamplingContext
+  const txn = getRootSpan(span) as TransactionWithV7FrozenDsc | undefined;
   if (!txn) {
     return dsc;
   }

packages/core/src/tracing/span.ts

@@ -19,6 +19,7 @@ import { DEBUG_BUILD } from '../debug-build';
 import {
   TRACE_FLAG_NONE,
   TRACE_FLAG_SAMPLED,
+  getRootSpan,
   spanTimeInputToSeconds,
   spanToJSON,
   spanToTraceContext,
@@ -305,12 +306,16 @@ export class Span implements SpanInterface {
       childSpan.spanRecorder.add(childSpan);
     }
 
-    childSpan.transaction = this.transaction;
+    const rootSpan = getRootSpan(this);
+    // TODO: still set span.transaction here until we have a more permanent solution
+    // Probably similarly to the weakmap we hold in node-experimental
+    // eslint-disable-next-line deprecation/deprecation
+    childSpan.transaction = rootSpan as Transaction;
 
-    if (DEBUG_BUILD && childSpan.transaction) {
+    if (DEBUG_BUILD && rootSpan) {
       const opStr = (spanContext && spanContext.op) || '< unknown op >';
       const nameStr = spanToJSON(childSpan).description || '< unknown name >';
-      const idStr = childSpan.transaction.spanContext().spanId;
+      const idStr = rootSpan.spanContext().spanId;
 
       const logMessage = `[Tracing] Starting '${opStr}' span on transaction '${nameStr}' (${idStr}).`;
       logger.log(logMessage);
@@ -417,11 +422,12 @@ export class Span implements SpanInterface {
 
   /** @inheritdoc */
   public end(endTimestamp?: SpanTimeInput): void {
+    const rootSpan = getRootSpan(this);
     if (
       DEBUG_BUILD &&
       // Don't call this for transactions
-      this.transaction &&
-      this.transaction.spanContext().spanId !== this._spanId
+      rootSpan &&
+      rootSpan.spanContext().spanId !== this._spanId
     ) {
       const logMessage = this._logMessage;
       if (logMessage) {

packages/core/src/tracing/transaction.ts

@@ -66,6 +66,8 @@ export class Transaction extends SpanClass implements TransactionInterface {
     this._trimEnd = transactionContext.trimEnd;
 
     // this is because transactions are also spans, and spans have a transaction pointer
+    // TODO (v8): Replace this with another way to set the root span
+    // eslint-disable-next-line deprecation/deprecation
     this.transaction = this;
 
     // If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means

packages/core/src/utils/applyScopeDataToEvent.ts

@@ -1,7 +1,7 @@
 import type { Breadcrumb, Event, PropagationContext, ScopeData, Span } from '@sentry/types';
 import { arrayify } from '@sentry/utils';
 import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
-import { spanToJSON, spanToTraceContext } from './spanUtils';
+import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';
 
 /**
  * Applies data from the scope to the event and runs all event processors on it.
@@ -174,13 +174,13 @@ function applySdkMetadataToEvent(
 
 function applySpanToEvent(event: Event, span: Span): void {
   event.contexts = { trace: spanToTraceContext(span), ...event.contexts };
-  const transaction = span.transaction;
-  if (transaction) {
+  const rootSpan = getRootSpan(span);
+  if (rootSpan) {
     event.sdkProcessingMetadata = {
       dynamicSamplingContext: getDynamicSamplingContextFromSpan(span),
       ...event.sdkProcessingMetadata,
     };
-    const transactionName = spanToJSON(transaction).description;
+    const transactionName = spanToJSON(rootSpan).description;
     if (transactionName) {
       event.tags = { transaction: transactionName, ...event.tags };
     }

packages/core/src/utils/spanUtils.ts

@@ -117,5 +117,7 @@ export function spanIsSampled(span: Span): boolean {
  * If the given span has no root span or transaction, `undefined` is returned.
  */
 export function getRootSpan(span: Span): Span | undefined {
+  // TODO (v8): Remove this check and just return span
+  // eslint-disable-next-line deprecation/deprecation
   return span.transaction;
 }

packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

@@ -20,7 +20,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
   });
 
   test('returns the DSC provided during transaction creation', () => {
-    // eslint-disable-next-line deprecation/deprecation
+    // eslint-disable-next-line deprecation/deprecation -- using old API on purpose
     const transaction = new Transaction({
       name: 'tx',
       metadata: { dynamicSamplingContext: { environment: 'myEnv' } },
@@ -68,7 +68,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
   });
 
   test('returns a new DSC, if no DSC was provided during transaction creation (via new Txn and deprecated metadata)', () => {
-    // eslint-disable-next-line deprecation/deprecation
+    // eslint-disable-next-line deprecation/deprecation -- using old API on purpose
     const transaction = new Transaction({
       name: 'tx',
       metadata: {
@@ -92,7 +92,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 
   describe('Including transaction name in DSC', () => {
     test('is not included if transaction source is url', () => {
-      // eslint-disable-next-line deprecation/deprecation
+      // eslint-disable-next-line deprecation/deprecation -- using old API on purpose
       const transaction = new Transaction({
         name: 'tx',
         metadata: {
@@ -109,8 +109,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
       ['is included if transaction source is parameterized route/url', 'route'],
       ['is included if transaction source is a custom name', 'custom'],
     ])('%s', (_: string, source) => {
-      // eslint-disable-next-line deprecation/deprecation
-      const transaction = new Transaction({
+      const transaction = startInactiveSpan({
         name: 'tx',
         metadata: {
           ...(source && { source: source as TransactionSource }),
@@ -120,7 +119,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
       // Only setting the attribute manually because we're directly calling new Transaction()
       transaction?.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, source);
 
-      const dsc = getDynamicSamplingContextFromSpan(transaction);
+      const dsc = getDynamicSamplingContextFromSpan(transaction!);
 
       expect(dsc.transaction).toEqual('tx');
     });

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

@@ -1,6 +1,5 @@
 import { TRACEPARENT_REGEXP, timestampInSeconds } from '@sentry/utils';
-import { Transaction } from '../../../build/types';
-import { Span, spanToTraceHeader } from '../../../src';
+import { Span, Transaction, spanToTraceHeader } from '../../../src';
 import { getRootSpan, spanIsSampled, spanTimeInputToSeconds, spanToJSON } from '../../../src/utils/spanUtils';
 
 describe('spanToTraceHeader', () => {
@@ -133,6 +132,7 @@ 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
+    // eslint-disable-next-line deprecation/deprecation
     root.transaction = root;
 
     // eslint-disable-next-line deprecation/deprecation
@@ -141,6 +141,7 @@ describe('getRootSpan', () => {
   });
 
   it('returns the root span of a span (Transaction)', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const root = new Transaction({ name: 'test' });
 
     // eslint-disable-next-line deprecation/deprecation
@@ -149,6 +150,7 @@ describe('getRootSpan', () => {
   });
 
   it('returns the span itself if it is a root span', () => {
+    // eslint-disable-next-line deprecation/deprecation
     const span = new Transaction({ name: 'test' });
 
     expect(getRootSpan(span)).toBe(span);