feat(canvas): Bind mutationCb outside of getCanvasManager (#141)

From what I can tell, `record` ends up getting bundled separate from `getCanvasManager` in user-land code and canvas mutation events end up not being transmitted because `_wrappedEmit` does not get set and it will hold the wrong `mirror` reference.
getsentry · Apr 26, 2024 · cb2a3d0 · cb2a3d0
1 parent f1da1c4
commit cb2a3d0
Showing 1 changed file with 47 additions and 30 deletions.
diff --git a/packages/rrweb/src/record/index.ts b/packages/rrweb/src/record/index.ts
@@ -326,16 +326,17 @@ function record<T = eventWithTime>(
 
   const processedNodeManager = new ProcessedNodeManager();
 
-  const canvasManager: CanvasManagerInterface = getCanvasManager
-    ? getCanvasManager({
-        recordCanvas,
-        blockClass,
-        blockSelector,
-        unblockSelector,
-        sampling: sampling['canvas'],
-        dataURLOptions,
-      })
-    : new CanvasManagerNoop();
+  const canvasManager: CanvasManagerInterface = _getCanvasManager(
+    getCanvasManager,
+    {
+      recordCanvas,
+      blockClass,
+      blockSelector,
+      unblockSelector,
+      sampling: sampling['canvas'],
+      dataURLOptions,
+    },
+  );
 
   const shadowDomManager: ShadowDomManagerInterface =
     typeof __RRWEB_EXCLUDE_SHADOW_DOM__ === 'boolean' &&
@@ -693,27 +694,43 @@ record.takeFullSnapshot = takeFullSnapshot;
 
 export default record;
 
-const wrappedCanvasMutationEmit = (p: canvasMutationParam) =>
-  wrappedEmit(
-    wrapEvent({
-      type: EventType.IncrementalSnapshot,
-      data: {
-        source: IncrementalSource.CanvasMutation,
-        ...p,
-      },
-    }),
-  );
+type PrivateOptions = 'mutationCb' | 'win' | 'mirror';
+type PublicGetCanvasManagerOptions = Omit<
+  CanvasManagerConstructorOptions,
+  PrivateOptions
+>;
+
+interface PrivateGetCanvasManagerOptions
+  extends PublicGetCanvasManagerOptions,
+    Pick<CanvasManagerConstructorOptions, PrivateOptions> {}
+
+function _getCanvasManager(
+  getCanvasManagerFn:
+    | undefined
+    | ((options: PrivateGetCanvasManagerOptions) => CanvasManagerInterface),
+  options: PublicGetCanvasManagerOptions,
+) {
+  return getCanvasManagerFn
+    ? getCanvasManagerFn({
+        ...options,
+        mirror,
+        win: window,
+        mutationCb: (p: canvasMutationParam) =>
+          wrappedEmit(
+            wrapEvent({
+              type: EventType.IncrementalSnapshot,
+              data: {
+                source: IncrementalSource.CanvasMutation,
+                ...p,
+              },
+            }),
+          ),
+      })
+    : new CanvasManagerNoop();
+}
 
 export function getCanvasManager(
-  options: Omit<
-    CanvasManagerConstructorOptions,
-    'mutationCb' | 'win' | 'mirror'
-  >,
+  options: PublicGetCanvasManagerOptions,
 ): CanvasManagerInterface {
-  return new CanvasManager({
-    ...options,
-    mutationCb: wrappedCanvasMutationEmit,
-    win: window,
-    mirror,
-  });
+  return new CanvasManager(options as CanvasManagerConstructorOptions);
 }