ref(replay): Extract addMemoryEntry out

Author: mydea

packages/replay/src/replay.ts

@@ -19,7 +19,7 @@ import { handleGlobalEventListener } from './coreHandlers/handleGlobalEvent';
 import { handleHistorySpanListener } from './coreHandlers/handleHistory';
 import { handleXhrSpanListener } from './coreHandlers/handleXhr';
 import { setupPerformanceObserver } from './coreHandlers/performanceObserver';
-import { createMemoryEntry, createPerformanceEntries } from './createPerformanceEntry';
+import { createPerformanceEntries } from './createPerformanceEntry';
 import { createEventBuffer, EventBuffer } from './eventBuffer';
 import { deleteSession } from './session/deleteSession';
 import { getSession } from './session/getSession';
@@ -36,6 +36,7 @@ import type {
   SendReplay,
 } from './types';
 import { addEvent } from './util/addEvent';
+import { addMemoryEntry } from './util/addMemoryEntry';
 import { captureInternalException } from './util/captureInternalException';
 import { createBreadcrumb } from './util/createBreadcrumb';
 import { createPayload } from './util/createPayload';
@@ -699,23 +700,6 @@ export class ReplayContainer {
     return createPerformanceSpans(this, createPerformanceEntries(entries));
   }
 
-  /**
-   * Create a "span" for the total amount of memory being used by JS objects
-   * (including v8 internal objects).
-   */
-  addMemoryEntry(): Promise<void[]> | undefined {
-    // window.performance.memory is a non-standard API and doesn't work on all browsers
-    // so we check before creating the event.
-    if (!('memory' in WINDOW.performance)) {
-      return;
-    }
-
-    return createPerformanceSpans(this, [
-      // @ts-ignore memory doesn't exist on type Performance as the API is non-standard (we check that it exists above)
-      createMemoryEntry(WINDOW.performance.memory),
-    ]);
-  }
-
   /**
    * Checks if recording should be stopped due to user inactivity. Otherwise
    * check if session is expired and create a new session if so. Triggers a new
@@ -817,7 +801,7 @@ export class ReplayContainer {
     }
 
     // Only attach memory event if eventBuffer is not empty
-    await this.addMemoryEntry();
+    await addMemoryEntry(this);
 
     try {
       // Note this empties the event buffer regardless of outcome of sending replay

packages/replay/src/util/addMemoryEntry.ts

@@ -0,0 +1,20 @@
+import { WINDOW } from '../constants';
+import { ReplayContainer } from '../replay';
+import { createPerformanceSpans } from './createPerformanceSpans';
+
+/**
+ * Create a "span" for the total amount of memory being used by JS objects
+ * (including v8 internal objects).
+ */
+export function addMemoryEntry(replay: ReplayContainer): Promise<void[]> | undefined {
+  // window.performance.memory is a non-standard API and doesn't work on all browsers
+  // so we check before creating the event.
+  if (!('memory' in WINDOW.performance)) {
+    return;
+  }
+
+  return createPerformanceSpans(replay, [
+    // @ts-ignore memory doesn't exist on type Performance as the API is non-standard (we check that it exists above)
+    createMemoryEntry(WINDOW.performance.memory),
+  ]);
+}

packages/replay/test/unit/flush.test.ts

@@ -1,6 +1,7 @@
 import * as SentryUtils from '@sentry/utils';
 
 import { SESSION_IDLE_DURATION, WINDOW } from '../../src/constants';
+import * as AddMemoryEntry from '../../src/util/addMemoryEntry';
 import { createPerformanceSpans } from '../../src/util/createPerformanceSpans';
 import { createPerformanceEntries } from './../../src/createPerformanceEntry';
 import { ReplayContainer } from './../../src/replay';
@@ -16,7 +17,7 @@ async function advanceTimers(time: number) {
 
 type MockSendReplay = jest.MockedFunction<typeof ReplayContainer.prototype.sendReplay>;
 type MockAddPerformanceEntries = jest.MockedFunction<typeof ReplayContainer.prototype.addPerformanceEntries>;
-type MockAddMemoryEntry = jest.MockedFunction<typeof ReplayContainer.prototype.addMemoryEntry>;
+type MockAddMemoryEntry = jest.SpyInstance;
 type MockEventBufferFinish = jest.MockedFunction<Exclude<typeof ReplayContainer.prototype.eventBuffer, null>['finish']>;
 type MockFlush = jest.MockedFunction<typeof ReplayContainer.prototype.flush>;
 type MockRunFlush = jest.MockedFunction<typeof ReplayContainer.prototype.runFlush>;
@@ -63,8 +64,7 @@ beforeAll(async () => {
     return [];
   });
 
-  jest.spyOn(replay, 'addMemoryEntry');
-  mockAddMemoryEntry = replay.addMemoryEntry as MockAddMemoryEntry;
+  mockAddMemoryEntry = jest.spyOn(AddMemoryEntry, 'addMemoryEntry');
 });
 
 beforeEach(() => {