Gathering detailed insights and metrics for @rrweb/types
Gathering detailed insights and metrics for @rrweb/types
Installations
npm install @rrweb/typesReleases
117
@rrweb/utils@2.0.0-alpha.17
@rrweb/utils@2.0.0-alpha.17
Published on 02 Aug 2024
@rrweb/types@2.0.0-alpha.17
@rrweb/types@2.0.0-alpha.17
Published on 02 Aug 2024
rrweb-snapshot@2.0.0-alpha.17
rrweb-snapshot@2.0.0-alpha.17
Published on 02 Aug 2024
rrweb-player@2.0.0-alpha.17
rrweb-player@2.0.0-alpha.17
Published on 02 Aug 2024
rrweb@2.0.0-alpha.17
rrweb@2.0.0-alpha.17
Published on 02 Aug 2024
rrvideo@2.0.0-alpha.17
rrvideo@2.0.0-alpha.17
Published on 02 Aug 2024
Developer
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
No
Node Version
20.15.1
NPM Version
10.7.0
Statistics
16,859 Stars
1,265 Commits
1,436 Forks
195 Watching
27 Branches
126 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (87.79%)
JavaScript (5.6%)
HTML (4.64%)
Svelte (1.69%)
CSS (0.26%)
Shell (0.03%)
Total Downloads
Cumulative downloads
Total Downloads
13,880,915
Last day
-2.5%
94,862
Compared to previous day
Last week
1.8%
509,204
Compared to previous week
Last month
4.5%
2,100,731
Compared to previous month
Last year
893.5%
12,610,422
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
2
Versions
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. 📚
📺 Presentation: Hacking the browser to digital twin your users 📺
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
- 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
- ...
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 build:allto build all packages and get a stable base, thenyarn 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. Add test cases in order to avoid future regression. - If tests are failing, but the change in output is desirable, run
yarn test:updateand carefully commit the changes in test output. - 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.
Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site.
Gold Sponsors 🥇
Silver Sponsors 🥈
Bronze Sponsors 🥉
Backers
Core Team Members
Yuyz0112 |
Yun Feng |
eoghanmurray |
Juice10 open for rrweb consulting |
Who's using rrweb?
|
|
|
|
|
|
|
|
|
|
|
|
|
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 26/27 approved changesets -- score normalized to 9
Reason
5 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 4
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci-cd.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/style-check.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/ci-cd.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/ci-cd.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-cd.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/ci-cd.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/style-check.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/style-check.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/style-check.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/rrweb-io/rrweb/style-check.yml/master?enable=pin
- Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 29 are checked with a SAST tool
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-96g7-g7g9-jxw8
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-8266-84wp-wv5c
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
4.1
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More