@openreplay/tracker 4.1.7 → 4.1.9

package/cjs/app/index.js

@@ -33,7 +33,7 @@ class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '4.1.7'; // TODO: version compatability check inside each plugin.
+        this.version = '4.1.8'; // TODO: version compatability check inside each plugin.
         this.delay = 0;
         this.projectKey = projectKey;
         this.options = Object.assign({
@@ -276,13 +276,16 @@ class App {
             return Promise.resolve(UnsuccessfulStart('OpenReplay: trying to call `start()` on the instance that has been started already.'));
         }
         this.activityState = ActivityState.Starting;
+        (0, utils_js_1.adjustTimeOrigin)();
         if (startOpts.sessionHash) {
             this.session.applySessionHash(startOpts.sessionHash);
         }
-        if (startOpts.forceNew) { // Reset session metadata only if requested directly
+        if (startOpts.forceNew) {
+            // Reset session metadata only if requested directly
             this.session.reset();
         }
         this.session.assign({
+            // MBTODO: maybe it would make sense to `forceNew` if the `userID` was changed
             userID: startOpts.userID,
             metadata: startOpts.metadata,
         });
@@ -327,7 +330,7 @@ class App {
             if (this.activityState === ActivityState.NotActive) {
                 return Promise.reject('Tracker stopped during authorisation');
             }
-            const { token, userUUID, projectID, beaconSizeLimit, delay, //               derived from token
+            const { token, userUUID, projectID, beaconSizeLimit, delay, //  derived from token
             sessionID, //  derived from token
             startTimestamp, // real startTS (server time), derived from sessionID
              } = r;
@@ -346,9 +349,8 @@ class App {
                 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)));
+            // (Re)send Metadata for the case of a new session
+            Object.entries(this.session.getInfo().metadata).forEach(([key, value]) => this.send((0, messages_gen_js_1.Metadata)(key, value)));
             this.localStorage.setItem(this.options.local_uuid_key, userUUID);
             this.worker.postMessage({
                 type: 'auth',

package/cjs/index.js

@@ -138,7 +138,7 @@ 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: '4.1.7',
+                trackerVersion: '4.1.8',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)

package/cjs/modules/timing.js

@@ -144,9 +144,9 @@ function default_1(app, opts) {
                 const speedIndex = paintBlocks === null
                     ? 0
                     : calculateSpeedIndex(firstContentfulPaint || firstPaint, paintBlocks);
+                const { domContentLoadedEventEnd, navigationStart } = performance.timing;
                 const timeToInteractive = interactiveWindowTickTime === null
-                    ? Math.max(interactiveWindowStartTime, firstContentfulPaint, performance.timing.domContentLoadedEventEnd - performance.timing.navigationStart ||
-                        0)
+                    ? Math.max(interactiveWindowStartTime, firstContentfulPaint, domContentLoadedEventEnd - navigationStart || 0)
                     : 0;
                 app.send((0, messages_gen_js_1.PageRenderTiming)(speedIndex, firstContentfulPaint > visuallyComplete ? firstContentfulPaint : visuallyComplete, timeToInteractive));
             }

package/cjs/modules/viewport.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const utils_js_1 = require("../utils.js");
 const messages_gen_js_1 = require("../app/messages.gen.js");
 function default_1(app) {
     let url, width, height;
-    let navigationStart = performance.timing.navigationStart;
+    let navigationStart;
     const sendSetPageLocation = app.safe(() => {
         const { URL } = document;
         if (URL !== url) {
@@ -25,6 +26,7 @@ function default_1(app) {
         : app.safe(() => app.send((0, messages_gen_js_1.SetPageVisibility)(document.hidden)));
     app.attachStartCallback(() => {
         url = '';
+        navigationStart = (0, utils_js_1.getTimeOrigin)();
         width = height = -1;
         sendSetPageLocation();
         sendSetViewportSize();

package/cjs/utils.d.ts

@@ -1,6 +1,8 @@
 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 function getTimeOrigin(): number;
 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,24 @@
 "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.getTimeOrigin = 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
+// Maybe move to timer/ticker
+let timeOrigin = exports.IN_BROWSER ? Date.now() - performance.now() : 0;
+function adjustTimeOrigin() {
+    timeOrigin = Date.now() - performance.now();
+}
+exports.adjustTimeOrigin = adjustTimeOrigin;
+function getTimeOrigin() {
+    return timeOrigin;
+}
+exports.getTimeOrigin = getTimeOrigin;
+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.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';
@@ -30,7 +30,7 @@ export default class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '4.1.7'; // TODO: version compatability check inside each plugin.
+        this.version = '4.1.8'; // TODO: version compatability check inside each plugin.
         this.delay = 0;
         this.projectKey = projectKey;
         this.options = Object.assign({
@@ -273,13 +273,16 @@ export default class App {
             return Promise.resolve(UnsuccessfulStart('OpenReplay: trying to call `start()` on the instance that has been started already.'));
         }
         this.activityState = ActivityState.Starting;
+        adjustTimeOrigin();
         if (startOpts.sessionHash) {
             this.session.applySessionHash(startOpts.sessionHash);
         }
-        if (startOpts.forceNew) { // Reset session metadata only if requested directly
+        if (startOpts.forceNew) {
+            // Reset session metadata only if requested directly
             this.session.reset();
         }
         this.session.assign({
+            // MBTODO: maybe it would make sense to `forceNew` if the `userID` was changed
             userID: startOpts.userID,
             metadata: startOpts.metadata,
         });
@@ -324,7 +327,7 @@ 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
+            const { token, userUUID, projectID, beaconSizeLimit, delay, //  derived from token
             sessionID, //  derived from token
             startTimestamp, // real startTS (server time), derived from sessionID
              } = r;
@@ -343,9 +346,8 @@ export default class App {
                 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)));
+            // (Re)send Metadata for the case of a new session
+            Object.entries(this.session.getInfo().metadata).forEach(([key, value]) => this.send(Metadata(key, value)));
             this.localStorage.setItem(this.options.local_uuid_key, userUUID);
             this.worker.postMessage({
                 type: 'auth',

package/lib/index.js

@@ -133,7 +133,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: '4.1.7',
+                trackerVersion: '4.1.8',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)

package/lib/modules/timing.js

@@ -142,9 +142,9 @@ export default function (app, opts) {
                 const speedIndex = paintBlocks === null
                     ? 0
                     : calculateSpeedIndex(firstContentfulPaint || firstPaint, paintBlocks);
+                const { domContentLoadedEventEnd, navigationStart } = performance.timing;
                 const timeToInteractive = interactiveWindowTickTime === null
-                    ? Math.max(interactiveWindowStartTime, firstContentfulPaint, performance.timing.domContentLoadedEventEnd - performance.timing.navigationStart ||
-                        0)
+                    ? Math.max(interactiveWindowStartTime, firstContentfulPaint, domContentLoadedEventEnd - navigationStart || 0)
                     : 0;
                 app.send(PageRenderTiming(speedIndex, firstContentfulPaint > visuallyComplete ? firstContentfulPaint : visuallyComplete, timeToInteractive));
             }

package/lib/modules/viewport.js

@@ -1,7 +1,8 @@
+import { getTimeOrigin } from '../utils.js';
 import { SetPageLocation, SetViewportSize, SetPageVisibility } from '../app/messages.gen.js';
 export default function (app) {
     let url, width, height;
-    let navigationStart = performance.timing.navigationStart;
+    let navigationStart;
     const sendSetPageLocation = app.safe(() => {
         const { URL } = document;
         if (URL !== url) {
@@ -23,6 +24,7 @@ export default function (app) {
         : app.safe(() => app.send(SetPageVisibility(document.hidden)));
     app.attachStartCallback(() => {
         url = '';
+        navigationStart = getTimeOrigin();
         width = height = -1;
         sendSetPageLocation();
         sendSetViewportSize();

package/lib/utils.d.ts

@@ -1,6 +1,8 @@
 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 function getTimeOrigin(): number;
 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,18 @@ 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
+// Maybe move to timer/ticker
+let timeOrigin = IN_BROWSER ? Date.now() - performance.now() : 0;
+export function adjustTimeOrigin() {
+    timeOrigin = Date.now() - performance.now();
+}
+export function getTimeOrigin() {
+    return timeOrigin;
+}
+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.9",
   "keywords": [
     "logging",
     "replay"