@openreplay/tracker 4.1.7 → 4.1.8

package/cjs/app/index.d.ts

@@ -109,7 +109,8 @@ export default class App {
     active(): boolean;
     resetNextPageSession(flag: boolean): void;
     private _start;
-    start(...args: Parameters<App['_start']>): Promise<StartPromiseReturn>;
+    start(options?: StartOptions): Promise<StartPromiseReturn>;
     stop(stopWorker?: boolean): void;
+    restart(): void;
 }
 export {};

package/cjs/app/index.js

@@ -83,7 +83,7 @@ class App {
             this.worker.onmessage = ({ data }) => {
                 if (data === 'restart') {
                     this.stop(false);
-                    this.start({}, true);
+                    this.start({ forceNew: true }); // TODO: keep userID & metadata (draw scenarios)
                 }
                 else if (data.type === 'failure') {
                     this.stop(false);
@@ -120,6 +120,7 @@ class App {
     }
     send(message, urgent = false) {
         if (this.activityState === ActivityState.NotActive) {
+            // this.debug.log('SendiTrying to send when not active', message) <- crashing the app
             return;
         }
         this.messages.push(message);
@@ -268,7 +269,8 @@ class App {
             this.sessionStorage.removeItem(this.options.session_reset_key);
         }
     }
-    _start(startOpts = {}, resetByWorker = false) {
+    _start(startOpts) {
+        (0, utils_js_1.adjustTimeOrigin)();
         if (!this.worker) {
             return Promise.resolve(UnsuccessfulStart('No worker found: perhaps, CSP is not set.'));
         }
@@ -279,13 +281,6 @@ class App {
         if (startOpts.sessionHash) {
             this.session.applySessionHash(startOpts.sessionHash);
         }
-        if (startOpts.forceNew) { // Reset session metadata only if requested directly
-            this.session.reset();
-        }
-        this.session.assign({
-            userID: startOpts.userID,
-            metadata: startOpts.metadata,
-        });
         const timestamp = (0, utils_js_1.now)();
         this.worker.postMessage({
             type: 'start',
@@ -296,16 +291,23 @@ class App {
             connAttemptCount: this.options.connAttemptCount,
             connAttemptGap: this.options.connAttemptGap,
         });
-        const lsReset = this.sessionStorage.getItem(this.options.session_reset_key) !== null;
+        this.session.update({
+            // TODO: transparent "session" module logic AND explicit internal api for plugins.
+            // "updating" with old metadata in order to trigger session's UpdateCallbacks.
+            // (for the case of internal .start() calls, like on "restart" webworker signal or assistent connection in tracker-assist )
+            metadata: startOpts.metadata || this.session.getInfo().metadata,
+            userID: startOpts.userID,
+        });
+        const sReset = this.sessionStorage.getItem(this.options.session_reset_key);
         this.sessionStorage.removeItem(this.options.session_reset_key);
-        const needNewSessionID = startOpts.forceNew || lsReset || resetByWorker;
+        const shouldReset = startOpts.forceNew || sReset !== null;
         return window
             .fetch(this.options.ingestPoint + '/v1/web/start', {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
             },
-            body: JSON.stringify(Object.assign(Object.assign({}, this.getTrackerInfo()), { timestamp, userID: this.session.getInfo().userID, token: needNewSessionID ? undefined : this.session.getSessionToken(), deviceMemory: performance_js_1.deviceMemory,
+            body: JSON.stringify(Object.assign(Object.assign({}, this.getTrackerInfo()), { timestamp, userID: this.session.getInfo().userID, token: shouldReset ? undefined : this.session.getSessionToken(), deviceMemory: performance_js_1.deviceMemory,
                 jsHeapSizeLimit: performance_js_1.jsHeapSizeLimit })),
         })
             .then((r) => {
@@ -327,28 +329,23 @@ class App {
             if (this.activityState === ActivityState.NotActive) {
                 return Promise.reject('Tracker stopped during authorisation');
             }
-            const { token, userUUID, projectID, beaconSizeLimit, delay, //               derived from token
-            sessionID, //  derived from token
-            startTimestamp, // real startTS (server time), derived from sessionID
-             } = r;
+            const { token, userUUID, sessionID, projectID, beaconSizeLimit, startTimestamp, // real startTS, derived from sessionID
+            delay, } = r;
             if (typeof token !== 'string' ||
                 typeof userUUID !== 'string' ||
-                (typeof startTimestamp !== 'number' && typeof startTimestamp !== 'undefined') ||
-                typeof sessionID !== 'string' ||
+                //typeof startTimestamp !== 'number' ||
+                //typeof sessionID !== 'string' ||
                 typeof delay !== 'number' ||
                 (typeof beaconSizeLimit !== 'number' && typeof beaconSizeLimit !== 'undefined')) {
                 return Promise.reject(`Incorrect server response: ${JSON.stringify(r)}`);
             }
             this.delay = delay;
+            const prevSessionID = this.session.getInfo().sessionID;
+            if (prevSessionID && prevSessionID !== sessionID) {
+                this.session.reset();
+            }
             this.session.setSessionToken(token);
-            this.session.assign({
-                sessionID,
-                timestamp: startTimestamp || timestamp,
-                projectID,
-            });
-            // Resend Metadata in case of updated sessionID
-            Object.entries(this.session.getInfo().metadata)
-                .forEach(([key, value]) => this.send((0, messages_gen_js_1.Metadata)(key, value)));
+            this.session.update({ sessionID, timestamp: startTimestamp || timestamp, projectID }); // TODO: no no-explicit 'any'
             this.localStorage.setItem(this.options.local_uuid_key, userUUID);
             this.worker.postMessage({
                 type: 'auth',
@@ -379,16 +376,16 @@ class App {
             return UnsuccessfulStart(START_ERROR);
         });
     }
-    start(...args) {
+    start(options = {}) {
         if (!document.hidden) {
-            return this._start(...args);
+            return this._start(options);
         }
         else {
             return new Promise((resolve) => {
                 const onVisibilityChange = () => {
                     if (!document.hidden) {
                         document.removeEventListener('visibilitychange', onVisibilityChange);
-                        resolve(this._start(...args));
+                        resolve(this._start(options));
                     }
                 };
                 document.addEventListener('visibilitychange', onVisibilityChange);
@@ -413,5 +410,9 @@ class App {
             }
         }
     }
+    restart() {
+        this.stop(false);
+        this.start({ forceNew: false });
+    }
 }
 exports.default = App;

package/cjs/app/session.d.ts

@@ -23,7 +23,7 @@ export default class Session {
     constructor(app: App, options: Options);
     attachUpdateCallback(cb: OnUpdateCallback): void;
     private handleUpdate;
-    assign(newInfo: Partial<SessionInfo>): void;
+    update(newInfo: Partial<SessionInfo>): void;
     setMetadata(key: string, value: string): void;
     setUserID(userID: string): void;
     private getPageNumber;

package/cjs/app/session.js

@@ -21,7 +21,7 @@ class Session {
         }
         this.callbacks.forEach((cb) => cb(newInfo));
     }
-    assign(newInfo) {
+    update(newInfo) {
         if (newInfo.userID !== undefined) {
             // TODO clear nullable/undefinable types
             this.userID = newInfo.userID;

package/cjs/modules/timing.js

@@ -70,12 +70,13 @@ function default_1(app, opts) {
     } // Resources are necessary for all timings
     let resources = {};
     function resourceTiming(entry) {
+        var _a;
         if (entry.duration < 0 || !(0, utils_js_1.isURL)(entry.name) || app.isServiceURL(entry.name))
             return;
         if (resources !== null) {
             resources[entry.name] = entry.startTime + entry.duration;
         }
-        app.send((0, messages_gen_js_1.ResourceTiming)(entry.startTime + performance.timing.navigationStart, entry.duration, entry.responseStart && entry.startTime ? entry.responseStart - entry.startTime : 0, entry.transferSize > entry.encodedBodySize ? entry.transferSize - entry.encodedBodySize : 0, entry.encodedBodySize || 0, entry.decodedBodySize || 0, entry.name, entry.initiatorType));
+        app.send((0, messages_gen_js_1.ResourceTiming)(entry.startTime + ((_a = performance === null || performance === void 0 ? void 0 : performance.timing) === null || _a === void 0 ? void 0 : _a.navigationStart), entry.duration, entry.responseStart && entry.startTime ? entry.responseStart - entry.startTime : 0, entry.transferSize > entry.encodedBodySize ? entry.transferSize - entry.encodedBodySize : 0, entry.encodedBodySize || 0, entry.decodedBodySize || 0, entry.name, entry.initiatorType));
     }
     const observer = new PerformanceObserver((list) => list.getEntries().forEach(resourceTiming));
     let prevSessionID;

package/cjs/utils.d.ts

@@ -1,6 +1,7 @@
 export declare const IN_BROWSER: boolean;
 export declare const IS_FIREFOX: false | RegExpMatchArray | null;
 export declare const MAX_STR_LEN = 100000;
+export declare function adjustTimeOrigin(): void;
 export declare const now: () => number;
 export declare const stars: (str: string) => string;
 export declare function normSpaces(str: string): string;

package/cjs/utils.js

@@ -1,23 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasOpenreplayAttribute = exports.getLabelAttribute = exports.deprecationWarn = exports.DOCS_HOST = exports.isURL = exports.normSpaces = exports.stars = exports.now = exports.MAX_STR_LEN = exports.IS_FIREFOX = exports.IN_BROWSER = void 0;
+exports.hasOpenreplayAttribute = exports.getLabelAttribute = exports.deprecationWarn = exports.DOCS_HOST = exports.isURL = exports.normSpaces = exports.stars = exports.now = exports.adjustTimeOrigin = exports.MAX_STR_LEN = exports.IS_FIREFOX = exports.IN_BROWSER = void 0;
 const DEPRECATED_ATTRS = { htmlmasked: 'hidden', masked: 'obscured' };
 exports.IN_BROWSER = !(typeof window === 'undefined');
 exports.IS_FIREFOX = exports.IN_BROWSER && navigator.userAgent.match(/firefox|fxios/i);
 exports.MAX_STR_LEN = 1e5;
-// TODO: time adjustment
-// // Bad to use `performance.timeOrigin || performance.timing.navigationStart`
-// // https://github.com/mdn/content/issues/4713
-// const timeOrigin: number | false =
-//   IN_BROWSER && (Date.now() - performance.now())
-// export const now: () => number =
-//   IN_BROWSER && timeOrigin && !!performance.now
-//     ? () => Math.round(performance.now() + timeOrigin)
-//     : () => Date.now()
-const navigationStart = exports.IN_BROWSER && (performance.timing.navigationStart || performance.timeOrigin);
-// performance.now() is buggy in some browsers
-exports.now = exports.IN_BROWSER && performance.now() && navigationStart
-    ? () => Math.round(performance.now() + navigationStart)
+// Buggy to use `performance.timeOrigin || performance.timing.navigationStart`
+// https://github.com/mdn/content/issues/4713
+let timeOrigin = exports.IN_BROWSER
+    ? Date.now() - performance.now()
+    : 0;
+function adjustTimeOrigin() {
+    timeOrigin = Date.now() - performance.now();
+}
+exports.adjustTimeOrigin = adjustTimeOrigin;
+exports.now = exports.IN_BROWSER && !!performance.now
+    ? () => Math.round(performance.now() + timeOrigin)
     : () => Date.now();
 exports.stars = 'repeat' in String.prototype
     ? (str) => '*'.repeat(str.length)

package/lib/app/index.d.ts

@@ -109,7 +109,8 @@ export default class App {
     active(): boolean;
     resetNextPageSession(flag: boolean): void;
     private _start;
-    start(...args: Parameters<App['_start']>): Promise<StartPromiseReturn>;
+    start(options?: StartOptions): Promise<StartPromiseReturn>;
     stop(stopWorker?: boolean): void;
+    restart(): void;
 }
 export {};

package/lib/app/index.js

@@ -1,5 +1,5 @@
 import { Timestamp, Metadata, UserID } from './messages.gen.js';
-import { now } from '../utils.js';
+import { now, adjustTimeOrigin } from '../utils.js';
 import Nodes from './nodes.js';
 import Observer from './observer/top_observer.js';
 import Sanitizer from './sanitizer.js';
@@ -80,7 +80,7 @@ export default class App {
             this.worker.onmessage = ({ data }) => {
                 if (data === 'restart') {
                     this.stop(false);
-                    this.start({}, true);
+                    this.start({ forceNew: true }); // TODO: keep userID & metadata (draw scenarios)
                 }
                 else if (data.type === 'failure') {
                     this.stop(false);
@@ -117,6 +117,7 @@ export default class App {
     }
     send(message, urgent = false) {
         if (this.activityState === ActivityState.NotActive) {
+            // this.debug.log('SendiTrying to send when not active', message) <- crashing the app
             return;
         }
         this.messages.push(message);
@@ -265,7 +266,8 @@ export default class App {
             this.sessionStorage.removeItem(this.options.session_reset_key);
         }
     }
-    _start(startOpts = {}, resetByWorker = false) {
+    _start(startOpts) {
+        adjustTimeOrigin();
         if (!this.worker) {
             return Promise.resolve(UnsuccessfulStart('No worker found: perhaps, CSP is not set.'));
         }
@@ -276,13 +278,6 @@ export default class App {
         if (startOpts.sessionHash) {
             this.session.applySessionHash(startOpts.sessionHash);
         }
-        if (startOpts.forceNew) { // Reset session metadata only if requested directly
-            this.session.reset();
-        }
-        this.session.assign({
-            userID: startOpts.userID,
-            metadata: startOpts.metadata,
-        });
         const timestamp = now();
         this.worker.postMessage({
             type: 'start',
@@ -293,16 +288,23 @@ export default class App {
             connAttemptCount: this.options.connAttemptCount,
             connAttemptGap: this.options.connAttemptGap,
         });
-        const lsReset = this.sessionStorage.getItem(this.options.session_reset_key) !== null;
+        this.session.update({
+            // TODO: transparent "session" module logic AND explicit internal api for plugins.
+            // "updating" with old metadata in order to trigger session's UpdateCallbacks.
+            // (for the case of internal .start() calls, like on "restart" webworker signal or assistent connection in tracker-assist )
+            metadata: startOpts.metadata || this.session.getInfo().metadata,
+            userID: startOpts.userID,
+        });
+        const sReset = this.sessionStorage.getItem(this.options.session_reset_key);
         this.sessionStorage.removeItem(this.options.session_reset_key);
-        const needNewSessionID = startOpts.forceNew || lsReset || resetByWorker;
+        const shouldReset = startOpts.forceNew || sReset !== null;
         return window
             .fetch(this.options.ingestPoint + '/v1/web/start', {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
             },
-            body: JSON.stringify(Object.assign(Object.assign({}, this.getTrackerInfo()), { timestamp, userID: this.session.getInfo().userID, token: needNewSessionID ? undefined : this.session.getSessionToken(), deviceMemory,
+            body: JSON.stringify(Object.assign(Object.assign({}, this.getTrackerInfo()), { timestamp, userID: this.session.getInfo().userID, token: shouldReset ? undefined : this.session.getSessionToken(), deviceMemory,
                 jsHeapSizeLimit })),
         })
             .then((r) => {
@@ -324,28 +326,23 @@ export default class App {
             if (this.activityState === ActivityState.NotActive) {
                 return Promise.reject('Tracker stopped during authorisation');
             }
-            const { token, userUUID, projectID, beaconSizeLimit, delay, //               derived from token
-            sessionID, //  derived from token
-            startTimestamp, // real startTS (server time), derived from sessionID
-             } = r;
+            const { token, userUUID, sessionID, projectID, beaconSizeLimit, startTimestamp, // real startTS, derived from sessionID
+            delay, } = r;
             if (typeof token !== 'string' ||
                 typeof userUUID !== 'string' ||
-                (typeof startTimestamp !== 'number' && typeof startTimestamp !== 'undefined') ||
-                typeof sessionID !== 'string' ||
+                //typeof startTimestamp !== 'number' ||
+                //typeof sessionID !== 'string' ||
                 typeof delay !== 'number' ||
                 (typeof beaconSizeLimit !== 'number' && typeof beaconSizeLimit !== 'undefined')) {
                 return Promise.reject(`Incorrect server response: ${JSON.stringify(r)}`);
             }
             this.delay = delay;
+            const prevSessionID = this.session.getInfo().sessionID;
+            if (prevSessionID && prevSessionID !== sessionID) {
+                this.session.reset();
+            }
             this.session.setSessionToken(token);
-            this.session.assign({
-                sessionID,
-                timestamp: startTimestamp || timestamp,
-                projectID,
-            });
-            // Resend Metadata in case of updated sessionID
-            Object.entries(this.session.getInfo().metadata)
-                .forEach(([key, value]) => this.send(Metadata(key, value)));
+            this.session.update({ sessionID, timestamp: startTimestamp || timestamp, projectID }); // TODO: no no-explicit 'any'
             this.localStorage.setItem(this.options.local_uuid_key, userUUID);
             this.worker.postMessage({
                 type: 'auth',
@@ -376,16 +373,16 @@ export default class App {
             return UnsuccessfulStart(START_ERROR);
         });
     }
-    start(...args) {
+    start(options = {}) {
         if (!document.hidden) {
-            return this._start(...args);
+            return this._start(options);
         }
         else {
             return new Promise((resolve) => {
                 const onVisibilityChange = () => {
                     if (!document.hidden) {
                         document.removeEventListener('visibilitychange', onVisibilityChange);
-                        resolve(this._start(...args));
+                        resolve(this._start(options));
                     }
                 };
                 document.addEventListener('visibilitychange', onVisibilityChange);
@@ -410,4 +407,8 @@ export default class App {
             }
         }
     }
+    restart() {
+        this.stop(false);
+        this.start({ forceNew: false });
+    }
 }

package/lib/app/session.d.ts

@@ -23,7 +23,7 @@ export default class Session {
     constructor(app: App, options: Options);
     attachUpdateCallback(cb: OnUpdateCallback): void;
     private handleUpdate;
-    assign(newInfo: Partial<SessionInfo>): void;
+    update(newInfo: Partial<SessionInfo>): void;
     setMetadata(key: string, value: string): void;
     setUserID(userID: string): void;
     private getPageNumber;

package/lib/app/session.js

@@ -19,7 +19,7 @@ export default class Session {
         }
         this.callbacks.forEach((cb) => cb(newInfo));
     }
-    assign(newInfo) {
+    update(newInfo) {
         if (newInfo.userID !== undefined) {
             // TODO clear nullable/undefinable types
             this.userID = newInfo.userID;

package/lib/modules/timing.js

@@ -68,12 +68,13 @@ export default function (app, opts) {
     } // Resources are necessary for all timings
     let resources = {};
     function resourceTiming(entry) {
+        var _a;
         if (entry.duration < 0 || !isURL(entry.name) || app.isServiceURL(entry.name))
             return;
         if (resources !== null) {
             resources[entry.name] = entry.startTime + entry.duration;
         }
-        app.send(ResourceTiming(entry.startTime + performance.timing.navigationStart, entry.duration, entry.responseStart && entry.startTime ? entry.responseStart - entry.startTime : 0, entry.transferSize > entry.encodedBodySize ? entry.transferSize - entry.encodedBodySize : 0, entry.encodedBodySize || 0, entry.decodedBodySize || 0, entry.name, entry.initiatorType));
+        app.send(ResourceTiming(entry.startTime + ((_a = performance === null || performance === void 0 ? void 0 : performance.timing) === null || _a === void 0 ? void 0 : _a.navigationStart), entry.duration, entry.responseStart && entry.startTime ? entry.responseStart - entry.startTime : 0, entry.transferSize > entry.encodedBodySize ? entry.transferSize - entry.encodedBodySize : 0, entry.encodedBodySize || 0, entry.decodedBodySize || 0, entry.name, entry.initiatorType));
     }
     const observer = new PerformanceObserver((list) => list.getEntries().forEach(resourceTiming));
     let prevSessionID;

package/lib/utils.d.ts

@@ -1,6 +1,7 @@
 export declare const IN_BROWSER: boolean;
 export declare const IS_FIREFOX: false | RegExpMatchArray | null;
 export declare const MAX_STR_LEN = 100000;
+export declare function adjustTimeOrigin(): void;
 export declare const now: () => number;
 export declare const stars: (str: string) => string;
 export declare function normSpaces(str: string): string;

package/lib/utils.js

@@ -2,19 +2,16 @@ const DEPRECATED_ATTRS = { htmlmasked: 'hidden', masked: 'obscured' };
 export const IN_BROWSER = !(typeof window === 'undefined');
 export const IS_FIREFOX = IN_BROWSER && navigator.userAgent.match(/firefox|fxios/i);
 export const MAX_STR_LEN = 1e5;
-// TODO: time adjustment
-// // Bad to use `performance.timeOrigin || performance.timing.navigationStart`
-// // https://github.com/mdn/content/issues/4713
-// const timeOrigin: number | false =
-//   IN_BROWSER && (Date.now() - performance.now())
-// export const now: () => number =
-//   IN_BROWSER && timeOrigin && !!performance.now
-//     ? () => Math.round(performance.now() + timeOrigin)
-//     : () => Date.now()
-const navigationStart = IN_BROWSER && (performance.timing.navigationStart || performance.timeOrigin);
-// performance.now() is buggy in some browsers
-export const now = IN_BROWSER && performance.now() && navigationStart
-    ? () => Math.round(performance.now() + navigationStart)
+// Buggy to use `performance.timeOrigin || performance.timing.navigationStart`
+// https://github.com/mdn/content/issues/4713
+let timeOrigin = IN_BROWSER
+    ? Date.now() - performance.now()
+    : 0;
+export function adjustTimeOrigin() {
+    timeOrigin = Date.now() - performance.now();
+}
+export const now = IN_BROWSER && !!performance.now
+    ? () => Math.round(performance.now() + timeOrigin)
     : () => Date.now();
 export const stars = 'repeat' in String.prototype
     ? (str) => '*'.repeat(str.length)

package/package.json

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