feat(core): Remove startTransaction export

Instead we, for now, inline this directly into core `trace` functions, which is the only place left where we use this.

Author: mydea

packages/browser/src/exports.ts

@@ -43,8 +43,6 @@ export {
   makeMain,
   setCurrentClient,
   Scope,
-  // eslint-disable-next-line deprecation/deprecation
-  startTransaction,
   continueTrace,
   SDK_VERSION,
   setContext,

packages/core/src/exports.ts

@@ -124,36 +124,6 @@ export function setUser(user: User | null): ReturnType<Hub['setUser']> {
   getIsolationScope().setUser(user);
 }
 
-/**
- * Starts a new `Transaction` and returns it. This is the entry point to manual tracing instrumentation.
- *
- * A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a
- * new child span within the transaction or any span, call the respective `.startChild()` method.
- *
- * Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.
- *
- * The transaction must be finished with a call to its `.end()` method, at which point the transaction with all its
- * finished child spans will be sent to Sentry.
- *
- * NOTE: This function should only be used for *manual* instrumentation. Auto-instrumentation should call
- * `startTransaction` directly on the hub.
- *
- * @param context Properties of the new `Transaction`.
- * @param customSamplingContext Information given to the transaction sampling function (along with context-dependent
- * default values). See {@link Options.tracesSampler}.
- *
- * @returns The transaction which was just started
- *
- * @deprecated Use `startSpan()`, `startSpanManual()` or `startInactiveSpan()` instead.
- */
-export function startTransaction(
-  context: TransactionContext,
-  customSamplingContext?: CustomSamplingContext,
-): ReturnType<Hub['startTransaction']> {
-  // eslint-disable-next-line deprecation/deprecation
-  return getCurrentHub().startTransaction({ ...context }, customSamplingContext);
-}
-
 /**
  * Create a cron monitor check in and send it to Sentry.
  *

packages/core/src/hub.ts

@@ -3,7 +3,6 @@ import type {
   Breadcrumb,
   BreadcrumbHint,
   Client,
-  CustomSamplingContext,
   Event,
   EventHint,
   Extra,
@@ -16,8 +15,6 @@ import type {
   Session,
   SessionContext,
   SeverityLevel,
-  Transaction,
-  TransactionContext,
   User,
 } from '@sentry/types';
 import { GLOBAL_OBJ, consoleSandbox, dateTimestampInSeconds, isThenable, logger, uuid4 } from '@sentry/utils';
@@ -438,46 +435,6 @@ export class Hub implements HubInterface {
     }
   }
 
-  /**
-   * Starts a new `Transaction` and returns it. This is the entry point to manual tracing instrumentation.
-   *
-   * A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a
-   * new child span within the transaction or any span, call the respective `.startChild()` method.
-   *
-   * Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.
-   *
-   * The transaction must be finished with a call to its `.end()` method, at which point the transaction with all its
-   * finished child spans will be sent to Sentry.
-   *
-   * @param context Properties of the new `Transaction`.
-   * @param customSamplingContext Information given to the transaction sampling function (along with context-dependent
-   * default values). See {@link Options.tracesSampler}.
-   *
-   * @returns The transaction which was just started
-   *
-   * @deprecated Use `startSpan()`, `startSpanManual()` or `startInactiveSpan()` instead.
-   */
-  public startTransaction(context: TransactionContext, customSamplingContext?: CustomSamplingContext): Transaction {
-    const result = this._callExtensionMethod<Transaction>('startTransaction', context, customSamplingContext);
-
-    if (DEBUG_BUILD && !result) {
-      // eslint-disable-next-line deprecation/deprecation
-      const client = this.getClient();
-      if (!client) {
-        logger.warn(
-          "Tracing extension 'startTransaction' is missing. You should 'init' the SDK before calling 'startTransaction'",
-        );
-      } else {
-        logger.warn(`Tracing extension 'startTransaction' has not been added. Call 'addTracingExtensions' before calling 'init':
-Sentry.addTracingExtensions();
-Sentry.init({...});
-`);
-      }
-    }
-
-    return result;
-  }
-
   /**
    * @inheritDoc
    *

packages/core/src/index.ts

@@ -17,8 +17,6 @@ export {
   captureMessage,
   close,
   flush,
-  // eslint-disable-next-line deprecation/deprecation
-  startTransaction,
   setContext,
   setExtra,
   setExtras,

packages/core/src/tracing/hubextensions.ts

@@ -1,66 +1,9 @@
-import type { ClientOptions, CustomSamplingContext, Hub, TransactionContext } from '@sentry/types';
-import { getMainCarrier } from '../asyncContext';
-
 import { registerErrorInstrumentation } from './errors';
-import { sampleTransaction } from './sampling';
-import { Transaction } from './transaction';
 
 /**
- * Creates a new transaction and adds a sampling decision if it doesn't yet have one.
- *
- * The Hub.startTransaction method delegates to this method to do its work, passing the Hub instance in as `this`, as if
- * it had been called on the hub directly. Exists as a separate function so that it can be injected into the class as an
- * "extension method."
- *
- * @param this: The Hub starting the transaction
- * @param transactionContext: Data used to configure the transaction
- * @param CustomSamplingContext: Optional data to be provided to the `tracesSampler` function (if any)
- *
- * @returns The new transaction
- *
- * @see {@link Hub.startTransaction}
- */
-function _startTransaction(
-  this: Hub,
-  transactionContext: TransactionContext,
-  customSamplingContext?: CustomSamplingContext,
-): Transaction {
-  // eslint-disable-next-line deprecation/deprecation
-  const client = this.getClient();
-  const options: Partial<ClientOptions> = (client && client.getOptions()) || {};
-
-  // eslint-disable-next-line deprecation/deprecation
-  let transaction = new Transaction(transactionContext, this);
-  transaction = sampleTransaction(transaction, options, {
-    name: transactionContext.name,
-    parentSampled: transactionContext.parentSampled,
-    transactionContext,
-    attributes: {
-      // eslint-disable-next-line deprecation/deprecation
-      ...transactionContext.data,
-      ...transactionContext.attributes,
-    },
-    ...customSamplingContext,
-  });
-  if (client) {
-    client.emit('startTransaction', transaction);
-    client.emit('spanStart', transaction);
-  }
-  return transaction;
-}
-
-/**
- * Adds tracing extensions to the global hub.
+ * Adds tracing extensions.
+ * TODO (v8): Do we still need this?? Can we solve this differently?
  */
 export function addTracingExtensions(): void {
-  const carrier = getMainCarrier();
-  if (!carrier.__SENTRY__) {
-    return;
-  }
-  carrier.__SENTRY__.extensions = carrier.__SENTRY__.extensions || {};
-  if (!carrier.__SENTRY__.extensions.startTransaction) {
-    carrier.__SENTRY__.extensions.startTransaction = _startTransaction;
-  }
-
   registerErrorInstrumentation();
 }

packages/core/src/tracing/sentrySpan.ts

@@ -60,8 +60,8 @@ export class SentrySpan implements Span {
   private _logMessage?: string;
 
   /**
-   * You should never call the constructor manually, always use `Sentry.startTransaction()`
-   * or call `startChild()` on an existing span.
+   * You should never call the constructor manually, always use `Sentry.startSpan()`
+   * or other span methods.
    * @internal
    * @hideconstructor
    * @hidden

packages/core/src/tracing/trace.ts

@@ -1,9 +1,17 @@
-import type { Hub, Scope, Span, SpanTimeInput, StartSpanOptions, TransactionContext } from '@sentry/types';
+import type {
+  ClientOptions,
+  Hub,
+  Scope,
+  Span,
+  SpanTimeInput,
+  StartSpanOptions,
+  TransactionContext,
+} from '@sentry/types';
 
 import { dropUndefinedKeys, logger, tracingContextFromHeaders } from '@sentry/utils';
 import type { AsyncContextStrategy } from '../asyncContext';
 import { getMainCarrier } from '../asyncContext';
-import { getCurrentScope, getIsolationScope, withScope } from '../currentScopes';
+import { getClient, getCurrentScope, getIsolationScope, withScope } from '../currentScopes';
 
 import { DEBUG_BUILD } from '../debug-build';
 import { getAsyncContextStrategy, getCurrentHub } from '../hub';
@@ -17,9 +25,11 @@ import {
   spanToJSON,
 } from '../utils/spanUtils';
 import { getDynamicSamplingContextFromSpan } from './dynamicSamplingContext';
+import { sampleTransaction } from './sampling';
 import { SentryNonRecordingSpan } from './sentryNonRecordingSpan';
 import type { SentrySpan } from './sentrySpan';
 import { SPAN_STATUS_ERROR } from './spanstatus';
+import { Transaction } from './transaction';
 import { setCapturedScopesOnSpan } from './utils';
 
 /**
@@ -324,8 +334,7 @@ function createChildSpanOrTransaction(
     const { traceId, spanId: parentSpanId } = parentSpan.spanContext();
     const sampled = spanIsSampled(parentSpan);
 
-    // eslint-disable-next-line deprecation/deprecation
-    span = hub.startTransaction({
+    span = _startTransaction({
       traceId,
       parentSpanId,
       parentSampled: sampled,
@@ -342,8 +351,7 @@ function createChildSpanOrTransaction(
       ...scope.getPropagationContext(),
     };
 
-    // eslint-disable-next-line deprecation/deprecation
-    span = hub.startTransaction({
+    span = _startTransaction({
       traceId,
       parentSpanId,
       parentSampled: sampled,
@@ -390,3 +398,26 @@ function getAcs(): AsyncContextStrategy {
   const carrier = getMainCarrier();
   return getAsyncContextStrategy(carrier);
 }
+
+function _startTransaction(transactionContext: TransactionContext): Transaction {
+  const client = getClient();
+  const options: Partial<ClientOptions> = (client && client.getOptions()) || {};
+
+  // eslint-disable-next-line deprecation/deprecation
+  let transaction = new Transaction(transactionContext, getCurrentHub());
+  transaction = sampleTransaction(transaction, options, {
+    name: transactionContext.name,
+    parentSampled: transactionContext.parentSampled,
+    transactionContext,
+    attributes: {
+      // eslint-disable-next-line deprecation/deprecation
+      ...transactionContext.data,
+      ...transactionContext.attributes,
+    },
+  });
+  if (client) {
+    client.emit('startTransaction', transaction);
+    client.emit('spanStart', transaction);
+  }
+  return transaction;
+}

packages/core/src/tracing/transaction.ts

@@ -45,8 +45,7 @@ export class Transaction extends SentrySpan implements TransactionInterface {
   private _metadata: Partial<TransactionMetadata>;
 
   /**
-   * This constructor should never be called manually. Those instrumenting tracing should use
-   * `Sentry.startTransaction()`, and internal methods should use `hub.startTransaction()`.
+   * This constructor should never be called manually.
    * @internal
    * @hideconstructor
    * @hidden

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

@@ -3,7 +3,6 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   Scope,
   addTracingExtensions,
-  getCurrentHub,
   getCurrentScope,
   getGlobalScope,
   getIsolationScope,
@@ -83,23 +82,6 @@ describe('startSpan', () => {
       }
     });
 
-    it('should return the same value as the callback if transactions are undefined', async () => {
-      // @ts-expect-error we are force overriding the transaction return to be undefined
-      // The `startTransaction` types are actually wrong - it can return undefined
-      // if tracingExtensions are not enabled
-      // eslint-disable-next-line deprecation/deprecation
-      jest.spyOn(getCurrentHub(), 'startTransaction').mockImplementationOnce(() => undefined);
-
-      try {
-        const result = await startSpan({ name: 'GET users/[id]' }, () => {
-          return callback();
-        });
-        expect(result).toEqual(expected);
-      } catch (e) {
-        expect(e).toEqual(expected);
-      }
-    });
-
     it('creates a transaction', async () => {
       let _span: Span | undefined = undefined;
       client.on('finishTransaction', transaction => {

packages/node-experimental/src/sdk/hub.ts

@@ -76,18 +76,6 @@ export function getCurrentHub(): Hub {
       return getClient().getIntegration(integration);
     },
 
-    startTransaction(
-      _context: TransactionContext,
-      _customSamplingContext?: CustomSamplingContext,
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ): any {
-      // eslint-disable-next-line no-console
-      console.warn('startTransaction is a noop in @sentry/node. Use `startSpan` instead.');
-      // We return an object here as hub.ts checks for the result of this
-      // and renders a different warning if this is empty
-      return {};
-    },
-
     startSession,
 
     endSession,