ref(replay): Extract types into types.ts

mydea · mydea · commit 653d816a55ad · 2022-12-07T16:51:18.000+01:00
To avoid circular dependencies.
diff --git a/packages/replay/.madgerc b/packages/replay/.madgerc
diff --git a/packages/replay/jest.setup.ts b/packages/replay/jest.setup.ts
@@ -2,8 +2,7 @@
 import { getCurrentHub } from '@sentry/core';
 import { Transport } from '@sentry/types';
 
-import { ReplayContainer } from './src/replay';
-import { Session } from './src/session/Session';
+import type { ReplayContainer, Session } from './src/types';
 
 // @ts-ignore TS error, this is replaced in prod builds bc of rollup
 global.__SENTRY_REPLAY_VERSION__ = 'version:Test';
diff --git a/packages/replay/src/coreHandlers/breadcrumbHandler.ts b/packages/replay/src/coreHandlers/breadcrumbHandler.ts
@@ -1,6 +1,6 @@
 import { Breadcrumb, Scope } from '@sentry/types';
 
-import { InstrumentationTypeBreadcrumb } from '../types';
+import type { InstrumentationTypeBreadcrumb } from '../types';
 import { DomHandlerData, handleDom } from './handleDom';
 import { handleScope } from './handleScope';
 
diff --git a/packages/replay/src/coreHandlers/handleFetch.ts b/packages/replay/src/coreHandlers/handleFetch.ts
@@ -1,5 +1,5 @@
 import type { ReplayPerformanceEntry } from '../createPerformanceEntry';
-import type { ReplayContainer } from '../replay';
+import type { ReplayContainer } from '../types';
 import { createPerformanceSpans } from '../util/createPerformanceSpans';
 import { isIngestHost } from '../util/isIngestHost';
 
diff --git a/packages/replay/src/coreHandlers/handleGlobalEvent.ts b/packages/replay/src/coreHandlers/handleGlobalEvent.ts
@@ -1,7 +1,7 @@
 import { Event } from '@sentry/types';
 
 import { REPLAY_EVENT_NAME, UNABLE_TO_SEND_REPLAY } from '../constants';
-import type { ReplayContainer } from '../replay';
+import type { ReplayContainer } from '../types';
 import { addInternalBreadcrumb } from '../util/addInternalBreadcrumb';
 
 /**
diff --git a/packages/replay/src/coreHandlers/handleHistory.ts b/packages/replay/src/coreHandlers/handleHistory.ts
@@ -1,5 +1,5 @@
 import { ReplayPerformanceEntry } from '../createPerformanceEntry';
-import type { ReplayContainer } from '../replay';
+import type { ReplayContainer } from '../types';
 import { createPerformanceSpans } from '../util/createPerformanceSpans';
 
 interface HistoryHandlerData {
diff --git a/packages/replay/src/coreHandlers/handleXhr.ts b/packages/replay/src/coreHandlers/handleXhr.ts
@@ -1,5 +1,5 @@
 import { ReplayPerformanceEntry } from '../createPerformanceEntry';
-import type { ReplayContainer } from '../replay';
+import type { ReplayContainer } from '../types';
 import { createPerformanceSpans } from '../util/createPerformanceSpans';
 import { isIngestHost } from '../util/isIngestHost';
 
diff --git a/packages/replay/src/coreHandlers/performanceObserver.ts b/packages/replay/src/coreHandlers/performanceObserver.ts
@@ -1,5 +1,4 @@
-import type { ReplayContainer } from '../replay';
-import { AllPerformanceEntry } from '../types';
+import type { AllPerformanceEntry, ReplayContainer } from '../types';
 import { dedupePerformanceEntries } from '../util/dedupePerformanceEntries';
 
 /**
diff --git a/packages/replay/src/createPerformanceEntry.ts b/packages/replay/src/createPerformanceEntry.ts
@@ -2,7 +2,7 @@ import { browserPerformanceTimeOrigin } from '@sentry/utils';
 import { record } from 'rrweb';
 
 import { WINDOW } from './constants';
-import { AllPerformanceEntry, PerformanceNavigationTiming, PerformancePaintTiming } from './types';
+import type { AllPerformanceEntry, PerformanceNavigationTiming, PerformancePaintTiming } from './types';
 import { isIngestHost } from './util/isIngestHost';
 
 export interface ReplayPerformanceEntry {
diff --git a/packages/replay/src/eventBuffer.ts b/packages/replay/src/eventBuffer.ts
@@ -4,7 +4,7 @@
 import { captureException } from '@sentry/core';
 import { logger } from '@sentry/utils';
 
-import { RecordingEvent, WorkerRequest, WorkerResponse } from './types';
+import type { EventBuffer, RecordingEvent, WorkerRequest, WorkerResponse } from './types';
 import workerString from './worker/worker.js';
 
 interface CreateEventBufferParams {
@@ -35,13 +35,6 @@ export function createEventBuffer({ useCompression }: CreateEventBufferParams):
   return new EventBufferArray();
 }
 
-export interface EventBuffer {
-  readonly length: number;
-  destroy(): void;
-  addEvent(event: RecordingEvent, isCheckout?: boolean): void;
-  finish(): Promise<string | Uint8Array>;
-}
-
 class EventBufferArray implements EventBuffer {
   private _events: RecordingEvent[];
 
diff --git a/packages/replay/src/replay.ts b/packages/replay/src/replay.ts
@@ -20,20 +20,23 @@ import { handleHistorySpanListener } from './coreHandlers/handleHistory';
 import { handleXhrSpanListener } from './coreHandlers/handleXhr';
 import { setupPerformanceObserver } from './coreHandlers/performanceObserver';
 import { createPerformanceEntries } from './createPerformanceEntry';
-import { createEventBuffer, EventBuffer } from './eventBuffer';
+import { createEventBuffer } from './eventBuffer';
 import { deleteSession } from './session/deleteSession';
 import { getSession } from './session/getSession';
 import { saveSession } from './session/saveSession';
-import { Session } from './session/Session';
 import type {
+  AddUpdateCallback,
   AllPerformanceEntry,
+  EventBuffer,
   InstrumentationTypeBreadcrumb,
   InternalEventContext,
   PopEventContext,
   RecordingEvent,
   RecordingOptions,
+  ReplayContainer as ReplayContainerInterface,
   ReplayPluginOptions,
   SendReplay,
+  Session,
 } from './types';
 import { addEvent } from './util/addEvent';
 import { addMemoryEntry } from './util/addMemoryEntry';
@@ -48,12 +51,11 @@ import { overwriteRecordDroppedEvent, restoreRecordDroppedEvent } from './util/m
 /**
  * Returns true to return control to calling function, otherwise continue with normal batching
  */
-type AddUpdateCallback = () => boolean | void;
 
 const BASE_RETRY_INTERVAL = 5000;
 const MAX_RETRY_COUNT = 3;
 
-export class ReplayContainer {
+export class ReplayContainer implements ReplayContainerInterface {
   public eventBuffer: EventBuffer | null = null;
 
   /**
@@ -398,7 +400,7 @@ export class ReplayContainer {
    * Accepts a callback to perform side-effects and returns true to stop batch
    * processing and hand back control to caller.
    */
-  addUpdate(cb?: AddUpdateCallback): void {
+  addUpdate(cb: AddUpdateCallback): void {
     // We need to always run `cb` (e.g. in the case of `this._waitForError == true`)
     const cbResult = cb?.();
 
diff --git a/packages/replay/src/session/Session.ts b/packages/replay/src/session/Session.ts
@@ -1,39 +1,8 @@
 import { uuid4 } from '@sentry/utils';
 
+import type { Sampled, Session } from '../types';
 import { isSampled } from '../util/isSampled';
 
-type Sampled = false | 'session' | 'error';
-
-export interface Session {
-  id: string;
-
-  /**
-   * Start time of current session
-   */
-  started: number;
-
-  /**
-   * Last known activity of the session
-   */
-  lastActivity: number;
-
-  /**
-   * Segment ID for replay events
-   */
-  segmentId: number;
-
-  /**
-   * The ID of the previous session.
-   * If this is empty, there was no previous session.
-   */
-  previousSessionId?: string;
-
-  /**
-   * Is the session sampled? `false` if not sampled, otherwise, `session` or `error`
-   */
-  sampled: Sampled;
-}
-
 /**
  * Get a session with defaults & applied sampling.
  */
diff --git a/packages/replay/src/session/createSession.ts b/packages/replay/src/session/createSession.ts
@@ -1,8 +1,8 @@
 import { logger } from '@sentry/utils';
 
-import { SessionOptions } from '../types';
+import type { Session, SessionOptions } from '../types';
 import { saveSession } from './saveSession';
-import { getSessionSampleType, makeSession, Session } from './Session';
+import { getSessionSampleType, makeSession } from './Session';
 
 /**
  * Create a new session, which in its current implementation is a Sentry event
diff --git a/packages/replay/src/session/fetchSession.ts b/packages/replay/src/session/fetchSession.ts
@@ -1,5 +1,6 @@
 import { REPLAY_SESSION_KEY, WINDOW } from '../constants';
-import { makeSession, Session } from './Session';
+import type { Session } from '../types';
+import { makeSession } from './Session';
 
 /**
  * Fetches a session from storage
diff --git a/packages/replay/src/session/getSession.ts b/packages/replay/src/session/getSession.ts
@@ -1,10 +1,9 @@
 import { logger } from '@sentry/utils';
 
-import { SessionOptions } from '../types';
+import type { Session, SessionOptions } from '../types';
 import { isSessionExpired } from '../util/isSessionExpired';
 import { createSession } from './createSession';
 import { fetchSession } from './fetchSession';
-import { Session } from './Session';
 
 interface GetSessionParams extends SessionOptions {
   /**
diff --git a/packages/replay/src/session/saveSession.ts b/packages/replay/src/session/saveSession.ts
@@ -1,5 +1,5 @@
 import { REPLAY_SESSION_KEY, WINDOW } from '../constants';
-import { Session } from './Session';
+import type { Session } from '../types';
 
 export function saveSession(session: Session): void {
   const hasSessionStorage = 'sessionStorage' in WINDOW;
diff --git a/packages/replay/src/types.ts b/packages/replay/src/types.ts
@@ -160,3 +160,62 @@ export interface InternalEventContext extends CommonEventContext {
    */
   earliestEvent: number | null;
 }
+
+export type Sampled = false | 'session' | 'error';
+
+export interface Session {
+  id: string;
+
+  /**
+   * Start time of current session
+   */
+  started: number;
+
+  /**
+   * Last known activity of the session
+   */
+  lastActivity: number;
+
+  /**
+   * Segment ID for replay events
+   */
+  segmentId: number;
+
+  /**
+   * The ID of the previous session.
+   * If this is empty, there was no previous session.
+   */
+  previousSessionId?: string;
+
+  /**
+   * Is the session sampled? `false` if not sampled, otherwise, `session` or `error`
+   */
+  sampled: Sampled;
+}
+
+export interface EventBuffer {
+  readonly length: number;
+  destroy(): void;
+  addEvent(event: RecordingEvent, isCheckout?: boolean): void;
+  finish(): Promise<string | Uint8Array>;
+}
+
+export type AddUpdateCallback = () => boolean | void;
+
+export interface ReplayContainer {
+  eventBuffer: EventBuffer | null;
+  performanceEvents: AllPerformanceEntry[];
+  session: Session | undefined;
+  isEnabled(): boolean;
+  isPaused(): boolean;
+  getContext(): InternalEventContext;
+  start(): void;
+  stop(): void;
+  pause(): void;
+  resume(): void;
+  startRecording(): void;
+  stopRecording(): boolean;
+  flushImmediate(): void;
+  triggerUserActivity(): void;
+  addUpdate(cb: AddUpdateCallback): void;
+}
diff --git a/packages/replay/src/util/addEvent.ts b/packages/replay/src/util/addEvent.ts
@@ -1,6 +1,5 @@
 import { SESSION_IDLE_DURATION } from '../constants';
-import type { ReplayContainer } from '../replay';
-import { RecordingEvent } from '../types';
+import type { RecordingEvent, ReplayContainer } from '../types';
 
 /**
  * Add an event to the event buffer
diff --git a/packages/replay/src/util/addMemoryEntry.ts b/packages/replay/src/util/addMemoryEntry.ts
@@ -1,5 +1,5 @@
 import { WINDOW } from '../constants';
-import type { ReplayContainer } from '../replay';
+import type { ReplayContainer } from '../types';
 import { createPerformanceSpans } from './createPerformanceSpans';
 
 /**
diff --git a/packages/replay/src/util/createPayload.ts b/packages/replay/src/util/createPayload.ts
@@ -1,4 +1,4 @@
-import { RecordedEvents } from '../types';
+import type { RecordedEvents } from '../types';
 
 export function createPayload({
   events,
diff --git a/packages/replay/src/util/createPerformanceSpans.ts b/packages/replay/src/util/createPerformanceSpans.ts
@@ -1,7 +1,7 @@
 import { EventType } from 'rrweb';
 
 import { ReplayPerformanceEntry } from '../createPerformanceEntry';
-import type { ReplayContainer } from '../replay';
+import type { ReplayContainer } from '../types';
 import { addEvent } from './addEvent';
 
 /**
diff --git a/packages/replay/src/util/isSessionExpired.ts b/packages/replay/src/util/isSessionExpired.ts
@@ -1,5 +1,5 @@
 import { MAX_SESSION_LIFE } from '../constants';
-import { Session } from '../session/Session';
+import type { Session } from '../types';
 import { isExpired } from './isExpired';
 
 /**
diff --git a/packages/replay/test/fixtures/performanceEntry/lcp.ts b/packages/replay/test/fixtures/performanceEntry/lcp.ts
@@ -1,4 +1,4 @@
-import { PerformancePaintTiming } from '../../../src/types';
+import type { PerformancePaintTiming } from '../../../src/types';
 
 export function PerformanceEntryLcp(obj?: Partial<PerformancePaintTiming>): PerformancePaintTiming {
   const entry = {
diff --git a/packages/replay/test/mocks/index.ts b/packages/replay/test/mocks/index.ts
@@ -2,7 +2,7 @@ import { getCurrentHub } from '@sentry/core';
 
 import { ReplayContainer } from '../../src/replay';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
-import { DomHandler, MockTransportSend } from './../types';
+import type { DomHandler, MockTransportSend } from './../types';
 import { MockSdkParams } from './mockSdk';
 
 export async function resetSdkMock({ replayOptions, sentryOptions }: MockSdkParams): Promise<{
diff --git a/packages/replay/test/mocks/mockRrweb.ts b/packages/replay/test/mocks/mockRrweb.ts
@@ -1,6 +1,6 @@
 import type { record as rrwebRecord } from 'rrweb';
 
-import { RecordingEvent } from '../../src/types';
+import type { RecordingEvent } from '../../src/types';
 
 type RecordAdditionalProperties = {
   takeFullSnapshot: jest.Mock;
diff --git a/packages/replay/test/mocks/mockSdk.ts b/packages/replay/test/mocks/mockSdk.ts
@@ -3,7 +3,7 @@ import { Envelope, Transport } from '@sentry/types';
 
 import { Replay as ReplayIntegration } from '../../src';
 import { ReplayContainer } from '../../src/replay';
-import { ReplayConfiguration } from '../../src/types';
+import type { ReplayConfiguration } from '../../src/types';
 
 export interface MockSdkParams {
   replayOptions?: ReplayConfiguration;
diff --git a/packages/replay/test/unit/index-errorSampleRate.test.ts b/packages/replay/test/unit/index-errorSampleRate.test.ts
@@ -8,7 +8,7 @@ import { ReplayContainer } from './../../src/replay';
 import { PerformanceEntryResource } from './../fixtures/performanceEntry/resource';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
 import { resetSdkMock } from './../mocks';
-import { DomHandler, MockTransportSend } from './../types';
+import type { DomHandler, MockTransportSend } from './../types';
 import { useFakeTimers } from './../utils/use-fake-timers';
 
 useFakeTimers();
diff --git a/packages/replay/test/unit/index.test.ts b/packages/replay/test/unit/index.test.ts
@@ -6,14 +6,14 @@ import { EventType } from 'rrweb';
 
 import { MAX_SESSION_LIFE, REPLAY_SESSION_KEY, VISIBILITY_CHANGE_TIMEOUT, WINDOW } from '../../src/constants';
 import { ReplayContainer } from '../../src/replay';
-import { RecordingEvent } from '../../src/types';
+import type { RecordingEvent } from '../../src/types';
 import { addEvent } from '../../src/util/addEvent';
 import { createPerformanceSpans } from '../../src/util/createPerformanceSpans';
 import { useFakeTimers } from '../utils/use-fake-timers';
 import { PerformanceEntryResource } from './../fixtures/performanceEntry/resource';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
 import { resetSdkMock } from './../mocks';
-import { DomHandler, MockTransportSend } from './../types';
+import type { DomHandler, MockTransportSend } from './../types';
 
 useFakeTimers();
 
