Commit Graph

102 Commits

Author SHA1 Message Date
Eoghan Murray
6e53410e2b Reset the lastPlayedEvent as it would otherwise be used to discard events in machine.ts as follows: (#250) 2020-07-28 22:52:50 +08:00
Yanzhen Yu
6cf3253d94 close #254 hotfix: only use virtual parent in sync mode 2020-07-19 08:54:18 +08:00
Yanzhen Yu
c5580f97f4 close #228 safe access content document, which may be destroyed manually 2020-07-18 15:29:01 +08:00
Yanzhen Yu
0756319b8e close #244 pass fullsnapshot event to the callback 2020-07-18 15:16:59 +08:00
Eoghan Murray
286b520907 Restore functioning of #200 - this got broken after #242 (#246)
- What was broken was that it would just play activity from the first page view, but then would stop at the second page view (meta) as actions after that had been discarded
 - This restores the functionality given by the comment 'return the events from last meta to the end.' - we never want to discard events that are after the baseline time
 - I believe 'session' is the incorrect terminology for this function name, as a session in web analytics usually means a series of page views
2020-07-16 00:12:37 +08:00
yz-yu
e2cc42e393 fix the skip event calculation (#242) 2020-07-11 17:06:56 +08:00
Yanzhen Yu
3e2b596664 tweak the code of getting last session, without splice events array 2020-07-11 11:03:40 +08:00
Yanzhen Yu
4bf533a675 fast-forward implementation v1
related to #6

Since the currently 'play at any time offset' implementation is pretty simple,
there are many things we can do to optimize its performance.

In this patch, we do the following optimizations:
1. Ignore some of the events during fast forward.
   For example, when we are going to fast forward to 10 minutes later,
   we do not need to perform mouse movement events during this period.
2. Use a fragment element as the 'virtual parent node'.
   So newly added DOM nodes will be appended to this fragment node,
   and finally being appended into the document as a batch operation.
These changes reduce a lot of time which was spent on reflow/repaint previously.
I've seen a 10 times performance improvement within these approaches.

And there are still some things we can do better but not in this patch.
1. We can build a virtual DOM tree to store the mutations of DOM.
   This will minimize the number of DOM operations.
2. Another thing that may help UX is to make the fast forward process async and cancellable.
   This may make the drag and drop interactions in the player's UI looks smooth.
2020-07-11 11:03:40 +08:00
Eoghan Murray
ef2c991012 Only execute events since most recent pageload when playing from an offset (#200)
On recordings with many full pageloads, dom state and mutations were being applied only to be discarded when a new pageload came in, resulting in very slow time to rebuild - and inability to interactively 'scrub' through these recordings
2020-07-11 10:21:46 +08:00
Eoghan Murray
6b0a0795ce Expose startTime and endTime in the getMetaData() call. I was using player.events[0].timestamp but player.events has gone away (since a78da77 I believe) (#235) 2020-07-10 13:37:56 +08:00
Eoghan Murray
43001ccbbd Ensure api method .play() can be called by external code without worrying about the internal state of the finite state machine (#236) 2020-07-10 13:36:57 +08:00
Yanzhen Yu
4cf196718c export utils as public API 2020-06-15 17:10:18 +08:00
Yanzhen Yu
7feb2c945c update typescript to 3.9.5 2020-06-12 18:32:48 +08:00
Yanzhen Yu
ee73bd4919 close #216 rebuild first full snapshot when init the replayer 2020-05-31 16:35:42 +08:00
yz-yu
8913bcb9d6 Live mode 2 (#226)
* refactoring play, pause, resume, load style sheet to subscribe style code

* support live mode in state machine

* 1. upgrade @xstate/fsm
2. add toggle interact methods to the player
2020-05-31 15:40:17 +08:00
Eoghan Murray
7d062830ab Keep npm run typings happy (#222) 2020-05-27 10:04:43 +08:00
Eoghan Murray
0bbe79b42b This dimension is in px but is unitless according to https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe (#214) 2020-05-23 15:24:19 +08:00
Rifaudeen
45a7f89f2b added custom-event emitter to replayer (#219) 2020-05-23 15:20:41 +08:00
yz-yu
7a666293b6 mutation observer v2 (#206)
There are some long-term issues in rrweb's mutation observer.

A scenario cause problem:
A list of DOM node: n1, n2, n3, n4, n5
Steps of modifying the nodes:
  1. remove n1, n2, n3, n4 sequentially
  2. append n4, n3, n2, n1 after n5 sequentially
Then we got the added node data like this:
  (id: n4, prev: null, next: n3  )
  (id: n3, prev: n4,   next: n2  )
  (id: n2, prev: n3,   next: n1  )
  (id: n1, prev: n2,   next: null)
The problem comes when we try to replay the first add node datum.
Since its prev node is null, we rely on its next sibling n3. But
n3 was not present at this moment, and in previous code, we fallback
to append n4 to the last of its parent node.

The solution is to defer the append of elements that missing
siblings. But it is also hard to tell which node is the first one
that needs to be appended.

Take a step back and rethink the design of the mutation observer,
we've found there are two implementations make things complicated.
1. We set the id to -1 when we seeing some nodes are not serialized yet.
2. We record both previous sibling and next sibling to determine the
position of the node.
But we can do better!
First, we can put nodes with un-serialized siblings
to a queue, and try to add it again later. Then we can just record the next
sibling as 'the single truth' so we can be sure which node is the last
one of its parent.

This patch has implemented the new observer strategy. Data recorded with
the new observer should no longer have any node with id -1. But for
compatibility consideration, we still keep some replayer code that helps
solve legacy data.
2020-05-02 14:08:10 +08:00
yz-yu
877e2ce958 impl basic player state machine (#198) 2020-04-12 15:16:30 +08:00
Yanzhen Yu
f159d7711f upgrade TS 2020-04-12 00:06:57 +08:00
yz-yu
4f36d0e57d Packer (#172)
* introduce pako and add general packer interface

* add tests for packer

* use function API instead of class API for better tree shaking support

* refcatoring the rollup bundle config
2020-04-07 18:03:47 +08:00
Eoghan Murray
e12d240064 Keep track of pause/play state so that player doesn't accidentally 'unpause' a user pause action (#189) 2020-03-31 22:15:17 +08:00
Yanzhen Yu
3f30c47cfb remove useless console.log 2020-03-29 22:05:07 +08:00
Yanzhen Yu
380819ca70 tolerate insertRule error since browser may throw Error on wrong prefix 2020-03-29 21:18:39 +08:00
Yanzhen Yu
6e38ae4735 avoid style sheet rules index overflow 2020-03-29 21:14:45 +08:00
Filip Slatinac
fc6c6c43d5 Checking node existence (#174)
* added our package

* reverted back to old rrweb snapshot

* Array.from does not capture all elements added in the set, we have to manually iterate through the iterator

* package lock

* checking if nodes are in the parent before we try inserting them
2020-03-01 15:02:32 +08:00
Eoghan Murray
444570b7fc Was experiencing case when a TouchEnd event occurred on a text element i.e. (nodeType: 3 / nodeName: #text) (#180)
This was a recording taken with rrweb 0.7.27 (3afff63970) and rrweb-snapshot 0.7.21 (a0dc9481b2) so issue may have been fixed in the intervening commits
2020-03-01 15:00:32 +08:00
Yanzhen Yu
29296b6877 add trigger focus option to replayer, which may helps integration into other apps 2020-02-28 19:48:36 +08:00
David Cramer
9b7f8d6027 Add support for replaying StyleSheetRule events (#178) 2020-02-25 21:07:17 +08:00
Yanzhen Yu
abfb90a778 impl media interactions recording
close #159
close #72
listen to HTMLMediaElement's play/pause events, and replay them
by programmatically play and pause the target element.
2020-01-12 21:37:01 +08:00
Yanzhen Yu
2d07b37701 close #153 emit event when it being casted 2019-12-08 16:45:21 +08:00
dphuang2
f7a3c992f8 Fix timeOffset on multiple stylesheet loads (#115)
In the case that the replayer triggers multiple FullSnapshot events, it
will call waitForStylesheetLoad multiple times. When the replayer
resumes, it could already have a timeoffset set from a previous
resume in a previous waitForStylesheetLoad call. In this case our new
timeoffset should be the value of our current time in the replay
(timer.timeOffset + getTimeOffset()). To solve this, I created a public
getCurrentTime function which correctly returns the time in the replay
and used that as our new timeoffset when resuming from a stylesheet
load.
2019-08-10 17:29:23 +08:00
Yanzhen Yu
3269089e1f fix#110 add NodeList forEach polyfill 2019-08-07 23:51:40 +08:00
dphuang2
b0ee3f8279 added 'pointer-events: none' for Replayer iframe (#96)
'pointer-events: none' prevents the user from interacting with the DOM
inside of the iframe. This prevents accidental tampering by a user when
watching replays such as link clicks or DOM manipulation.

pointer-events supported by 97.15% usage: https://caniuse.com/#feat=pointer-events
2019-07-19 13:24:55 +08:00
肉肉肉肉
b569b84794 new feature: add custom style in replayer (#87)
* new feature: add custom style in replayer

* concat style rules for loop
2019-07-10 12:33:54 +08:00
Yanzhen Yu
d43aa974f5 fix#71 fix touch event listener and throttle touch move callback 2019-06-17 18:07:30 +08:00
Yanzhen Yu
d32b31f3e3 remove mitt typings namesapce 2019-06-05 17:33:20 +08:00
Yanzhen Yu
6d3b9c2345 Upgrade the DOM mutation observer
This is an important patch contains some crtical bug fixes for
the DOM mutation observer.
Previously the observer did not handle complex DOM movement very
well. So in this patch we optimized this by distinguishing moved
node better and added a resolving queue to avoid the error caused
by ordering.
2019-06-05 16:39:29 +08:00
Yanzhen Yu
627ed9439b emit mouse interaction event during replay 2019-05-31 15:28:45 +08:00
yz-yu
2398f5c0b1 start to support live mode (#73)
1. add a liveMode flag to config, when liveMode is set, the timer
will keep running even though all the actions casted
2. add a public method addEvent, which will cast newly added event
in sync
3. move mouse in sync mode with the latest position info
2019-05-26 16:02:52 +08:00
Yanzhen Yu
107296eee3 add the inline stylesheet option when recording 2019-05-12 21:10:34 +08:00
Yanzhen Yu
faed623986 resume with time offset when after wait stylesheet load 2019-04-09 17:00:02 +08:00
Yanzhen Yu
059cbe4fd8 move browser related APIs into runtime 2019-04-02 21:29:14 +08:00
Yanzhen Yu
c04e4bf0a5 impl #23 add custom privacy selectors 2019-04-02 00:25:08 +08:00
Yanzhen Yu
d9ffe4c736 check attribute is null instead of any falsy value 2019-02-17 15:54:14 +08:00
Yanzhen Yu
a69bf87f7f check whether the removed node's ancestors has been removed 2019-02-01 23:13:00 +08:00
Yanzhen Yu
ebd1457ce2 turn some warning message into debug message 2019-01-30 00:47:41 +08:00
yz-yu
22330207eb improve mouse record and replay (#49)
Increase the throttle value of collecting mouse move and add a
transition time to the replayer's mouse. This may decrease the
size of mouse move data and make the replay movement more smooth.
Another change is to move and hover when click event is replayed.
This is to improve the replay of some programmatic click, such as
E2E tests.
2019-01-25 18:25:35 +08:00
Yanzhen Yu
6abf4fd4a0 move all events to an enum and update guide 2019-01-25 17:18:51 +08:00