Accurate and efficient recording of user experience, GUI changes and user interaction events on a remote web document
The present disclosure describes how to capture events (e.g., changes and user interactions) of a Web document and combine those changes with the original DOM displayed to accurately and efficiently enable a replay engine to redisplay the DOM, changes, and user interactions which occurred within a user's browser. The data collected from a client-side HTML DOM capture engine can be combined with a minimal amount of contextual information to a replay engine so as to accurately and efficiently replay a session of a plurality of web documents.
1. A method for tracking events associated with a web document on a client device, the method comprising performing, by the client device:
receiving, from a web server, the web document at the client device, the web document having nodes in a Document Object Model (DOM), wherein the DOM is a tree data structure;
capturing, by a capture agent, a plurality of events associated with a plurality of nodes in the DOM, wherein each of the plurality of events includes one or more changes to the DOM, wherein the plurality of events include user interactions on the web document;
for each of the plurality of events:
determining a timestamp for the event;
determining identification information of an associated node, wherein the associated node is associated with the one or more changes to the DOM, and
storing the identification information, the timestamp, and the one or more changes in an event record; and
transmitting, from the capture agent, the event records to a server-side web session storage engine for replaying the user interactions according to the timestamps of the plurality of events.
2. The method of claim 1 , wherein determining the identification information of the associated node includes:
searching for a unique DOM node identifier of the associated node.
3. The method of claim 2 , further comprising:
when the unique DOM node identifier is not found for the associated node:
searching for a sibling or ancestor node that has a unique DOM node identifier;
when the sibling or ancestor node that has the unique DOM node identifier is identified, determining a path from the sibling or ancestor node to the associated node; and
storing the unique DOM node identifier of the sibling or ancestor node and the path in the event record.
4. The method of claim 3 , wherein the path includes an order of the associated node among its siblings.
5. The method of claim 3 , further comprising:
when no sibling or ancestor node that has the unique DOM node identifier is identified:
storing DOM element attributes that are unique among sibling DOM elements to identify a first node in the path to the associated node.
6. The method of claim 2 , further comprising:
when the unique DOM node identifier is not found:
storing DOM element attributes of the associated node that are unique.
7. The method of claim 1 , wherein the plurality of events include at least one of: an addition of one or more nodes in the DOM or a removal of one or more nodes in the DOM.
8. The method of claim 1 , further comprising:
receiving the event records at the server-side web session storage engine; and
combining, by the server-side web session storage engine, the event records with a server-side captured DOM of the web document to generate a modified DOM from an original unmodified DOM.
9. The method of claim 8 , wherein the server-side captured DOM of the web document is received by the server-side web session storage engine from the web server.
10. The method of claim 1 , further comprising:
identifying, by the capture agent, overlapping modification events; and
storing only one event record for the overlapping modification events.
11. The method of claim 10 , wherein a modification of a single ancestor node represents overlapping modification events targeting a single ancestor node subtree.
12. The method of claim 1 , further comprising:
merging, by the capture agent, adjacent sibling DOM text nodes into a single node for identification of the associated node of an event.
13. The method of claim 1 , further comprising:
storing, by the capture agent, the event records in client storage until the event records are transmitted to the server-side web session storage engine; and
deleting the event records after sending the event records to the server-side web session storage engine.
14. The method of claim 13 , further comprising:
subsequent to deleting the event records, capturing a plurality of additional events associated with nodes in the DOM;
for each of the plurality of additional events:
determining additional identification information of an additional associated node, and
storing the additional identification information in an additional event record; and
transmitting, from the capture agent, the additional event records to the server-side web session storage engine.
15. The method of claim 1 , further comprising:
displaying the web document by a web browser, wherein the capture agent sends the event records when the web browser is not making any other network requests.
16. The method of claim 1 , further comprising:
compressing, by the capture agent, the event records before transmitting the event records to the server-side web session storage engine.
17. The method of claim 1 , further comprising:
stripping, by the capture agent, sensitive information before transmitting the event records to the server-side web session storage engine.
18. The method of claim 1 , wherein the capture agent is received from a third party server using information from the web server.
19. The method of claim 1 , wherein the capture agent is received separately from a delivery of the web document.
20. The method of claim 1 , wherein capturing the plurality of events associated with the plurality of nodes in the DOM includes:
determining, by the capture agent, a first node modification and a second node modification to be an overlapping modification based on a first node being an ancestor of a second node in the DOM tree, the first node modification targeting a subtree of the DOM tree including the second node.
21. The method of claim 1 , wherein the method further comprises:
generating, by the capture agent, an event record for a DOM tree modification, the event record including a first identification information for uniquely identifying a first node and a first node modification, the event record suppressing duplicate information by not including a second node modification based on a determination that the first node modification and the second node modification are overlapping.
22. A computer product comprising a computer readable medium storing a plurality of instructions for controlling a client device to perform a method to track events associated with a web document on the client device, the method comprising:
receiving, from a web server, the web document at the client device, the web document having nodes in a Document Object Model (DOM), wherein the DOM is a tree data structure;
capturing, by a capture agent, a plurality of events associated with a plurality of nodes in the DOM, wherein each of the plurality of events includes one or more changes to the DOM, wherein the plurality of events include user interactions on the web document;
for each of the plurality of events:
determining a timestamp for the event;
determining identification information of an associated node, wherein the associated node is associated with the one or more changes to the DOM, and
storing the identification information, the timestamp, and the one or more changes in an event record; and
transmitting, from the capture agent, the event records to a server-side web session storage engine for replaying the user interactions according to the timestamps of the plurality of events.
23. The computer product of claim 22 , wherein determining the identification information of the associated node includes:
searching for a sibling or ancestor node that has a unique DOM node identifier; and
when no sibling or ancestor node that has a unique DOM node identifier is identified:
storing DOM element attributes that are unique among sibling DOM elements to identify a first node in a path to the associated node.
24. The computer product of claim 22 , wherein determining the identification information of the associated node includes:
searching for a unique DOM node identifier of the associated node; and
when the unique DOM node identifier is not found:
storing DOM element attributes of the associated node that are unique.
25. The computer product of claim 22 , wherein the plurality of events include at least one of: an addition of one or more nodes in the DOM or a removal of one or more nodes in the DOM.
26. The computer product of claim 22 , wherein the method further comprises:
receiving the event records at the server-side web session storage engine; and
combining, by the server-side web session storage engine, the event records with a server-side captured DOM of the web document to generate a modified DOM from an original unmodified DOM.
27. The computer product of claim 26 , wherein the server-side captured DOM of the web document is received by the server-side web session storage engine from the web server.
28. The computer product of claim 22 , wherein the method further comprises:
identifying, by the capture agent, overlapping modification events; and
storing only one event record for the overlapping modification events.
29. The computer product of claim 22 , wherein capturing the plurality of events associated with the plurality of nodes in the DOM includes:
determining, by the capture agent, a first node modification and a second node modification to be an overlapping modification based on a first node being an ancestor of a second node in the DOM tree, the first node modification targeting a subtree of the DOM tree including the second node.
30. The computer product of claim 22 , wherein the method further comprises:
generating, by the capture agent, an event record for a DOM tree modification, the event record including a first identification information for uniquely identifying a first node and a first node modification, the event record suppressing duplicate information by not including a second node modification based on a determination that the first node modification and the second node modification are overlapping.