Rename paused -> frozen for consistency and change to use getter/sett…

…er access methods
rrweb-io · Oct 4, 2020 · 1006d8e · 1006d8e
1 parent c93fbfd
commit 1006d8e
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 11 deletions.
diff --git a/src/record/index.ts b/src/record/index.ts
@@ -82,7 +82,7 @@ function record<T = eventWithTime>(
   let incrementalSnapshotCount = 0;
   wrappedEmit = (e: eventWithTime, isCheckout?: boolean) => {
     if (
-      mutationBuffer.paused &&
+      mutationBuffer.isFrozen() &&
 	e.type !== EventType.FullSnapshot &&
       !(
         e.type == EventType.IncrementalSnapshot &&
@@ -92,7 +92,7 @@ function record<T = eventWithTime>(
       // we've got a user initiated event so first we need to apply
       // all DOM changes that have been buffering during paused state
       mutationBuffer.emit();
-      mutationBuffer.paused = false;
+      mutationBuffer.unfreeze();
     }
 
     emit(((packFn ? packFn(e) : e) as unknown) as T, isCheckout);
@@ -125,8 +125,8 @@ function record<T = eventWithTime>(
       isCheckout,
     );
 
-    let wasPaused = mutationBuffer.paused;
-    mutationBuffer.paused = true;  // don't allow any mirror modifications during snapshotting
+    let wasFrozen = mutationBuffer.isFrozen();
+    mutationBuffer.freeze();  // don't allow any mirror modifications during snapshotting
     const [node, idNodeMap] = snapshot(
       document,
       blockClass,
@@ -164,9 +164,9 @@ function record<T = eventWithTime>(
         },
       }),
     );
-    if (!wasPaused) {
+    if (!wasFrozen) {
       mutationBuffer.emit();  // emit anything queued up now
-      mutationBuffer.paused = false;
+      mutationBuffer.unfreeze();
     }
   }
 
@@ -347,7 +347,7 @@ record.addCustomEvent = <T>(tag: string, payload: T) => {
 };
 
 record.freezePage = () => {
-  mutationBuffer.paused = true;
+  mutationBuffer.freeze();
 };
 
 export default record;
diff --git a/src/record/mutation.ts b/src/record/mutation.ts
@@ -109,7 +109,7 @@ function isINode(n: Node | INode): n is INode {
  * controls behaviour of a MutationObserver
  */
 export default class MutationBuffer {
-  public paused: boolean = false;
+  private frozen: boolean = false;
 
   private texts: textCursor[] = [];
   private attributes: attributeCursor[] = [];
@@ -159,9 +159,21 @@ export default class MutationBuffer {
     this.emissionCallback = cb;
   }
 
+  public freeze() {
+    this.frozen = true;
+  }
+
+  public unfreeze() {
+    this.frozen = false;
+  }
+
+  public isFrozen() {
+    return this.frozen;
+  }
+
   public processMutations = (mutations: mutationRecord[]) => {
     mutations.forEach(this.processMutation);
-    if (!this.paused) {
+    if (!this.frozen) {
       this.emit();
     }
   };

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -4,4 +4,5 @@ import { mirror } from './utils';
 import * as utils from './utils';
 export { EventType, IncrementalSource, MouseInteractions, ReplayerEvents, } from './types';
 declare const addCustomEvent: <T>(tag: string, payload: T) => void;
-export { record, addCustomEvent, Replayer, mirror, utils };
+declare const freezePage: () => void;
+export { record, addCustomEvent, freezePage, Replayer, mirror, utils };
diff --git a/typings/record/mutation.d.ts b/typings/record/mutation.d.ts
@@ -1,7 +1,7 @@
 import { MaskInputOptions } from 'rrweb-snapshot';
 import { mutationRecord, blockClass, mutationCallBack } from '../types';
 export default class MutationBuffer {
-    paused: boolean;
+    private frozen;
     private texts;
     private attributes;
     private removes;
@@ -16,6 +16,9 @@ export default class MutationBuffer {
     private maskInputOptions;
     private recordCanvas;
     init(cb: mutationCallBack, blockClass: blockClass, inlineStylesheet: boolean, maskInputOptions: MaskInputOptions, recordCanvas: boolean): void;
+    freeze(): void;
+    unfreeze(): void;
+    isFrozen(): boolean;
     processMutations: (mutations: mutationRecord[]) => void;
     emit: () => void;
     private processMutation;