move functionality to replay

mydea · mydea · commit 0916dc3911d4 · 2023-03-15T11:46:52.000+01:00
diff --git a/packages/browser-integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/fetch/init.js b/packages/browser-integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/fetch/init.js
diff --git a/packages/browser-integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/xhr/init.js b/packages/browser-integration-tests/suites/integrations/ExtendedNetworkBreadcrumbs/xhr/init.js
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/contentLengthHeader/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/contentLengthHeader/subject.js
@@ -1,5 +1,3 @@
-const xhr = new XMLHttpRequest();
-
 fetch('http://localhost:7654/foo', {
   headers: {
     Accept: 'application/json',
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/contentLengthHeader/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/contentLengthHeader/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('parses response_body_size from Content-Length header if available', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/init.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/init.js
@@ -0,0 +1,17 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+window.Replay = new Sentry.Replay({
+  flushMinDelay: 200,
+  flushMaxDelay: 200,
+});
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  sampleRate: 1,
+  // We ensure to sample for errors, so by default nothing is sent
+  replaysSessionSampleRate: 0.0,
+  replaysOnErrorSampleRate: 1.0,
+
+  integrations: [window.Replay],
+});
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/noContentLengthHeader/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/noContentLengthHeader/subject.js
@@ -1,5 +1,3 @@
-const xhr = new XMLHttpRequest();
-
 fetch('http://localhost:7654/foo', {
   headers: {
     Accept: 'application/json',
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/noContentLengthHeader/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/noContentLengthHeader/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('does not capture response_body_size without Content-Length header', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/nonTextBody/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/nonTextBody/subject.js
@@ -1,5 +1,3 @@
-const xhr = new XMLHttpRequest();
-
 const blob = new Blob(['<html>Hello world!!</html>'], { type: 'text/html' });
 
 fetch('http://localhost:7654/foo', {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/nonTextBody/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/nonTextBody/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('calculates body sizes for non-string bodies', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', async route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/requestBody/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/requestBody/subject.js
@@ -1,5 +1,3 @@
-const xhr = new XMLHttpRequest();
-
 fetch('http://localhost:7654/foo', {
   method: 'POST',
   headers: {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/requestBody/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/requestBody/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('captures request_body_size when body is sent', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/contentLengthHeader/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/contentLengthHeader/subject.js
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/contentLengthHeader/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/contentLengthHeader/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('parses response_body_size from Content-Length header if available', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/init.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/init.js
@@ -0,0 +1,17 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+window.Replay = new Sentry.Replay({
+  flushMinDelay: 200,
+  flushMaxDelay: 200,
+});
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  sampleRate: 1,
+  // We ensure to sample for errors, so by default nothing is sent
+  replaysSessionSampleRate: 0.0,
+  replaysOnErrorSampleRate: 1.0,
+
+  integrations: [window.Replay],
+});
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/noContentLengthHeader/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/noContentLengthHeader/subject.js
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/noContentLengthHeader/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/noContentLengthHeader/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('captures response_body_size without Content-Length header', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/nonTextBody/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/nonTextBody/subject.js
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/nonTextBody/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/nonTextBody/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('calculates body sizes for non-string bodies', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', async route => {
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/requestBody/subject.js b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/requestBody/subject.js
diff --git a/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/requestBody/test.ts b/packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/xhr/requestBody/test.ts
@@ -3,8 +3,13 @@ import type { Event } from '@sentry/types';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
+import { shouldSkipReplayTest } from '../../../../../utils/replayHelpers';
 
 sentryTest('captures request_body_size when body is sent', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipReplayTest()) {
+    sentryTest.skip();
+  }
+
   const url = await getLocalTestPath({ testDir: __dirname });
 
   await page.route('**/foo', route => {
diff --git a/packages/integrations/src/index.ts b/packages/integrations/src/index.ts
@@ -9,4 +9,3 @@ export { RewriteFrames } from './rewriteframes';
 export { SessionTiming } from './sessiontiming';
 export { Transaction } from './transaction';
 export { HttpClient } from './httpclient';
-export { ExtendedNetworkBreadcrumbs } from './extendednetworkbreadcrumbs';
diff --git a/packages/integrations/test/tsconfig.json b/packages/integrations/test/tsconfig.json
@@ -4,5 +4,5 @@
 {
   "extends": "../tsconfig.test.json",
 
-  "include": ["./**/*"]
+  "include": ["./**/*", "../../replay/test/unit/coreHandlers/extendednetworkbreadcrumbs.test.ts"]
 }
diff --git a/packages/replay/src/coreHandlers/extendNetworkBreadcrumbs.ts b/packages/replay/src/coreHandlers/extendNetworkBreadcrumbs.ts
@@ -1,10 +1,8 @@
+import { getCurrentHub } from '@sentry/core';
 import type {
   Breadcrumb,
   BreadcrumbHint,
-  EventProcessor,
   HandlerDataFetch,
-  Hub,
-  Integration,
   SentryWrappedXMLHttpRequest,
   TextEncoderInternal,
 } from '@sentry/types';
@@ -17,53 +15,29 @@ interface ExtendedNetworkBreadcrumbsOptions {
 }
 
 /**
- * Add this integration _in addition_ the the default Breadcrumbs integration,
- * to enrich the xhr/fetch breadcrumbs with additional information.
+ * This will enrich the xhr/fetch breadcrumbs with additional information.
  *
  * This adds:
  * * request_body_size
  * * response_body_size
  *
- * To the breadcrumb data.
+ * to the breadcrumb data.
  */
-export class ExtendedNetworkBreadcrumbs implements Integration {
-  /**
-   * @inheritDoc
-   */
-  public static id: string = 'ExtendedNetworkBreadcrumbs';
-
-  /**
-   * @inheritDoc
-   */
-  public name: string = ExtendedNetworkBreadcrumbs.id;
-
-  private _options: Partial<ExtendedNetworkBreadcrumbsOptions>;
-
-  /**
-   * @inheritDoc
-   */
-  public constructor(options?: Partial<ExtendedNetworkBreadcrumbsOptions>) {
-    this._options = options || {};
-  }
+export function extendNetworkBreadcrumbs(): void {
+  const client = getCurrentHub().getClient();
 
-  /**
-   * @inheritDoc
-   */
-  public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
-    const client = getCurrentHub().getClient();
-
-    try {
-      this._options.textEncoder = this._options.textEncoder || new TextEncoder();
-    } catch (error) {
-      __DEBUG_BUILD__ && logger.warn('No textEncoder available, skipping ExtendedNetworkBreadcrumbs');
-      return;
-    }
+  try {
+    const textEncoder = new TextEncoder();
 
-    const options = this._options as ExtendedNetworkBreadcrumbsOptions;
+    const options: ExtendedNetworkBreadcrumbsOptions = {
+      textEncoder,
+    };
 
     if (client && client.on) {
       client.on('beforeAddBreadcrumb', (breadcrumb, hint) => _beforeNetworkBreadcrumb(options, breadcrumb, hint));
     }
+  } catch {
+    // Do nothing
   }
 }
 
diff --git a/packages/replay/src/util/addGlobalListeners.ts b/packages/replay/src/util/addGlobalListeners.ts
@@ -1,6 +1,7 @@
 import { addGlobalEventProcessor, getCurrentHub } from '@sentry/core';
 import { addInstrumentationHandler } from '@sentry/utils';
 
+import { extendNetworkBreadcrumbs } from '../coreHandlers/extendNetworkBreadcrumbs';
 import { handleDomListener } from '../coreHandlers/handleDom';
 import { handleFetchSpanListener } from '../coreHandlers/handleFetch';
 import { handleGlobalEventListener } from '../coreHandlers/handleGlobalEvent';
@@ -26,4 +27,6 @@ export function addGlobalListeners(replay: ReplayContainer): void {
   // Tag all (non replay) events that get sent to Sentry with the current
   // replay ID so that we can reference them later in the UI
   addGlobalEventProcessor(handleGlobalEventListener(replay));
+
+  extendNetworkBreadcrumbs();
 }
diff --git a/packages/replay/test/unit/coreHandlers/extendNetworkBreadcrumbs.test.ts b/packages/replay/test/unit/coreHandlers/extendNetworkBreadcrumbs.test.ts
@@ -1,12 +1,8 @@
-/**
- * @jest-environment jsdom
- */
-
 import { TextEncoder } from 'util';
 
-import { getBodySize, parseContentSizeHeader } from '../src/extendednetworkbreadcrumbs';
+import { getBodySize, parseContentSizeHeader } from '../../../src/coreHandlers/extendNetworkBreadcrumbs';
 
-describe('instrument', () => {
+describe('Unit | coreHandlers | extendNetworkBreadcrumbs', () => {
   describe('parseContentSizeHeader()', () => {
     it.each([
       [undefined, undefined],

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-const xhr = new XMLHttpRequest();`
`2`		`-`
`3`	`1`	`fetch('http://localhost:7654/foo', {`
`4`	`2`	`headers: {`
`5`	`3`	`Accept: 'application/json',`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-const xhr = new XMLHttpRequest();`
`2`		`-`
`3`	`1`	`const blob = new Blob(['<html>Hello world!!</html>'], { type: 'text/html' });`
`4`	`2`
`5`	`3`	`fetch('http://localhost:7654/foo', {`