feat: Remove unusuedrecord.xxx methods & module scope vars

Author: mydea

packages/rrweb/src/record/index.ts

@@ -65,13 +65,11 @@ declare global {
   const __RRWEB_EXCLUDE_IFRAME__: boolean;
 }
 
-let wrappedEmit!: (e: eventWithTime, isCheckout?: boolean) => void;
-
-let _takeFullSnapshot!: (isCheckout?: boolean) => void;
-let canvasManager: CanvasManagerInterface;
-let recording = false;
+// Tihs is stored in module scope because we access it in other exported methods
+let _takeFullSnapshot: undefined | ((isCheckout?: boolean) => void);
 
 export const mirror = createMirror();
+
 function record<T = eventWithTime>(
   options: recordOptions<T> = {},
 ): listenerHandler | undefined {
@@ -211,7 +209,7 @@ function record<T = eventWithTime>(
     }
     return e as unknown as T;
   };
-  wrappedEmit = (e: eventWithTime, isCheckout?: boolean) => {
+  const wrappedEmit = (e: eventWithTime, isCheckout?: boolean) => {
     if (
       mutationBuffers[0]?.isFrozen() &&
       e.type !== EventType.FullSnapshot &&
@@ -256,7 +254,7 @@ function record<T = eventWithTime>(
         checkoutEveryNms &&
         e.timestamp - lastFullSnapshotEvent.timestamp > checkoutEveryNms;
       if (exceedCount || exceedTime) {
-        _takeFullSnapshot(true);
+        takeFullSnapshot(true);
       }
     }
   };
@@ -335,7 +333,7 @@ function record<T = eventWithTime>(
 
   const processedNodeManager = new ProcessedNodeManager();
 
-  canvasManager =
+  const canvasManager: CanvasManagerInterface =
     typeof __RRWEB_EXCLUDE_CANVAS__ === 'boolean' && __RRWEB_EXCLUDE_CANVAS__
       ? new CanvasManagerNoop()
       : new CanvasManager({
@@ -386,7 +384,7 @@ function record<T = eventWithTime>(
           mirror,
         });
 
-  _takeFullSnapshot = (isCheckout = false) => {
+  const takeFullSnapshot = (isCheckout = false) => {
     wrappedEmit(
       wrapEvent({
         type: EventType.Meta,
@@ -468,6 +466,7 @@ function record<T = eventWithTime>(
         mirror.getId(document),
       );
   };
+  _takeFullSnapshot = takeFullSnapshot;
 
   try {
     const handlers: listenerHandler[] = [];
@@ -644,9 +643,8 @@ function record<T = eventWithTime>(
     });
 
     const init = () => {
-      _takeFullSnapshot();
+      takeFullSnapshot();
       handlers.push(observe(document));
-      recording = true;
     };
     if (
       document.readyState === 'interactive' ||
@@ -684,7 +682,7 @@ function record<T = eventWithTime>(
     return () => {
       handlers.forEach((h) => h());
       processedNodeManager.destroy();
-      recording = false;
+      _takeFullSnapshot = undefined;
       unregisterErrorHandler();
     };
   } catch (error) {
@@ -693,34 +691,18 @@ function record<T = eventWithTime>(
   }
 }
 
-record.addCustomEvent = <T>(tag: string, payload: T) => {
-  if (!recording) {
-    throw new Error('please add custom event after start recording');
-  }
-  wrappedEmit(
-    wrapEvent({
-      type: EventType.Custom,
-      data: {
-        tag,
-        payload,
-      },
-    }),
-  );
-};
-
-record.freezePage = () => {
-  mutationBuffers.forEach((buf) => buf.freeze());
-};
+// record.addCustomEvent is removed because Sentry Session Replay does not use it
+// record.freezePage is removed because Sentry Session Replay does not use it
 
 export function takeFullSnapshot(isCheckout?: boolean) {
-  if (!recording) {
+  if (!_takeFullSnapshot) {
     throw new Error('please take full snapshot after start recording');
   }
   _takeFullSnapshot(isCheckout);
 }
 
-record.takeFullSnapshot = takeFullSnapshot;
-
+// For backwards compatibility - we can eventually remove this when we migrated to using the exported `mirror` & `takeFullSnapshot`
 record.mirror = mirror;
+record.takeFullSnapshot = takeFullSnapshot;
 
 export default record;