@openreplay/tracker 3.6.3 → 3.6.5

package/cjs/app/observer/observer.js

@@ -13,13 +13,9 @@ function isIgnored(node) {
     if (tag === 'LINK') {
         const rel = node.getAttribute('rel');
         const as = node.getAttribute('as');
-        return !((rel === null || rel === void 0 ? void 0 : rel.includes('stylesheet')) || as === "style" || as === "font");
+        return !((rel === null || rel === void 0 ? void 0 : rel.includes('stylesheet')) || as === 'style' || as === 'font');
     }
-    return (tag === 'SCRIPT' ||
-        tag === 'NOSCRIPT' ||
-        tag === 'META' ||
-        tag === 'TITLE' ||
-        tag === 'BASE');
+    return (tag === 'SCRIPT' || tag === 'NOSCRIPT' || tag === 'META' || tag === 'TITLE' || tag === 'BASE');
 }
 function isObservable(node) {
     if ((0, guards_js_1.isRootNode)(node)) {
@@ -32,17 +28,11 @@ function isObservable(node) {
     - fix unbinding logic + send all removals first (ensure sequence is correct)
     - use document as a 0-node in the upper context (should be updated in player at first)
 */
-/*
-  Nikita:
-    - rn we only send unbind event for parent (all child nodes will be cut in the live replay anyways)
-      to prevent sending 1k+ unbinds for child nodes and making replay file bigger than it should be
-*/
 var RecentsType;
 (function (RecentsType) {
     RecentsType[RecentsType["New"] = 0] = "New";
     RecentsType[RecentsType["Removed"] = 1] = "Removed";
     RecentsType[RecentsType["Changed"] = 2] = "Changed";
-    RecentsType[RecentsType["RemovedChild"] = 3] = "RemovedChild";
 })(RecentsType || (RecentsType = {}));
 class Observer {
     constructor(app, isTopContext = false) {
@@ -54,7 +44,8 @@ class Observer {
         this.attributesMap = new Map();
         this.textSet = new Set();
         this.observer = new MutationObserver(this.app.safe((mutations) => {
-            for (const mutation of mutations) { // mutations order is sequential
+            for (const mutation of mutations) {
+                // mutations order is sequential
                 const target = mutation.target;
                 const type = mutation.type;
                 if (!isObservable(target)) {
@@ -62,7 +53,10 @@ class Observer {
                 }
                 if (type === 'childList') {
                     for (let i = 0; i < mutation.removedNodes.length; i++) {
-                        this.bindTree(mutation.removedNodes[i], true);
+                        // Should be the same as bindTree(mutation.removedNodes[i]), but logic needs to be be untied
+                        if (isObservable(mutation.removedNodes[i])) {
+                            this.bindNode(mutation.removedNodes[i]);
+                        }
                     }
                     for (let i = 0; i < mutation.addedNodes.length; i++) {
                         this.bindTree(mutation.addedNodes[i]);
@@ -83,7 +77,7 @@ class Observer {
                     }
                     let attr = this.attributesMap.get(id);
                     if (attr === undefined) {
-                        this.attributesMap.set(id, attr = new Set());
+                        this.attributesMap.set(id, (attr = new Set()));
                     }
                     attr.add(name);
                     continue;
@@ -131,7 +125,7 @@ class Observer {
             return;
         }
         if (name === 'value' &&
-            (0, guards_js_1.hasTag)(node, "INPUT") &&
+            (0, guards_js_1.hasTag)(node, 'INPUT') &&
             node.type !== 'button' &&
             node.type !== 'reset' &&
             node.type !== 'submit') {
@@ -141,7 +135,7 @@ class Observer {
             this.app.send(new messages_js_1.RemoveNodeAttribute(id, name));
             return;
         }
-        if (name === 'style' || name === 'href' && (0, guards_js_1.hasTag)(node, "LINK")) {
+        if (name === 'style' || (name === 'href' && (0, guards_js_1.hasTag)(node, 'LINK'))) {
             this.app.send(new messages_js_1.SetNodeAttributeURLBased(id, name, value, this.app.getBaseHref()));
             return;
         }
@@ -151,7 +145,7 @@ class Observer {
         this.app.send(new messages_js_1.SetNodeAttribute(id, name, value));
     }
     sendNodeData(id, parentElement, data) {
-        if ((0, guards_js_1.hasTag)(parentElement, "STYLE") || (0, guards_js_1.hasTag)(parentElement, "style")) {
+        if ((0, guards_js_1.hasTag)(parentElement, 'STYLE') || (0, guards_js_1.hasTag)(parentElement, 'style')) {
             this.app.send(new messages_js_1.SetCSSDataURLBased(id, data, this.app.getBaseHref()));
             return;
         }
@@ -163,40 +157,43 @@ class Observer {
         if (isNew) {
             this.recents.set(id, RecentsType.New);
         }
-        else if (this.recents.get(id) !== RecentsType.New) { // can we do just `else` here?
+        else if (this.recents.get(id) !== RecentsType.New) {
             this.recents.set(id, RecentsType.Removed);
         }
     }
-    unbindChildNode(node) {
-        const [id] = this.app.nodes.registerNode(node);
-        this.recents.set(id, RecentsType.RemovedChild);
-    }
-    bindTree(node, isChildUnbinding = false) {
+    bindTree(node) {
         if (!isObservable(node)) {
             return;
         }
         this.bindNode(node);
         const walker = document.createTreeWalker(node, NodeFilter.SHOW_ELEMENT + NodeFilter.SHOW_TEXT, {
-            acceptNode: (node) => isIgnored(node)
-                || (this.app.nodes.getID(node) !== undefined && !isChildUnbinding)
+            acceptNode: (node) => isIgnored(node) || this.app.nodes.getID(node) !== undefined
                 ? NodeFilter.FILTER_REJECT
                 : NodeFilter.FILTER_ACCEPT,
         }, 
         // @ts-ignore
         false);
         while (walker.nextNode()) {
-            if (isChildUnbinding) {
-                this.unbindChildNode(walker.currentNode);
-            }
-            else {
-                this.bindNode(walker.currentNode);
-            }
+            this.bindNode(walker.currentNode);
         }
     }
-    unbindNode(node) {
+    unbindTree(node) {
         const id = this.app.nodes.unregisterNode(node);
         if (id !== undefined && this.recents.get(id) === RecentsType.Removed) {
-            this.app.send(new messages_js_1.RemoveNode(id));
+            // Sending RemoveNode only for parent to maintain
+            this.app.send((0, messages_js_1.RemoveNode)(id));
+            // Unregistering all the children in order to clear the memory
+            const walker = document.createTreeWalker(node, NodeFilter.SHOW_ELEMENT + NodeFilter.SHOW_TEXT, {
+                acceptNode: (node) => isIgnored(node) || this.app.nodes.getID(node) === undefined
+                    ? NodeFilter.FILTER_REJECT
+                    : NodeFilter.FILTER_ACCEPT,
+            }, 
+            // @ts-ignore
+            false);
+            while (walker.nextNode()) {
+                this.app.nodes.unregisterNode(walker.currentNode);
+            }
+            // MBTODO: count and send RemovedNodesCount (for the page crash detection in heuristics)
         }
     }
     // A top-consumption function on the infinite lists test. (~1% of performance resources)
@@ -209,20 +206,20 @@ 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, guards_js_1.hasTag)(node, "HTML") || !this.isTopContext) {
+        if (!(0, guards_js_1.hasTag)(node, 'HTML') || !this.isTopContext) {
             if (parent === null) {
                 // Sometimes one observation contains attribute mutations for the removimg node, which gets ignored here.
-                // That shouldn't affect the visual rendering ( should it? )
-                this.unbindNode(node);
+                // That shouldn't affect the visual rendering ( should it? maybe when transition applied? )
+                this.unbindTree(node);
                 return false;
             }
             parentID = this.app.nodes.getID(parent);
             if (parentID === undefined) {
-                this.unbindNode(node);
+                this.unbindTree(node);
                 return false;
             }
             if (!this.commitNode(parentID)) {
-                this.unbindNode(node);
+                this.unbindTree(node);
                 return false;
             }
             this.app.sanitizer.handleNode(id, parentID, node);
@@ -317,7 +314,8 @@ class Observer {
         });
         this.clear();
     }
-    // ISSSUE
+    // ISSSUE (nodeToBinde should be the same as node. Look at the comment about 0-node at the beginning of the file.)
+    // TODO: use one observer instance for all iframes/shadowRoots (composition instiad of inheritance)
     observeRoot(node, beforeCommit, nodeToBind = node) {
         this.observer.observe(node, {
             childList: true,

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

@@ -1,4 +1,4 @@
-import Observer from "./observer.js";
+import Observer from './observer.js';
 export default class ShadowRootObserver extends Observer {
     observe(el: Element): void;
 }

package/cjs/app/observer/shadow_root_observer.js

@@ -11,7 +11,7 @@ class ShadowRootObserver extends observer_js_1.default {
         } // log
         this.observeRoot(shRoot, (rootID) => {
             if (rootID === undefined) {
-                console.log("OpenReplay: Shadow Root was not bound");
+                console.log('OpenReplay: Shadow Root was not bound');
                 return;
             }
             this.app.send((0, messages_js_1.CreateIFrameDocument)(hostID, rootID));

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

@@ -1,5 +1,5 @@
-import Observer from "./observer.js";
-import App from "../index.js";
+import Observer from './observer.js';
+import App from '../index.js';
 export interface Options {
     captureIFrames: boolean;
 }

package/cjs/app/observer/top_observer.js

@@ -13,18 +13,18 @@ class TopObserver extends observer_js_1.default {
         this.iframeObservers = [];
         this.shadowRootObservers = [];
         this.options = Object.assign({
-            captureIFrames: true
+            captureIFrames: true,
         }, options);
         // IFrames
-        this.app.nodes.attachNodeCallback(node => {
-            if ((0, guards_js_1.hasTag)(node, "IFRAME") &&
-                ((this.options.captureIFrames && !(0, utils_js_1.hasOpenreplayAttribute)(node, "obscured"))
-                    || (0, utils_js_1.hasOpenreplayAttribute)(node, "capture"))) {
+        this.app.nodes.attachNodeCallback((node) => {
+            if ((0, guards_js_1.hasTag)(node, 'IFRAME') &&
+                ((this.options.captureIFrames && !(0, utils_js_1.hasOpenreplayAttribute)(node, 'obscured')) ||
+                    (0, utils_js_1.hasOpenreplayAttribute)(node, 'capture'))) {
                 this.handleIframe(node);
             }
         });
         // ShadowDOM
-        this.app.nodes.attachNodeCallback(node => {
+        this.app.nodes.attachNodeCallback((node) => {
             if ((0, guards_js_1.isElementNode)(node) && node.shadowRoot !== null) {
                 this.handleShadowRoot(node.shadowRoot);
             }
@@ -48,7 +48,7 @@ class TopObserver extends observer_js_1.default {
             this.iframeObservers.push(observer);
             observer.observe(iframe);
         });
-        iframe.addEventListener("load", handle); // why app.attachEventListener not working?
+        iframe.addEventListener('load', handle); // why app.attachEventListener not working?
         handle();
     }
     handleShadowRoot(shRoot) {
@@ -60,14 +60,15 @@ class TopObserver extends observer_js_1.default {
         // Protection from several subsequent calls?
         const observer = this;
         Element.prototype.attachShadow = function () {
+            // eslint-disable-next-line
             const shadow = attachShadowNativeFn.apply(this, arguments);
             observer.handleShadowRoot(shadow);
             return shadow;
         };
         // Can observe documentElement (<html>) here, because it is not supposed to be changing.
         // However, it is possible in some exotic cases and may cause an ignorance of the newly created <html>
-        // In this case context.document have to be observed, but this will cause 
-        // the change in the re-player behaviour caused by CreateDocument message: 
+        // In this case context.document have to be observed, but this will cause
+        // 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(window.document, () => {
@@ -76,9 +77,9 @@ class TopObserver extends observer_js_1.default {
     }
     disconnect() {
         Element.prototype.attachShadow = attachShadowNativeFn;
-        this.iframeObservers.forEach(o => o.disconnect());
+        this.iframeObservers.forEach((o) => o.disconnect());
         this.iframeObservers = [];
-        this.shadowRootObservers.forEach(o => o.disconnect());
+        this.shadowRootObservers.forEach((o) => o.disconnect());
         this.shadowRootObservers = [];
         super.disconnect();
     }

package/cjs/app/sanitizer.d.ts

@@ -1,4 +1,4 @@
-import type App from "./index.js";
+import type App from './index.js';
 export interface Options {
     obscureTextEmails: boolean;
     obscureTextNumbers: boolean;

package/cjs/app/sanitizer.js

@@ -14,20 +14,20 @@ class Sanitizer {
     }
     handleNode(id, parentID, node) {
         if (this.masked.has(parentID) ||
-            ((0, guards_js_1.isElementNode)(node) &&
-                (0, utils_js_1.hasOpenreplayAttribute)(node, 'masked'))) {
+            ((0, guards_js_1.isElementNode)(node) && (0, utils_js_1.hasOpenreplayAttribute)(node, 'masked'))) {
             this.masked.add(id);
         }
         if (this.maskedContainers.has(parentID) ||
-            ((0, guards_js_1.isElementNode)(node) &&
-                (0, utils_js_1.hasOpenreplayAttribute)(node, 'htmlmasked'))) {
+            ((0, guards_js_1.isElementNode)(node) && (0, utils_js_1.hasOpenreplayAttribute)(node, 'htmlmasked'))) {
             this.maskedContainers.add(id);
         }
     }
     sanitize(id, data) {
         if (this.masked.has(id)) {
             // TODO: is it the best place to put trim() ? Might trimmed spaces be considered in layout in certain cases?
-            return data.trim().replace(/[^\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]/g, '█');
+            return data
+                .trim()
+                .replace(/[^\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]/g, '█');
         }
         if (this.options.obscureTextNumbers) {
             data = data.replace(/\d/g, '0');

package/cjs/app/session.d.ts

@@ -1,14 +1,26 @@
+import type App from './index.js';
 interface SessionInfo {
-    sessionID: string | null;
+    sessionID: string | undefined;
     metadata: Record<string, string>;
     userID: string | null;
+    timestamp: number;
+    projectID?: string;
 }
 declare type OnUpdateCallback = (i: Partial<SessionInfo>) => void;
+export declare type Options = {
+    session_token_key: string;
+    session_pageno_key: string;
+};
 export default class Session {
+    private readonly app;
+    private readonly options;
     private metadata;
     private userID;
     private sessionID;
-    private callbacks;
+    private readonly callbacks;
+    private timestamp;
+    private projectID;
+    constructor(app: App, options: Options);
     attachUpdateCallback(cb: OnUpdateCallback): void;
     private handleUpdate;
     update(newInfo: Partial<SessionInfo>): void;

package/cjs/app/session.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class Session {
-    constructor() {
+    constructor(app, options) {
+        this.app = app;
+        this.options = options;
         this.metadata = {};
         this.userID = null;
-        this.sessionID = null;
         this.callbacks = [];
+        this.timestamp = 0;
     }
     attachUpdateCallback(cb) {
         this.callbacks.push(cb);
@@ -17,18 +19,25 @@ class Session {
         if (newInfo.sessionID == null) {
             delete newInfo.sessionID;
         }
-        this.callbacks.forEach(cb => cb(newInfo));
+        this.callbacks.forEach((cb) => cb(newInfo));
     }
     update(newInfo) {
-        if (newInfo.userID !== undefined) { // TODO clear nullable/undefinable types
+        if (newInfo.userID !== undefined) {
+            // TODO clear nullable/undefinable types
             this.userID = newInfo.userID;
         }
         if (newInfo.metadata !== undefined) {
-            Object.entries(newInfo.metadata).forEach(([k, v]) => this.metadata[k] = v);
+            Object.entries(newInfo.metadata).forEach(([k, v]) => (this.metadata[k] = v));
         }
         if (newInfo.sessionID !== undefined) {
             this.sessionID = newInfo.sessionID;
         }
+        if (newInfo.timestamp !== undefined) {
+            this.timestamp = newInfo.timestamp;
+        }
+        if (newInfo.projectID !== undefined) {
+            this.projectID = newInfo.projectID;
+        }
         this.handleUpdate(newInfo);
     }
     setMetadata(key, value) {
@@ -44,12 +53,16 @@ class Session {
             sessionID: this.sessionID,
             metadata: this.metadata,
             userID: this.userID,
+            timestamp: this.timestamp,
+            projectID: this.projectID,
         };
     }
     reset() {
+        this.app.sessionStorage.removeItem(this.options.session_token_key);
         this.metadata = {};
         this.userID = null;
-        this.sessionID = null;
+        this.sessionID = undefined;
+        this.timestamp = 0;
     }
 }
 exports.default = Session;

package/cjs/app/ticker.d.ts

@@ -1,4 +1,4 @@
-import App from "./index.js";
+import App from './index.js';
 declare type Callback = () => void;
 export default class Ticker {
     private readonly app;

package/cjs/common/messages.d.ts

@@ -1,4 +1,4 @@
-import type { Writer, Message } from "./types.js";
+import type { Writer, Message } from './types.js';
 export default Message;
 export declare const classes: Map<number, Function>;
 declare class _BatchMeta implements Message {