feat(tracing): Add enableTracing option (#7238)

Author: mydea

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+This release adds a new `enableTracing` option, which can be used instead of `tracesSampleRate` for an easier setup.
+Related to this, the `hasTracingEnabled` utility function was moved from `@sentry/tracing` to `@sentry/core`.
+The old export from `@sentry/tracing` has been deprecated and will be removed in v8.
+
 ## 7.37.2
 
 This release includes changes and fixes around text masking and blocking in Replay's `rrweb` dependency. See versions [1.102.0](https://github.com/getsentry/rrweb/releases/tag/1.102.0) and [1.103.0](https://github.com/getsentry/rrweb/releases/tag/1.103.0).

package.json

@@ -25,6 +25,7 @@
     "lint:eslint": "lerna run lint:eslint",
     "postpublish": "lerna run --stream --concurrency 1 postpublish",
     "test": "lerna run --ignore @sentry-internal/* test",
+    "test:unit": "lerna run --ignore @sentry-internal/* test:unit",
     "test-ci-browser": "lerna run test --ignore \"@sentry/{node,opentelemetry-node,serverless,nextjs,remix,gatsby}\" --ignore @sentry-internal/*",
     "test-ci-node": "ts-node ./scripts/node-unit-tests.ts",
     "test:update-snapshots": "lerna run test:update-snapshots"

packages/core/src/index.ts

@@ -30,6 +30,7 @@ export { SDK_VERSION } from './version';
 export { getIntegrationsToSetup } from './integration';
 export { FunctionToString, InboundFilters } from './integrations';
 export { prepareEvent } from './utils/prepareEvent';
+export { hasTracingEnabled } from './utils/hasTracingEnabled';
 
 import * as Integrations from './integrations';
 

packages/core/src/utils/hasTracingEnabled.ts

@@ -0,0 +1,23 @@
+import type { Options } from '@sentry/types';
+
+import { getCurrentHub } from '../hub';
+
+// Treeshakable guard to remove all code related to tracing
+declare const __SENTRY_TRACING__: boolean | undefined;
+
+/**
+ * Determines if tracing is currently enabled.
+ *
+ * Tracing is enabled when at least one of `tracesSampleRate` and `tracesSampler` is defined in the SDK config.
+ */
+export function hasTracingEnabled(
+  maybeOptions?: Pick<Options, 'tracesSampleRate' | 'tracesSampler' | 'enableTracing'> | undefined,
+): boolean {
+  if (typeof __SENTRY_TRACING__ === 'boolean' && !__SENTRY_TRACING__) {
+    return false;
+  }
+
+  const client = getCurrentHub().getClient();
+  const options = maybeOptions || (client && client.getOptions());
+  return !!options && (options.enableTracing || 'tracesSampleRate' in options || 'tracesSampler' in options);
+}

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

@@ -0,0 +1,32 @@
+import { hasTracingEnabled } from '../../../src';
+
+describe('hasTracingEnabled', () => {
+  const tracesSampler = () => 1;
+  const tracesSampleRate = 1;
+  it.each([
+    ['No options', undefined, false],
+    ['No tracesSampler or tracesSampleRate or enableTracing', {}, false],
+    ['With tracesSampler', { tracesSampler }, true],
+    ['With tracesSampleRate', { tracesSampleRate }, true],
+    ['With enableTracing=true', { enableTracing: true }, true],
+    ['With enableTracing=false', { enableTracing: false }, false],
+    ['With tracesSampler && enableTracing=false', { tracesSampler, enableTracing: false }, true],
+    ['With tracesSampleRate && enableTracing=false', { tracesSampler, enableTracing: false }, true],
+    ['With tracesSampler and tracesSampleRate', { tracesSampler, tracesSampleRate }, true],
+    [
+      'With tracesSampler and tracesSampleRate and enableTracing=true',
+      { tracesSampler, tracesSampleRate, enableTracing: true },
+      true,
+    ],
+    [
+      'With tracesSampler and tracesSampleRate and enableTracing=false',
+      { tracesSampler, tracesSampleRate, enableTracing: false },
+      true,
+    ],
+  ])(
+    '%s',
+    (_: string, input: Parameters<typeof hasTracingEnabled>[0], output: ReturnType<typeof hasTracingEnabled>) => {
+      expect(hasTracingEnabled(input)).toBe(output);
+    },
+  );
+});

packages/gatsby/package.json

@@ -20,6 +20,7 @@
     "access": "public"
   },
   "dependencies": {
+    "@sentry/core": "7.38.0",
     "@sentry/react": "7.38.0",
     "@sentry/tracing": "7.38.0",
     "@sentry/types": "7.38.0",

packages/gatsby/src/utils/integrations.ts

@@ -1,3 +1,4 @@
+import { hasTracingEnabled } from '@sentry/core';
 import * as Tracing from '@sentry/tracing';
 import type { Integration } from '@sentry/types';
 
@@ -13,7 +14,7 @@ export type UserIntegrations = Integration[] | UserFnIntegrations;
  * @param options The options users have defined.
  */
 export function getIntegrationsFromOptions(options: GatsbyOptions): UserIntegrations {
-  const isTracingEnabled = Tracing.hasTracingEnabled(options);
+  const isTracingEnabled = hasTracingEnabled(options);
   if (options.integrations === undefined) {
     return getIntegrationsFromArray([], isTracingEnabled);
   } else if (Array.isArray(options.integrations)) {

packages/nextjs/src/client/index.ts

@@ -1,7 +1,8 @@
+import { hasTracingEnabled } from '@sentry/core';
 import { RewriteFrames } from '@sentry/integrations';
 import type { BrowserOptions } from '@sentry/react';
 import { configureScope, init as reactInit, Integrations } from '@sentry/react';
-import { BrowserTracing, defaultRequestInstrumentationOptions, hasTracingEnabled } from '@sentry/tracing';
+import { BrowserTracing, defaultRequestInstrumentationOptions } from '@sentry/tracing';
 import type { EventProcessor } from '@sentry/types';
 
 import { getVercelEnv } from '../common/getVercelEnv';

packages/nextjs/src/edge/utils/edgeWrapperUtils.ts

@@ -1,5 +1,4 @@
-import { captureException, getCurrentHub, startTransaction } from '@sentry/core';
-import { hasTracingEnabled } from '@sentry/tracing';
+import { captureException, getCurrentHub, hasTracingEnabled, startTransaction } from '@sentry/core';
 import type { Span } from '@sentry/types';
 import {
   addExceptionMechanism,

packages/nextjs/src/server/index.ts

@@ -1,9 +1,8 @@
 import type { Carrier } from '@sentry/core';
-import { getHubFromCarrier, getMainCarrier } from '@sentry/core';
+import { getHubFromCarrier, getMainCarrier, hasTracingEnabled } from '@sentry/core';
 import { RewriteFrames } from '@sentry/integrations';
 import type { NodeOptions } from '@sentry/node';
 import { configureScope, getCurrentHub, init as nodeInit, Integrations } from '@sentry/node';
-import { hasTracingEnabled } from '@sentry/tracing';
 import type { EventProcessor } from '@sentry/types';
 import { escapeStringForRegex, logger } from '@sentry/utils';
 import * as domainModule from 'domain';