MCPcopy
hub / github.com/rrweb-io/rrweb

github.com/rrweb-io/rrweb @rrdom-nodejs@2.1.0 sqlite

repository ↗ · DeepWiki ↗ · release rrdom-nodejs@2.1.0 ↗ · compare 2 versions
1,177 symbols 3,721 edges 223 files 102 documented · 9%
README

Try rrweb

rrweb

rrweb 纪录片（中文）

Join the chat at slack Reddit record bundle size replay bundle size CDN catalog

我已开通 Github Sponsor， 您可以通过赞助的形式帮助 rrweb 的开发。

rrweb 是 'record and replay the web' 的简写，旨在利用现代浏览器所提供的强大 API 录制并回放任意 web 界面中的用户操作。

指南

📚 rrweb 使用指南 📚

🍳 场景示例 🍳

项目结构

rrweb 主要由 3 部分组成：

  • rrweb-snapshot，包含 snapshot 和 rebuild 两个功能。snapshot 用于将 DOM 及其状态转化为可序列化的数据结构并添加唯一标识；rebuild 则是将 snapshot 记录的数据结构重建为对应的 DOM。
  • rrweb，包含 record 和 replay 两个功能。record 用于记录 DOM 中的所有变更（mutation）；replay 则是将记录的变更按照对应的时间一一重放。
  • rrweb-player，为 rrweb 提供一套 UI 控件，提供基于 GUI 的暂停、快进、拖拽至任意时间点播放等功能。

Roadmap

  • storage engine: 对大规模 rrweb 数据进行去重
  • 在常见场景下对 mutation 数据进行压缩
  • 基于新的插件 API 提供更多插件，包括:
  • XHR 插件
  • fetch 插件
  • GraphQL 插件
  • ...

Internal Design

Contribute Guide

为了保证录制和回放时可以对应到一致的数据结构，rrweb 采用 typescript 开发以提供更强的类型支持。

Typescript 手册

  1. Fork 需要修改的 rrweb 组件仓库
  2. yarn install 安装所需依赖
  3. 修改代码并通过测试
  4. 提交代码，创建 pull request

除了添加集成测试和单元测试之外，rrweb 还提供了交互式的测试工具。

使用 REPL 工具

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site.

Gold Sponsors 🥇

sponsor sponsor sponsor sponsor sponsor sponsor sponsor

Silver Sponsors 🥈

sponsor sponsor sponsor sponsor sponsor sponsor sponsor

Bronze Sponsors 🥉

sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor sponsor

Backers

Core Team Members

Yuyz0112 Yun Feng eoghanmurray Juice10 open for rrweb consulting

Who's using rrweb?

SmartX PostHog Smart screen recording for SaaS
Sentry Pendo Mixpanel Datadog
Amplitude New Relic The first ever UX automation tool Remote Access & Co-Browsing
The open source, fullstack Monitoring Platform. Comprehensive data analytics platform that empowers businesses to gain valuable insights and make data-driven decisions. Intercept, Modify, Record & Replay HTTP Requests. In-app bug reporting & customer feedback platform.
Self-hosted website analytics with heatmaps and session recordings. Interactive product demos for small marketing teams

Extension points exported contracts — how you extend this code

IRRDocument (Interface)
(no doc) [3 implementers]
packages/rrdom/src/document.ts
ICrossOriginIframeMirror (Interface)
(no doc) [2 implementers]
packages/types/src/index.ts
IMimeType (Interface)
(no doc)
packages/all/test/utils.ts
RRElementTagNameMap (Interface)
(no doc)
packages/rrdom-nodejs/src/document-nodejs.ts
SideBarItem (Interface)
(no doc)
packages/web-extension/src/components/SidebarWithHeader.tsx
IMimeType (Interface)
(no doc)
packages/browser-client/test/utils.ts
IMimeType (Interface)
(no doc)
packages/rrweb-snapshot/test/integration.test.ts
Options (Interface)
(no doc)
packages/plugins/rrweb-plugin-canvas-webrtc-replay/src/simple-peer-light.d.ts

Core symbols most depended-on inside this repo

evaluate
called by 535
packages/rrweb/test/utils.ts
createElement
called by 294
packages/rrdom/src/document.ts
appendChild
called by 182
packages/rrdom/src/document.ts
add
called by 145
packages/types/src/index.ts
waitForRAF
called by 137
packages/rrweb/test/utils.ts
getId
called by 117
packages/types/src/index.ts
on
called by 97
packages/plugins/rrweb-plugin-canvas-webrtc-record/src/simple-peer-light.d.ts
assertSnapshot
called by 97
packages/rrweb/test/utils.ts

Shape

Function 542
Method 417
Class 147
Interface 56
Enum 15

Languages

TypeScript100%

Modules by API surface

packages/rrdom/src/document.ts111 symbols
packages/rrdom-nodejs/src/document-nodejs.ts64 symbols
packages/rrweb/src/replay/index.ts60 symbols
packages/rrweb/test/utils.ts58 symbols
packages/rrdom/src/index.ts46 symbols
packages/rrweb/src/utils.ts42 symbols
packages/rrweb/test/html/assets/webgl-utils.js39 symbols
packages/rrweb-snapshot/src/utils.ts35 symbols
packages/rrweb/src/record/observer.ts31 symbols
packages/types/src/index.ts27 symbols
packages/rrweb-snapshot/src/snapshot.ts27 symbols
packages/plugins/rrweb-plugin-network-record/src/index.ts26 symbols

Dependencies from manifests, versioned

@chakra-ui/react2.3.4 · 1×
@changesets/changelog-github0.7.0 · 1×
@changesets/cli2.31.0 · 1×
@emotion/react11.10.4 · 1×
@emotion/styled11.10.4 · 1×
@monorepo-utils/workspaces-to-typescript-project-references2.8.2 · 1×
@open-tech-world/cli-progress-bar2.0.2 · 1×
@rrweb/packer2.1.0 · 1×
@rrweb/record2.1.0 · 1×
@rrweb/replay2.1.0 · 1×
@rrweb/rrweb-plugin-console-record2.1.0 · 1×
@rrweb/rrweb-plugin-network-record2.1.0 · 1×

For agents

$ claude mcp add rrweb \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact