Chore: Migrate build to vite (#1033)
* Chore: Add move most types from rrweb to @rrweb/types package * Split off type imports * Split off type import to its own line * Get vite to generate type definitions * Apply formatting changes * noEmit not allowed in tsconfig, moved it to build step * Migrate rrdom-nodejs build to vite * Apply formatting changes * Migrate rrweb-snapshot to vite * Unify configs * Chore: Migrate rrdom to vite Turns out what we where doing by overwriting `public textContent: string | undefined` as a getter in a subclass is something that isn't allowed in typescript. Because we where using `// @ts-ignore` to hide this error our bundler chose to allow the overwrite. Vite choses to disallow the overwrite making all subclasses' `textContent` undefined. To mitigate this we're using an abstract class, which does allow sub classes to decide if they wan't to use getters or not. * Chore: Migrate rrweb to vite WIP * build:browser was removed (for now) * BREAKING: moved rrweb-plugin-console to its own npm module This removes console from rrweb-all.js * Support cjs files in startServer * Move canvas-webrtc plugin to its own package * Chore: move sequential-id plugin to its own package * Chore: Configure rrweb's vite bundling * `Id` had lowercase `d` before, making it lowercase again * Test: Move console tests to their own package * remove unused utils from rrdom * pull in latest version of master something when wrong earlier when resolving merge conflicts, this should be correct * Fix type casting issue in diff.ts * Fix typo * Fix duplicate entries in package.json and tsconfig.json * Apply formatting changes * Update dependencies in package.json files * Update dependencies to use Vite 5.2.8 in package.json files * Get tests passing for rrdom `apply virtual style rules to node` tests need to be moved to rrweb to avoid circular dependencies * Fix image loading issue in integration tests * Move pack/unpack to its own @rrweb/packer module * Get tests to work in rrdom-nodejs * Port tests in rrweb-snapshot to vitest and fix them * Fix tests for rrweb-plugin-console-record * Add @rrweb/all package * Fix publint and attw errors for rrdom and @rrweb/types * Use shared vitest.config.ts in rrweb-snapshot package * Fix publint and attw issues for rrweb-snapshot * Export `ReplayPlugin` type directly from rrweb * Fix publint and attw issues for packages * Fix publint & attw issue. I was bumping into this issue:3729bc2a3c/docs/problems/NoResolution.mdAnd had to choose one of these three methods described here: https://github.com/andrewbranch/example-subpath-exports-ts-compat?tab=readme-ov-file#typescript-friendly-strategies-for-packagejson-subpath-exports-compatibility And I ended up going for the method described here:1ffe3425b0/examples/node_modules/package-json-redirects (package-json-redirects)The redirect method seemed the least invasive and most effective. * Fix publint & attw issue. I was bumping into this issue:3729bc2a3c/docs/problems/NoResolution.mdAnd had to choose one of these three methods described here: https://github.com/andrewbranch/example-subpath-exports-ts-compat?tab=readme-ov-file#typescript-friendly-strategies-for-packagejson-subpath-exports-compatibility And I ended up going for the method described here:1ffe3425b0/examples/node_modules/package-json-redirects (package-json-redirects)The redirect method seemed the least invasive and most effective. * move some rrdom tests that require rrweb to rrweb package * Use pre-jest 29 syntax for snapshotting * get rrweb passing publint and attw * const enum does not work with isolated modules flag * Fix script tag type in webgl.test.ts.snap and update rrweb.umd.cjs path in webgl.test.ts * Fix paths * Move tests for console record plugin and fix bundle path * Fix tests for rrweb * pack integration tests were moved to @rrweb/all * Update rrweb bundle path in test files * Fix flaky scroll emit from test * Migrate rrweb's tests over to vitest and make them pass * Make sure benchmarks & updating tests work * Remove jest from rrweb * Fix paths * always use rrweb's own cssom * Update tsconfig.json for rrweb-plugin-sequential-id-record Fixes this error: Error: @rrweb/rrweb-plugin-sequential-id-record:prepublish: tsconfig.json(9,5): error TS6377: Cannot write file '/home/runner/work/rrweb/rrweb/tsconfig.tsbuildinfo' because it will overwrite '.tsbuildinfo' file generated by referenced project '/home/runner/work/rrweb/rrweb/packages/rrweb' * Add tsbuildinfo config to extended tsconfig files * Move rrdom over to vitest * Apply formatting changes * Update rrweb imports to use the new package structure * extend rrweb-snapshot's tsconfig from monorepo base config * extend @rrweb/types's tsconfig from monorepo base config * extend rrdom's tsconfig from monorepo base config * extend rrdom-nodejs's tsconfig from monorepo base config * extend web-extension's tsconfig from monorepo base config * unify tsconfigs * Continue when tests fail * Add stricter type checking * Add check-types global command * remove jest * Remove unused code * Add check-types command to build script * Fix linting issues * Add setup Chrome action for CI/CD workflow * Update puppeteer version in package.json for rrweb * Update Chrome setup in CI/CD workflow * Update Chrome setup in CI/CD workflow * Add Chrome setup and test cache location * Update CI/CD workflow to test chrome cache location * Add chrome installation step to CI/CD workflow * Update Puppeteer configuration for headless testing * Update dependencies and workflow configuration * Use same version of chrome on CI as is run locally * Use version of chrome that seems to work with rrdom tests * Try using puppeteerrc to define chrome version * Add .cache directory to .gitignore * Move global flag to vitest config * Update puppeteer version to 20.9.0 * Update console log messages in rrweb-plugin-console-record for new puppeteer version * Remove redundant Chrome setup from CI/CD workflow * Add minification and umd for all built files * Update import paths for rrweb dist files * Add @rrweb/replay and @rrweb/record * Add script to lint packages * Apply formatting changes * exclude styles export from typescript package type checking * WIP Move rrweb-player over to vite * Apply formatting changes * chore: Update rrweb plugin import paths * Remove rollup from rrweb-player * Fix typing issues * Fix typing issues * chore: Update rrweb-player to use vite for build process * Apply formatting changes * chore: Export Player class in rrweb-player/src/main.ts Makes attw happy * Apply formatting changes * Gets wiped by yarn workspaces-to-typescript-project-references * Add .eslintignore and .eslintrc.cjs files for rrweb-player package * Apply formatting changes * Update dependencies in rrweb-player/package.json * Apply formatting changes * chore: Update eslint configuration for rrweb-player package * Apply formatting changes * chore: Remove unused files from rrweb-player package * Apply formatting changes * chore: Update rrweb-player import path to use rrweb-player.cjs * chore: Update addEventListener signature in rrweb-player * Apply formatting changes * Add .eslintignore and update .gitignore files for to root * Apply formatting changes * Update documentation * Update @rrweb/types package description * Apply formatting changes * Update build and run commands in CONTRIBUTING.md * Apply formatting changes * Update package versions to 2.0.0-alpha.13 * Apply formatting changes * Apply formatting changes * Fix import statement in media/index.ts * Apply formatting changes * chore: Update .gitignore to exclude build and dist directories * Apply formatting changes * Apply formatting changes * Migrate setTimeout to vitest * Apply formatting changes * Apply formatting changes * Fix isNativeShadowDom function signature in utils.ts * try out jsr * Apply formatting changes * Update package versions to 2.0.0-alpha.14 * Apply formatting changes * Fix name of rrwebSnapshot object * Apply formatting changes * Remove unused lock files * Apply formatting changes * Update rrweb bundle path to use umd.cjs format * Apply formatting changes * Trigger tests to run again * Rename snapshots for vitest * Apply formatting changes * Ping CI * Apply formatting changes * Ping CI * Apply formatting changes * Ignore files generated by svelte-kit for prettier * Correct Player object
This commit is contained in:
Justin Halsall
248
packages/plugins/rrweb-plugin-canvas-webrtc-replay/Readme.md
Normal file
248
packages/plugins/rrweb-plugin-canvas-webrtc-replay/Readme.md
Normal file
@@ -0,0 +1,248 @@
|
||||
# rrweb canvas webrtc plugin
|
||||
|
||||
Plugin that live streams contents of canvas elements via webrtc
|
||||
|
||||
## Example of live streaming via `yarn live-stream`
|
||||
|
||||
https://user-images.githubusercontent.com/4106/186701616-fd71a107-5d53-423c-ba09-0395a3a0252f.mov
|
||||
|
||||
## Instructions
|
||||
|
||||
### Record side
|
||||
|
||||
```js
|
||||
// Record side
|
||||
|
||||
import rrweb from 'rrweb';
|
||||
import { RRWebPluginCanvasWebRTCRecord } from '@rrweb/rrweb-plugin-canvas-webrtc-record';
|
||||
|
||||
const webRTCRecordPlugin = new RRWebPluginCanvasWebRTCRecord({
|
||||
signalSendCallback: (msg) => {
|
||||
// provides webrtc sdp offer signal & connect message
|
||||
// make sure you send this to the replayer's `webRTCReplayPlugin.signalReceive(signal)`
|
||||
sendSignalToReplayer(msg); // example of function that sends the signal to the replayer
|
||||
},
|
||||
});
|
||||
|
||||
rrweb.record({
|
||||
emit: (event) => {
|
||||
// send these events to the `replayer.addEvent(event)`, how you do that is up to you
|
||||
// you can send them to a server for example which can then send them to the replayer
|
||||
sendEventToReplayer(event); // example of function that sends the event to the replayer
|
||||
},
|
||||
plugins: [
|
||||
// add the plugin to the list of plugins, and initialize it via `.initPlugin()`
|
||||
webRTCRecordPlugin.initPlugin(),
|
||||
],
|
||||
recordCanvas: false, // we don't want canvas recording turned on, we're going to do that via the plugin
|
||||
});
|
||||
```
|
||||
|
||||
### Replay Side
|
||||
|
||||
```js
|
||||
// Replay side
|
||||
import rrweb from 'rrweb';
|
||||
import { RRWebPluginCanvasWebRTCReplay } from '@rrweb/rrweb-plugin-canvas-webrtc-replay';
|
||||
|
||||
const webRTCReplayPlugin = new RRWebPluginCanvasWebRTCReplay({
|
||||
canvasFoundCallback(canvas, context) {
|
||||
console.log('canvas', canvas);
|
||||
// send the canvas id to `webRTCRecordPlugin.setupStream(id)`, how you do that is up to you
|
||||
// you can send them to a server for example which can then send them to the replayer
|
||||
sendCanvasIdToRecordScript(context.id); // example of function that sends the id to the record script
|
||||
},
|
||||
signalSendCallback(signal) {
|
||||
// provides webrtc sdp offer signal & connect message
|
||||
// make sure you send this to the record script's `webRTCRecordPlugin.signalReceive(signal)`
|
||||
sendSignalToRecordScript(signal); // example of function that sends the signal to the record script
|
||||
},
|
||||
});
|
||||
|
||||
const replayer = new rrweb.Replayer([], {
|
||||
UNSAFE_replayCanvas: true, // turn canvas replay on!
|
||||
liveMode: true, // live mode is needed to stream events to the replayer
|
||||
plugins: [webRTCReplayPlugin.initPlugin()],
|
||||
});
|
||||
replayer.startLive(); // start the replayer in live mode
|
||||
|
||||
replayer.addEvent(event); // call this whenever an event is received from the record script
|
||||
```
|
||||
|
||||
## More info
|
||||
|
||||
https://github.com/rrweb-io/rrweb/pull/976
|
||||
|
||||
## Sponsors
|
||||
|
||||
[Become a sponsor](https://opencollective.com/rrweb#sponsor) and get your logo on our README on Github with a link to your site.
|
||||
|
||||
### Gold Sponsors 🥇
|
||||
|
||||
<div dir="auto">
|
||||
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/0/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/1/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/2/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/3/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/4/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/5/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/6/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||||
|
||||
</div>
|
||||
|
||||
### Silver Sponsors 🥈
|
||||
|
||||
<div dir="auto">
|
||||
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/0/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/1/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/2/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/3/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/4/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/5/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/6/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||||
|
||||
</div>
|
||||
|
||||
### Bronze Sponsors 🥉
|
||||
|
||||
<div dir="auto">
|
||||
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/0/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/1/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/2/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/3/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/4/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/5/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/6/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/7/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/7/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
<a href="https://opencollective.com/rrweb/tiers/sponsors/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/8/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||||
|
||||
</div>
|
||||
|
||||
### Backers
|
||||
|
||||
<a href="https://opencollective.com/rrweb#sponsor" rel="nofollow"><img src="https://opencollective.com/rrweb/tiers/backers.svg?avatarHeight=36"></a>
|
||||
|
||||
## Core Team Members
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/Yuyz0112">
|
||||
<img
|
||||
src="https://avatars.githubusercontent.com/u/13651389?s=100"
|
||||
width="100px;"
|
||||
alt=""
|
||||
/>
|
||||
<br /><sub><b>Yuyz0112</b></sub>
|
||||
<br /><br />
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/YunFeng0817">
|
||||
<img
|
||||
src="https://avatars.githubusercontent.com/u/27533910?s=100"
|
||||
width="100px;"
|
||||
alt=""
|
||||
/>
|
||||
<br /><sub><b>Yun Feng</b></sub>
|
||||
<br /><br />
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/eoghanmurray">
|
||||
<img
|
||||
src="https://avatars.githubusercontent.com/u/156780?s=100"
|
||||
width="100px;"
|
||||
alt=""
|
||||
/>
|
||||
<br /><sub><b>eoghanmurray</b></sub>
|
||||
<br /><br />
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/Juice10">
|
||||
<img
|
||||
src="https://avatars.githubusercontent.com/u/4106?s=100"
|
||||
width="100px;"
|
||||
alt=""
|
||||
/>
|
||||
<br /><sub><b>Juice10</b></sub>
|
||||
<br /><sub>open for rrweb consulting</sub>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Who's using rrweb?
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="http://www.smartx.com/" target="_blank">
|
||||
<img width="195px" src="https://www.rrweb.io/logos/smartx.png">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://posthog.com?utm_source=rrweb&utm_medium=sponsorship&utm_campaign=open-source-sponsorship" target="_blank">
|
||||
<img width="195px" src="https://www.rrweb.io/logos/posthog.png">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://statcounter.com/session-replay/" target="_blank">
|
||||
<img width="195px" src="https://statcounter.com/images/logo-statcounter-arc-blue.svg">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://recordonce.com/" target="_blank">
|
||||
<img width="195px" alt="Smart screen recording for SaaS" src="https://uploads-ssl.webflow.com/5f3d133183156245630d4446/5f3d1940abe8db8612c23521_Record-Once-logo-554x80px.svg">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://cux.io" target="_blank">
|
||||
<img style="padding: 8px" alt="The first ever UX automation tool" width="195px" src="https://cux.io/cux-logo.svg">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://remsupp.com" target="_blank">
|
||||
<img style="padding: 8px" alt="Remote Access & Co-Browsing" width="195px" src="https://remsupp.com/images/logo.png">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://highlight.io" target="_blank">
|
||||
<img style="padding: 8px" alt="The open source, fullstack Monitoring Platform." width="195px" src="https://github.com/highlight/highlight/raw/main/highlight.io/public/images/logo.png">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://analyzee.io" target="_blank">
|
||||
<img style="padding: 8px" alt="Comprehensive data analytics platform that empowers businesses to gain valuable insights and make data-driven decisions." width="195px" src="https://cdn.analyzee.io/assets/analyzee-logo.png">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://requestly.io" target="_blank">
|
||||
<img style="padding: 8px" alt="Intercept, Modify, Record & Replay HTTP Requests." width="195px" src="https://github.com/requestly/requestly/assets/16779465/652552db-c867-44cb-9bb5-94a2026e04ca">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://gleap.io" target="_blank">
|
||||
<img style="padding: 8px" alt="In-app bug reporting & customer feedback platform." width="195px" src="https://assets-global.website-files.com/6506f3f29c68b1724807619d/6506f56010237164c6306591_GleapLogo.svg">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://uxwizz.com" target="_blank">
|
||||
<img style="padding: 8px" alt="Self-hosted website analytics with heatmaps and session recordings." width="195px" src="https://github.com/UXWizz/public-files/raw/main/assets/logo.png">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://www.howdygo.com" target="_blank">
|
||||
<img style="padding: 8px" alt="Interactive product demos for small marketing teams" width="195px" src="https://assets-global.website-files.com/650afb446f1dd5bd410f00cc/650b2cec6188ff54dd9b01e1_Logo.svg">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -0,0 +1,54 @@
|
||||
{
|
||||
"name": "@rrweb/rrweb-plugin-canvas-webrtc-replay",
|
||||
"version": "2.0.0-alpha.14",
|
||||
"description": "",
|
||||
"type": "module",
|
||||
"main": "./dist/rrweb-plugin-canvas-webrtc-replay.umd.cjs",
|
||||
"module": "./dist/rrweb-plugin-canvas-webrtc-replay.js",
|
||||
"unpkg": "./dist/rrweb-plugin-canvas-webrtc-replay.umd.cjs",
|
||||
"typings": "dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"import": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"default": "./dist/rrweb-plugin-canvas-webrtc-replay.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./dist/index.d.cts",
|
||||
"default": "./dist/rrweb-plugin-canvas-webrtc-replay.cjs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"package.json"
|
||||
],
|
||||
"scripts": {
|
||||
"dev": "vite build --watch",
|
||||
"build": "tsc -noEmit && vite build",
|
||||
"check-types": "tsc -noEmit",
|
||||
"prepublish": "npm run build"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/rrweb-io/rrweb.git"
|
||||
},
|
||||
"keywords": [
|
||||
"rrweb"
|
||||
],
|
||||
"author": "justin@recordonce.com",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/rrweb-io/rrweb/issues"
|
||||
},
|
||||
"homepage": "https://github.com/rrweb-io/rrweb#readme",
|
||||
"devDependencies": {
|
||||
"rrweb": "^2.0.0-alpha.14",
|
||||
"typescript": "^4.7.3",
|
||||
"vite": "^5.2.8",
|
||||
"vite-plugin-dts": "^3.8.1"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"rrweb": "^2.0.0-alpha.14"
|
||||
}
|
||||
}
|
||||
166
packages/plugins/rrweb-plugin-canvas-webrtc-replay/src/index.ts
Normal file
166
packages/plugins/rrweb-plugin-canvas-webrtc-replay/src/index.ts
Normal file
@@ -0,0 +1,166 @@
|
||||
import type { RRNode } from 'rrdom';
|
||||
import type { Mirror } from 'rrweb-snapshot';
|
||||
import SimplePeer from 'simple-peer-light';
|
||||
import type { ReplayPlugin, Replayer } from 'rrweb';
|
||||
import type { WebRTCDataChannel } from './types';
|
||||
|
||||
// TODO: restrict callback to real nodes only, or make sure callback gets called when real node gets added to dom as well
|
||||
|
||||
export class RRWebPluginCanvasWebRTCReplay {
|
||||
private canvasFoundCallback: (
|
||||
node: Node | RRNode,
|
||||
context: { id: number; replayer: Replayer },
|
||||
) => void;
|
||||
private signalSendCallback: (signal: RTCSessionDescriptionInit) => void;
|
||||
private mirror: Mirror | undefined;
|
||||
|
||||
constructor({
|
||||
canvasFoundCallback,
|
||||
signalSendCallback,
|
||||
}: {
|
||||
canvasFoundCallback: RRWebPluginCanvasWebRTCReplay['canvasFoundCallback'];
|
||||
signalSendCallback: RRWebPluginCanvasWebRTCReplay['signalSendCallback'];
|
||||
}) {
|
||||
this.canvasFoundCallback = canvasFoundCallback;
|
||||
this.signalSendCallback = signalSendCallback;
|
||||
}
|
||||
|
||||
public initPlugin(): ReplayPlugin {
|
||||
return {
|
||||
onBuild: (
|
||||
node: Node | RRNode,
|
||||
context: { id: number; replayer: Replayer },
|
||||
) => {
|
||||
if (node.nodeName === 'CANVAS') {
|
||||
this.canvasFoundCallback(node, context);
|
||||
}
|
||||
},
|
||||
getMirror: (options) => {
|
||||
this.mirror = options.nodeMirror;
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
private startStream(
|
||||
target: HTMLCanvasElement | HTMLVideoElement,
|
||||
stream: MediaStream,
|
||||
) {
|
||||
if (this.runningStreams.has(stream)) return;
|
||||
|
||||
if (target.tagName === 'VIDEO') {
|
||||
const remoteVideo = target as HTMLVideoElement;
|
||||
remoteVideo.srcObject = stream;
|
||||
void remoteVideo.play();
|
||||
this.runningStreams.add(stream);
|
||||
return;
|
||||
}
|
||||
|
||||
if ('MediaStreamTrackProcessor' in window) {
|
||||
const canvas = target as HTMLCanvasElement;
|
||||
const ctx = canvas.getContext('2d');
|
||||
if (!ctx)
|
||||
throw new Error(
|
||||
`startStream: Could not get 2d canvas context for ${canvas.outerHTML}`,
|
||||
);
|
||||
const track = stream.getVideoTracks()[0]; // MediaStream.getVideoTracks()[0]
|
||||
const processor = new MediaStreamTrackProcessor({ track: track });
|
||||
const reader = processor.readable.getReader();
|
||||
const readChunk = function () {
|
||||
void reader.read().then(({ done, value }) => {
|
||||
if (!value) return;
|
||||
// the MediaStream video can have dynamic size based on bandwidth available
|
||||
if (
|
||||
canvas.width !== value.displayWidth ||
|
||||
canvas.height !== value.displayHeight
|
||||
) {
|
||||
canvas.width = value.displayWidth;
|
||||
canvas.height = value.displayHeight;
|
||||
}
|
||||
ctx.clearRect(0, 0, canvas.width, canvas.height);
|
||||
// value is a VideoFrame
|
||||
ctx.drawImage(value, 0, 0);
|
||||
value.close(); // close the VideoFrame when we're done with it
|
||||
if (!done) {
|
||||
readChunk();
|
||||
}
|
||||
});
|
||||
};
|
||||
readChunk();
|
||||
this.runningStreams.add(stream);
|
||||
} else {
|
||||
// Fallback for non-Chromium browsers.
|
||||
// Replaces the canvas element with a video element.
|
||||
|
||||
const remoteVideo = document.createElement('video');
|
||||
remoteVideo.setAttribute('autoplay', 'true');
|
||||
remoteVideo.setAttribute('playsinline', 'true');
|
||||
|
||||
// const { id } = mutation;
|
||||
remoteVideo.setAttribute('width', target.width.toString());
|
||||
remoteVideo.setAttribute('height', target.height.toString());
|
||||
target.replaceWith(remoteVideo);
|
||||
|
||||
this.startStream(remoteVideo, stream);
|
||||
}
|
||||
}
|
||||
|
||||
private peer: SimplePeer.Instance | null = null;
|
||||
private streamNodeMap = new Map<string, number>();
|
||||
private streams = new Set<MediaStream>();
|
||||
private runningStreams = new WeakSet<MediaStream>();
|
||||
public signalReceive(msg: RTCSessionDescriptionInit) {
|
||||
if (!this.peer) {
|
||||
this.peer = new SimplePeer({
|
||||
initiator: false,
|
||||
// trickle: false,
|
||||
});
|
||||
|
||||
this.peer.on('error', (err: Error) => {
|
||||
this.peer = null;
|
||||
console.log('error', err);
|
||||
});
|
||||
|
||||
this.peer.on('close', () => {
|
||||
this.peer = null;
|
||||
console.log('closing');
|
||||
});
|
||||
|
||||
this.peer.on('signal', (data: RTCSessionDescriptionInit) => {
|
||||
this.signalSendCallback(data);
|
||||
});
|
||||
|
||||
this.peer.on('connect', () => {
|
||||
// connected!
|
||||
});
|
||||
|
||||
this.peer.on('data', (data: SimplePeer.SimplePeerData) => {
|
||||
try {
|
||||
const json = JSON.parse(data as string) as WebRTCDataChannel;
|
||||
this.streamNodeMap.set(json.streamId, json.nodeId);
|
||||
} catch (error) {
|
||||
console.error('Could not parse data', error);
|
||||
}
|
||||
this.flushStreams();
|
||||
});
|
||||
|
||||
this.peer.on('stream', (stream: MediaStream) => {
|
||||
this.streams.add(stream);
|
||||
this.flushStreams();
|
||||
});
|
||||
}
|
||||
this.peer.signal(msg);
|
||||
}
|
||||
|
||||
private flushStreams() {
|
||||
this.streams.forEach((stream) => {
|
||||
const nodeId = this.streamNodeMap.get(stream.id);
|
||||
if (!nodeId) return;
|
||||
const target = this.mirror?.getNode(nodeId) as
|
||||
| HTMLCanvasElement
|
||||
| HTMLVideoElement
|
||||
| null;
|
||||
// got remote video stream, now let's show it in a video or canvas element
|
||||
if (target) this.startStream(target, stream);
|
||||
});
|
||||
}
|
||||
}
|
||||
309
packages/plugins/rrweb-plugin-canvas-webrtc-replay/src/simple-peer-light.d.ts
vendored
Normal file
309
packages/plugins/rrweb-plugin-canvas-webrtc-replay/src/simple-peer-light.d.ts
vendored
Normal file
@@ -0,0 +1,309 @@
|
||||
/* eslint-disable */
|
||||
/// <reference types="node" />
|
||||
declare module 'simple-peer-light' {
|
||||
import * as stream from 'stream';
|
||||
|
||||
const SimplePeer: SimplePeer.SimplePeer;
|
||||
|
||||
namespace SimplePeer {
|
||||
interface Options {
|
||||
/** set to `true` if this is the initiating peer */
|
||||
initiator?: boolean | undefined;
|
||||
/** custom webrtc data channel configuration (used by [`createDataChannel`](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createDataChannel)) */
|
||||
channelConfig?: RTCDataChannelInit | undefined;
|
||||
/** custom webrtc data channel name */
|
||||
channelName?: string | undefined;
|
||||
/** custom webrtc configuration (used by [`RTCPeerConnection`](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection) constructor) */
|
||||
config?: RTCConfiguration | undefined;
|
||||
/** custom offer options (used by [`createOffer`](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createOffer) method) */
|
||||
offerOptions?: RTCOfferOptions | undefined;
|
||||
/** custom answer options (used by [`createAnswer`](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createAnswer) method) */
|
||||
answerOptions?: RTCAnswerOptions | undefined;
|
||||
/** function to transform the generated SDP signaling data (for advanced users) */
|
||||
sdpTransform?: ((this: Instance, sdp: string) => string) | undefined;
|
||||
/** if video/voice is desired, pass stream returned from [`getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) */
|
||||
stream?: MediaStream | undefined;
|
||||
/** an array of MediaStreams returned from [`getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) */
|
||||
streams?: MediaStream[] | undefined;
|
||||
/** set to `false` to disable [trickle ICE](http://webrtchacks.com/trickle-ice/) and get a single 'signal' event (slower) */
|
||||
trickle?: boolean | undefined;
|
||||
/** similar to `trickle`, needs to be set to `false` to disable trickling, defaults to `false` */
|
||||
allowHalfTrickle?: boolean | undefined;
|
||||
/** if `trickle` is set to `false`, determines how long to wait before providing an offer or answer; default value is 5000 milliseconds */
|
||||
iceCompleteTimeout?: number | undefined;
|
||||
/** custom webrtc implementation, mainly useful in node to specify in the [wrtc](https://npmjs.com/package/wrtc) package. */
|
||||
wrtc?:
|
||||
| {
|
||||
RTCPeerConnection: typeof RTCPeerConnection;
|
||||
RTCSessionDescription: typeof RTCSessionDescription;
|
||||
RTCIceCandidate: typeof RTCIceCandidate;
|
||||
}
|
||||
| undefined;
|
||||
/** set to true to create the stream in Object Mode. In this mode, incoming string data is not automatically converted to Buffer objects. */
|
||||
objectMode?: boolean | undefined;
|
||||
}
|
||||
interface SimplePeer {
|
||||
prototype: Instance;
|
||||
/**
|
||||
* Create a new WebRTC peer connection.
|
||||
*
|
||||
* A "data channel" for text/binary communication is always established, because it's cheap and often useful. For video/voice communication, pass the stream option.
|
||||
*
|
||||
* If opts is specified, then the default options (see <https://github.com/feross/simple-peer#peer--new-peeropts>) will be overridden.
|
||||
*/
|
||||
new (opts?: Options): Instance;
|
||||
|
||||
/** Detect native WebRTC support in the javascript environment. */
|
||||
readonly WEBRTC_SUPPORT: boolean;
|
||||
|
||||
// ********************************
|
||||
// methods which are not documented
|
||||
// ********************************
|
||||
|
||||
/**
|
||||
* Expose peer and data channel config for overriding all Peer
|
||||
* instances. Otherwise, just set opts.config or opts.channelConfig
|
||||
* when constructing a Peer.
|
||||
*/
|
||||
config: RTCConfiguration;
|
||||
/**
|
||||
* Expose peer and data channel config for overriding all Peer
|
||||
* instances. Otherwise, just set opts.config or opts.channelConfig
|
||||
* when constructing a Peer.
|
||||
*/
|
||||
channelConfig: RTCDataChannelInit;
|
||||
}
|
||||
|
||||
type TypedArray =
|
||||
| Int8Array
|
||||
| Uint8Array
|
||||
| Uint8ClampedArray
|
||||
| Int16Array
|
||||
| Uint16Array
|
||||
| Int32Array
|
||||
| Uint32Array
|
||||
| Float32Array
|
||||
| Float64Array;
|
||||
|
||||
type SimplePeerData = string | Buffer | TypedArray | ArrayBuffer | Blob;
|
||||
|
||||
type SignalData =
|
||||
| {
|
||||
type: 'transceiverRequest';
|
||||
transceiverRequest: {
|
||||
kind: string;
|
||||
init?: RTCRtpTransceiverInit | undefined;
|
||||
};
|
||||
}
|
||||
| {
|
||||
type: 'renegotiate';
|
||||
renegotiate: true;
|
||||
}
|
||||
| {
|
||||
type: 'candidate';
|
||||
candidate: RTCIceCandidate;
|
||||
}
|
||||
| RTCSessionDescriptionInit;
|
||||
|
||||
interface Instance extends stream.Duplex {
|
||||
/**
|
||||
* Call this method whenever the remote peer emits a `peer.on('signal')` event.
|
||||
*
|
||||
* The `data` will encapsulate a webrtc offer, answer, or ice candidate. These messages help
|
||||
* the peers to eventually establish a direct connection to each other. The contents of these
|
||||
* strings are an implementation detail that can be ignored by the user of this module;
|
||||
* simply pass the data from 'signal' events to the remote peer and call `peer.signal(data)`
|
||||
* to get connected.
|
||||
*/
|
||||
signal(data: string | SignalData): void;
|
||||
|
||||
/**
|
||||
* Send text/binary data to the remote peer. `data` can be any of several types: `String`,
|
||||
* `Buffer` (see [buffer](https://github.com/feross/buffer)), `ArrayBufferView` (`Uint8Array`,
|
||||
* etc.), `ArrayBuffer`, or `Blob` (in browsers that support it).
|
||||
*
|
||||
* Note: If this method is called before the `peer.on('connect')` event has fired,
|
||||
* then an exception will be thrown. Use `peer.write(data)`
|
||||
* (which is inherited from the node.js [duplex stream](https://nodejs.org/api/stream.html) interface)
|
||||
* if you want this data to be buffered instead.
|
||||
*/
|
||||
send(data: SimplePeerData): void;
|
||||
|
||||
/** Add a `MediaStream` to the connection. */
|
||||
addStream(stream: MediaStream): void;
|
||||
|
||||
/** Remove a `MediaStream` from the connection. */
|
||||
removeStream(stream: MediaStream): void;
|
||||
|
||||
/** Add a `MediaStreamTrack` to the connection. Must also pass the `MediaStream` you want to attach it to. */
|
||||
addTrack(track: MediaStreamTrack, stream: MediaStream): void;
|
||||
|
||||
/** Remove a `MediaStreamTrack` from the connection. Must also pass the `MediaStream` that it was attached to. */
|
||||
removeTrack(track: MediaStreamTrack, stream: MediaStream): void;
|
||||
|
||||
/** Replace a `MediaStreamTrack` with another track. Must also pass the `MediaStream` that the old track was attached to. */
|
||||
replaceTrack(
|
||||
oldTrack: MediaStreamTrack,
|
||||
newTrack: MediaStreamTrack,
|
||||
stream: MediaStream,
|
||||
): void;
|
||||
|
||||
/** Add a `RTCRtpTransceiver` to the connection. Can be used to add transceivers before adding tracks. Automatically called as necessary by `addTrack`. */
|
||||
addTransceiver(kind: string, init?: RTCRtpTransceiverInit): void;
|
||||
|
||||
// TODO: https://github.com/feross/simple-peer/blob/d972548299a50f836ca91c36e39304ef0f9474b7/index.js#L427
|
||||
// destroy(onclose?: () => void): void;
|
||||
/**
|
||||
* Destroy and cleanup this peer connection.
|
||||
*
|
||||
* If the optional `err` parameter is passed, then it will be emitted as an `'error'`
|
||||
* event on the stream.
|
||||
*/
|
||||
destroy(error?: Error): any;
|
||||
|
||||
// ********************************
|
||||
// methods which are not documented
|
||||
// ********************************
|
||||
|
||||
readonly bufferSize: number;
|
||||
readonly connected: boolean;
|
||||
address():
|
||||
| { port: undefined; family: undefined; address: undefined }
|
||||
| { port: number; family: 'IPv6' | 'IPv4'; address: string };
|
||||
|
||||
// used for debug logging
|
||||
_debug(message?: any, ...optionalParams: any[]): void;
|
||||
|
||||
// ******
|
||||
// events
|
||||
// ******
|
||||
addListener(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
listener: () => void,
|
||||
): this;
|
||||
addListener(event: 'signal', listener: (data: SignalData) => void): this;
|
||||
addListener(
|
||||
event: 'stream',
|
||||
listener: (stream: MediaStream) => void,
|
||||
): this;
|
||||
addListener(
|
||||
event: 'track',
|
||||
listener: (track: MediaStreamTrack, stream: MediaStream) => void,
|
||||
): this;
|
||||
addListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
addListener(event: 'error', listener: (err: Error) => void): this;
|
||||
addListener(
|
||||
event: string | symbol,
|
||||
listener: (...args: any[]) => void,
|
||||
): this;
|
||||
|
||||
emit(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
): boolean;
|
||||
emit(event: 'signal', data: SignalData): this;
|
||||
emit(event: 'stream', stream: MediaStream): this;
|
||||
emit(event: 'track', track: MediaStreamTrack, stream: MediaStream): this;
|
||||
emit(event: 'data', chunk: any): boolean;
|
||||
emit(event: 'error', err: Error): boolean;
|
||||
emit(event: string | symbol, ...args: any[]): boolean;
|
||||
|
||||
on(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
listener: () => void,
|
||||
): this;
|
||||
on(event: 'signal', listener: (data: SignalData) => void): this;
|
||||
on(event: 'stream', listener: (stream: MediaStream) => void): this;
|
||||
on(
|
||||
event: 'track',
|
||||
listener: (track: MediaStreamTrack, stream: MediaStream) => void,
|
||||
): this;
|
||||
on(event: 'data', listener: (chunk: any) => void): this;
|
||||
on(event: 'error', listener: (err: Error) => void): this;
|
||||
on(event: string | symbol, listener: (...args: any[]) => void): this;
|
||||
|
||||
once(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
listener: () => void,
|
||||
): this;
|
||||
once(event: 'signal', listener: (data: SignalData) => void): this;
|
||||
once(event: 'stream', listener: (stream: MediaStream) => void): this;
|
||||
once(
|
||||
event: 'track',
|
||||
listener: (track: MediaStreamTrack, stream: MediaStream) => void,
|
||||
): this;
|
||||
once(event: 'data', listener: (chunk: any) => void): this;
|
||||
once(event: 'error', listener: (err: Error) => void): this;
|
||||
once(event: string | symbol, listener: (...args: any[]) => void): this;
|
||||
|
||||
prependListener(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
listener: () => void,
|
||||
): this;
|
||||
prependListener(
|
||||
event: 'signal',
|
||||
listener: (data: SignalData) => void,
|
||||
): this;
|
||||
prependListener(
|
||||
event: 'stream',
|
||||
listener: (stream: MediaStream) => void,
|
||||
): this;
|
||||
prependListener(
|
||||
event: 'track',
|
||||
listener: (track: MediaStreamTrack, stream: MediaStream) => void,
|
||||
): this;
|
||||
prependListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
prependListener(event: 'error', listener: (err: Error) => void): this;
|
||||
prependListener(
|
||||
event: string | symbol,
|
||||
listener: (...args: any[]) => void,
|
||||
): this;
|
||||
|
||||
prependOnceListener(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
listener: () => void,
|
||||
): this;
|
||||
prependOnceListener(
|
||||
event: 'signal',
|
||||
listener: (data: SignalData) => void,
|
||||
): this;
|
||||
prependOnceListener(
|
||||
event: 'stream',
|
||||
listener: (stream: MediaStream) => void,
|
||||
): this;
|
||||
prependOnceListener(
|
||||
event: 'track',
|
||||
listener: (track: MediaStreamTrack, stream: MediaStream) => void,
|
||||
): this;
|
||||
prependOnceListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
prependOnceListener(event: 'error', listener: (err: Error) => void): this;
|
||||
prependOnceListener(
|
||||
event: string | symbol,
|
||||
listener: (...args: any[]) => void,
|
||||
): this;
|
||||
|
||||
removeListener(
|
||||
event: 'connect' | 'close' | 'end' | 'pause' | 'readable' | 'resume',
|
||||
listener: () => void,
|
||||
): this;
|
||||
removeListener(
|
||||
event: 'signal',
|
||||
listener: (data: SignalData) => void,
|
||||
): this;
|
||||
removeListener(
|
||||
event: 'stream',
|
||||
listener: (stream: MediaStream) => void,
|
||||
): this;
|
||||
removeListener(
|
||||
event: 'track',
|
||||
listener: (track: MediaStreamTrack, stream: MediaStream) => void,
|
||||
): this;
|
||||
removeListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
removeListener(event: 'error', listener: (err: Error) => void): this;
|
||||
removeListener(
|
||||
event: string | symbol,
|
||||
listener: (...args: any[]) => void,
|
||||
): this;
|
||||
}
|
||||
}
|
||||
export default SimplePeer;
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
export interface WebRTCDataChannel {
|
||||
nodeId: number;
|
||||
streamId: string;
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"extends": "../../../tsconfig.base.json",
|
||||
"include": ["src"],
|
||||
"exclude": ["vite.config.ts"],
|
||||
"compilerOptions": {
|
||||
"rootDir": "src",
|
||||
"tsBuildInfoFile": "./tsconfig.tsbuildinfo"
|
||||
},
|
||||
"references": [
|
||||
{
|
||||
"path": "../../rrweb"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
import config from '../../../vite.config.default';
|
||||
|
||||
export default config('src/index.ts', 'rrwebPluginCanvasWebRTCReplay');
|
||||
Reference in New Issue
Block a user