@openreplay/tracker 3.4.13 → 3.4.17-beta.0

package/cjs/modules/input.js

@@ -3,7 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInputLabel = void 0;
 const utils_js_1 = require("../utils.js");
 const index_js_1 = require("../messages/index.js");
-function isInput(node) {
+function isTextEditable(node) {
+    if (node instanceof HTMLTextAreaElement) {
+        return true;
+    }
     if (!(node instanceof HTMLInputElement)) {
         return false;
     }
@@ -111,7 +114,7 @@ function default_1(app, opts) {
     app.ticker.attach(() => {
         inputValues.forEach((value, id) => {
             const node = app.nodes.getNode(id);
-            if (!isInput(node)) {
+            if (!isTextEditable(node)) {
                 inputValues.delete(id);
                 return;
             }
@@ -142,7 +145,7 @@ function default_1(app, opts) {
         if (id === undefined) {
             return;
         }
-        if (isInput(node)) {
+        if (isTextEditable(node)) {
             inputValues.set(id, node.value);
             sendInputValue(id, node);
             return;

package/cjs/modules/mouse.js

@@ -85,7 +85,7 @@ function default_1(app) {
             tag === 'LI' ||
             target.onclick != null ||
             target.getAttribute('role') === 'button') {
-            const label = app.observer.getInnerTextSecure(target);
+            const label = app.sanitizer.getInnerTextSecure(target);
             return (0, utils_js_1.normSpaces)(label).slice(0, 100);
         }
         return '';

package/lib/app/context.d.ts

@@ -0,0 +1,18 @@
+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 declare function inDocument(node: Node): boolean;
+export {};

package/lib/app/context.js

@@ -0,0 +1,43 @@
+// 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];
+}
+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)) {
+            return true;
+        }
+        // @ts-ignore
+        context = context.parent;
+    }
+    return false;
+}

package/lib/app/index.d.ts

@@ -1,19 +1,21 @@
 import Message from "../messages/message.js";
 import Nodes from "./nodes.js";
-import Observer from "./observer.js";
+import Sanitizer from "./sanitizer.js";
 import Ticker from "./ticker.js";
-import type { Options as ObserverOptions } from "./observer.js";
+import type { Options as ObserverOptions } from "./observer/top_observer.js";
+import type { Options as SanitizerOptions } from "./sanitizer.js";
 import type { Options as WebworkerOptions } from "../messages/webworker.js";
 export interface OnStartInfo {
     sessionID: string;
     sessionToken: string;
     userUUID: string;
 }
-export declare type Options = {
+declare type AppOptions = {
     revID: string;
     node_id: string;
     session_token_key: string;
     session_pageno_key: string;
+    session_reset_key: string;
     local_uuid_key: string;
     ingestPoint: string;
     resourceBaseHref: string | null;
@@ -21,7 +23,8 @@ export declare type Options = {
     __debug_report_edp: string | null;
     __debug_log: boolean;
     onStart?: (info: OnStartInfo) => void;
-} & ObserverOptions & WebworkerOptions;
+} & WebworkerOptions;
+export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
 declare type Callback = () => void;
 declare type CommitCallback = (messages: Array<Message>) => void;
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
@@ -29,8 +32,9 @@ export default class App {
     readonly nodes: Nodes;
     readonly ticker: Ticker;
     readonly projectKey: string;
+    readonly sanitizer: Sanitizer;
     private readonly messages;
-    readonly observer: Observer;
+    private readonly observer;
     private readonly startCallbacks;
     private readonly stopCallbacks;
     private readonly commitCallbacks;
@@ -40,7 +44,7 @@ export default class App {
     private isActive;
     private version;
     private readonly worker?;
-    constructor(projectKey: string, sessionToken: string | null | undefined, opts: Partial<Options>);
+    constructor(projectKey: string, sessionToken: string | null | undefined, options: Partial<Options>);
     private _debug;
     send(message: Message, urgent?: boolean): void;
     private commit;
@@ -58,6 +62,7 @@ export default class App {
     resolveResourceURL(resourceURL: string): string;
     isServiceURL(url: string): boolean;
     active(): boolean;
+    resetNextPageSession(flag: boolean): void;
     private _start;
     start(reset?: boolean): Promise<OnStartInfo>;
     stop(): void;

package/lib/app/index.js

@@ -1,42 +1,42 @@
 import { timestamp, log, warn } from "../utils.js";
 import { Timestamp } from "../messages/index.js";
 import Nodes from "./nodes.js";
-import Observer from "./observer.js";
+import Observer from "./observer/top_observer.js";
+import Sanitizer from "./sanitizer.js";
 import Ticker from "./ticker.js";
 import { deviceMemory, jsHeapSizeLimit } from "../modules/performance.js";
 // TODO: use backendHost only
 export const DEFAULT_INGEST_POINT = 'https://api.openreplay.com/ingest';
 export default class App {
-    constructor(projectKey, sessionToken, opts) {
+    constructor(projectKey, sessionToken, options) {
         this.messages = [];
         this.startCallbacks = [];
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this._sessionID = null;
         this.isActive = false;
-        this.version = '3.4.13';
+        this.version = '3.4.17-beta.0';
         this.projectKey = projectKey;
         this.options = Object.assign({
             revID: '',
             node_id: '__openreplay_id',
             session_token_key: '__openreplay_token',
             session_pageno_key: '__openreplay_pageno',
+            session_reset_key: '__openreplay_reset',
             local_uuid_key: '__openreplay_uuid',
             ingestPoint: DEFAULT_INGEST_POINT,
             resourceBaseHref: null,
             __is_snippet: false,
             __debug_report_edp: null,
             __debug_log: false,
-            obscureTextEmails: true,
-            obscureTextNumbers: false,
-            captureIFrames: false,
-        }, opts);
+        }, options);
         if (sessionToken != null) {
             sessionStorage.setItem(this.options.session_token_key, sessionToken);
         }
         this.revID = this.options.revID;
+        this.sanitizer = new Sanitizer(this, options);
         this.nodes = new Nodes(this.options.node_id);
-        this.observer = new Observer(this, this.options);
+        this.observer = new Observer(this, options);
         this.ticker = new Ticker(this);
         this.ticker.attach(() => this.commit());
         try {
@@ -178,6 +178,14 @@ export default class App {
     active() {
         return this.isActive;
     }
+    resetNextPageSession(flag) {
+        if (flag) {
+            sessionStorage.setItem(this.options.session_reset_key, 't');
+        }
+        else {
+            sessionStorage.removeItem(this.options.session_reset_key);
+        }
+    }
     _start(reset) {
         if (!this.isActive) {
             if (!this.worker) {
@@ -200,18 +208,20 @@ export default class App {
                 connAttemptGap: this.options.connAttemptGap,
             };
             this.worker.postMessage(messageData); // brings delay of 10th ms?
-            let token = sessionStorage.getItem(this.options.session_token_key);
-            const tokenIsActive = localStorage.getItem("__or_at_" + token);
-            if (tokenIsActive) {
-                token = null;
-            }
+            // let token = sessionStorage.getItem(this.options.session_token_key)
+            // const tokenIsActive = localStorage.getItem("__or_at_" + token)
+            // if (tokenIsActive) {
+            //   token = null
+            // }
+            const sReset = sessionStorage.getItem(this.options.session_reset_key);
+            sessionStorage.removeItem(this.options.session_reset_key);
             return window.fetch(this.options.ingestPoint + '/v1/web/start', {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json',
                 },
                 body: JSON.stringify({
-                    token,
+                    token: sessionStorage.getItem(this.options.session_token_key),
                     userUUID: localStorage.getItem(this.options.local_uuid_key),
                     projectKey: this.projectKey,
                     revID: this.revID,
@@ -220,7 +230,7 @@ export default class App {
                     isSnippet: this.options.__is_snippet,
                     deviceMemory,
                     jsHeapSizeLimit,
-                    reset,
+                    reset: reset || sReset !== null,
                 }),
             })
                 .then(r => {
@@ -242,13 +252,13 @@ export default class App {
                 }
                 sessionStorage.setItem(this.options.session_token_key, token);
                 localStorage.setItem(this.options.local_uuid_key, userUUID);
-                localStorage.setItem("__or_at_" + token, "true");
-                this.attachEventListener(window, 'beforeunload', () => {
-                    localStorage.removeItem("__or_at_" + token);
-                }, false);
-                this.attachEventListener(window, 'pagehide', () => {
-                    localStorage.removeItem("__or_at_" + token);
-                }, false);
+                // localStorage.setItem("__or_at_" + token, "true")
+                // this.attachEventListener(window, 'beforeunload', ()=>{
+                //   localStorage.removeItem("__or_at_" + token)
+                // }, false);
+                // this.attachEventListener(window, 'pagehide', ()=>{
+                //   localStorage.removeItem("__or_at_" + token)
+                // }, false);
                 if (typeof sessionID === 'string') {
                     this._sessionID = sessionID;
                 }
@@ -298,6 +308,7 @@ export default class App {
                 if (this.worker) {
                     this.worker.postMessage("stop");
                 }
+                this.sanitizer.clear();
                 this.observer.disconnect();
                 this.nodes.clear();
                 this.ticker.stop();

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

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

package/lib/app/observer/iframe_observer.js

@@ -0,0 +1,19 @@
+import Observer from "./observer.js";
+import { CreateIFrameDocument } from "../../messages/index.js";
+export default class IFrameObserver extends Observer {
+    observe(iframe) {
+        const doc = iframe.contentDocument;
+        const hostID = this.app.nodes.getID(iframe);
+        if (!doc || hostID === undefined) {
+            return;
+        } //log TODO common app.logger
+        // Have to observe document, because the inner <html> might be changed
+        this.observeRoot(doc, (docID) => {
+            if (docID === undefined) {
+                console.log("OpenReplay: Iframe document not bound");
+                return;
+            }
+            this.app.send(CreateIFrameDocument(hostID, docID));
+        });
+    }
+}

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

@@ -0,0 +1,25 @@
+import App from "../index.js";
+export default abstract class Observer {
+    protected readonly app: App;
+    protected readonly context: Window;
+    private readonly observer;
+    private readonly commited;
+    private readonly recents;
+    private readonly myNodes;
+    private readonly indexes;
+    private readonly attributesList;
+    private readonly textSet;
+    private readonly inUpperContext;
+    constructor(app: App, 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, nodeToBind?: Node): void;
+    disconnect(): void;
+}