ref: Refactor into ExtendedNetworkBreadcrumbs

Author: mydea

packages/browser/src/integrations/breadcrumbs.ts

@@ -10,7 +10,6 @@ import {
   parseUrl,
   safeJoin,
   severityLevelFromString,
-  dropUndefinedKeys,
 } from '@sentry/utils';
 
 import { WINDOW } from '../helpers';
@@ -223,18 +222,16 @@ function _xhrBreadcrumb(handlerData: HandlerData & HandlerDataXhr): void {
     return;
   }
 
-  const { method, url, status_code, body, request_body_size, response_body_size } = handlerData.xhr.__sentry_xhr__;
+  const { method, url, status_code, body } = handlerData.xhr.__sentry_xhr__;
 
   getCurrentHub().addBreadcrumb(
     {
       category: 'xhr',
-      data: dropUndefinedKeys({
+      data: {
         method,
         url,
         status_code,
-        request_body_size,
-        response_body_size,
-      }),
+      },
       type: 'http',
     },
     {
@@ -262,7 +259,7 @@ function _fetchBreadcrumb(handlerData: HandlerData & HandlerDataFetch): void {
     getCurrentHub().addBreadcrumb(
       {
         category: 'fetch',
-        data: dropUndefinedKeys(handlerData.fetchData),
+        data: handlerData.fetchData,
         level: 'error',
         type: 'http',
       },
@@ -276,7 +273,7 @@ function _fetchBreadcrumb(handlerData: HandlerData & HandlerDataFetch): void {
       {
         category: 'fetch',
         data: {
-          ...dropUndefinedKeys(handlerData.fetchData),
+          ...handlerData.fetchData,
           status_code: handlerData.response && handlerData.response.status,
         },
         type: 'http',

packages/core/src/baseclient.ts

@@ -1,5 +1,7 @@
 /* eslint-disable max-lines */
 import type {
+  Breadcrumb,
+  BreadcrumbHint,
   Client,
   ClientOptions,
   DataCategory,
@@ -363,6 +365,9 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /** @inheritdoc */
   public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 
+  /** @inheritdoc */
+  public on(hook: 'beforeBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
+
   /** @inheritdoc */
   public on(hook: string, callback: unknown): void {
     if (!this._hooks[hook]) {
@@ -379,6 +384,9 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   /** @inheritdoc */
   public emit(hook: 'beforeEnvelope', envelope: Envelope): void;
 
+  /** @inheritdoc */
+  public emit(hook: 'beforeBreadcrumb', breadcrumb: Breadcrumb, hint?: BreadcrumbHint): void;
+
   /** @inheritdoc */
   public emit(hook: string, ...rest: unknown[]): void {
     if (this._hooks[hook]) {

packages/core/src/hub.ts

@@ -271,6 +271,10 @@ export class Hub implements HubInterface {
 
     if (finalBreadcrumb === null) return;
 
+    if (client.emit) {
+      client.emit('beforeBreadcrumb', finalBreadcrumb, hint);
+    }
+
     scope.addBreadcrumb(finalBreadcrumb, maxBreadcrumbs);
   }
 

packages/integration-tests/suites/integrations/browser/breadcrumbs/fetch/contentLengthHeader/subject.js renamed to packages/integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/fetch/contentLengthHeader/subject.js

@@ -1,8 +1,8 @@
 import { expect } from '@playwright/test';
 import type { Event } from '@sentry/types';
 
-import { sentryTest } from '../../../../../../utils/fixtures';
-import { getFirstSentryEnvelopeRequest } from '../../../../../../utils/helpers';
+import { sentryTest } from '../../../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
 
 sentryTest('parses response_body_size from Content-Length header if available', async ({ getLocalTestPath, page }) => {
   const url = await getLocalTestPath({ testDir: __dirname });

packages/integration-tests/suites/integrations/browser/breadcrumbs/fetch/contentLengthHeader/test.ts renamed to packages/integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/fetch/contentLengthHeader/test.ts

@@ -1,8 +1,8 @@
 import { expect } from '@playwright/test';
 import type { Event } from '@sentry/types';
 
-import { sentryTest } from '../../../../../../utils/fixtures';
-import { getFirstSentryEnvelopeRequest } from '../../../../../../utils/helpers';
+import { sentryTest } from '../../../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
 
 sentryTest('adds a breadcrumb for basic fetch GET request', async ({ getLocalTestPath, page }) => {
   const url = await getLocalTestPath({ testDir: __dirname });

packages/integration-tests/suites/integrations/browser/breadcrumbs/fetch/get/subject.js renamed to packages/integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/fetch/get/subject.js

@@ -0,0 +1,11 @@
+import * as Sentry from '@sentry/browser';
+import { ExtendedNetworkBreadcrumbs } from '@sentry/integrations';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  defaultIntegrations: false,
+  integrations: [new Sentry.Integrations.Breadcrumbs(), new ExtendedNetworkBreadcrumbs()],
+  sampleRate: 1,
+});

packages/integration-tests/suites/integrations/browser/breadcrumbs/fetch/get/test.ts renamed to packages/integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/fetch/get/test.ts

@@ -1,8 +1,8 @@
 import { expect } from '@playwright/test';
 import type { Event } from '@sentry/types';
 
-import { sentryTest } from '../../../../../../utils/fixtures';
-import { getFirstSentryEnvelopeRequest } from '../../../../../../utils/helpers';
+import { sentryTest } from '../../../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
 
 sentryTest('calculates body sizes for non-string bodies', async ({ getLocalTestPath, page }) => {
   const url = await getLocalTestPath({ testDir: __dirname });