@openreplay/tracker 3.4.11 → 3.4.15

package/lib/app/observer/observer.js

@@ -0,0 +1,376 @@
+import { stars, hasOpenreplayAttribute } from "../../utils.js";
+import { RemoveNodeAttribute, SetNodeAttribute, SetNodeAttributeURLBased, SetCSSDataURLBased, SetNodeData, CreateTextNode, CreateElementNode, MoveNode, RemoveNode, } from "../../messages/index.js";
+function isSVGElement(node) {
+    return node.namespaceURI === 'http://www.w3.org/2000/svg';
+}
+// TODO: we need a type expert here so we won't have to ignore the lines
+// TODO: use it everywhere (static function; export from which file? <-- global Window typing required)
+export function isInstance(node, constr) {
+    const doc = node.ownerDocument;
+    if (!doc) { // null if Document
+        return constr.name === 'Document';
+    }
+    let context = 
+    // @ts-ignore (for EI, Safary)
+    doc.parentWindow ||
+        doc.defaultView; // TODO: smart global typing for Window object
+    while (context.parent && context.parent !== context) {
+        // @ts-ignore
+        if (node instanceof context[constr.name]) {
+            return true;
+        }
+        // @ts-ignore
+        context = context.parent;
+    }
+    // @ts-ignore
+    return node instanceof context[constr.name];
+}
+function isIgnored(node) {
+    if (isInstance(node, Text)) {
+        return false;
+    }
+    if (!isInstance(node, Element)) {
+        return true;
+    }
+    const tag = node.tagName.toUpperCase();
+    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 (tag === 'SCRIPT' ||
+        tag === 'NOSCRIPT' ||
+        tag === 'META' ||
+        tag === 'TITLE' ||
+        tag === 'BASE');
+}
+function isRootNode(node) {
+    return isInstance(node, Document) || isInstance(node, ShadowRoot);
+}
+function isObservable(node) {
+    if (isRootNode(node)) {
+        return true;
+    }
+    return !isIgnored(node);
+}
+export default class Observer {
+    constructor(app, options, context = window) {
+        this.app = app;
+        this.context = context;
+        this.commited = [];
+        this.recents = [];
+        this.myNodes = [];
+        this.indexes = [];
+        this.attributesList = [];
+        this.textSet = new Set();
+        this.textMasked = new Set();
+        this.options = Object.assign({
+            obscureTextEmails: true,
+            obscureTextNumbers: false,
+        }, options);
+        this.inUpperContext = context.parent === context;
+        this.observer = new MutationObserver(this.app.safe((mutations) => {
+            for (const mutation of mutations) {
+                const target = mutation.target;
+                const type = mutation.type;
+                // TODO TODO TODO: move to iframe_observer/remove??? (check if )
+                // Special case
+                // 'childList' on Document might happen in case of iframe. 
+                // TODO: generalize as much as possible
+                // if (isInstance(target, Document) // Also ShadowRoot can be here
+                //     && type === 'childList' 
+                //     //&& new Array(mutation.addedNodes).some(node => isInstance(node, HTMLHtmlElement))
+                // ) {
+                //   const parentFrame = target.defaultView?.frameElement
+                //   if (!parentFrame) { continue }
+                //   this.bindTree(target.documentElement)
+                //   const frameID = this.app.nodes.getID(parentFrame)
+                //   const docID = this.app.nodes.getID(target.documentElement)
+                //   if (frameID === undefined || docID === undefined) { continue }
+                //   this.app.send(CreateIFrameDocument(frameID, docID));
+                //   continue;
+                // }
+                if (!isObservable(target) || !context.document.contains(target)) {
+                    continue;
+                }
+                if (type === 'childList') {
+                    for (let i = 0; i < mutation.removedNodes.length; i++) {
+                        this.bindTree(mutation.removedNodes[i]);
+                    }
+                    for (let i = 0; i < mutation.addedNodes.length; i++) {
+                        this.bindTree(mutation.addedNodes[i]);
+                    }
+                    continue;
+                }
+                const id = this.app.nodes.getID(target);
+                if (id === undefined) {
+                    continue;
+                }
+                if (id >= this.recents.length) { // TODO: something more convinient
+                    this.recents[id] = undefined;
+                }
+                if (type === 'attributes') {
+                    const name = mutation.attributeName;
+                    if (name === null) {
+                        continue;
+                    }
+                    let attr = this.attributesList[id];
+                    if (attr === undefined) {
+                        this.attributesList[id] = attr = new Set();
+                    }
+                    attr.add(name);
+                    continue;
+                }
+                if (type === 'characterData') {
+                    this.textSet.add(id);
+                    continue;
+                }
+            }
+            this.commitNodes();
+        }));
+    }
+    clear() {
+        this.commited.length = 0;
+        this.recents.length = 0;
+        this.indexes.length = 1;
+        this.attributesList.length = 0;
+        this.textSet.clear();
+        //this.textMasked.clear();
+    }
+    sendNodeAttribute(id, node, name, value) {
+        if (isSVGElement(node)) {
+            if (name.substr(0, 6) === 'xlink:') {
+                name = name.substr(6);
+            }
+            if (value === null) {
+                this.app.send(new RemoveNodeAttribute(id, name));
+            }
+            else if (name === 'href') {
+                if (value.length > 1e5) {
+                    value = '';
+                }
+                this.app.send(new SetNodeAttributeURLBased(id, name, value, this.app.getBaseHref()));
+            }
+            else {
+                this.app.send(new SetNodeAttribute(id, name, value));
+            }
+            return;
+        }
+        if (name === 'src' ||
+            name === 'srcset' ||
+            name === 'integrity' ||
+            name === 'crossorigin' ||
+            name === 'autocomplete' ||
+            name.substr(0, 2) === 'on') {
+            return;
+        }
+        if (name === 'value' &&
+            isInstance(node, HTMLInputElement) &&
+            node.type !== 'button' &&
+            node.type !== 'reset' &&
+            node.type !== 'submit') {
+            return;
+        }
+        if (value === null) {
+            this.app.send(new RemoveNodeAttribute(id, name));
+            return;
+        }
+        if (name === 'style' || name === 'href' && isInstance(node, HTMLLinkElement)) {
+            this.app.send(new SetNodeAttributeURLBased(id, name, value, this.app.getBaseHref()));
+            return;
+        }
+        if (name === 'href' || value.length > 1e5) {
+            value = '';
+        }
+        this.app.send(new SetNodeAttribute(id, name, value));
+    }
+    /* TODO:  abstract sanitation */
+    getInnerTextSecure(el) {
+        const id = this.app.nodes.getID(el);
+        if (!id) {
+            return '';
+        }
+        return this.checkObscure(id, el.innerText);
+    }
+    checkObscure(id, data) {
+        if (this.textMasked.has(id)) {
+            return data.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');
+        }
+        if (this.options.obscureTextEmails) {
+            data = data.replace(/([^\s]+)@([^\s]+)\.([^\s]+)/g, (...f) => stars(f[1]) + '@' + stars(f[2]) + '.' + stars(f[3]));
+        }
+        return data;
+    }
+    sendNodeData(id, parentElement, data) {
+        if (isInstance(parentElement, HTMLStyleElement) || isInstance(parentElement, SVGStyleElement)) {
+            this.app.send(new SetCSSDataURLBased(id, data, this.app.getBaseHref()));
+            return;
+        }
+        data = this.checkObscure(id, data);
+        this.app.send(new SetNodeData(id, data));
+    }
+    /* end TODO:  abstract sanitation */
+    bindNode(node) {
+        const r = this.app.nodes.registerNode(node);
+        const id = r[0];
+        this.recents[id] = r[1] || this.recents[id] || false;
+        this.myNodes[id] = true;
+    }
+    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
+                ? NodeFilter.FILTER_REJECT
+                : NodeFilter.FILTER_ACCEPT,
+        }, 
+        // @ts-ignore
+        false);
+        while (walker.nextNode()) {
+            this.bindNode(walker.currentNode);
+        }
+    }
+    unbindNode(node) {
+        const id = this.app.nodes.unregisterNode(node);
+        if (id !== undefined && this.recents[id] === false) {
+            this.app.send(new RemoveNode(id));
+        }
+    }
+    _commitNode(id, node) {
+        if (isRootNode(node)) {
+            return true;
+        }
+        const parent = node.parentNode;
+        let parentID;
+        // 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 (parent === null) {
+                this.unbindNode(node);
+                return false;
+            }
+            parentID = this.app.nodes.getID(parent);
+            if (parentID === undefined) {
+                this.unbindNode(node);
+                return false;
+            }
+            if (!this.commitNode(parentID)) {
+                this.unbindNode(node);
+                return false;
+            }
+            if (this.textMasked.has(parentID) ||
+                (isInstance(node, Element) && hasOpenreplayAttribute(node, 'masked'))) {
+                this.textMasked.add(id);
+            }
+        }
+        let sibling = node.previousSibling;
+        while (sibling !== null) {
+            const siblingID = this.app.nodes.getID(sibling);
+            if (siblingID !== undefined) {
+                this.commitNode(siblingID);
+                this.indexes[id] = this.indexes[siblingID] + 1;
+                break;
+            }
+            sibling = sibling.previousSibling;
+        }
+        if (sibling === null) {
+            this.indexes[id] = 0; //
+        }
+        const isNew = this.recents[id];
+        const index = this.indexes[id];
+        if (index === undefined) {
+            throw 'commitNode: missing node index';
+        }
+        if (isNew === true) {
+            if (isInstance(node, Element)) {
+                if (parentID !== undefined) {
+                    this.app.send(new CreateElementNode(id, parentID, index, node.tagName, isSVGElement(node)));
+                }
+                for (let i = 0; i < node.attributes.length; i++) {
+                    const attr = node.attributes[i];
+                    this.sendNodeAttribute(id, node, attr.nodeName, attr.value);
+                }
+            }
+            else if (isInstance(node, Text)) {
+                // for text node id != 0, hence parentID !== undefined and parent is Element
+                this.app.send(new CreateTextNode(id, parentID, index));
+                this.sendNodeData(id, parent, node.data);
+            }
+            return true;
+        }
+        if (isNew === false && parentID !== undefined) {
+            this.app.send(new MoveNode(id, parentID, index));
+        }
+        const attr = this.attributesList[id];
+        if (attr !== undefined) {
+            if (!isInstance(node, Element)) {
+                throw 'commitNode: node is not an element';
+            }
+            for (const name of attr) {
+                this.sendNodeAttribute(id, node, name, node.getAttribute(name));
+            }
+        }
+        if (this.textSet.has(id)) {
+            if (!isInstance(node, Text)) {
+                throw 'commitNode: node is not a text';
+            }
+            // for text node id != 0, hence parent is Element
+            this.sendNodeData(id, parent, node.data);
+        }
+        return true;
+    }
+    commitNode(id) {
+        const node = this.app.nodes.getNode(id);
+        if (node === undefined) {
+            return false;
+        }
+        const cmt = this.commited[id];
+        if (cmt !== undefined) {
+            return cmt;
+        }
+        return (this.commited[id] = this._commitNode(id, node));
+    }
+    commitNodes() {
+        let node;
+        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).
+            // ???!?!?R@TW:$HKJ$WLKn
+            if (!this.myNodes[id]) {
+                continue;
+            }
+            this.commitNode(id);
+            if (this.recents[id] === true && (node = this.app.nodes.getNode(id))) {
+                this.app.nodes.callNodeCallbacks(node);
+            }
+        }
+        this.clear();
+    }
+    // ISSSUE
+    observeRoot(node, beforeCommit, nodeToBind = node) {
+        this.observer.observe(node, {
+            childList: true,
+            attributes: true,
+            characterData: true,
+            subtree: true,
+            attributeOldValue: false,
+            characterDataOldValue: false,
+        });
+        this.bindTree(nodeToBind);
+        beforeCommit(this.app.nodes.getID(node));
+        this.commitNodes();
+    }
+    disconnect() {
+        this.observer.disconnect();
+        this.clear();
+        // to sanitizer
+        this.textMasked.clear();
+        this.myNodes.length = 0;
+    }
+}

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

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

package/lib/app/observer/shadow_root_observer.js

@@ -0,0 +1,18 @@
+import Observer from "./observer.js";
+import { CreateIFrameDocument } from "../../messages/index.js";
+export default class ShadowRootObserver extends Observer {
+    observe(el) {
+        const shRoot = el.shadowRoot;
+        const hostID = this.app.nodes.getID(el);
+        if (!shRoot || hostID === undefined) {
+            return;
+        } // log
+        this.observeRoot(shRoot, (rootID) => {
+            if (rootID === undefined) {
+                console.log("OpenReplay: Shadow Root was not bound");
+                return;
+            }
+            this.app.send(CreateIFrameDocument(hostID, rootID));
+        });
+    }
+}

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

@@ -0,0 +1,15 @@
+import Observer from "./observer.js";
+import type { Options as BaseOptions } from "./observer.js";
+import App from "../index.js";
+export interface Options extends Partial<BaseOptions> {
+    captureIFrames: boolean;
+}
+export default class TopObserver extends Observer<Options> {
+    constructor(app: App, options: Partial<Options>);
+    private iframeObservers;
+    private handleIframe;
+    private shadowRootObservers;
+    private handleShadowRoot;
+    observe(): void;
+    disconnect(): void;
+}

package/lib/app/observer/top_observer.js

@@ -0,0 +1,79 @@
+import Observer, { isInstance } from "./observer.js";
+import IFrameObserver from "./iframe_observer.js";
+import ShadowRootObserver from "./shadow_root_observer.js";
+import { CreateDocument } from "../../messages/index.js";
+const attachShadowNativeFn = Element.prototype.attachShadow;
+export default class TopObserver extends Observer {
+    constructor(app, options) {
+        super(app, Object.assign({
+            captureIFrames: false
+        }, options));
+        this.iframeObservers = [];
+        this.shadowRootObservers = [];
+        // IFrames
+        this.app.nodes.attachNodeCallback(node => {
+            if (isInstance(node, HTMLIFrameElement) &&
+                (this.options.captureIFrames || node.getAttribute("data-openreplay-capture"))) {
+                this.handleIframe(node);
+            }
+        });
+        // ShadowDOM
+        this.app.nodes.attachNodeCallback(node => {
+            if (isInstance(node, Element) && node.shadowRoot !== null) {
+                this.handleShadowRoot(node.shadowRoot);
+            }
+        });
+    }
+    handleIframe(iframe) {
+        let context = null;
+        const handle = this.app.safe(() => {
+            const id = this.app.nodes.getID(iframe);
+            if (id === undefined) {
+                return;
+            } //log
+            if (iframe.contentWindow === context) {
+                return;
+            } //Does this happen frequently?
+            context = iframe.contentWindow;
+            if (!context) {
+                return;
+            }
+            const observer = new IFrameObserver(this.app, this.options, context);
+            this.iframeObservers.push(observer);
+            observer.observe(iframe);
+        });
+        this.app.attachEventListener(iframe, "load", handle);
+        handle();
+    }
+    handleShadowRoot(shRoot) {
+        const observer = new ShadowRootObserver(this.app, this.options, this.context);
+        this.shadowRootObservers.push(observer);
+        observer.observe(shRoot.host);
+    }
+    observe() {
+        // Protection from several subsequent calls?
+        const observer = this;
+        Element.prototype.attachShadow = function () {
+            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: 
+        //   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.app.send(new CreateDocument());
+        }, this.context.document.documentElement);
+    }
+    disconnect() {
+        Element.prototype.attachShadow = attachShadowNativeFn;
+        this.iframeObservers.forEach(o => o.disconnect());
+        this.iframeObservers = [];
+        this.shadowRootObservers.forEach(o => o.disconnect());
+        this.shadowRootObservers = [];
+        super.disconnect();
+    }
+}

package/lib/index.js

@@ -111,7 +111,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.4.11',
+                trackerVersion: '3.4.15',
                 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.4.11",
+  "version": "3.4.15",
   "keywords": [
     "logging",
     "replay"