ref(node-experimental): Remove custom breadcrumb handling

Instead, just rely on the default behavior of having these on the isolation scope.

Author: mydea

packages/node-experimental/src/index.ts

@@ -30,7 +30,6 @@ export { startSpan, startSpanManual, startInactiveSpan, getActiveSpan } from '@s
 export {
   getClient,
   isInitialized,
-  addBreadcrumb,
   captureException,
   captureEvent,
   captureMessage,
@@ -55,6 +54,7 @@ export { getCurrentHub, makeMain } from './sdk/hub';
 export { Scope } from './sdk/scope';
 
 export {
+  addBreadcrumb,
   makeNodeTransport,
   defaultStackParser,
   getSentryRelease,

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

@@ -3,8 +3,6 @@
 import type { Span } from '@opentelemetry/api';
 import { context, trace } from '@opentelemetry/api';
 import type {
-  Breadcrumb,
-  BreadcrumbHint,
   CaptureContext,
   Event,
   EventHint,
@@ -15,7 +13,6 @@ import type {
   SeverityLevel,
   User,
 } from '@sentry/types';
-import { consoleSandbox, dateTimestampInSeconds } from '@sentry/utils';
 import { getContextFromScope, getScopesFromContext, setScopesOnContext } from '../utils/contextData';
 
 import type { ExclusiveEventHintOrCaptureContext } from '../utils/prepareEvent';
@@ -116,29 +113,6 @@ export function captureEvent(event: Event, hint?: EventHint): string {
   return getCurrentScope().captureEvent(event, hint);
 }
 
-/**
- * Add a breadcrumb to the current isolation scope.
- */
-export function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): void {
-  const client = getClient();
-
-  const { beforeBreadcrumb, maxBreadcrumbs } = client.getOptions();
-
-  if (maxBreadcrumbs && maxBreadcrumbs <= 0) return;
-
-  const timestamp = dateTimestampInSeconds();
-  const mergedBreadcrumb = { timestamp, ...breadcrumb };
-  const finalBreadcrumb = beforeBreadcrumb
-    ? (consoleSandbox(() => beforeBreadcrumb(mergedBreadcrumb, hint)) as Breadcrumb | null)
-    : mergedBreadcrumb;
-
-  if (finalBreadcrumb === null) return;
-
-  client.emit('beforeAddBreadcrumb', finalBreadcrumb, hint);
-
-  getIsolationScope().addBreadcrumb(finalBreadcrumb, maxBreadcrumbs);
-}
-
 /**
  * Add a global event processor.
  */

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

@@ -9,9 +9,8 @@ import type {
   TransactionContext,
 } from '@sentry/types';
 
-import { endSession, startSession } from '@sentry/core';
+import { addBreadcrumb, endSession, startSession } from '@sentry/core';
 import {
-  addBreadcrumb,
   captureEvent,
   getClient,
   getCurrentScope,

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

@@ -1,6 +1,6 @@
 import { getGlobalScope as _getGlobalScope, setGlobalScope } from '@sentry/core';
 import { OpenTelemetryScope } from '@sentry/opentelemetry';
-import type { Breadcrumb, Client, Event, EventHint, SeverityLevel } from '@sentry/types';
+import type { Client, Event, EventHint, SeverityLevel } from '@sentry/types';
 import { uuid4 } from '@sentry/utils';
 
 import { getGlobalCarrier } from './globals';
@@ -161,13 +161,6 @@ export class Scope extends OpenTelemetryScope implements ScopeInterface {
     return eventId;
   }
 
-  /**
-   * @inheritDoc
-   */
-  public addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this {
-    return this._addBreadcrumb(breadcrumb, maxBreadcrumbs);
-  }
-
   /** Get scope data for this scope only. */
   public getOwnScopeData(): ScopeData {
     return super.getScopeData();

packages/node-experimental/test/integration/breadcrumbs.test.ts

@@ -1,6 +1,6 @@
-import { captureException, withScope } from '@sentry/core';
+import { addBreadcrumb, captureException, withScope } from '@sentry/core';
 import { startSpan } from '@sentry/opentelemetry';
-import { addBreadcrumb, getClient, withIsolationScope } from '../../src/sdk/api';
+import { getClient, withIsolationScope } from '../../src/sdk/api';
 
 import type { NodeExperimentalClient } from '../../src/types';
 import { cleanupOtel, mockSdkInit } from '../helpers/mockSdkInit';

packages/node-experimental/test/integration/scope.test.ts

@@ -41,11 +41,7 @@ describe('Integration | Scope', () => {
           scope2.setTag('tag3', 'val3');
 
           Sentry.startSpan({ name: 'outer' }, span => {
-            // TODO: This is "incorrect" until we stop cloning the current scope for setSpanScopes
-            // Once we change this, the scopes _should_ be the same again
-            if (enableTracing) {
-              expect(getSpanScopes(span)?.scope).not.toBe(scope2);
-            }
+            expect(getSpanScopes(span)?.scope).toBe(enableTracing ? scope2 : undefined);
 
             spanId = span.spanContext().spanId;
             traceId = span.spanContext().traceId;

packages/opentelemetry/src/custom/scope.ts

@@ -2,23 +2,17 @@ import type { Span } from '@opentelemetry/api';
 import type { TimedEvent } from '@opentelemetry/sdk-trace-base';
 import { Scope } from '@sentry/core';
 import type { Breadcrumb, ScopeData, SeverityLevel, Span as SentrySpan } from '@sentry/types';
-import { dateTimestampInSeconds, dropUndefinedKeys, logger, normalize } from '@sentry/utils';
+import { dropUndefinedKeys, logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from '../debug-build';
 import { InternalSentrySemanticAttributes } from '../semanticAttributes';
 import { convertOtelTimeToSeconds } from '../utils/convertOtelTimeToSeconds';
-import { getActiveSpan, getRootSpan } from '../utils/getActiveSpan';
+import { getActiveSpan } from '../utils/getActiveSpan';
 import { getSpanParent } from '../utils/spanData';
 import { spanHasEvents } from '../utils/spanTypes';
 
 /** A fork of the classic scope with some otel specific stuff. */
 export class OpenTelemetryScope extends Scope {
-  /**
-   * This can be set to ensure the scope uses _this_ span as the active one,
-   * instead of using getActiveSpan().
-   */
-  public activeSpan: Span | undefined;
-
   /**
    * @inheritDoc
    */
@@ -71,26 +65,6 @@ export class OpenTelemetryScope extends Scope {
     return this;
   }
 
-  /**
-   * @inheritDoc
-   */
-  public addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this {
-    const activeSpan = this.activeSpan || getActiveSpan();
-    const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined;
-
-    if (rootSpan) {
-      const mergedBreadcrumb = {
-        timestamp: dateTimestampInSeconds(),
-        ...breadcrumb,
-      };
-
-      rootSpan.addEvent(...breadcrumbToOtelEvent(mergedBreadcrumb));
-      return this;
-    }
-
-    return this._addBreadcrumb(breadcrumb, maxBreadcrumbs);
-  }
-
   /** @inheritDoc */
   public getScopeData(): ScopeData {
     const data = super.getScopeData();
@@ -100,17 +74,11 @@ export class OpenTelemetryScope extends Scope {
     return data;
   }
 
-  /** Add a breadcrumb to this scope. */
-  protected _addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this {
-    return super.addBreadcrumb(breadcrumb, maxBreadcrumbs);
-  }
-
   /**
    * @inheritDoc
    */
   protected _getBreadcrumbs(): Breadcrumb[] {
-    const span = this.activeSpan || getActiveSpan();
-
+    const span = getActiveSpan();
     const spanBreadcrumbs = span ? getBreadcrumbsForSpan(span) : [];
 
     return spanBreadcrumbs.length > 0 ? this._breadcrumbs.concat(spanBreadcrumbs) : this._breadcrumbs;
@@ -126,39 +94,6 @@ function getBreadcrumbsForSpan(span: Span): Breadcrumb[] {
   return events.map(otelEventToBreadcrumb);
 }
 
-function breadcrumbToOtelEvent(breadcrumb: Breadcrumb): Parameters<Span['addEvent']> {
-  const name = breadcrumb.message || '<no message>';
-
-  const dataAttrs = serializeBreadcrumbData(breadcrumb.data);
-
-  return [
-    name,
-    dropUndefinedKeys({
-      [InternalSentrySemanticAttributes.BREADCRUMB_TYPE]: breadcrumb.type,
-      [InternalSentrySemanticAttributes.BREADCRUMB_LEVEL]: breadcrumb.level,
-      [InternalSentrySemanticAttributes.BREADCRUMB_EVENT_ID]: breadcrumb.event_id,
-      [InternalSentrySemanticAttributes.BREADCRUMB_CATEGORY]: breadcrumb.category,
-      ...dataAttrs,
-    }),
-    breadcrumb.timestamp ? new Date(breadcrumb.timestamp * 1000) : undefined,
-  ];
-}
-
-function serializeBreadcrumbData(data: Breadcrumb['data']): undefined | Record<string, unknown> {
-  if (!data || Object.keys(data).length === 0) {
-    return undefined;
-  }
-
-  try {
-    const normalizedData = normalize(data);
-    return {
-      [InternalSentrySemanticAttributes.BREADCRUMB_DATA]: JSON.stringify(normalizedData),
-    };
-  } catch (e) {
-    return undefined;
-  }
-}
-
 function otelEventToBreadcrumb(event: TimedEvent): Breadcrumb {
   const attributes = event.attributes || {};
 

packages/opentelemetry/src/spanProcessor.ts

@@ -37,15 +37,7 @@ function onSpanStart(span: Span, parentContext: Context, _ScopeClass: typeof Ope
     // eslint-disable-next-line deprecation/deprecation
     const isolationScope = actualHub.getIsolationScope();
     setSpanHub(span, actualHub);
-
-    // Use this scope for finishing the span
-    // TODO: For now we need to clone this, as we need to store the `activeSpan` on it
-    // Once we can get rid of this (when we move breadcrumbs to the isolation scope),
-    // we can stop cloning this here
-    const finishScope = (scope as OpenTelemetryScope).clone();
-    // this is needed for breadcrumbs, for now, as they are stored on the span currently
-    finishScope.activeSpan = span;
-    setSpanScopes(span, { scope: finishScope, isolationScope });
+    setSpanScopes(span, { scope, isolationScope });
   }
 }