clarity-js 0.7.68 → 0.7.70

package/src/layout/mutation.ts

@@ -26,7 +26,7 @@ let mutations: MutationQueue[] = [];
 let throttledMutations: { [key: number]: MutationRecordWithTime } = {};
 let insertRule: (rule: string, index?: number) => number = null;
 let deleteRule: (index?: number) => void = null;
-let attachShadow: (init: ShadowRootInit)  => ShadowRoot = null;
+let attachShadow: (init: ShadowRootInit) => ShadowRoot = null;
 let mediaInsertRule: (rule: string, index?: number) => number = null;
 let mediaDeleteRule: (index?: number) => void = null;
 let queue: Node[] = [];
@@ -35,64 +35,82 @@ let throttleDelay: number = null;
 let activePeriod = null;
 let history: MutationHistory = {};
 let criticalPeriod = null;
+let observedNodes: WeakMap<Node, MutationObserver> = new WeakMap<Node, MutationObserver>();
+
+// We ignore mutations if these attributes are updated
+const IGNORED_ATTRIBUTES = ["data-google-query-id", "data-load-complete", "data-google-container-id"];
 
 export function start(): void {
-    start.dn = FunctionNames.MutationStart;
-    observers = [];
-    queue = [];
-    timeout = null;
-    activePeriod = 0;
-    history = {};
-    criticalPeriod = 0;
-
-    // Some popular open source libraries, like styled-components, optimize performance
-    // by injecting CSS using insertRule API vs. appending text node. A side effect of
-    // using javascript API is that it doesn't trigger DOM mutation and therefore we
-    // need to override the insertRule API and listen for changes manually.
-    if (insertRule === null) { 
-      insertRule = CSSStyleSheet.prototype.insertRule; 
-      CSSStyleSheet.prototype.insertRule = function(): number {
-        if (core.active()) { schedule(this.ownerNode); }
-        return insertRule.apply(this, arguments);
-      };
-    }
+  start.dn = FunctionNames.MutationStart;
+  observers = [];
+  queue = [];
+  timeout = null;
+  activePeriod = 0;
+  history = {};
+  criticalPeriod = 0;
+  observedNodes = new WeakMap<Node, MutationObserver>();
 
-    if ("CSSMediaRule" in window && mediaInsertRule === null) { 
-      mediaInsertRule = CSSMediaRule.prototype.insertRule; 
-      CSSMediaRule.prototype.insertRule = function(): number {
-        if (core.active()) { schedule(this.parentStyleSheet.ownerNode); }
-        return mediaInsertRule.apply(this, arguments);
-      };
-    }
+  // Some popular open source libraries, like styled-components, optimize performance
+  // by injecting CSS using insertRule API vs. appending text node. A side effect of
+  // using javascript API is that it doesn't trigger DOM mutation and therefore we
+  // need to override the insertRule API and listen for changes manually.
+  if (insertRule === null) {
+    insertRule = CSSStyleSheet.prototype.insertRule;
+    CSSStyleSheet.prototype.insertRule = function (): number {
+      if (core.active()) {
+        schedule(this.ownerNode);
+      }
+      return insertRule.apply(this, arguments);
+    };
+  }
 
-    if (deleteRule === null) { 
-      deleteRule = CSSStyleSheet.prototype.deleteRule;
-      CSSStyleSheet.prototype.deleteRule = function(): void {
-        if (core.active()) { schedule(this.ownerNode); }
-        return deleteRule.apply(this, arguments);
-      };
-    }
+  if ("CSSMediaRule" in window && mediaInsertRule === null) {
+    mediaInsertRule = CSSMediaRule.prototype.insertRule;
+    CSSMediaRule.prototype.insertRule = function (): number {
+      if (core.active()) {
+        schedule(this.parentStyleSheet.ownerNode);
+      }
+      return mediaInsertRule.apply(this, arguments);
+    };
+  }
+
+  if (deleteRule === null) {
+    deleteRule = CSSStyleSheet.prototype.deleteRule;
+    CSSStyleSheet.prototype.deleteRule = function (): void {
+      if (core.active()) {
+        schedule(this.ownerNode);
+      }
+      return deleteRule.apply(this, arguments);
+    };
+  }
 
-    if ("CSSMediaRule" in window && mediaDeleteRule === null) { 
-      mediaDeleteRule = CSSMediaRule.prototype.deleteRule;
-      CSSMediaRule.prototype.deleteRule = function(): void {
-        if (core.active()) { schedule(this.parentStyleSheet.ownerNode); }
-        return mediaDeleteRule.apply(this, arguments);
+  if ("CSSMediaRule" in window && mediaDeleteRule === null) {
+    mediaDeleteRule = CSSMediaRule.prototype.deleteRule;
+    CSSMediaRule.prototype.deleteRule = function (): void {
+      if (core.active()) {
+        schedule(this.parentStyleSheet.ownerNode);
+      }
+      return mediaDeleteRule.apply(this, arguments);
+    };
+  }
+
+  // Add a hook to attachShadow API calls
+  // In case we are unable to add a hook and browser throws an exception,
+  // reset attachShadow variable and resume processing like before
+  if (attachShadow === null) {
+    attachShadow = Element.prototype.attachShadow;
+    try {
+      Element.prototype.attachShadow = function (): ShadowRoot {
+        if (core.active()) {
+          return schedule(attachShadow.apply(this, arguments)) as ShadowRoot;
+        } else {
+          return attachShadow.apply(this, arguments);
+        }
       };
+    } catch {
+      attachShadow = null;
     }
-
-   // Add a hook to attachShadow API calls
-   // In case we are unable to add a hook and browser throws an exception,
-   // reset attachShadow variable and resume processing like before
-   if (attachShadow === null) { 
-     attachShadow = Element.prototype.attachShadow;    
-     try {
-       Element.prototype.attachShadow = function (): ShadowRoot {
-         if (core.active()) { return schedule(attachShadow.apply(this, arguments)) as ShadowRoot; }
-         else { return attachShadow.apply(this, arguments)}   
-       }
-     } catch { attachShadow = null; }
-  } 
+  }
 }
 
 export function observe(node: Node): void {
@@ -101,13 +119,21 @@ export function observe(node: Node): void {
   // For this reason, we need to wire up mutations every time we see a new shadow dom.
   // Also, wrap it inside a try / catch. In certain browsers (e.g. legacy Edge), observer on shadow dom can throw errors
   try {
+    // Cleanup old observer if present.
+    if (observedNodes.has(node)) {
+      observedNodes.get(node)?.disconnect();
+    }
+
     let m = api(Constant.MutationObserver);
-    let observer =  m in window ? new window[m](measure(handle) as MutationCallback) : null;
+    let observer = m in window ? new window[m](measure(handle) as MutationCallback) : null;
     if (observer) {
       observer.observe(node, { attributes: true, childList: true, characterData: true, subtree: true });
+      observedNodes.set(node, observer);
       observers.push(observer);
     }
-  } catch (e) { internal.log(Code.MutationObserver, Severity.Info, e ? e.name : null); }
+  } catch (e) {
+    internal.log(Code.MutationObserver, Severity.Info, e ? e.name : null);
+  }
 }
 
 export function monitor(frame: HTMLIFrameElement): void {
@@ -120,7 +146,11 @@ export function monitor(frame: HTMLIFrameElement): void {
 }
 
 export function stop(): void {
-  for (let observer of observers) { if (observer) { observer.disconnect(); } }
+  for (let observer of observers) {
+    if (observer) {
+      observer.disconnect();
+    }
+  }
   observers = [];
   history = {};
   mutations = [];
@@ -141,28 +171,43 @@ function handle(m: MutationRecord[]): void {
   // Queue up mutation records for asynchronous processing
   let now = time();
   summary.track(Event.Mutation, now);
-  mutations.push({ time: now, mutations: m});
+  mutations.push({ time: now, mutations: m });
   task.schedule(process, Priority.High).then((): void => {
-      setTimeout(doc.compute)
-      measure(region.compute)();
+    setTimeout(doc.compute);
+    measure(region.compute)();
   });
 }
 
 async function processMutation(timer: Timer, mutation: MutationRecord, instance: number, timestamp: number): Promise<void> {
   let state = task.state(timer);
-  if (state === Task.Wait) { state = await task.suspend(timer); }
-  if (state === Task.Stop) { return; }      
+
+  if (state === Task.Wait) {
+    state = await task.suspend(timer);
+  }
+  if (state === Task.Stop) {
+    return;
+  }
+
   let target = mutation.target;
   let type = config.throttleDom ? track(mutation, timer, instance, timestamp) : mutation.type;
-  if (type && target && target.ownerDocument) { dom.parse(target.ownerDocument); }
-  if (type && target && target.nodeType == Node.DOCUMENT_FRAGMENT_NODE && (target as ShadowRoot).host) { dom.parse(target as ShadowRoot); }
+
+  if (type && target && target.ownerDocument) {
+    dom.parse(target.ownerDocument);
+  }
+
+  if (type && target && target.nodeType == Node.DOCUMENT_FRAGMENT_NODE && (target as ShadowRoot).host) {
+    dom.parse(target as ShadowRoot);
+  }
+
   switch (type) {
     case Constant.Attributes:
+      if (IGNORED_ATTRIBUTES.indexOf(mutation.attributeName) < 0) {
         processNode(target, Source.Attributes, timestamp);
-        break;
+      }
+      break;
     case Constant.CharacterData:
-        processNode(target, Source.CharacterData, timestamp);
-        break;
+      processNode(target, Source.CharacterData, timestamp);
+      break;
     case Constant.ChildList:
       processNodeList(mutation.addedNodes, Source.ChildListAdd, timer, timestamp);
       processNodeList(mutation.removedNodes, Source.ChildListRemove, timer, timestamp);
@@ -179,7 +224,7 @@ async function process(): Promise<void> {
     let record = mutations.shift();
     let instance = time();
     for (let mutation of record.mutations) {
-      await processMutation(timer, mutation, instance, record.time)
+      await processMutation(timer, mutation, instance, record.time);
     }
     await encode(Event.Mutation, timer, record.time);
   }
@@ -202,13 +247,13 @@ async function process(): Promise<void> {
   }
 
   cleanHistory();
-  
+
   task.stop(timer);
 }
 
 function cleanHistory(): void {
   let now = time();
-  if (Object.keys(history).length > Setting.MaxMutationHistoryCount) { 
+  if (Object.keys(history).length > Setting.MaxMutationHistoryCount) {
     history = {};
     metric.count(Metric.HistoryClear);
   }
@@ -223,33 +268,40 @@ function cleanHistory(): void {
 
 function track(m: MutationRecord, timer: Timer, instance: number, timestamp: number): string {
   let value = m.target ? dom.get(m.target.parentNode) : null;
+
   // Check if the parent is already discovered and that the parent is not the document root
   if (value && value.data.tag !== Constant.HTML) {
     // calculate inactive period based on the timestamp of the mutation not when the mutation is processed
     let inactive = timestamp > activePeriod;
+
     // Calculate critical period based on when mutation is processed
     const critical = instance < criticalPeriod;
     let target = dom.get(m.target);
     let element = target && target.selector ? target.selector.join() : m.target.nodeName;
     let parent = value.selector ? value.selector.join() : Constant.Empty;
+
     // Check if its a low priority (e.g., ads related) element mutation happening during critical period
     // If the discard list is empty, we discard all mutations during critical period
-    const lowPriMutation =
-      config.throttleMutations && critical &&
-      (config.discard.length === 0 || config.discard.some((key) => element.includes(key)));
+    const lowPriMutation = config.throttleMutations && critical && (config.discard.length === 0 || config.discard.some((key) => element.includes(key)));
+
     // We use selector, instead of id, to determine the key (signature for the mutation) because in some cases
     // repeated mutations can cause elements to be destroyed and then recreated as new DOM nodes
     // In those cases, IDs will change however the selector (which is relative to DOM xPath) remains the same
     let key = [parent, element, m.attributeName, names(m.addedNodes), names(m.removedNodes)].join();
+
     // Initialize an entry if it doesn't already exist
     history[key] = key in history ? history[key] : [0, instance];
     let h = history[key];
+
     // Lookup any pending nodes queued up for removal, and process them now if we suspended a mutation before
-    if (inactive === false && h[0] >= Setting.MutationSuspendThreshold) { processNodeList(h[2], Source.ChildListRemove, timer, timestamp); }
-    
+    if (inactive === false && h[0] >= Setting.MutationSuspendThreshold) {
+      processNodeList(h[2], Source.ChildListRemove, timer, timestamp);
+    }
+
     // Update the counter, do not reset counter if its critical period
     h[0] = inactive || lowPriMutation ? (h[1] === instance ? h[0] : h[0] + 1) : 1;
     h[1] = instance;
+
     // Return updated mutation type based on,
     // 1. if we have already hit the threshold or not
     // 2. if its a low priority mutation happening during critical time period
@@ -260,11 +312,13 @@ function track(m: MutationRecord, timer: Timer, instance: number, timestamp: num
       if (instance > timestamp + Setting.MutationActivePeriod) {
         return m.type;
       }
+
       if (!config.dropMutations) {
         // we only store the most recent mutation for a given key if it is being throttled
-        throttledMutations[key] = {mutation: m, timestamp};
+        throttledMutations[key] = { mutation: m, timestamp };
       }
-      return Constant.Throttle; 
+
+      return Constant.Throttle;
     }
   }
   return m.type;
@@ -272,7 +326,9 @@ function track(m: MutationRecord, timer: Timer, instance: number, timestamp: num
 
 function names(nodes: NodeList): string {
   let output: string[] = [];
-  for (let i = 0; nodes && i < nodes.length; i++) { output.push(nodes[i].nodeName); }
+  for (let i = 0; nodes && i < nodes.length; i++) {
+    output.push(nodes[i].nodeName);
+  }
   return output.join();
 }
 
@@ -284,8 +340,12 @@ async function processNodeList(list: NodeList, source: Source, timer: Timer, tim
       traverse(node, timer, source, timestamp);
     } else {
       let state = task.state(timer);
-      if (state === Task.Wait) { state = await task.suspend(timer); }
-      if (state === Task.Stop) { break; }
+      if (state === Task.Wait) {
+        state = await task.suspend(timer);
+      }
+      if (state === Task.Stop) {
+        break;
+      }
       processNode(node, source, timestamp);
     }
   }
@@ -295,18 +355,26 @@ function processThrottledMutations(): void {
   if (throttleDelay) {
     clearTimeout(throttleDelay);
   }
-  throttleDelay = setTimeout(() => { task.schedule(process, Priority.High) }, Setting.LookAhead);
+  throttleDelay = setTimeout(() => {
+    task.schedule(process, Priority.High);
+  }, Setting.LookAhead);
 }
 
 export function schedule(node: Node): Node {
   // Only schedule manual trigger for this node if it's not already in the queue
-  if (queue.indexOf(node) < 0) { queue.push(node); }
+  if (queue.indexOf(node) < 0) {
+    queue.push(node);
+  }
 
   // Cancel any previous trigger before scheduling a new one.
   // It's common for a webpage to call multiple synchronous "insertRule" / "deleteRule" calls.
   // And in those cases we do not wish to monitor changes multiple times for the same node.
-  if (timeout) { clearTimeout(timeout); }
-  timeout = setTimeout(() => { trigger() }, Setting.LookAhead);
+  if (timeout) {
+    clearTimeout(timeout);
+  }
+  timeout = setTimeout(() => {
+    trigger();
+  }, Setting.LookAhead);
 
   return node;
 }
@@ -317,7 +385,9 @@ function trigger(): void {
     if (node) {
       let shadowRoot = node.nodeType === Node.DOCUMENT_FRAGMENT_NODE;
       // Skip re-processing shadowRoot if it was already discovered
-      if (shadowRoot && dom.has(node)) { continue; }
+      if (shadowRoot && dom.has(node)) {
+        continue;
+      }
       generate(node, shadowRoot ? Constant.ChildList : Constant.CharacterData);
     }
   }
@@ -326,15 +396,17 @@ function trigger(): void {
 
 function generate(target: Node, type: MutationRecordType): void {
   generate.dn = FunctionNames.MutationGenerate;
-  measure(handle)([{
-    addedNodes: [target],
-    attributeName: null,
-    attributeNamespace: null,
-    nextSibling: null,
-    oldValue: null,
-    previousSibling: null,
-    removedNodes: [],
-    target,
-    type
-  }]);
+  measure(handle)([
+    {
+      addedNodes: [target],
+      attributeName: null,
+      attributeNamespace: null,
+      nextSibling: null,
+      oldValue: null,
+      previousSibling: null,
+      removedNodes: [],
+      target,
+      type,
+    },
+  ]);
 }

package/types/data.d.ts

@@ -433,6 +433,12 @@ export interface BaselineData {
     downX: number;
     downY: number;
     downTime: number;
+    upX: number;
+    upY: number;
+    upTime: number;
+    pointerPrevX: number;
+    pointerPrevY: number;
+    pointerPrevTime: number;
 }
 
 export interface IdentityData {