Go to file

Justin Halsall 2887c8c7e5 #853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

* rrdom: add a diff function for properties

* implement diffChildren function and unit tests

* finish basic functions of diff algorithm

* fix several bugs in the diff algorithm

* replace the virtual parent optimization in applyMutation()

* fix: moveAndHover after the diff algorithm is executed

* replace virtual style map with rrdom

cssom version has to be above 0.5.0 to pass virtual style tests

* fix: failed virtual style tests in replayer.test.ts

* fix: failed polyfill tests caused by nodejs compatibility of different versions

* fix: svg viewBox attribute doesn't work

Cause the attribute viewBox is case sensitive, set value for viewbox doesn't work

* feat: replace treeIndex optimization with rrdom

* fix bug of diffProps and disable smooth scrolling animation in fast-forward mode

* feat: add iframe support

* fix: @rollup/plugin-typescript build errors in rrweb-player

Error: @rollup/plugin-typescript TS1371: This import is never used as a value and must use 'import type' because the 'importsNotUsedAsValues' is set to 'error'

* fix: bug when fast-forward input events and add test for it

* add test for fast-forward scroll events

* fix: custom style rules don't get inserted into some iframe elements

* code style tweak

* fix: enable to diff iframe elements

* fix  the jest error "Unexpected token 'export'"

* try to fix build error of rrweb-player

* correct the attributes definition in rrdom

* fix: custom style rules are not inserted in some iframes

* add support for shadow dom

* add support for MediaInteraction

* add canvas support

* fix unit test error in rrdom

* add support for Text, Comment

* try to refactor RRDom

* refactor RRDom to reduce duplicate code

* rename document-browser to virtual-dom

* increase the test coverage for document.ts and add ownerDocument for it

* Merge branch 'master' into virtual-dom

* add more test for virtual-dom.ts

* use cssstyle in document-nodejs

* fix: bundle error

* improve document-nodejs

* enable to diff scroll positions of an element

* rename rrdom to virtualDom for more readability and make the tree public

* revert unknown change

* improve the css style parser for comments

* improve code style

* update typings

* add handling for the case where legacy_missingNodeRetryMap is not empty

* only import types from rrweb into rrdom

* Apply suggestions from code review

Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>

* Apply suggestions from code review

* fix building error in rrweb

* add a method setDefaultSN to set a default value for a RRNode's __sn

* fix rrweb test error and bump up other packages

* add support for custom property of css styles

* add a switch for virtual-dom optimization

* Apply suggestions from code review

1. add an enum type for NodeType
2. rename nodeType from rrweb-snapshot to RRNodeType
3. rename notSerializedId to unserializedId
4. add comments for some confusing variables

* adapt changes of #865 to virtual-dom and improve the test case for more coverage

* apply review suggestions

https://github.com/rrweb-io/rrweb/pull/853#pullrequestreview-922474953

* tweak the diff algorithm

* add description of the flag useVirtualDom and remove outdated logConfig

* Remove console.log

* Contain changes to document

* Upgrade rollup to 2.70.2

* Revert "Upgrade rollup to 2.70.2"

This reverts commit b1be81a2a76565935c9dc391f31beb7f64d25956.

* Fix type checking rrdom

* Fix typing error while bundling

* Fix tslib error on build

Rollup would output the following error:
`semantic error TS2343: This syntax requires an imported helper named '__spreadArray' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.`

* Increase memory limit for rollup

* Use esbuild for bundling

Speeds up bundling significantly

* Avoid circular dependencies and import un-bundled rrdom

* Fix imports

* Revert back to pre-esbuild

This reverts the following commits:
b7b3c8dbaa551a0129da1477136b1baaad28e6e1
72e23b8e27f9030d911358d3a17fe5ad1b3b5d4f
85d600a20c56cfa764cf1f858932ba14e67b1d23
61e1a5d323212ca8fbe0569e0b3062ddd53fc612

* Set node to lts (12 is no longer supported)

* Speed up bundling and use less memory

This fixes the out of memory errors happening while bundling

* remove __sn from rrdom

* fix typo

* test: add a test case for StyleSheet mutation exceptions while fast-forwarding

* rename Array.prototype.slice.call() to Array.from()

* improve test cases

* fix: PR #887 in 'virtual-dom' branch

* apply justin's suggestion on 'Array.from' refactor

related commit 0f6729d27a323260b36fbe79485a86715c0bc98a

* improve import code structure

Co-authored-by: Yun Feng <yun.feng@anu.edu.au>

2026-04-01 12:00:00 +08:00

.github

Create FUNDING.yml

2026-04-01 12:00:00 +08:00

.vscode

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

docs

Record canvas snapshots N times per second (#859 )

2026-04-01 12:00:00 +08:00

packages

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

.gitignore

Add WebGL support (#756 )

2026-04-01 12:00:00 +08:00

.npmignore

Add yarn support for installing unreleased rrweb as a dependency (#497 )

2026-04-01 12:00:00 +08:00

.prettierrc

init the repo and integrate rrweb-snapshot

2026-04-01 12:00:00 +08:00

.release-it.json

add changelog config

2026-04-01 12:00:00 +08:00

.travis.yml

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

CHANGELOG.md

close #489 add v1.0.0 changelog

2026-04-01 12:00:00 +08:00

guide.md

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

guide.zh_CN.md

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

lerna.json

update lerna scripts

2026-04-01 12:00:00 +08:00

LICENSE

add company info

2026-04-01 12:00:00 +08:00

package.json

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

README.md

Add Twitter badge (#829 )

2026-04-01 12:00:00 +08:00

README.zh_CN.md

Add Statcounter logo (#738 )

2026-04-01 12:00:00 +08:00

yarn.lock

#853 Second try: fast-forward implementation v2: virtual dom optimization (#895 )

2026-04-01 12:00:00 +08:00

README.md

Try rrweb

rrweb

The rrweb documentary (in Chinese, with English subtitles)

中文文档

I have joined Github Sponsors and highly appreciate your sponsorship.

rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web.

Guide

📚 Read the rrweb guide here. 📚

🍳 Recipes 🍳

Project Structure

rrweb is mainly composed of 3 parts:

rrweb-snapshot, including both snapshot and rebuilding features. The snapshot is used to convert the DOM and its state into a serializable data structure with a unique identifier; the rebuilding feature is to rebuild the snapshot into corresponding DOM.
rrweb, including two functions, record and replay. The record function is used to record all the mutations in the DOM; the replay is to replay the recorded mutations one by one according to the corresponding timestamp.
rrweb-player, is a player UI for rrweb, providing GUI-based functions like pause, fast-forward, drag and drop to play at any time.

Roadmap

rrdom: an ad-hoc DOM for rrweb session data #419
storage engine: do deduplication on a large number of rrweb sessions
more end-to-end tests
compact mutation data in common patterns
provide plugins via the new plugin API, including:
- XHR plugin
- fetch plugin
- GraphQL plugin
- ...

Internal Design

Contribute Guide

Since we want the record and replay sides to share a strongly typed data structure, rrweb is developed with typescript which provides stronger type support.

Typescript handbook

Fork this repository.
Run yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).
Run yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.
Navigate to one of the sub-packages (in the packages folder) where you'd like to make a change.
Patch the code and run yarn test to run the tests, make sure they pass before you commit anything.
Push the code and create a pull request.