From fe0794341c8d99baa09f53451288d5b756fd0c47 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Mon, 4 Mar 2024 19:31:39 -0500 Subject: [PATCH] feat(v8/tracing): Delete BrowserTracing class --- .../browserTracingIntegrationShim/test.ts | 2 +- .../integration-shims/src/BrowserTracing.ts | 2 +- .../src/browser/browsertracing.ts | 455 ------------------ .../tracing-internal/src/browser/index.ts | 2 +- 4 files changed, 3 insertions(+), 458 deletions(-) delete mode 100644 packages/tracing-internal/src/browser/browsertracing.ts diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim/test.ts b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim/test.ts index 71510468a513..c52bf2a6b68c 100644 --- a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim/test.ts +++ b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim/test.ts @@ -30,7 +30,7 @@ sentryTest( expect(requestCount).toBe(0); expect(consoleMessages).toEqual([ - 'You are using new BrowserTracing() even though this bundle does not include tracing.', + 'You are using browserTracingIntegration() even though this bundle does not include tracing.', ]); }, ); diff --git a/packages/integration-shims/src/BrowserTracing.ts b/packages/integration-shims/src/BrowserTracing.ts index 32841d842718..7fa357dffabf 100644 --- a/packages/integration-shims/src/BrowserTracing.ts +++ b/packages/integration-shims/src/BrowserTracing.ts @@ -9,7 +9,7 @@ import { consoleSandbox } from '@sentry/utils'; export const browserTracingIntegrationShim = defineIntegration((_options?: unknown) => { consoleSandbox(() => { // eslint-disable-next-line no-console - console.warn('You are using new BrowserTracing() even though this bundle does not include tracing.'); + console.warn('You are using browserTracingIntegration() even though this bundle does not include tracing.'); }); return { diff --git a/packages/tracing-internal/src/browser/browsertracing.ts b/packages/tracing-internal/src/browser/browsertracing.ts deleted file mode 100644 index e499fd9ff11b..000000000000 --- a/packages/tracing-internal/src/browser/browsertracing.ts +++ /dev/null @@ -1,455 +0,0 @@ -import type { Hub, IdleTransaction } from '@sentry/core'; -import { spanToJSON } from '@sentry/core'; -import { - SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, - TRACING_DEFAULTS, - addTracingExtensions, - getActiveTransaction, - startIdleTransaction, -} from '@sentry/core'; -import type { EventProcessor, Integration, Transaction, TransactionContext, TransactionSource } from '@sentry/types'; -import { getDomElement, logger, propagationContextFromHeaders } from '@sentry/utils'; - -import { DEBUG_BUILD } from '../common/debug-build'; -import { registerBackgroundTabDetection } from './backgroundtab'; -import { - addPerformanceEntries, - startTrackingInteractions, - startTrackingLongTasks, - startTrackingWebVitals, -} from './metrics'; -import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './request'; -import { instrumentRoutingWithDefaults } from './router'; -import { WINDOW } from './types'; - -export const BROWSER_TRACING_INTEGRATION_ID = 'BrowserTracing'; - -/** Options for Browser Tracing integration */ -export interface BrowserTracingOptions { - /** - * The time to wait in ms until the transaction will be finished during an idle state. An idle state is defined - * by a moment where there are no in-progress spans. - * - * The transaction will use the end timestamp of the last finished span as the endtime for the transaction. - * If there are still active spans when this the `idleTimeout` is set, the `idleTimeout` will get reset. - * Time is in ms. - * - * Default: 1000 - */ - idleTimeout: number; - - /** - * The max duration for a transaction. If a transaction duration hits the `finalTimeout` value, it - * will be finished. - * Time is in ms. - * - * Default: 30000 - */ - finalTimeout: number; - - /** - * The heartbeat interval. If no new spans are started or open spans are finished within 3 heartbeats, - * the transaction will be finished. - * Time is in ms. - * - * Default: 5000 - */ - heartbeatInterval: number; - - /** - * Flag to enable/disable creation of `navigation` transaction on history changes. - * - * Default: true - */ - startTransactionOnLocationChange: boolean; - - /** - * Flag to enable/disable creation of `pageload` transaction on first pageload. - * - * Default: true - */ - startTransactionOnPageLoad: boolean; - - /** - * Flag Transactions where tabs moved to background with "cancelled". Browser background tab timing is - * not suited towards doing precise measurements of operations. By default, we recommend that this option - * be enabled as background transactions can mess up your statistics in nondeterministic ways. - * - * Default: true - */ - markBackgroundTransactions: boolean; - - /** - * If true, Sentry will capture long tasks and add them to the corresponding transaction. - * - * Default: true - */ - enableLongTask: boolean; - - /** - * Flag to disable patching all together for fetch requests. - * - * Default: true - */ - traceFetch: boolean; - - /** - * Flag to disable patching all together for xhr requests. - * - * Default: true - */ - traceXHR: boolean; - - /** - * If true, Sentry will capture http timings and add them to the corresponding http spans. - * - * Default: true - */ - enableHTTPTimings: boolean; - - /** - * _metricOptions allows the user to send options to change how metrics are collected. - * - * _metricOptions is currently experimental. - * - * Default: undefined - */ - _metricOptions?: Partial<{ - /** - * @deprecated This property no longer has any effect and will be removed in v8. - */ - _reportAllChanges: boolean; - }>; - - /** - * _experiments allows the user to send options to define how this integration works. - * Note that the `enableLongTask` options is deprecated in favor of the option at the top level, and will be removed in v8. - * - * TODO (v8): Remove enableLongTask - * - * Default: undefined - */ - _experiments: Partial<{ - enableLongTask: boolean; - enableInteractions: boolean; - onStartRouteTransaction: (t: Transaction | undefined, ctx: TransactionContext, getCurrentHub: () => Hub) => void; - }>; - - /** - * beforeNavigate is called before a pageload/navigation transaction is created and allows users to modify transaction - * context data, or drop the transaction entirely (by setting `sampled = false` in the context). - * - * Note: For legacy reasons, transactions can also be dropped by returning `undefined`. - * - * @param context: The context data which will be passed to `startTransaction` by default - * - * @returns A (potentially) modified context object, with `sampled = false` if the transaction should be dropped. - */ - beforeNavigate?(this: void, context: TransactionContext): TransactionContext | undefined; - - /** - * Instrumentation that creates routing change transactions. By default creates - * pageload and navigation transactions. - */ - routingInstrumentation( - this: void, - customStartTransaction: (context: TransactionContext) => T | undefined, - startTransactionOnPageLoad?: boolean, - startTransactionOnLocationChange?: boolean, - ): void; - - /** - * This function will be called before creating a span for a request with the given url. - * Return false if you don't want a span for the given url. - * - * Default: (url: string) => true - */ - shouldCreateSpanForRequest?(this: void, url: string): boolean; -} - -const DEFAULT_BROWSER_TRACING_OPTIONS: BrowserTracingOptions = { - ...TRACING_DEFAULTS, - markBackgroundTransactions: true, - routingInstrumentation: instrumentRoutingWithDefaults, - startTransactionOnLocationChange: true, - startTransactionOnPageLoad: true, - enableLongTask: true, - _experiments: {}, - ...defaultRequestInstrumentationOptions, -}; - -/** - * The Browser Tracing integration automatically instruments browser pageload/navigation - * actions as transactions, and captures requests, metrics and errors as spans. - * - * The integration can be configured with a variety of options, and can be extended to use - * any routing library. This integration uses {@see IdleTransaction} to create transactions. - * - * @deprecated Use `browserTracingIntegration()` instead. - */ -export class BrowserTracing implements Integration { - // This class currently doesn't have a static `id` field like the other integration classes, because it prevented - // @sentry/tracing from being treeshaken. Tree shakers do not like static fields, because they behave like side effects. - // TODO: Come up with a better plan, than using static fields on integration classes, and use that plan on all - // integrations. - - /** Browser Tracing integration options */ - public options: BrowserTracingOptions; - - /** - * @inheritDoc - */ - public name: string; - - private _getCurrentHub?: () => Hub; - - private _latestRouteName?: string; - private _latestRouteSource?: TransactionSource; - - private _collectWebVitals: () => void; - - public constructor(_options?: Partial) { - this.name = BROWSER_TRACING_INTEGRATION_ID; - - addTracingExtensions(); - - this.options = { - ...DEFAULT_BROWSER_TRACING_OPTIONS, - ..._options, - }; - - // Special case: enableLongTask can be set in _experiments - // TODO (v8): Remove this in v8 - if (this.options._experiments.enableLongTask !== undefined) { - this.options.enableLongTask = this.options._experiments.enableLongTask; - } - - this._collectWebVitals = startTrackingWebVitals(); - if (this.options.enableLongTask) { - startTrackingLongTasks(); - } - if (this.options._experiments.enableInteractions) { - startTrackingInteractions(); - } - } - - /** - * @inheritDoc - */ - public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void { - this._getCurrentHub = getCurrentHub; - const hub = getCurrentHub(); - // eslint-disable-next-line deprecation/deprecation - const client = hub.getClient(); - const clientOptions = client && client.getOptions(); - - const { - routingInstrumentation: instrumentRouting, - startTransactionOnLocationChange, - startTransactionOnPageLoad, - markBackgroundTransactions, - traceFetch, - traceXHR, - shouldCreateSpanForRequest, - enableHTTPTimings, - _experiments, - } = this.options; - - instrumentRouting( - (context: TransactionContext) => { - const transaction = this._createRouteTransaction(context); - - this.options._experiments.onStartRouteTransaction && - this.options._experiments.onStartRouteTransaction(transaction, context, getCurrentHub); - - return transaction; - }, - startTransactionOnPageLoad, - startTransactionOnLocationChange, - ); - - if (markBackgroundTransactions) { - registerBackgroundTabDetection(); - } - - if (_experiments.enableInteractions) { - this._registerInteractionListener(); - } - - instrumentOutgoingRequests({ - traceFetch, - traceXHR, - tracePropagationTargets: clientOptions && clientOptions.tracePropagationTargets, - shouldCreateSpanForRequest, - enableHTTPTimings, - }); - } - - /** Create routing idle transaction. */ - private _createRouteTransaction(context: TransactionContext): Transaction | undefined { - if (!this._getCurrentHub) { - DEBUG_BUILD && - logger.warn(`[Tracing] Did not create ${context.op} transaction because _getCurrentHub is invalid.`); - return undefined; - } - - const hub = this._getCurrentHub(); - - const { beforeNavigate, idleTimeout, finalTimeout, heartbeatInterval } = this.options; - - const isPageloadTransaction = context.op === 'pageload'; - - let expandedContext: TransactionContext; - if (isPageloadTransaction) { - const sentryTrace = isPageloadTransaction ? getMetaContent('sentry-trace') : ''; - const baggage = isPageloadTransaction ? getMetaContent('baggage') : undefined; - const { traceId, dsc, parentSpanId, sampled } = propagationContextFromHeaders(sentryTrace, baggage); - expandedContext = { - traceId, - parentSpanId, - parentSampled: sampled, - ...context, - metadata: { - // eslint-disable-next-line deprecation/deprecation - ...context.metadata, - dynamicSamplingContext: dsc, - }, - trimEnd: true, - }; - } else { - expandedContext = { - trimEnd: true, - ...context, - }; - } - - const modifiedContext = typeof beforeNavigate === 'function' ? beforeNavigate(expandedContext) : expandedContext; - - // For backwards compatibility reasons, beforeNavigate can return undefined to "drop" the transaction (prevent it - // from being sent to Sentry). - const finalContext = modifiedContext === undefined ? { ...expandedContext, sampled: false } : modifiedContext; - - // If `beforeNavigate` set a custom name, record that fact - finalContext.attributes = - finalContext.name !== expandedContext.name - ? { ...finalContext.attributes, [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' } - : finalContext.attributes; - - this._latestRouteName = finalContext.name; - if (finalContext.attributes) { - this._latestRouteSource = finalContext.attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]; - } - - if (finalContext.sampled === false) { - DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`); - } - - DEBUG_BUILD && logger.log(`[Tracing] Starting ${finalContext.op} transaction on scope`); - - const { location } = WINDOW; - - const idleTransaction = startIdleTransaction( - hub, - finalContext, - idleTimeout, - finalTimeout, - true, - { location }, // for use in the tracesSampler - heartbeatInterval, - isPageloadTransaction, // should wait for finish signal if it's a pageload transaction - ); - - if (isPageloadTransaction) { - WINDOW.document.addEventListener('readystatechange', () => { - if (['interactive', 'complete'].includes(WINDOW.document.readyState)) { - idleTransaction.sendAutoFinishSignal(); - } - }); - - if (['interactive', 'complete'].includes(WINDOW.document.readyState)) { - idleTransaction.sendAutoFinishSignal(); - } - } - - idleTransaction.registerBeforeFinishCallback(transaction => { - this._collectWebVitals(); - addPerformanceEntries(transaction); - }); - - return idleTransaction as Transaction; - } - - /** Start listener for interaction transactions */ - private _registerInteractionListener(): void { - let inflightInteractionTransaction: IdleTransaction | undefined; - const registerInteractionTransaction = (): void => { - const { idleTimeout, finalTimeout, heartbeatInterval } = this.options; - const op = 'ui.action.click'; - - // eslint-disable-next-line deprecation/deprecation - const currentTransaction = getActiveTransaction(); - if (currentTransaction) { - const currentTransactionOp = spanToJSON(currentTransaction).op; - if (currentTransactionOp && ['navigation', 'pageload'].includes(currentTransactionOp)) { - DEBUG_BUILD && - logger.warn( - `[Tracing] Did not create ${op} transaction because a pageload or navigation transaction is in progress.`, - ); - return undefined; - } - } - - if (inflightInteractionTransaction) { - inflightInteractionTransaction.setFinishReason('interactionInterrupted'); - inflightInteractionTransaction.end(); - inflightInteractionTransaction = undefined; - } - - if (!this._getCurrentHub) { - DEBUG_BUILD && logger.warn(`[Tracing] Did not create ${op} transaction because _getCurrentHub is invalid.`); - return undefined; - } - - if (!this._latestRouteName) { - DEBUG_BUILD && logger.warn(`[Tracing] Did not create ${op} transaction because _latestRouteName is missing.`); - return undefined; - } - - const hub = this._getCurrentHub(); - const { location } = WINDOW; - - const context: TransactionContext = { - name: this._latestRouteName, - op, - trimEnd: true, - data: { - [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: this._latestRouteSource || 'url', - }, - }; - - inflightInteractionTransaction = startIdleTransaction( - hub, - context, - idleTimeout, - finalTimeout, - true, - { location }, // for use in the tracesSampler - heartbeatInterval, - ); - }; - - ['click'].forEach(type => { - addEventListener(type, registerInteractionTransaction, { once: false, capture: true }); - }); - } -} - -/** Returns the value of a meta tag */ -export function getMetaContent(metaName: string): string | undefined { - // Can't specify generic to `getDomElement` because tracing can be used - // in a variety of environments, have to disable `no-unsafe-member-access` - // as a result. - const metaTag = getDomElement(`meta[name=${metaName}]`); - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - return metaTag ? metaTag.getAttribute('content') : undefined; -} diff --git a/packages/tracing-internal/src/browser/index.ts b/packages/tracing-internal/src/browser/index.ts index 17464ad780af..d1bbbffe02b3 100644 --- a/packages/tracing-internal/src/browser/index.ts +++ b/packages/tracing-internal/src/browser/index.ts @@ -2,8 +2,8 @@ export * from '../exports'; export type { RequestInstrumentationOptions } from './request'; -export { BROWSER_TRACING_INTEGRATION_ID } from './browsertracing'; export { + BROWSER_TRACING_INTEGRATION_ID, browserTracingIntegration, startBrowserTracingNavigationSpan, startBrowserTracingPageLoadSpan,