Files

Yun Feng 3cc4323094 improve rrdom performance (#1127 )

* add more check to rrdom to make diff algorithm more robust

* fix: selector match in iframe is case-insensitive

add try catch to some fragile points

* test: increase timeout value for Jest

* improve code style

* fix: failed to execute insertBefore on Node in the diff function

this happens when ids of doctype or html element are changed in the virtual dom

also improve the code quality

* refactor diff function to make the code cleaner

* fix: virtual nodes are passed to plugin's onBuild function

* refactor the diff function and adjust the order of diff work.

* call afterAppend hook in a consistent traversal order

* improve the performance of the "contains" function

reduce the complexity from O(n) to O(logn)
a specific benchmark is needed to add further

* add a real events for benchmark

* refactor: change the data structure of childNodes from array to linked list

* remove legacy code in rrweb package

* update unit tests

* update change log

2023-02-14 11:54:30 +01:00

scripts

Cross origin iframe support (#1035 )

2022-11-16 13:11:11 +08:00

src

improve rrdom performance (#1127 )

2023-02-14 11:54:30 +01:00

test

improve rrdom performance (#1127 )

2023-02-14 11:54:30 +01:00

.gitignore

[Plugin] Live stream canvas via webrtc (#976 )

2022-09-15 11:24:05 +08:00

.release-it.json

CI: add a prettier GitHub action to format code automatically (#988 )

2022-09-06 09:38:43 +08:00

jest.config.js

[Plugin] Live stream canvas via webrtc (#976 )

2022-09-15 11:24:05 +08:00

package.json

fix duplicated shadow dom (#1095 )

2023-02-12 14:00:18 +01:00

README.md

Fix #972 [Docs]: Add Readme.md to packages/rrweb (#1025 )

2022-10-17 18:16:40 +08:00

rollup.config.js

Fix cross origin iframe bugs (#1093 )

2023-01-16 15:26:33 +08:00

tsconfig.json

fix CI error (#1045 )

2022-11-07 12:54:36 +08:00

README.md

Try rrweb

rrweb

This is a simpler version of the original rrewb README within this rrweb subpackage

中文文档

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 mainly includes two funtions:

Record: The record function is used to record all the mutations in the DOM
Replay: The replay function is to replay the recorded mutations one by one according to the corresponding timestamp.

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.

Protip: You can run yarn test in the root folder to run all the tests.

In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool.

Using the REPL tool

Core Team Members

_Yuyz0112

_Mark-Fenng

_eoghanmurray

_Juice10

Who's using rrweb