a8478f1da4
* inline stylesheets when loaded * set empty link elements to loaded by default * Clean up stylesheet manager * Remove attribute mutation code * Update packages/rrweb/test/record.test.ts * Update packages/rrweb/test/record.test.ts * Update packages/rrweb/test/record.test.ts * Update packages/rrweb/scripts/repl.js * Update packages/rrweb/test/record.test.ts * Update packages/rrweb/src/record/index.ts * Add todo * Move require out of time sensitive assert * Add waitForRAF, its more reliable than waitForTimeout * Remove flaky tests * Add recording stylesheets in iframes * Remove variability from flaky test * Make test more robust * Fix naming * Add test cases for inlineImages * Add test cases for inlineImages * Record iframe mutations cross page * Test: should record images inside iframe with blob url after iframe was reloaded * Handle negative ids in rrdom correctly When iframes get inserted they create untracked elements, both on the dom and rrdom side. Because they are untracked they generate negative numbers when fetching the id from mirror. This creates a problem when comparing and fetching ids across mirrors. This commit tries to get away from using negative ids as much as possible in rrdom's comparisons * Update packages/rrdom/src/diff.ts Co-authored-by: Yun Feng <yun.feng@anu.edu.au> * Start unserialized nodes at -2 This way we don't accidentally think of them as mirror misses * Set unserialized id starting number at -2 * Remove duplication * Use turbo instead of lerna * Skip benchmark as it is unreliable when executed in parallel * Strip port number from serialization, it can vary * Add settimeout to virtual dom test * Remove console.log and refactor blob:url serialization * Include references in tsconfig to indicate which monorepo packages are being used * Add stream setup * Migrate project to es module * Add reference to rrweb from rrdom * Move jest config to ESM * Setup basic WebRTC canvas streaming * Cleanup and refactor WebRTC streaming * Remove ? which isn't propper javascript * Yarn lock * Remove webrtc code from rrweb * Add plugin hooks Record/Replay plugins `.getMirror` exposes the mirror to plugins Replay plugins `.onBuild` called whenever a node was added to the dom * Expose plugins with server * Use unminified version for tests * Don't include simple-peer in rrweb main project * Add canvas webrtc plugin Streams contents of canvas via webrtc * ignore tsconfig.tsbuildinfo * Cleanup unused code * type definition files are no longer committed * Devtools off by default * Extract .css into its own file * Refactor plugin apis and fix multi canvas streaming support * Add readme to rrweb canvas webrtc plugin * Reference canvas-webrtc plugin in documentation * Forbidden non-null assertion * Remove linting of each project, yarn lint:report will do this * Remove test code * Cut down line length * fix CI failure and improve the zh_CN doc * Update packages/rrweb/src/plugins/canvas-webrtc/replay/index.ts Co-authored-by: Yun Feng <yun.feng@anu.edu.au> * Cleaner styling of replay Co-authored-by: Yun Feng <yun.feng@anu.edu.au> * Clean up stream.js based on @Mark-Fenng's feedback * Remove duplicate send Co-authored-by: Yun Feng <yun.feng@anu.edu.au> Co-authored-by: Yun Feng <yun.feng0817@gmail.com>
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. 📚
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.
- Fork this repository.
- Run
yarn installin the root to install required dependencies for all sub-packages (note:npm installis not recommended). - Run
yarn devin the root to get auto-building for all the sub-packages whenever you modify anything. - Navigate to one of the sub-packages (in the
packagesfolder) where you'd like to make a change. - Patch the code and run
yarn testto 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.
Core Team Members
Yuyz0112 |
Mark-Fenng |
eoghanmurray |
Juice10 |
Who's using rrweb
|
|
|
|
|
|