Skip to content

Fix iframe shadowdomed canvas not being captured bug. #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/rrweb-player/src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import _Player from './Player.svelte';

type PlayerProps = {
events: eventWithTime[];
width: number;
height:number;
};

class Player extends _Player {
Expand Down
2 changes: 1 addition & 1 deletion packages/rrweb-snapshot/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"preserveConstEnums": true,
"rootDir": "src",
"outDir": "build",
"lib": ["es6", "dom"]
"lib": ["es6", "dom", "ES2020", "ES2021.WeakRef"]
},
"exclude": ["test"],
"include": ["src"],
Expand Down
6 changes: 5 additions & 1 deletion packages/rrweb/src/record/iframe-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import CrossOriginIframeMirror from './cross-origin-iframe-mirror';
import { EventType, IncrementalSource } from '@rrweb/types';
import type { eventWithTime, mutationCallBack } from '@rrweb/types';
import type { StylesheetManager } from './stylesheet-manager';
import type { CanvasManager } from './observers/canvas/canvas-manager';

export class IframeManager {
private iframes: WeakMap<HTMLIFrameElement, true> = new WeakMap();
Expand All @@ -20,17 +21,19 @@ export class IframeManager {
private loadListener?: (iframeEl: HTMLIFrameElement) => unknown;
private stylesheetManager: StylesheetManager;
private recordCrossOriginIframes: boolean;

private canvasManager : CanvasManager;
constructor(options: {
mirror: Mirror;
mutationCb: mutationCallBack;
stylesheetManager: StylesheetManager;
canvasManager : CanvasManager;
recordCrossOriginIframes: boolean;
wrappedEmit: (e: eventWithTime, isCheckout?: boolean) => void;
}) {
this.mutationCb = options.mutationCb;
this.wrappedEmit = options.wrappedEmit;
this.stylesheetManager = options.stylesheetManager;
this.canvasManager = options.canvasManager;
this.recordCrossOriginIframes = options.recordCrossOriginIframes;
this.crossOriginIframeStyleMirror = new CrossOriginIframeMirror(
this.stylesheetManager.styleMirror.generateId.bind(
Expand All @@ -45,6 +48,7 @@ export class IframeManager {

public addIframe(iframeEl: HTMLIFrameElement) {
this.iframes.set(iframeEl, true);
this.canvasManager.addIFrame(iframeEl);
if (iframeEl.contentWindow)
this.crossOriginIframeMap.set(iframeEl.contentWindow, iframeEl);
}
Expand Down
24 changes: 13 additions & 11 deletions packages/rrweb/src/record/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,9 +282,21 @@ function record<T = eventWithTime>(
adoptedStyleSheetCb: wrappedAdoptedStyleSheetEmit,
});

canvasManager = new CanvasManager({
recordCanvas,
mutationCb: wrappedCanvasMutationEmit,
win: window,
blockClass,
blockSelector,
mirror,
sampling: sampling.canvas,
dataURLOptions,
});

const iframeManager = new IframeManager({
mirror,
mutationCb: wrappedMutationEmit,
canvasManager: canvasManager,
stylesheetManager: stylesheetManager,
recordCrossOriginIframes,
wrappedEmit,
Expand All @@ -305,20 +317,10 @@ function record<T = eventWithTime>(

const processedNodeManager = new ProcessedNodeManager();

canvasManager = new CanvasManager({
recordCanvas,
mutationCb: wrappedCanvasMutationEmit,
win: window,
blockClass,
blockSelector,
mirror,
sampling: sampling.canvas,
dataURLOptions,
});

const shadowDomManager = new ShadowDomManager({
mutationCb: wrappedMutationEmit,
scrollCb: wrappedScrollEmit,
canvasManager: canvasManager,
bypassOptions: {
blockClass,
blockSelector,
Expand Down
43 changes: 37 additions & 6 deletions packages/rrweb/src/record/observers/canvas/canvas-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ export class CanvasManager {
this.locked = false;
}

private shadowDoms = new Set<WeakRef<ShadowRoot>>();
private iframes = new Set<WeakRef<HTMLIFrameElement>>();

public addshadowRoot(shadowroot:ShadowRoot){
this.shadowDoms.add(new WeakRef(shadowroot));
}

public addIFrame(iframeEl: HTMLIFrameElement){
this.iframes.add(new WeakRef(iframeEl));
}

constructor(options: {
recordCanvas: boolean;
mutationCb: canvasMutationCallback;
Expand Down Expand Up @@ -157,14 +168,34 @@ export class CanvasManager {
const timeBetweenSnapshots = 1000 / fps;
let lastSnapshotTime = 0;
let rafId: number;

const that=this;
const getCanvas = (): HTMLCanvasElement[] => {
const matchedCanvas: HTMLCanvasElement[] = [];
win.document.querySelectorAll('canvas').forEach((canvas) => {
if (!isBlocked(canvas, blockClass, blockSelector, true)) {
matchedCanvas.push(canvas);
}
function collectWindowCanvas(win:Window){
win.document.querySelectorAll('canvas').forEach((canvas:HTMLCanvasElement) => {
if (!isBlocked(canvas, blockClass, blockSelector, true)) {
matchedCanvas.push(canvas);
}
});
}
// handle shadow root cases
that.shadowDoms.forEach(function(shadowroot:WeakRef<ShadowRoot>){
const sr=shadowroot.deref();
if (!sr) return;
sr.querySelectorAll('canvas').forEach((canvas:HTMLCanvasElement) => {
if (!isBlocked(canvas, blockClass, blockSelector, true)) {
matchedCanvas.push(canvas);
}
});
});
collectWindowCanvas(win);
// handle iframe cases
that.iframes.forEach((iframeEl:WeakRef<HTMLIFrameElement>)=>{
const iframe=iframeEl.deref();
if (!iframe) return;
if (!iframe.contentWindow || !iframe.contentDocument) return;
collectWindowCanvas(iframe.contentWindow);
})
return matchedCanvas;
};

Expand Down Expand Up @@ -233,7 +264,7 @@ export class CanvasManager {
): void {
this.startRAFTimestamping();
this.startPendingCanvasMutationFlusher();

const canvasContextReset = initCanvasContextObserver(
win,
blockClass,
Expand Down
8 changes: 6 additions & 2 deletions packages/rrweb/src/record/shadow-dom-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { MutationBufferParam } from '../types';
import type {
mutationCallBack,
scrollCallback,
SamplingStrategy,
SamplingStrategy
} from '@rrweb/types';
import {
initMutationObserver,
Expand All @@ -12,7 +12,7 @@ import {
import { patch, inDom } from '../utils';
import type { Mirror } from 'rrweb-snapshot';
import { isNativeShadowDom } from 'rrweb-snapshot';

import type { CanvasManager } from './observers/canvas/canvas-manager';
type BypassOptions = Omit<
MutationBufferParam,
'doc' | 'mutationCb' | 'mirror' | 'shadowDomManager'
Expand All @@ -27,17 +27,20 @@ export class ShadowDomManager {
private bypassOptions: BypassOptions;
private mirror: Mirror;
private restoreHandlers: (() => void)[] = [];
private canvasManager: CanvasManager;

constructor(options: {
mutationCb: mutationCallBack;
scrollCb: scrollCallback;
canvasManager : CanvasManager;
bypassOptions: BypassOptions;
mirror: Mirror;
}) {
this.mutationCb = options.mutationCb;
this.scrollCb = options.scrollCb;
this.bypassOptions = options.bypassOptions;
this.mirror = options.mirror;
this.canvasManager = options.canvasManager;

this.init();
}
Expand All @@ -52,6 +55,7 @@ export class ShadowDomManager {
if (!isNativeShadowDom(shadowRoot)) return;
if (this.shadowDoms.has(shadowRoot)) return;
this.shadowDoms.add(shadowRoot);
this.canvasManager.addshadowRoot(shadowRoot);
const observer = initMutationObserver(
{
...this.bypassOptions,
Expand Down
9 changes: 6 additions & 3 deletions packages/rrweb/src/replay/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ export class Replayer {
triggerFocus: true,
UNSAFE_replayCanvas: false,
pauseAnimation: true,
mouseCursor: true,
mouseTail: defaultMouseTailConfig,
useVirtualDom: true, // Virtual-dom optimization is enabled by default.
logger: console,
Expand Down Expand Up @@ -569,9 +570,11 @@ export class Replayer {
this.wrapper.classList.add('replayer-wrapper');
this.config.root.appendChild(this.wrapper);

this.mouse = document.createElement('div');
this.mouse.classList.add('replayer-mouse');
this.wrapper.appendChild(this.mouse);
if (this.config.mouseCursor !== false) {
this.mouse = document.createElement('div');
this.mouse.classList.add('replayer-mouse');
this.wrapper.appendChild(this.mouse);
}

if (this.config.mouseTail !== false) {
this.mouseTail = document.createElement('canvas');
Expand Down
1 change: 1 addition & 0 deletions packages/rrweb/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ export type playerConfig = {
triggerFocus: boolean;
UNSAFE_replayCanvas: boolean;
pauseAnimation?: boolean;
mouseCursor:boolean;
mouseTail:
| boolean
| {
Expand Down
4 changes: 3 additions & 1 deletion packages/rrweb/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
"outDir": "build",
"lib": [
"es6",
"dom"
"dom",
"ES2020",
"ES2021.WeakRef"
],
"downlevelIteration": true,
"importsNotUsedAsValues": "error",
Expand Down