Skip to content

Commit

Permalink
fix(rrdom): Ignore invalid DOM attributes when diffing (#213)
Browse files Browse the repository at this point in the history
We encountered an issue where replays with invalid attributes (e.g.
`@click`) would break rendering the replay after seeking. The exception
bubbles up to
[here](https://github.com/rrweb-io/rrweb/blob/62093d4385a09eb0980c2ac02d97eea5ce2882be/packages/rrweb/src/replay/index.ts#L270-L279),
which means the replay will continue to play, but the replay mirror will
be incomplete.

Closes getsentry/team-replay#458
  • Loading branch information
billyvg authored Aug 26, 2024
1 parent 781b2a1 commit ae2ab5d
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
11 changes: 10 additions & 1 deletion packages/rrdom/src/diff.ts
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,16 @@ function diffProps(
}
};
} else if (newTree.tagName === 'IFRAME' && name === 'srcdoc') continue;
else oldTree.setAttribute(name, newValue);
else {
try {
oldTree.setAttribute(name, newValue);
} catch (err) {
// We want to continue diffing so we quietly catch
// this exception. Otherwise, this can throw and bubble up to
// the `ReplayerEvents.Flush` listener and break rendering
console.warn(err);
}
}
}

for (const { name } of Array.from(oldAttributes))
Expand Down
26 changes: 26 additions & 0 deletions packages/rrdom/test/diff.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,32 @@ describe('diff algorithm for rrdom', () => {
expect((node as Node as HTMLElement).className).toBe('node');
});

it('ignores invalid attributes', () => {
const tagName = 'DIV';
const node = document.createElement(tagName);
const sn = Object.assign({}, elementSn, {
attributes: { '@click': 'foo' },
tagName,
});
mirror.add(node, sn);

const rrDocument = new RRDocument();
const rrNode = rrDocument.createElement(tagName);
const sn2 = Object.assign({}, elementSn, {
attributes: { '@click': 'foo' },
tagName,
});
rrDocument.mirror.add(rrNode, sn2);

rrNode.attributes = { id: 'node1', class: 'node', '@click': 'foo' };
diff(node, rrNode, replayer);
expect((node as Node as HTMLElement).id).toBe('node1');
expect((node as Node as HTMLElement).className).toBe('node');
expect('@click' in (node as Node as HTMLElement)).toBe(false);
expect(warn).toHaveBeenCalledTimes(1);
warn.mockClear();
});

it('can update exist properties', () => {
const tagName = 'DIV';
const node = document.createElement(tagName);
Expand Down

0 comments on commit ae2ab5d

Please sign in to comment.