* test(recording side): add test case for adopted stylesheets in shadow doms and iframe
* add type definition for adopted StyleSheets
* create a StyleSheet Mirror
* enable to record the outermost document's adoptedStyleSheet
* enable to serialize all stylesheets in documents (iframe) and shadow roots
* enable to record adopted stylesheets while building full snapshot
* test: add test case for mutations on adoptedStyleSheets
* defer to record adoptedStyleSheets to avoid create events before full snapshot
* feat: enable to track the mutation of AdoptedStyleSheets
* Merge branch 'fix-shadowdom-record' into construct-style
* fix: incorrect id conditional judgement
* test: add a test case for replaying side
* tweak the style mirror for replayer
* feat: enable to replay adoptedStyleSheet events
* fix: rule index wasn't recorded when serializing the adoptedStyleSheets
* add test case for mutation of stylesheet objects and add support for replace & replaceSync
* refactor: improve the code quality
* feat: monkey patch adoptedStyleSheet API to track its modification
* feat: add support for checkouting fullsnapshot
* CI: fix failed type checks
* test: add test case for nested shadow doms and iframe elements
* feat: add support for adoptedStyleSheets in VirtualDom mode
* style: format files
* test: improve the robustness of the test case
* CI: fix an eslint error
* test: improve the robustness of the test case
* fix: adoptedStyleSheets not applied in fast-forward mode (virtual dom optimization not used)
* refactor the data structure of adoptedStyleSheet event to make it more efficient and robust
* improve the robustness in the live mode
In the live mode where events are transferred over network without strict order guarantee, some newer events are applied before some old events and adopted stylesheets may haven't been created.
Added a retry mechanism to solve this problem.
* apply Yanzhen's review suggestion
* update action name
* test: make the test case more robust for travis CI
* Update packages/rrweb/src/record/constructableStyleSheets.d.ts
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
* Update packages/rrweb/src/record/constructableStyleSheets.d.ts
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
* apply Justin's review suggestions
add more browser compatibility checks
* add eslint-plugin-compat and config
* fix record test type errors
* make Mirror's replace function act the same with the original one when there's no existed node to replace
* test: increase the robustness of test cases
* remove eslint disable in favor of feature detection
Early returns aren't supported yet unfortunately, otherwise this code would be cleaner https://github.com/amilajack/eslint-plugin-compat/issues/523
* Remove eslint-disable-next-line compat/compat
* Standardize browserslist and remove lint exceptions (#1010)
* test: revert deleting virtual style tests and rewrite them to fit the current code base
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
* inline stylesheets when loaded
* set empty link elements to loaded by default
* Clean up stylesheet manager
* Remove attribute mutation code
* Update packages/rrweb/test/record.test.ts
* Update packages/rrweb/test/record.test.ts
* Update packages/rrweb/test/record.test.ts
* Update packages/rrweb/scripts/repl.js
* Update packages/rrweb/test/record.test.ts
* Update packages/rrweb/src/record/index.ts
* Add todo
* Move require out of time sensitive assert
* Add waitForRAF, its more reliable than waitForTimeout
* Remove flaky tests
* Add recording stylesheets in iframes
* Remove variability from flaky test
* Make test more robust
* Fix naming
* Add test cases for inlineImages
* Add test cases for inlineImages
* Record iframe mutations cross page
* Test: should record images inside iframe with blob url after iframe was reloaded
* Handle negative ids in rrdom correctly
When iframes get inserted they create untracked elements, both on the dom and rrdom side.
Because they are untracked they generate negative numbers when fetching the id from mirror.
This creates a problem when comparing and fetching ids across mirrors.
This commit tries to get away from using negative ids as much as possible in rrdom's comparisons
* Update packages/rrdom/src/diff.ts
Co-authored-by: Yun Feng <yun.feng@anu.edu.au>
* Start unserialized nodes at -2
This way we don't accidentally think of them as mirror misses
* Set unserialized id starting number at -2
* Remove duplication
* Use turbo instead of lerna
* Skip benchmark as it is unreliable when executed in parallel
* Strip port number from serialization, it can vary
* Add settimeout to virtual dom test
* Remove console.log and refactor blob:url serialization
* Include references in tsconfig to indicate which monorepo packages are being used
* Add stream setup
* Migrate project to es module
* Add reference to rrweb from rrdom
* Move jest config to ESM
* Setup basic WebRTC canvas streaming
* Cleanup and refactor WebRTC streaming
* Remove ? which isn't propper javascript
* Yarn lock
* Remove webrtc code from rrweb
* Add plugin hooks
Record/Replay plugins
`.getMirror` exposes the mirror to plugins
Replay plugins
`.onBuild` called whenever a node was added to the dom
* Expose plugins with server
* Use unminified version for tests
* Don't include simple-peer in rrweb main project
* Add canvas webrtc plugin
Streams contents of canvas via webrtc
* ignore tsconfig.tsbuildinfo
* Cleanup unused code
* type definition files are no longer committed
* Devtools off by default
* Extract .css into its own file
* Refactor plugin apis and fix multi canvas streaming support
* Add readme to rrweb canvas webrtc plugin
* Reference canvas-webrtc plugin in documentation
* Forbidden non-null assertion
* Remove linting of each project, yarn lint:report will do this
* Remove test code
* Cut down line length
* fix CI failure and improve the zh_CN doc
* Update packages/rrweb/src/plugins/canvas-webrtc/replay/index.ts
Co-authored-by: Yun Feng <yun.feng@anu.edu.au>
* Cleaner styling of replay
Co-authored-by: Yun Feng <yun.feng@anu.edu.au>
* Clean up stream.js based on @Mark-Fenng's feedback
* Remove duplicate send
Co-authored-by: Yun Feng <yun.feng@anu.edu.au>
Co-authored-by: Yun Feng <yun.feng0817@gmail.com>
* refactor: eliminate eslint errors as many as I can
* refactor: fix more eslint errors in the record module
* LINT: fix @typescript-eslint/unbound-method
* LINT: fix all eslint errors in source code
* LINT: fix as many eslint warnings as possible
Co-authored-by: Justin Halsall <Juice10@users.noreply.github.com>
* Speed up snapshotting of many new dom nodes
By avoiding reflow we shave about 15-25% off our snapshotting time
* Improve newlyAddedElement docs
* Optimize needMaskingText by using el.closest and less recursion
* Serve all rrweb dist files
* Split serializeNode into smaller functions
Makes it easier to profile
* Slow down cpu enhance tracing on fast machines
* Increase timeout
* Perf: only loop through ancestors when they have something to compare to
* Perf: `hasNode` is cheaper than `getMeta`
* Perf: If parents where already checked, no need to do it again
* Perf: reverse for loops are faster
Because they only do the .lenght check once. In this case I don't think we'll see much performance gains if any
* Clean up code
* Perf: check ancestors once with isBlocked
* guessing this might fixes canvas test
* Update packages/rrweb/src/record/observers/canvas/webgl.ts
Co-authored-by: yz-yu <yanzhen@smartx.com>
* Fix#904 (#906)
Properly remove crossorigin attribute
* Bump minimist from 1.2.5 to 1.2.6 (#902)
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)
---
updated-dependencies:
- dependency-name: minimist
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: yz-yu <yanzhen@smartx.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* 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>
* Only record canvas when recordCanvas is true
* All should be compiled first
Makes recompiling+debugging a lot faster
* Add support for compiling web workes
Replaces @rollup/plugin-typescript for rollup-plugin-typescript2 as the former is incompatible with rollup-plugin-web-worker-loader
* Update yarn.lock
* Upgrade to typescript 4.5.5
* add support for replay of ImageBitmap in 2d canvas
* Snapshot canvases in a web-worker on FPS basis
* Fix performance of canvas recording and playback
* Wait for all images to be preloaded before checking results
* flatten base64 strings, as encoding isn't consistent
* Cleanup
* Add serializing to 2d canvases as well
* Disable blob serialize test
We don't have any code for it yet
* Upgrade @rollup/plugin-commonjs to 21.0.2
Fixes
https://linguinecode.com/post/import-export-appear-at-the-top-level
* Move canvas recording options to `sampling`
Based on: https://github.com/rrweb-io/rrweb/pull/859#discussion_r846582146
* Add very basic webgl support
* document the default
* only capture rr_dataURL in 2d canvas contexts
* rr_dataURL no longer part of webgl snapshot
* ignore __diff_output__ from jest-image-snapshot
* Rename generic "Monorepo" to "RRWeb Monorepo"
* Serialize WebGL variables
* Move rrweb test port number to unique port
rrweb-snapshot uses 3030, rrweb uses 3031
* Prepare for WebGL2
* Split up canvas replay and record webgl vars
* fix typo
* fix typo part 2
* fix typo
* Handle non-variables too
* provide correct context for warning
* (De)Serialize a lot of different objects
* monorepo root should be the first in the list
* Upgrade puppeteer to 11.x
* Correctly de-serialize webgl variables
* Encode arrayBuffers contents to base64
* rename contents to base64
* add webgl2 support and serialize HTMLImageElements
* Support serializing ImageData
* Correctly classify WebGL2 events
* Serialize format changed
* check if canvas has contents before we save the dataURL
* Remove blank dataURL
* reference original file not type defintion file
* update types
* rename code worspace
* update dependencies
* add spector to inspect webgl
* remove live server settings from code workspace
* Save canvas context in the node
Prevents from saving webgl canvases as 2d dataUrls
* remove extra braces
* add ICanvas type
* use ICanvas from rrweb-snapshot in rrweb instead of OgmentedCanvas
* add snapshots and webgl 2 tests
* Upgrade to puppeteer 12.0.1
* Revert back to puppeteer 9.1.1
* Keep index order consistent between replay and record
* keep correct index order in webgl2
* fixed forgotten import
* buffer up pending canvas mutations
* unify the way webgl and webgl2 get patched
* fix parsing error
* Add types for serialize-args
* Add debugging for webgl replay
* Move start-server to utils
* turn off debug mode by default
* Move pendingCanvasMutations to local object and fix if/else statement
* Always save pending mutations
* only use assert snapshot as it's clearer whats going on
* Ugly fix for now
* Making the tests more DRY
* flush at the end of each request animation frame
* Looks like the promise made this test more predictable
* add waitForRAF
* Make nested iframe recording robust no matter the test speed
* mute noisy error in test
* force a requestAnimationFrame
* Bundle events within one frame together as much as possible
WebGL events need to be bundled together as much as possible so they don't accidentally get split over multiple animation frames.
`newFrame: true` is used to indicate the start of an new animation frame in the recording, and that the event shouldn't be bundled with the previous events.
* Rename RafStamps
* Override event.delay
* cleanup
* Add tests for addDelay
* Add webgl e2e test
* Remove settimeout
* DRY-up test
* Preload images in webgl
* Add e2e test for webgl image preloading
* don't turn on devtools by default!
* Remove spector
* close server after use
* Add imageMap parameter
* Make e2e image test more robust
* document debug mode
* cleanup
* WebGL recording in iframes & Safari 14 support
* fix tests
* don't save null objects as WebGLVar
* group (de)serialized webgl variables by context
* Fix test
* fix tests
* bundle webgl mutations on request animation frame
Instead of fixing it on the replay side we buffer up webgl canvas mutations and wait for a new RAF to flush them. This allows us to remove `newFrame` from the events and simplify things a little
* Add canvas element to mutation observer file
* Add Canvas (Mutation) Manager
Allows you to do `record.freezePage()` and canvas events will get paused.
Based on https://github.com/rrweb-io/rrweb/pull/756#issuecomment-1007566907
* cleanup
* Make sure the correct </body> gets replaced
* Perf: Speed up check to see if canvas is blank
* Access unpatched getImageData
* Use is2DCanvasBlank only for 2d context
* 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>
* Fix sheet insertion
Restore skip duration
Use virtualStyleRulesMap to re-populate stylesheet on Flush event
Clear virtualStyleRulesMap after flush applied
* Support rule deletion in virtual processing
* Simply restoreNodeSheet with early aborts
* Encountered a bug where firstFullSnapshot was played twice because timer was immediately started and reached the snapshot before the setTimeout returned
* Ignoring a FullSnapshot needs to be a one-time only thing, as otherwise we'll ignore it after scrubbing (restarting play head at a particular time). This is a problem if mutations have altered the player state, and we try to replay those mutations, so we e.g. try to remove an element that has already been removed because we haven't reset the FullSnapshot state
* Some `npm run typings` related fixups
* add basic html snapshot functionality
* move restoreNodeSheet to it's own module
* Refactor virtual style rules to buffer changes.
Only applies changes on flush.
`virtualStyleRulesMap` now works with strings instead of CSSRules.
CSSRules can only be via made `.insertRule` on CSSStyleSheet in most browsers.
And `new CSSStyleSheet()` only works in Chrome currently.
* remove unused code
* move VirtualStyleRules from CSSRule to string in tests
* correct paths for tests
* naming
* create and restore style snapshots for virtual nodes
* update replayer snapshot
* move storeCSSRules to virtual-styles.ts
* try/catch access to .sheet in case of access errors
* clean up tests
Co-authored-by: Vladimir Milenko <vladimir.milenko@uber.com>
Co-authored-by: Eoghan Murray <eoghan@getthere.ie>
* mask value attribute changes for elements in maskInputOptions
* refactor initInputObserver to use maskInputValue
* add todo
* Fix typo
* upgrade rrweb-snapshot to 1.1.6
* move maskInputValue to rrweb-snapshot
* add failing test
* assert order of events
* defer attaching of iframe till FullSnapshot is done
Fixes: https://github.com/rrweb-io/rrweb/issues/567
* correct event order in iframe integration test snapshot
* trigger build
* trigger build
* Move settimeout responsibility to snapshot
https://github.com/rrweb-io/rrweb-snapshot/pull/78
* upgrade rrweb-snapshot to 1.1.4
* DRY record tests
* cleanup
* Upgrade puppeteer to 9.1.1
for (hopefully) more consistent behaviour between CI and development
* make input bigger to prevent triggering scroll events
* page.waitFor is deprecated
more info: https://github.com/puppeteer/puppeteer/issues/6214
* Set os and distro for Travis ci
Co-authored-by: yz-yu <yanzhen@smartx.com>
* feat: add options to mask texts
* feat: add the default mask function
* refactor: rename options to identify the difference between mask text and mask input
* test: add tests about masking
* doc: add options about masking
* chore: bump up rrweb-snapshot version
