@openreplay/tracker 3.4.7 → 3.4.11

package/lib/app/observer/iframe_observer.js

@@ -1,18 +0,0 @@
-import Observer from './observer';
-import { CreateIFrameDocument, } from '../../messages';
-export default class IFrameObserver extends Observer {
-    observe(iframe) {
-        const doc = iframe.contentDocument;
-        const frameID = this.app.nodes.getID(iframe);
-        if (!doc || frameID === undefined) {
-            return;
-        } //log TODO common app.logger
-        this.observeRoot(doc, (docID) => {
-            if (docID === undefined) {
-                console.log("OpenReplay: Document not bound");
-                return;
-            }
-            this.app.send(CreateIFrameDocument(frameID, docID));
-        });
-    }
-}

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

@@ -1,46 +0,0 @@
-import App from '../index';
-export interface Window extends globalThis.Window {
-    HTMLInputElement: typeof HTMLInputElement;
-    HTMLLinkElement: typeof HTMLLinkElement;
-    HTMLStyleElement: typeof HTMLStyleElement;
-    SVGStyleElement: typeof SVGStyleElement;
-    HTMLIFrameElement: typeof HTMLIFrameElement;
-    Text: typeof Text;
-    Element: typeof Element;
-    ShadowRoot: typeof ShadowRoot;
-}
-declare type WindowConstructor = Document | Element | Text | ShadowRoot | HTMLInputElement | HTMLLinkElement | HTMLStyleElement | HTMLIFrameElement;
-declare type Constructor<T> = {
-    new (...args: any[]): T;
-    name: string;
-};
-export declare function isInstance<T extends WindowConstructor>(node: Node, constr: Constructor<T>): node is T;
-export interface Options {
-    obscureTextEmails: boolean;
-    obscureTextNumbers: boolean;
-}
-export default abstract class Observer<AdditionalOptions = {}> {
-    protected readonly app: App;
-    protected readonly context: Window;
-    private readonly observer;
-    private readonly commited;
-    private readonly recents;
-    private readonly indexes;
-    private readonly attributesList;
-    private readonly textSet;
-    private readonly textMasked;
-    protected readonly options: Options & AdditionalOptions;
-    constructor(app: App, options: Partial<Options> & AdditionalOptions, context?: Window);
-    private clear;
-    private sendNodeAttribute;
-    private sendNodeData;
-    private bindNode;
-    private bindTree;
-    private unbindNode;
-    private _commitNode;
-    private commitNode;
-    private commitNodes;
-    protected observeRoot(node: Node, beforeCommit: (id?: number) => unknown): void;
-    disconnect(): void;
-}
-export {};

package/lib/app/observer/observer.js

@@ -1,348 +0,0 @@
-import { stars, hasOpenreplayAttribute } from '../../utils';
-import { CreateElementNode, CreateTextNode, SetNodeData, SetCSSDataURLBased, SetNodeAttribute, SetNodeAttributeURLBased, RemoveNodeAttribute, MoveNode, RemoveNode, } from '../../messages';
-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.options = Object.assign({
-            obscureTextEmails: true,
-            obscureTextNumbers: false,
-        }, options);
-        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) {
-                    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();
-        }));
-        this.commited = [];
-        this.recents = [];
-        this.indexes = [0];
-        this.attributesList = [];
-        this.textSet = new Set();
-        this.textMasked = new Set();
-    }
-    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));
-    }
-    sendNodeData(id, parentElement, data) {
-        if (isInstance(parentElement, HTMLStyleElement) || isInstance(parentElement, SVGStyleElement)) {
-            this.app.send(new SetCSSDataURLBased(id, data, this.app.getBaseHref()));
-            return;
-        }
-        if (this.textMasked.has(id)) {
-            data = data.replace(/[^\f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]/g, '█');
-        }
-        else {
-            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]));
-            }
-        }
-        this.app.send(new SetNodeData(id, data));
-    }
-    bindNode(node) {
-        const r = this.app.nodes.registerNode(node);
-        const id = r[0];
-        this.recents[id] = r[1] || this.recents[id] || 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
-                ? NodeFilter.FILTER_REJECT
-                : NodeFilter.FILTER_ACCEPT,
-        }, 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;
-        // if (isInstance(node, HTMLHtmlElement)) { // ?? TODO: get rid of "specia" cases
-        //   this.indexes[id] = 0
-        // } else {
-        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++) {
-            this.commitNode(id);
-            if (this.recents[id] === true && (node = this.app.nodes.getNode(id))) {
-                this.app.nodes.callNodeCallbacks(node);
-            }
-        }
-        this.clear();
-    }
-    observeRoot(node, beforeCommit) {
-        this.observer.observe(node, {
-            childList: true,
-            attributes: true,
-            characterData: true,
-            subtree: true,
-            attributeOldValue: false,
-            characterDataOldValue: false,
-        });
-        this.bindTree(node);
-        beforeCommit(this.app.nodes.getID(node));
-        this.commitNodes();
-    }
-    disconnect() {
-        this.observer.disconnect();
-        this.clear();
-    }
-}

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

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

package/lib/app/observer/shadow_root_observer.js

@@ -1,18 +0,0 @@
-import Observer from './observer';
-import { CreateIFrameDocument, } from '../../messages';
-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

@@ -1,15 +0,0 @@
-import Observer from './observer';
-import type { Options as BaseOptions } from './observer';
-import type App from '../index';
-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

@@ -1,75 +0,0 @@
-import Observer, { isInstance } from './observer';
-import IFrameObserver from './iframe_observer';
-import ShadowRootObserver from './shadow_root_observer';
-import { CreateDocument, } from '../../messages';
-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);
-            }
-        });
-        const attachShadowNative = Element.prototype.attachShadow;
-        const observer = this;
-        Element.prototype.attachShadow = function () {
-            const shadow = attachShadowNative.apply(this, arguments);
-            if (app.active()) { // Is it necessary here? 
-                // TODO: clearify logic - sub-observation should happen only during main observation.
-                // THat works well with node callbacks, but not here
-                observer.handleShadowRoot(shadow);
-            }
-            return shadow;
-        };
-    }
-    handleIframe(iframe) {
-        let context = null;
-        const handle = () => {
-            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() {
-        this.observeRoot(this.context.document, () => {
-            this.app.send(new CreateDocument());
-        });
-    }
-    disconnect() {
-        this.iframeObservers.forEach(o => o.disconnect());
-        this.iframeObservers = [];
-        this.shadowRootObservers.forEach(o => o.disconnect());
-        this.shadowRootObservers = [];
-        super.disconnect();
-    }
-}