Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

rrweb-snapshot

rrweb-io2mMIT2.0.0-alpha.4TypeScript support: included

rrweb's component to take a snapshot of DOM, aka DOM serializer

rrweb, snapshot, DOM

readme

Try rrweb

rrweb

The rrweb documentary (in Chinese, with English subtitles)

Join the chat at slack Twitter Follow total gzip size recorder gzip size

中文文档

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

  1. Fork this repository.
  2. Run yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).
  3. Run yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.
  4. Navigate to one of the sub-packages (in the packages folder) where you'd like to make a change.
  5. Patch the code and run yarn test to run the tests, make sure they pass before you commit anything.
  6. 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

The first ever UX automation tool
Remote Access & Co-Browsing

changelog

Changelog

v1.0.0

Featrues & Improvements

  • Support record same-origin non-sandboxed iframe.
  • Support record open-mode shadow DOM.
  • Implement the plugin API.
  • Export record.takeFullSnapshot as a public API
  • Record and replay drag events.
  • Add options to mask texts (#540).

Fixes

  • Get the original MutationObserver when Angular patched it.
  • Fix RangeError: Maximum call stack size exceeded (#479).
  • Fix the linked-list implementation in the recorder.
  • Don't perform newly added actions if the player is paused (#539).
  • Fix inaccurate mouse position (#522)

Breaking Changes

  • Deprecated the usage of rrweb.mirror. Please use record.mirror and replayer.getMirror() instead.
  • Deprecated the record option recordLog. See the new plugin API here.
  • Deprecated the replay option . See the new plugin API here.