Try 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.

📚 Read the rrweb guide here. 📚

🍳 Recipes 🍳

📺 Presentation: Hacking the browser to digital twin your users 📺

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.

• storage engine: do deduplication on a large number of rrweb sessions
• compact mutation data in common patterns
• provide plugins via the new plugin API, including:
  • XHR plugin
  • fetch plugin
  • GraphQL plugin
  • ...

• serialization
• incremental snapshot
• replay
• sandbox

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 pnpm install in the root to install required dependencies for all sub-packages. The repo pins pnpm via the packageManager field and Corepack, so you should not need to install pnpm globally.
3. Run pnpm build:all to build all packages and get a stable base, then pnpm 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 pnpm test to run the tests, make sure they pass before you commit anything. Add test cases in order to avoid future regression.
6. If tests are failing, but the change in output is desirable, run pnpm test:update and carefully commit the changes in test output.
7. Open a pull request with a conventional-commit-style title (feat:, fix:, perf:, chore:, etc.). The PR title is what semantic versioning uses to compute the next version on release, and is enforced by a Validate PR title CI check.

Protip: You can run pnpm 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

See CONTRIBUTING.md for more on the development workflow.

Releases of @amplitude/rrweb* packages are driven by Lerna in fixed-versioning mode, triggered manually via the Release GitHub Actions workflow. Trigger options:

• release (from master): bump versions via conventional commits, push commit + tag, publish to npm under latest, create a GitHub Release.
• prerelease (from a short-lived alpha branch): publish X.Y.Z-alpha.N under the alpha dist-tag. Consumers install via npm install @amplitude/rrweb@alpha.
• dry-run (any branch): preview the next version without pushing or publishing.

See RELEASE.md for the full release procedure, the OIDC trusted-publishing setup, the deploy-key infrastructure that lets the workflow push back to a protected branch, rotation steps, and troubleshooting.