Go to file

Eoghan Murray 4b6efde134 Monkeypatch each iframe (#716 )

* `setTimeout` and `clearTimeout` are global functions. Think the window versions of them were for the following reason: https://stackoverflow.com/questions/60245787/

* Comments and extra test here helped me understand which inserts were expected and which are to be ignored

* Add a test for the style setProperty/removeProperty added in #671

* Add a test to ensure that listeners get added correctly in nested iframes - particularly important for those which rely on prototype monkeypatching

* Pass in the window object from the current iframe so that monkeypatching applies to all windows

* Satisfy typings

* No need to insert an iframe as there's one already set up for us

* Enable the console logger to also intercept log messages within iframes

* There's no tests for FontFace but presumably the monkeypatching here works similarly to the others

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

.github

Create FUNDING.yml

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

docs

Record and replay nested stylesheet rules (#666 )

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

packages

Monkeypatch each iframe (#716 )

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

.gitignore

fix: fix console plugin's OOM problem (#656 )

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

.travis.yml

add lerna to manage monorepo

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

Reference packages directly in docs (removing direct references to the old rrweb-snapshot and rrweb-player repositories) (#647 )

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

guide.zh_CN.md

Reference packages directly in docs (removing direct references to the old rrweb-snapshot and rrweb-player repositories) (#647 )

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

update lerna scripts

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

README.md

prefer yarn over npm (#705 )

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

README.zh_CN.md

prefer yarn over npm (#705 )

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

yarn.lock

Bump tar from 4.4.17 to 4.4.19 (#686 )

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

README.md

Try rrweb

rrweb

The new adventure of the rrweb community

中文文档

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