Skip to content

Fix/workaround iframe parent #1624

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 4 commits into
base: master
Choose a base branch
from
Open
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
5 changes: 5 additions & 0 deletions .changeset/brave-planes-begin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"rrweb": patch
---

Workaround for avoid the replayer from crashing when there's an error when trying to attach a document to a non-iframe
12 changes: 12 additions & 0 deletions packages/rrweb/src/replay/index.ts
Original file line number Diff line number Diff line change
@@ -932,7 +932,7 @@
sn?.type === NodeType.Element &&
sn?.tagName.toUpperCase() === 'HTML'
) {
const { documentElement, head } = iframeEl.contentDocument!;

Check warning on line 935 in packages/rrweb/src/replay/index.ts

GitHub Actions / ESLint Report Analysis

packages/rrweb/src/replay/index.ts#L935

[@typescript-eslint/no-non-null-assertion] Forbidden non-null assertion.
this.insertStyleRules(
documentElement as HTMLElement | RRElement,
head as HTMLElement | RRElement,
@@ -951,14 +951,14 @@
};

buildNodeWithSN(mutation.node, {
doc: iframeEl.contentDocument! as Document,

Check warning on line 954 in packages/rrweb/src/replay/index.ts

GitHub Actions / ESLint Report Analysis

packages/rrweb/src/replay/index.ts#L954

[@typescript-eslint/no-non-null-assertion] Forbidden non-null assertion.
mirror: mirror as Mirror,
hackCss: true,
skipChild: false,
afterAppend,
cache: this.cache,
});
afterAppend(iframeEl.contentDocument! as Document, mutation.node.id);

Check warning on line 961 in packages/rrweb/src/replay/index.ts

GitHub Actions / ESLint Report Analysis

packages/rrweb/src/replay/index.ts#L961

[@typescript-eslint/no-non-null-assertion] Forbidden non-null assertion.

for (const { mutationInQueue, builtNode } of collectedIframes) {
this.attachDocumentToIframe(mutationInQueue, builtNode);
@@ -1075,7 +1075,7 @@
const canvas = document.createElement('canvas');
const ctx = canvas.getContext('2d');
const imgd = ctx?.createImageData(canvas.width, canvas.height);
ctx?.putImageData(imgd!, 0, 0);

Check warning on line 1078 in packages/rrweb/src/replay/index.ts

GitHub Actions / ESLint Report Analysis

packages/rrweb/src/replay/index.ts#L1078

[@typescript-eslint/no-non-null-assertion] Forbidden non-null assertion.
}
}
private async deserializeAndPreloadCanvasEvents(
@@ -1396,7 +1396,7 @@
// Only apply virtual dom optimization if the fast-forward process has node mutation. Because the cost of creating a virtual dom tree and executing the diff algorithm is usually higher than directly applying other kind of events.
if (this.config.useVirtualDom && !this.usingVirtualDom && isSync) {
this.usingVirtualDom = true;
buildFromDom(this.iframe.contentDocument!, this.mirror, this.virtualDom);

Check warning on line 1399 in packages/rrweb/src/replay/index.ts

GitHub Actions / ESLint Report Analysis

packages/rrweb/src/replay/index.ts#L1399

[@typescript-eslint/no-non-null-assertion] Forbidden non-null assertion.
// If these legacy missing nodes haven't been resolved, they should be converted to virtual nodes.
if (Object.keys(this.legacy_missingNodeRetryMap).length) {
for (const key in this.legacy_missingNodeRetryMap) {
@@ -1509,11 +1509,23 @@
return queue.push(mutation);
}

if (
mutation.node.type === NodeType.Document &&
parent?.nodeName?.toLowerCase() !== 'iframe'
) {
console.warn(
'[Replayer] Skipping invalid document append to a non-iframe parent.',
mutation,
parent,
);
return;
}

if (mutation.node.isShadow) {
// If the parent is attached a shadow dom after it's created, it won't have a shadow root.
if (!hasShadowRoot(parent)) {
(parent as Element | RRElement).attachShadow({ mode: 'open' });
parent = (parent as Element | RRElement).shadowRoot! as Node | RRNode;

Check warning on line 1528 in packages/rrweb/src/replay/index.ts

GitHub Actions / ESLint Report Analysis

packages/rrweb/src/replay/index.ts#L1528

[@typescript-eslint/no-non-null-assertion] Forbidden non-null assertion.
} else parent = parent.shadowRoot as Node | RRNode;
}