@openreplay/tracker 3.5.3 → 3.5.4

package/cjs/app/context.js

@@ -12,37 +12,60 @@ function isInstance(node, constr) {
     // @ts-ignore (for EI, Safary)
     doc.parentWindow ||
         doc.defaultView; // TODO: smart global typing for Window object
-    while (context.parent && context.parent !== context) {
+    while ((context.parent || context.top) && context.parent !== context) {
         // @ts-ignore
         if (node instanceof context[constr.name]) {
             return true;
         }
         // @ts-ignore
-        context = context.parent;
+        context = context.parent || context.top;
     }
     // @ts-ignore
     return node instanceof context[constr.name];
 }
 exports.isInstance = isInstance;
+// TODO: ensure 1. it works in every cases (iframes/detached nodes) and 2. the most efficient
 function inDocument(node) {
     const doc = node.ownerDocument;
     if (!doc) {
-        return false;
-    }
-    if (doc.contains(node)) {
         return true;
-    }
-    let context = 
-    // @ts-ignore (for EI, Safary)
-    doc.parentWindow ||
-        doc.defaultView;
-    while (context.parent && context.parent !== context) {
-        if (context.document.contains(node)) {
+    } // Document
+    let current = node;
+    while (current) {
+        if (current === doc) {
             return true;
         }
-        // @ts-ignore
-        context = context.parent;
+        else if (isInstance(current, ShadowRoot)) {
+            current = current.host;
+        }
+        else {
+            current = current.parentNode;
+        }
     }
     return false;
 }
 exports.inDocument = inDocument;
+// export function inDocument(node: Node): boolean {
+//   // @ts-ignore compatability
+//   if (node.getRootNode) {
+//     let root: Node
+//     while ((root = node.getRootNode()) !== node) {
+//        ////
+//     }
+//   }
+//   const doc = node.ownerDocument
+//   if (!doc) { return false }
+//   if (doc.contains(node)) { return true }
+//   let context: Window = 
+//     // @ts-ignore (for EI, Safary)
+//     doc.parentWindow || 
+//     doc.defaultView;
+//   while(context.parent && context.parent !== context) {
+//     if (context.document.contains(node)) {
+//       return true
+//     }
+//     // @ts-ignore
+//     context = context.parent
+//   }
+//   return false;
+// }

package/cjs/app/index.js

@@ -29,7 +29,7 @@ class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '3.5.3'; // TODO: version compatability check inside each plugin.
+        this.version = '3.5.4'; // TODO: version compatability check inside each plugin.
         this.preStartMessages = [];
         this.projectKey = projectKey;
         this.options = Object.assign({

package/cjs/app/observer/observer.d.ts

@@ -1,7 +1,7 @@
 import App from "../index.js";
 export default abstract class Observer {
     protected readonly app: App;
-    protected readonly context: Window;
+    protected readonly isTopContext: boolean;
     private readonly observer;
     private readonly commited;
     private readonly recents;
@@ -9,8 +9,7 @@ export default abstract class Observer {
     private readonly indexes;
     private readonly attributesList;
     private readonly textSet;
-    private readonly inUpperContext;
-    constructor(app: App, context?: Window);
+    constructor(app: App, isTopContext?: boolean);
     private clear;
     private sendNodeAttribute;
     private sendNodeData;

package/cjs/app/observer/observer.js

@@ -34,16 +34,15 @@ function isObservable(node) {
     return !isIgnored(node);
 }
 class Observer {
-    constructor(app, context = window) {
+    constructor(app, isTopContext = false) {
         this.app = app;
-        this.context = context;
+        this.isTopContext = isTopContext;
         this.commited = [];
         this.recents = [];
         this.myNodes = [];
         this.indexes = [];
         this.attributesList = [];
         this.textSet = new Set();
-        this.inUpperContext = context.parent === context; //TODO: get rid of context here
         this.observer = new MutationObserver(this.app.safe((mutations) => {
             for (const mutation of mutations) {
                 const target = mutation.target;
@@ -186,7 +185,7 @@ class Observer {
         // Disable parent check for the upper context HTMLHtmlElement, because it is root there... (before)
         // TODO: get rid of "special" cases (there is an issue with CreateDocument altered behaviour though)
         // TODO: Clean the logic (though now it workd fine) 
-        if (!(0, context_js_1.isInstance)(node, HTMLHtmlElement) || !this.inUpperContext) {
+        if (!(0, context_js_1.isInstance)(node, HTMLHtmlElement) || !this.isTopContext) {
             if (parent === null) {
                 this.unbindNode(node);
                 return false;
@@ -274,6 +273,8 @@ class Observer {
         for (let id = 0; id < this.recents.length; id++) {
             // TODO: make things/logic nice here.
             // commit required in any case if recents[id] true or false (in case of unbinding) or undefined (in case of attr change).
+            // Possible solution: separate new node commit (recents) and new attribute/move node commit
+            // Otherwise commitNode is called on each node, which might be a lot
             if (!this.myNodes[id]) {
                 continue;
             }

package/cjs/app/observer/top_observer.js

@@ -9,16 +9,17 @@ const utils_js_1 = require("../../utils.js");
 const attachShadowNativeFn = utils_js_1.IN_BROWSER ? Element.prototype.attachShadow : () => new ShadowRoot();
 class TopObserver extends observer_js_1.default {
     constructor(app, options) {
-        super(app);
+        super(app, true);
         this.iframeObservers = [];
         this.shadowRootObservers = [];
         this.options = Object.assign({
-            captureIFrames: false
+            captureIFrames: true
         }, options);
         // IFrames
         this.app.nodes.attachNodeCallback(node => {
             if ((0, context_js_1.isInstance)(node, HTMLIFrameElement) &&
-                (this.options.captureIFrames || node.getAttribute("data-openreplay-capture"))) {
+                ((this.options.captureIFrames && !(0, utils_js_1.hasOpenreplayAttribute)(node, "obscured"))
+                    || (0, utils_js_1.hasOpenreplayAttribute)(node, "capture"))) {
                 this.handleIframe(node);
             }
         });
@@ -30,28 +31,28 @@ class TopObserver extends observer_js_1.default {
         });
     }
     handleIframe(iframe) {
-        let context = null;
+        let doc = null;
         const handle = this.app.safe(() => {
             const id = this.app.nodes.getID(iframe);
             if (id === undefined) {
                 return;
             } //log
-            if (iframe.contentWindow === context) {
+            if (iframe.contentDocument === doc) {
                 return;
-            } //Does this happen frequently?
-            context = iframe.contentWindow;
-            if (!context) {
+            } // How frequently can it happen?
+            doc = iframe.contentDocument;
+            if (!doc || !iframe.contentWindow) {
                 return;
             }
-            const observer = new iframe_observer_js_1.default(this.app, context);
+            const observer = new iframe_observer_js_1.default(this.app);
             this.iframeObservers.push(observer);
             observer.observe(iframe);
         });
-        this.app.attachEventListener(iframe, "load", handle);
+        iframe.addEventListener("load", handle); // why app.attachEventListener not working?
         handle();
     }
     handleShadowRoot(shRoot) {
-        const observer = new shadow_root_observer_js_1.default(this.app, this.context);
+        const observer = new shadow_root_observer_js_1.default(this.app);
         this.shadowRootObservers.push(observer);
         observer.observe(shRoot.host);
     }
@@ -69,9 +70,9 @@ class TopObserver extends observer_js_1.default {
         // the change in the re-player behaviour caused by CreateDocument message: 
         //   the 0-node ("fRoot") will become #document rather than documentElement as it is now.
         // Alternatively - observe(#document) then bindNode(documentElement)
-        this.observeRoot(this.context.document, () => {
+        this.observeRoot(window.document, () => {
             this.app.send(new index_js_1.CreateDocument());
-        }, this.context.document.documentElement);
+        }, window.document.documentElement);
     }
     disconnect() {
         Element.prototype.attachShadow = attachShadowNativeFn;

package/cjs/index.js

@@ -127,7 +127,7 @@ class API {
             // no-cors issue only with text/plain or not-set Content-Type
             // req.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
             req.send(JSON.stringify({
-                trackerVersion: '3.5.3',
+                trackerVersion: '3.5.4',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)

package/lib/app/context.js

@@ -9,35 +9,58 @@ export function isInstance(node, constr) {
     // @ts-ignore (for EI, Safary)
     doc.parentWindow ||
         doc.defaultView; // TODO: smart global typing for Window object
-    while (context.parent && context.parent !== context) {
+    while ((context.parent || context.top) && context.parent !== context) {
         // @ts-ignore
         if (node instanceof context[constr.name]) {
             return true;
         }
         // @ts-ignore
-        context = context.parent;
+        context = context.parent || context.top;
     }
     // @ts-ignore
     return node instanceof context[constr.name];
 }
+// TODO: ensure 1. it works in every cases (iframes/detached nodes) and 2. the most efficient
 export function inDocument(node) {
     const doc = node.ownerDocument;
     if (!doc) {
-        return false;
-    }
-    if (doc.contains(node)) {
         return true;
-    }
-    let context = 
-    // @ts-ignore (for EI, Safary)
-    doc.parentWindow ||
-        doc.defaultView;
-    while (context.parent && context.parent !== context) {
-        if (context.document.contains(node)) {
+    } // Document
+    let current = node;
+    while (current) {
+        if (current === doc) {
             return true;
         }
-        // @ts-ignore
-        context = context.parent;
+        else if (isInstance(current, ShadowRoot)) {
+            current = current.host;
+        }
+        else {
+            current = current.parentNode;
+        }
     }
     return false;
 }
+// export function inDocument(node: Node): boolean {
+//   // @ts-ignore compatability
+//   if (node.getRootNode) {
+//     let root: Node
+//     while ((root = node.getRootNode()) !== node) {
+//        ////
+//     }
+//   }
+//   const doc = node.ownerDocument
+//   if (!doc) { return false }
+//   if (doc.contains(node)) { return true }
+//   let context: Window = 
+//     // @ts-ignore (for EI, Safary)
+//     doc.parentWindow || 
+//     doc.defaultView;
+//   while(context.parent && context.parent !== context) {
+//     if (context.document.contains(node)) {
+//       return true
+//     }
+//     // @ts-ignore
+//     context = context.parent
+//   }
+//   return false;
+// }

package/lib/app/index.js

@@ -26,7 +26,7 @@ export default class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '3.5.3'; // TODO: version compatability check inside each plugin.
+        this.version = '3.5.4'; // TODO: version compatability check inside each plugin.
         this.preStartMessages = [];
         this.projectKey = projectKey;
         this.options = Object.assign({

package/lib/app/observer/observer.d.ts

@@ -1,7 +1,7 @@
 import App from "../index.js";
 export default abstract class Observer {
     protected readonly app: App;
-    protected readonly context: Window;
+    protected readonly isTopContext: boolean;
     private readonly observer;
     private readonly commited;
     private readonly recents;
@@ -9,8 +9,7 @@ export default abstract class Observer {
     private readonly indexes;
     private readonly attributesList;
     private readonly textSet;
-    private readonly inUpperContext;
-    constructor(app: App, context?: Window);
+    constructor(app: App, isTopContext?: boolean);
     private clear;
     private sendNodeAttribute;
     private sendNodeData;

package/lib/app/observer/observer.js

@@ -32,16 +32,15 @@ function isObservable(node) {
     return !isIgnored(node);
 }
 export default class Observer {
-    constructor(app, context = window) {
+    constructor(app, isTopContext = false) {
         this.app = app;
-        this.context = context;
+        this.isTopContext = isTopContext;
         this.commited = [];
         this.recents = [];
         this.myNodes = [];
         this.indexes = [];
         this.attributesList = [];
         this.textSet = new Set();
-        this.inUpperContext = context.parent === context; //TODO: get rid of context here
         this.observer = new MutationObserver(this.app.safe((mutations) => {
             for (const mutation of mutations) {
                 const target = mutation.target;
@@ -184,7 +183,7 @@ export default class Observer {
         // Disable parent check for the upper context HTMLHtmlElement, because it is root there... (before)
         // TODO: get rid of "special" cases (there is an issue with CreateDocument altered behaviour though)
         // TODO: Clean the logic (though now it workd fine) 
-        if (!isInstance(node, HTMLHtmlElement) || !this.inUpperContext) {
+        if (!isInstance(node, HTMLHtmlElement) || !this.isTopContext) {
             if (parent === null) {
                 this.unbindNode(node);
                 return false;
@@ -272,6 +271,8 @@ export default class Observer {
         for (let id = 0; id < this.recents.length; id++) {
             // TODO: make things/logic nice here.
             // commit required in any case if recents[id] true or false (in case of unbinding) or undefined (in case of attr change).
+            // Possible solution: separate new node commit (recents) and new attribute/move node commit
+            // Otherwise commitNode is called on each node, which might be a lot
             if (!this.myNodes[id]) {
                 continue;
             }

package/lib/app/observer/top_observer.js

@@ -3,20 +3,21 @@ import { isInstance } from "../context.js";
 import IFrameObserver from "./iframe_observer.js";
 import ShadowRootObserver from "./shadow_root_observer.js";
 import { CreateDocument } from "../../messages/index.js";
-import { IN_BROWSER } from '../../utils.js';
+import { IN_BROWSER, hasOpenreplayAttribute } from '../../utils.js';
 const attachShadowNativeFn = IN_BROWSER ? Element.prototype.attachShadow : () => new ShadowRoot();
 export default class TopObserver extends Observer {
     constructor(app, options) {
-        super(app);
+        super(app, true);
         this.iframeObservers = [];
         this.shadowRootObservers = [];
         this.options = Object.assign({
-            captureIFrames: false
+            captureIFrames: true
         }, options);
         // IFrames
         this.app.nodes.attachNodeCallback(node => {
             if (isInstance(node, HTMLIFrameElement) &&
-                (this.options.captureIFrames || node.getAttribute("data-openreplay-capture"))) {
+                ((this.options.captureIFrames && !hasOpenreplayAttribute(node, "obscured"))
+                    || hasOpenreplayAttribute(node, "capture"))) {
                 this.handleIframe(node);
             }
         });
@@ -28,28 +29,28 @@ export default class TopObserver extends Observer {
         });
     }
     handleIframe(iframe) {
-        let context = null;
+        let doc = null;
         const handle = this.app.safe(() => {
             const id = this.app.nodes.getID(iframe);
             if (id === undefined) {
                 return;
             } //log
-            if (iframe.contentWindow === context) {
+            if (iframe.contentDocument === doc) {
                 return;
-            } //Does this happen frequently?
-            context = iframe.contentWindow;
-            if (!context) {
+            } // How frequently can it happen?
+            doc = iframe.contentDocument;
+            if (!doc || !iframe.contentWindow) {
                 return;
             }
-            const observer = new IFrameObserver(this.app, context);
+            const observer = new IFrameObserver(this.app);
             this.iframeObservers.push(observer);
             observer.observe(iframe);
         });
-        this.app.attachEventListener(iframe, "load", handle);
+        iframe.addEventListener("load", handle); // why app.attachEventListener not working?
         handle();
     }
     handleShadowRoot(shRoot) {
-        const observer = new ShadowRootObserver(this.app, this.context);
+        const observer = new ShadowRootObserver(this.app);
         this.shadowRootObservers.push(observer);
         observer.observe(shRoot.host);
     }
@@ -67,9 +68,9 @@ export default class TopObserver extends Observer {
         // the change in the re-player behaviour caused by CreateDocument message: 
         //   the 0-node ("fRoot") will become #document rather than documentElement as it is now.
         // Alternatively - observe(#document) then bindNode(documentElement)
-        this.observeRoot(this.context.document, () => {
+        this.observeRoot(window.document, () => {
             this.app.send(new CreateDocument());
-        }, this.context.document.documentElement);
+        }, window.document.documentElement);
     }
     disconnect() {
         Element.prototype.attachShadow = attachShadowNativeFn;

package/lib/index.js

@@ -123,7 +123,7 @@ export default class API {
             // no-cors issue only with text/plain or not-set Content-Type
             // req.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
             req.send(JSON.stringify({
-                trackerVersion: '3.5.3',
+                trackerVersion: '3.5.4',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openreplay/tracker",
   "description": "The OpenReplay tracker main package",
-  "version": "3.5.3",
+  "version": "3.5.4",
   "keywords": [
     "logging",
     "replay"