ref: Use addBreadcrumb directly & allow to pass hint

mydea · mydea · commit 90ba85994a36 · 2023-12-18T09:55:24.000+01:00
Instead of using `hub.addBreadcrumb()`
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -1,5 +1,5 @@
 /* eslint-disable max-lines */
-import { getClient, getCurrentHub } from '@sentry/core';
+import { addBreadcrumb, getClient } from '@sentry/core';
 import type {
   Event as SentryEvent,
   HandlerDataConsole,
@@ -123,7 +123,7 @@ export class Breadcrumbs implements Integration {
  * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
  */
 function addSentryBreadcrumb(event: SentryEvent): void {
-  getCurrentHub().addBreadcrumb(
+  addBreadcrumb(
     {
       category: `sentry.${event.type === 'transaction' ? 'transaction' : 'event'}`,
       event_id: event.event_id,
@@ -173,7 +173,7 @@ function _domBreadcrumb(dom: BreadcrumbsOptions['dom']): (handlerData: HandlerDa
       return;
     }
 
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: `ui.${handlerData.name}`,
         message: target,
@@ -213,7 +213,7 @@ function _consoleBreadcrumb(handlerData: HandlerDataConsole): void {
     }
   }
 
-  getCurrentHub().addBreadcrumb(breadcrumb, {
+  addBreadcrumb(breadcrumb, {
     input: handlerData.args,
     level: handlerData.level,
   });
@@ -247,7 +247,7 @@ function _xhrBreadcrumb(handlerData: HandlerDataXhr): void {
     endTimestamp,
   };
 
-  getCurrentHub().addBreadcrumb(
+  addBreadcrumb(
     {
       category: 'xhr',
       data,
@@ -282,7 +282,7 @@ function _fetchBreadcrumb(handlerData: HandlerDataFetch): void {
       endTimestamp,
     };
 
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: 'fetch',
         data,
@@ -303,7 +303,7 @@ function _fetchBreadcrumb(handlerData: HandlerDataFetch): void {
       startTimestamp,
       endTimestamp,
     };
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: 'fetch',
         data,
@@ -338,7 +338,7 @@ function _historyBreadcrumb(handlerData: HandlerDataHistory): void {
     from = parsedFrom.relative;
   }
 
-  getCurrentHub().addBreadcrumb({
+  addBreadcrumb({
     category: 'navigation',
     data: {
       from,
diff --git a/packages/browser/test/unit/integrations/breadcrumbs.test.ts b/packages/browser/test/unit/integrations/breadcrumbs.test.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub } from '@sentry/core';
+import * as SentryCore from '@sentry/core';
 import type { Client } from '@sentry/types';
 
 import { Breadcrumbs, BrowserClient, Hub, flush } from '../../../src';
@@ -18,21 +18,20 @@ jest.mock('@sentry/core', () => {
 
 describe('Breadcrumbs', () => {
   it('Should add sentry breadcrumb', async () => {
-    const addBreadcrumb = jest.fn();
-    hub.addBreadcrumb = addBreadcrumb;
-
     client = new BrowserClient({
       ...getDefaultBrowserClientOptions(),
       dsn: 'https://username@domain/123',
       integrations: [new Breadcrumbs()],
     });
 
-    getCurrentHub().bindClient(client);
+    SentryCore.getCurrentHub().bindClient(client);
+
+    const addBreadcrumbSpy = jest.spyOn(SentryCore, 'addBreadcrumb').mockImplementation(() => {});
 
     client.captureMessage('test');
     await flush(2000);
 
-    expect(addBreadcrumb.mock.calls[0][0].category).toEqual('sentry.event');
-    expect(addBreadcrumb.mock.calls[0][0].message).toEqual('test');
+    expect(addBreadcrumbSpy.mock.calls[0][0].category).toEqual('sentry.event');
+    expect(addBreadcrumbSpy.mock.calls[0][0].message).toEqual('test');
   });
 });
diff --git a/packages/core/src/exports.ts b/packages/core/src/exports.ts
@@ -1,5 +1,6 @@
 import type {
   Breadcrumb,
+  BreadcrumbHint,
   CaptureContext,
   CheckIn,
   Client,
@@ -90,8 +91,8 @@ export function configureScope(callback: (scope: Scope) => void): ReturnType<Hub
  *
  * @param breadcrumb The breadcrumb to record.
  */
-export function addBreadcrumb(breadcrumb: Breadcrumb): ReturnType<Hub['addBreadcrumb']> {
-  getCurrentHub().addBreadcrumb(breadcrumb);
+export function addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): ReturnType<Hub['addBreadcrumb']> {
+  getCurrentHub().addBreadcrumb(breadcrumb, hint);
 }
 
 /**
diff --git a/packages/node-experimental/src/integrations/http.ts b/packages/node-experimental/src/integrations/http.ts
@@ -3,7 +3,7 @@ import type { Span } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
-import { hasTracingEnabled, isSentryRequestUrl } from '@sentry/core';
+import { addBreadcrumb, hasTracingEnabled, isSentryRequestUrl } from '@sentry/core';
 import { _INTERNAL, getClient, getCurrentHub, getSpanKind, setSpanMetadata } from '@sentry/opentelemetry';
 import type { EventProcessor, Hub, Integration } from '@sentry/types';
 import { stringMatchesSomePattern } from '@sentry/utils';
@@ -159,7 +159,7 @@ export class Http implements Integration {
     }
 
     const data = _INTERNAL.getRequestSpanData(span);
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: 'http',
         data: {
diff --git a/packages/node-experimental/src/integrations/node-fetch.ts b/packages/node-experimental/src/integrations/node-fetch.ts
@@ -1,8 +1,8 @@
 import type { Span } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
 import type { Instrumentation } from '@opentelemetry/instrumentation';
-import { hasTracingEnabled } from '@sentry/core';
-import { _INTERNAL, getClient, getCurrentHub, getSpanKind } from '@sentry/opentelemetry';
+import { addBreadcrumb, hasTracingEnabled } from '@sentry/core';
+import { _INTERNAL, getClient, getSpanKind } from '@sentry/opentelemetry';
 import type { Integration } from '@sentry/types';
 
 import type { NodeExperimentalClient } from '../types';
@@ -114,7 +114,7 @@ export class NodeFetch extends NodePerformanceIntegration<NodeFetchOptions> impl
     }
 
     const data = _INTERNAL.getRequestSpanData(span);
-    getCurrentHub().addBreadcrumb({
+    addBreadcrumb({
       category: 'http',
       data: {
         ...data,
diff --git a/packages/node/src/integrations/console.ts b/packages/node/src/integrations/console.ts
@@ -1,5 +1,5 @@
 import * as util from 'util';
-import { getCurrentHub } from '@sentry/core';
+import { addBreadcrumb, getCurrentHub } from '@sentry/core';
 import type { Integration } from '@sentry/types';
 import { addConsoleInstrumentationHandler, severityLevelFromString } from '@sentry/utils';
 
@@ -26,7 +26,7 @@ export class Console implements Integration {
         return;
       }
 
-      hub.addBreadcrumb(
+      addBreadcrumb(
         {
           category: 'console',
           level: severityLevelFromString(level),
diff --git a/packages/node/src/integrations/http.ts b/packages/node/src/integrations/http.ts
@@ -1,7 +1,7 @@
 import type * as http from 'http';
 import type * as https from 'https';
 import type { Hub } from '@sentry/core';
-import { getClient, getCurrentScope } from '@sentry/core';
+import { addBreadcrumb, getClient, getCurrentScope } from '@sentry/core';
 import { getCurrentHub, getDynamicSamplingContextFromClient, isSentryRequestUrl } from '@sentry/core';
 import type {
   DynamicSamplingContext,
@@ -214,7 +214,7 @@ function _createWrappedRequestMethodFactory(
       return;
     }
 
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: 'http',
         data: {
diff --git a/packages/node/src/integrations/undici/index.ts b/packages/node/src/integrations/undici/index.ts
@@ -1,4 +1,5 @@
 import {
+  addBreadcrumb,
   getClient,
   getCurrentHub,
   getCurrentScope,
@@ -214,7 +215,7 @@ export class Undici implements Integration {
     }
 
     if (this._options.breadcrumbs) {
-      hub.addBreadcrumb(
+      addBreadcrumb(
         {
           category: 'http',
           data: {
@@ -254,7 +255,7 @@ export class Undici implements Integration {
     }
 
     if (this._options.breadcrumbs) {
-      hub.addBreadcrumb(
+      addBreadcrumb(
         {
           category: 'http',
           data: {
diff --git a/packages/node/test/integrations/http.test.ts b/packages/node/test/integrations/http.test.ts
@@ -592,6 +592,7 @@ describe('default protocols', () => {
   function captureBreadcrumb(key: string): Promise<Breadcrumb> {
     const hub = new Hub();
     jest.spyOn(sentryCore, 'getCurrentHub').mockReturnValue(hub);
+    jest.spyOn(sentryCore, 'addBreadcrumb').mockImplementation((...rest) => hub.addBreadcrumb(...rest));
 
     let resolve: (value: Breadcrumb | PromiseLike<Breadcrumb>) => void;
     const p = new Promise<Breadcrumb>(r => {
diff --git a/packages/replay/src/util/log.ts b/packages/replay/src/util/log.ts
@@ -1,4 +1,4 @@
-import { getCurrentHub } from '@sentry/core';
+import { addBreadcrumb } from '@sentry/core';
 import { logger } from '@sentry/utils';
 
 import { DEBUG_BUILD } from '../debug-build';
@@ -14,7 +14,7 @@ export function logInfo(message: string, shouldAddBreadcrumb?: boolean): void {
   logger.info(message);
 
   if (shouldAddBreadcrumb) {
-    addBreadcrumb(message);
+    addLogBreadcrumb(message);
   }
 }
 
@@ -33,14 +33,13 @@ export function logInfoNextTick(message: string, shouldAddBreadcrumb?: boolean):
     // Wait a tick here to avoid race conditions for some initial logs
     // which may be added before replay is initialized
     setTimeout(() => {
-      addBreadcrumb(message);
+      addLogBreadcrumb(message);
     }, 0);
   }
 }
 
-function addBreadcrumb(message: string): void {
-  const hub = getCurrentHub();
-  hub.addBreadcrumb(
+function addLogBreadcrumb(message: string): void {
+  addBreadcrumb(
     {
       category: 'console',
       data: {
diff --git a/packages/vercel-edge/src/integrations/wintercg-fetch.ts b/packages/vercel-edge/src/integrations/wintercg-fetch.ts
@@ -1,5 +1,5 @@
 import { instrumentFetchRequest } from '@sentry-internal/tracing';
-import { getClient, getCurrentHub, isSentryRequestUrl } from '@sentry/core';
+import { addBreadcrumb, getClient, getCurrentHub, isSentryRequestUrl } from '@sentry/core';
 import type { FetchBreadcrumbData, FetchBreadcrumbHint, HandlerDataFetch, Integration, Span } from '@sentry/types';
 import { LRUMap, addFetchInstrumentationHandler, stringMatchesSomePattern } from '@sentry/utils';
 
@@ -130,7 +130,7 @@ function createBreadcrumb(handlerData: HandlerDataFetch): void {
       endTimestamp,
     };
 
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: 'fetch',
         data,
@@ -150,7 +150,7 @@ function createBreadcrumb(handlerData: HandlerDataFetch): void {
       startTimestamp,
       endTimestamp,
     };
-    getCurrentHub().addBreadcrumb(
+    addBreadcrumb(
       {
         category: 'fetch',
         data,
diff --git a/packages/vercel-edge/test/wintercg-fetch.test.ts b/packages/vercel-edge/test/wintercg-fetch.test.ts
@@ -34,7 +34,7 @@ jest.spyOn(sentryCore, 'getClient').mockImplementation(() => fakeHubInstance.get
 
 const addFetchInstrumentationHandlerSpy = jest.spyOn(sentryUtils, 'addFetchInstrumentationHandler');
 const instrumentFetchRequestSpy = jest.spyOn(internalTracing, 'instrumentFetchRequest');
-const addBreadcrumbSpy = jest.spyOn(fakeHubInstance, 'addBreadcrumb');
+const addBreadcrumbSpy = jest.spyOn(sentryCore, 'addBreadcrumb');
 
 beforeEach(() => {
   jest.clearAllMocks();

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import * as util from 'util';`
`2`		`-import { getCurrentHub } from '@sentry/core';`
	`2`	`+import { addBreadcrumb, getCurrentHub } from '@sentry/core';`
`3`	`3`	`import type { Integration } from '@sentry/types';`
`4`	`4`	`import { addConsoleInstrumentationHandler, severityLevelFromString } from '@sentry/utils';`
`5`	`5`
`@@ -26,7 +26,7 @@ export class Console implements Integration {`
`26`	`26`	`return;`
`27`	`27`	`}`
`28`	`28`
`29`		`- hub.addBreadcrumb(`
	`29`	`+ addBreadcrumb(`
`30`	`30`	`{`
`31`	`31`	`category: 'console',`
`32`	`32`	`level: severityLevelFromString(level),`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import {`
	`2`	`+ addBreadcrumb,`
`2`	`3`	`getClient,`
`3`	`4`	`getCurrentHub,`
`4`	`5`	`getCurrentScope,`
`@@ -214,7 +215,7 @@ export class Undici implements Integration {`
`214`	`215`	`}`
`215`	`216`
`216`	`217`	`if (this._options.breadcrumbs) {`
`217`		`- hub.addBreadcrumb(`
	`218`	`+ addBreadcrumb(`
`218`	`219`	`{`
`219`	`220`	`category: 'http',`
`220`	`221`	`data: {`
`@@ -254,7 +255,7 @@ export class Undici implements Integration {`
`254`	`255`	`}`
`255`	`256`
`256`	`257`	`if (this._options.breadcrumbs) {`
`257`		`- hub.addBreadcrumb(`
	`258`	`+ addBreadcrumb(`
`258`	`259`	`{`
`259`	`260`	`category: 'http',`
`260`	`261`	`data: {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { getCurrentHub } from '@sentry/core';`
	`1`	`+import { addBreadcrumb } from '@sentry/core';`
`2`	`2`	`import { logger } from '@sentry/utils';`
`3`	`3`
`4`	`4`	`import { DEBUG_BUILD } from '../debug-build';`
`@@ -14,7 +14,7 @@ export function logInfo(message: string, shouldAddBreadcrumb?: boolean): void {`
`14`	`14`	`logger.info(message);`
`15`	`15`
`16`	`16`	`if (shouldAddBreadcrumb) {`
`17`		`- addBreadcrumb(message);`
	`17`	`+ addLogBreadcrumb(message);`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`
`@@ -33,14 +33,13 @@ export function logInfoNextTick(message: string, shouldAddBreadcrumb?: boolean):`
`33`	`33`	`// Wait a tick here to avoid race conditions for some initial logs`
`34`	`34`	`// which may be added before replay is initialized`
`35`	`35`	`setTimeout(() => {`
`36`		`- addBreadcrumb(message);`
	`36`	`+ addLogBreadcrumb(message);`
`37`	`37`	`}, 0);`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`
`41`		`-function addBreadcrumb(message: string): void {`
`42`		`- const hub = getCurrentHub();`
`43`		`- hub.addBreadcrumb(`
	`41`	`+function addLogBreadcrumb(message: string): void {`
	`42`	`+ addBreadcrumb(`
`44`	`43`	`{`
`45`	`44`	`category: 'console',`
`46`	`45`	`data: {`