* Don't allow video autoplay to automatically unfreeze page. If it's a 'real' playback, there should be a mount or a keyboard event which will serve to unfreeze the page. Also add other non-user events to the list (we really should have an `isUserEvent` function)
* Apply formatting changes
* Create a new `umd` folder alongside `dist` for output of UMD files with a plain `.js` instead of `.cjs` extension, as the latter won't be served with the correct mime type by jsdelivr
- #1687 (just rename `.cjs` to `.js`) was rejected due to the the 'dual package hazard' [1], and produces a warning when run through publint.dev (which was the original motivation for changing to \.cjs)
- jsdelivr won't be serving `.cjs` with the correct mime type: https://github.com/jsdelivr/jsdelivr/issues/18584
[1] https://nodejs.org/en/learn/modules/publishing-a-package#the-dual-package-hazard
* Update to point to alpha.19 as presumably that's when the umd folder will be available after the changes in this PR
* Apply formatting changes
* Don't try to create the same directory twice (was failing on packages/packer/umd)
* Create thirty-shirts-grow.md
* Revert something that shouldn't have gotten into the UMD branch folder
* Apply formatting changes
* Update vite.config.default.ts
* Apply formatting changes
* build: include umd builds in published packages
Add umd directory to the files array in package.json for all packages to include UMD builds in npm publications. Also update .gitignore to exclude
umd folders from version control.
* Docs: point to correct file
* Remove unused code
* docs: update rrweb cdn urls to umd bundles
Align README and guide examples with published UMD file locations for
rrweb, @rrweb/record, and @rrweb/replay.
Update versioned rrweb script examples from 2.0.0-alpha.19 to
2.0.0-alpha.21 in both English and Chinese guides.
* build(all): include umd folder in package files
---------
Co-authored-by: eoghanmurray <eoghanmurray@users.noreply.github.com>
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
* chore: maintain CSS output file name in vite@6.0.1
Without this change, build would fail because the produced stylesheet assumes
the `package.json['name']` i.e., `styles/rrweb.css`. To maintain the existing
behavior, these changes are required.
See https://vite.dev/guide/migration.html#customize-css-output-file-name-in-library-mode
* build(rrvideo): upgrade playwright from 1.32.1 to 1.56.1
Update playwright dependency to latest version and refactor test execution options to use a shared configuration with increased timeout for stability.
* debug(rrvideo): add comprehensive logging to video transformation process
Add detailed console.log statements throughout the transformToVideo function to track execution flow and debug potential issues. Logging covers browser launch, context creation, page navigation, replay progress, and video file operations.
* ci(rrvideo): install playwright browsers and improve test output visibility
- Add Playwright Chromium installation step to CI workflow
- Change test execution stdio from 'pipe' to 'inherit' for better debugging
* fix(rrvideo): prevent autoplay and manually start playback after event listeners
Set autoPlay to false in replayer configuration and manually call play() after all event listeners are attached. This ensures event handlers are properly registered before playback begins, preventing potential race conditions.
Also refactor test execution options to separate stdio configuration from timeout settings for better control over test output visibility.
* fix(rrvideo): add timeout and error handling to replay process
Add comprehensive error handling to prevent hanging during video transformation:
- Add 2-minute timeout for replay finish event
- Add console and error listeners for better debugging
- Improve promise chain with proper error catching
- Clear timeout on successful completion or error
This prevents the process from hanging indefinitely when the replay finish event never fires.
* fix(rrvideo): add error handling and restructure replayer initialization
Wrap replayer initialization in try-catch block to handle potential errors gracefully. Restructure Player instantiation to use rrwebPlayer directly instead of rrwebPlayer.Player, and move width/height into props object for correct API usage. On error, log to console and trigger onReplayFinish callback to prevent hanging state.
* build(umd): rename record and replay globals
Update UMD build globals for recorder and replayer and
refresh documentation accordingly.
BREAKING CHANGE: UMD global names changed to rrwebRecord
and rrwebReplay.
* fix(rrvideo): adjust replay timeout to duration
* docs: update rrweb-player CDN script path
* Update vite.config.default.ts
Co-authored-by: Eoghan Murray <eoghan@getthere.ie>
---------
Co-authored-by: Rui <rui@conti.sh>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Eoghan Murray <eoghan@getthere.ie>
Support a contrived/rare case where a <style> element has multiple text node children (this is usually only possible to recreate via javascript append) ... this PR fixes cases where there are subsequent text mutations to these nodes; previously these would have been lost
* In this scenario, a new CSS comment may now be inserted into the captured `_cssText` for a <style> element to show where it should be broken up into text elements upon replay: `/* rr_split */`
* The new 'can record and replay style mutations' test is the principal way to the problematic scenarios, and is a detailed 'catch-all' test with many checks to cover most of the ways things can fail
* There are new tests for splitting/rebuilding the css using the rr_split marker
* The prior 'dynamic stylesheet' route is now the main route for serializing a stylesheet; dynamic stylesheet were missed out in #1533 but that case is now covered with this PR
This PR was originally extracted from #1475 so the initial motivation was to change the approach on stringifying <style> elements to do so in a single place. This is also the motivating factor for always serializing <style> elements via the `_cssText` attribute rather than in it's childNodes; in #1475 we will be delaying populating `_cssText` for performance and instead recorrding them as assets.
Thanks for the detailed review to Justin Halsall <Juice10@users.noreply.github.com> & Yun Feng <https://github.com/YunFeng0817>
* chore: its important to run `yarn build:all` before running `yarn dev`
* feat: trigger showModal from rrdom and rrweb
* feat: Add support for replaying modal and non modal dialog elements
* chore: Update dev script to remove CLEAR_DIST_DIR flag
* Get modal recording and replay working
* DRY up dialog test and dedupe snapshot images
* feat: Refactor dialog test to use updated attribute name
* feat: Update dialog test to include rr_open attribute
* chore: Add npm dependency happy-dom@14.12.0
* Add more test cases for dialog
* Clean up naming
* Refactor dialog open code
* Revert changed code that doesn't do anything
* Add documentation for unimplemented type
* chore: Remove unnecessary comments in dialog.test.ts
* rename rr_open to rr_openMode
* Replace todo with a skipped test
* Add better logging for CI
* Rename rr_openMode to rr_open_mode
rrdom downcases all attribute names which made `rr_openMode` tricky to deal with
* Remove unused images
* Move after iframe append based on @YunFeng0817's comment
https://github.com/rrweb-io/rrweb/pull/1503#discussion_r1666363931
* Remove redundant dialog handling from rrdom.
rrdom already handles dialog element creation it's self
* Rename variables for dialog handling in rrweb replay module
* Update packages/rrdom/src/document.ts
---------
Co-authored-by: Eoghan Murray <eoghan@getthere.ie>
- Running `yarn build` in a `packages/*/` directory will trigger build of all dependencies too, and cache them if possible.
- Fix for `yarn dev` breaking for `rrweb` package whenever changing files in `rrweb` package
- Update typescript, turbo, vite and vite-plugin-dts
- Require `workspaces-to-typescript-project-references` from `prepublish`
* 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.md
And 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.md
And 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
* first commit
* rrvideo v0.1.0
First version of rrvideo.
1. Use as a Node.JS lib.
2. Use as a CLI.
Features are implemented via puppeteer, ffmpeg and rrweb-player.
* add readme
* update publish script
* add node env in cli file and change package.json bin to same like README (#4)
Co-authored-by: Xu Yinjie <xuyinjie@xiaobangtouzi.com>
* release 0.2.0
* fix#6 avoid assign undefined to config
* Fix: Solve the inconsistency between rrvideo and the real recorded page rendering when rendering the page with a headless browser (https://github.com/rrweb-io/rrvideo/pull/26)
Author: xujiujiu <906784584@qq.com>
---------
Co-authored-by: xujiujiu <906784584@qq.com>
* refactor rrvideo
1. refactor code
2. change monorepo config
3. remove separate TS dependencies
* add changeset
* fix: eslint errors
---------
Co-authored-by: Yanzhen Yu <yanzhen@smartx.com>
Co-authored-by: xyj <593500664@qq.com>
Co-authored-by: Xu Yinjie <xuyinjie@xiaobangtouzi.com>
Co-authored-by: xujiujiu <906784584@qq.com>
* fix: module error
refactor all suffix of bundled scripts with commonjs module from 'js' to cjs
error:
ReferenceError: exports is not defined in ES module scope
This file is being treated as an ES module because it has a '.js' file extension and '.../rrweb/package.json' contains "type": "module". To treat it as a CommonJS script, rename it to use the '.cjs' file extension.
* update jest config files
* Upgrade puppeteer to 17.1.3 in rrweb-snapshot
* Apply formatting changes
* Add ?
* Make tests less flakey
* Make attribute-setting more explicit
* Make test less flakey
* Make test less flakey
* Upgrade puppeteer for rrdom
* Use wait for request animation frame instead of timeout
* Force append to happen in second event
* Wait till iframe was loaded (now 100ms)
* Round the currentTime to 1 decimal place
* 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
* Align version of @rrweb/types with main rrweb package
Based on @mark-fenng's comments https://github.com/rrweb-io/rrweb/pull/1031/files#r1002298176
* Move up keywords
* rrdom: add a diff function for properties
* implement diffChildren function and unit tests
* finish basic functions of diff algorithm
* fix several bugs in the diff algorithm
* replace the virtual parent optimization in applyMutation()
* fix: moveAndHover after the diff algorithm is executed
* replace virtual style map with rrdom
cssom version has to be above 0.5.0 to pass virtual style tests
* fix: failed virtual style tests in replayer.test.ts
* fix: failed polyfill tests caused by nodejs compatibility of different versions
* fix: svg viewBox attribute doesn't work
Cause the attribute viewBox is case sensitive, set value for viewbox doesn't work
* feat: replace treeIndex optimization with rrdom
* fix bug of diffProps and disable smooth scrolling animation in fast-forward mode
* feat: add iframe support
* fix: @rollup/plugin-typescript build errors in rrweb-player
Error: @rollup/plugin-typescript TS1371: This import is never used as a value and must use 'import type' because the 'importsNotUsedAsValues' is set to 'error'
* fix: bug when fast-forward input events and add test for it
* add test for fast-forward scroll events
* fix: custom style rules don't get inserted into some iframe elements
* code style tweak
* fix: enable to diff iframe elements
* fix the jest error "Unexpected token 'export'"
* try to fix build error of rrweb-player
* correct the attributes definition in rrdom
* fix: custom style rules are not inserted in some iframes
* add support for shadow dom
* add support for MediaInteraction
* add canvas support
* fix unit test error in rrdom
* add support for Text, Comment
* try to refactor RRDom
* refactor RRDom to reduce duplicate code
* rename document-browser to virtual-dom
* increase the test coverage for document.ts and add ownerDocument for it
* Merge branch 'master' into virtual-dom
* add more test for virtual-dom.ts
* use cssstyle in document-nodejs
* fix: bundle error
* improve document-nodejs
* enable to diff scroll positions of an element
* rename rrdom to virtualDom for more readability and make the tree public
* revert unknown change
* improve the css style parser for comments
* improve code style
* update typings
* add handling for the case where legacy_missingNodeRetryMap is not empty
* only import types from rrweb into rrdom
* Apply suggestions from code review
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
* Apply suggestions from code review
* fix building error in rrweb
* add a method setDefaultSN to set a default value for a RRNode's __sn
* fix rrweb test error and bump up other packages
* add support for custom property of css styles
* add a switch for virtual-dom optimization
* Apply suggestions from code review
1. add an enum type for NodeType
2. rename nodeType from rrweb-snapshot to RRNodeType
3. rename notSerializedId to unserializedId
4. add comments for some confusing variables
* adapt changes of #865 to virtual-dom and improve the test case for more coverage
* apply review suggestions
https://github.com/rrweb-io/rrweb/pull/853#pullrequestreview-922474953
* tweak the diff algorithm
* add description of the flag useVirtualDom and remove outdated logConfig
* Remove console.log
* Contain changes to document
* Upgrade rollup to 2.70.2
* Revert "Upgrade rollup to 2.70.2"
This reverts commit b1be81a2a76565935c9dc391f31beb7f64d25956.
* Fix type checking rrdom
* Fix typing error while bundling
* Fix tslib error on build
Rollup would output the following error:
`semantic error TS2343: This syntax requires an imported helper named '__spreadArray' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.`
* Increase memory limit for rollup
* Use esbuild for bundling
Speeds up bundling significantly
* Avoid circular dependencies and import un-bundled rrdom
* Fix imports
* Revert back to pre-esbuild
This reverts the following commits:
b7b3c8dbaa551a0129da1477136b1baaad28e6e1
72e23b8e27f9030d911358d3a17fe5ad1b3b5d4f
85d600a20c56cfa764cf1f858932ba14e67b1d23
61e1a5d323212ca8fbe0569e0b3062ddd53fc612
* Set node to lts (12 is no longer supported)
* Speed up bundling and use less memory
This fixes the out of memory errors happening while bundling
* remove __sn from rrdom
* fix typo
* test: add a test case for StyleSheet mutation exceptions while fast-forwarding
* rename Array.prototype.slice.call() to Array.from()
* improve test cases
* fix: PR #887 in 'virtual-dom' branch
* apply justin's suggestion on 'Array.from' refactor
related commit 0f6729d27a323260b36fbe79485a86715c0bc98a
* improve import code structure
Co-authored-by: Yun Feng <yun.feng@anu.edu.au>
* create rrdom package
* test(rrdom): add unit tests for polyfill.ts
* fix(rrweb snapshot): type check errors
Errors are caused by the declaration similarity of @types/mocha and @types/jest if we install both of them in the whole project.
* Set tagNames to upper case by default
This mirrors the `Element.tagName` implementation:
```
For DOM trees which represent HTML documents, the returned tag name is always in the canonical upper-case form. For example, tagName called on a <div> element returns "DIV".
```
https://developer.mozilla.org/en-US/docs/Web/API/Element/tagName
* Add workspace file
* VSCode settings for rrdom tests
* Add basic test for RRDocument
* Only setup jest tests for rrdom
* mock Node type and Event type for nodejs environment
* test(rrdom): add snapshot for document.test.ts
* fix issue of nwsapi import and add unit tests for rrdom
* fix: querySelectorAll returns nothing when querying elements with ids and classNames
* fix: error of unit test for Event polyfill
Since Event class is built in nodejs after v15.0.0
* add a dummy implementation of canvas
* add style element support
* add unit test for style element
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
