@openreplay/tracker 3.5.9 → 3.5.10

package/cjs/app/index.d.ts

@@ -8,16 +8,18 @@ import type { Options as ObserverOptions } from "./observer/top_observer.js";
 import type { Options as SanitizerOptions } from "./sanitizer.js";
 import type { Options as LoggerOptions } from "./logger.js";
 import type { Options as WebworkerOptions } from "../../webworker/types.js";
-export interface OnStartInfo {
-    sessionID: string;
-    sessionToken: string;
-    userUUID: string;
-}
 export interface StartOptions {
     userID?: string;
     metadata?: Record<string, string>;
     forceNew?: boolean;
 }
+export interface OnStartInfo {
+    sessionID: string;
+    sessionToken: string;
+    userUUID: string;
+}
+declare type StartCallback = (i: OnStartInfo) => void;
+declare type CommitCallback = (messages: Array<Message>) => void;
 declare type AppOptions = {
     revID: string;
     node_id: string;
@@ -31,11 +33,9 @@ declare type AppOptions = {
     __is_snippet: boolean;
     __debug_report_edp: string | null;
     __debug__?: LoggerOptions;
-    onStart?: (info: OnStartInfo) => void;
+    onStart?: StartCallback;
 } & WebworkerOptions;
 export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
-declare type Callback = () => void;
-declare type CommitCallback = (messages: Array<Message>) => void;
 export declare const CANCELED = "canceled";
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
@@ -58,13 +58,12 @@ export default class App {
     private readonly worker?;
     constructor(projectKey: string, sessionToken: string | null | undefined, options: Partial<Options>);
     private _debug;
-    private readonly preStartMessages;
     send(message: Message, urgent?: boolean): void;
     private commit;
     safe<T extends (...args: any[]) => void>(fn: T): T;
     attachCommitCallback(cb: CommitCallback): void;
-    attachStartCallback(cb: Callback): void;
-    attachStopCallback(cb: Callback): void;
+    attachStartCallback(cb: StartCallback): void;
+    attachStopCallback(cb: Function): void;
     attachEventListener(target: EventTarget, type: string, listener: EventListener, useSafe?: boolean, useCapture?: boolean): void;
     checkRequiredVersion(version: string): boolean;
     private getStartInfo;

package/cjs/app/index.js

@@ -29,8 +29,7 @@ class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '3.5.9'; // TODO: version compatability check inside each plugin.
-        this.preStartMessages = [];
+        this.version = '3.5.10'; // TODO: version compatability check inside each plugin.
         this.projectKey = projectKey;
         this.options = Object.assign({
             revID: '',
@@ -103,15 +102,12 @@ class App {
         if (this.activityState === ActivityState.NotActive) {
             return;
         }
-        if (this.activityState === ActivityState.Starting) {
-            this.preStartMessages.push(message);
-        }
-        if (this.preStartMessages.length) {
-            this.messages.push(...this.preStartMessages);
-            this.preStartMessages.length = 0;
-        }
         this.messages.push(message);
-        if (urgent) {
+        // TODO: commit on start if there were `urgent` sends; 
+        // Clearify where urgent can be used for;
+        // Clearify workflow for each type of message in case it was sent before start 
+        //      (like Fetch before start; maybe add an option "preCapture: boolean" or sth alike)
+        if (this.activityState === ActivityState.Active && urgent) {
             this.commit();
         }
     }
@@ -292,12 +288,12 @@ class App {
                 beaconSizeLimit
             };
             this.worker.postMessage(startWorkerMsg);
-            this.startCallbacks.forEach((cb) => cb());
+            const onStartInfo = { sessionToken: token, userUUID, sessionID };
+            this.startCallbacks.forEach((cb) => cb(onStartInfo));
             this.observer.observe();
             this.ticker.start();
             this.notify.log("OpenReplay tracking started.");
             // TODO: get rid of onStart
-            const onStartInfo = { sessionToken: token, userUUID, sessionID };
             if (typeof this.options.onStart === 'function') {
                 this.options.onStart(onStartInfo);
             }

package/cjs/index.js

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

package/cjs/modules/timing.js

@@ -70,18 +70,6 @@ function default_1(app, opts) {
     if (!options.captureResourceTimings) {
         return;
     } // Resources are necessary for all timings
-    const mQueue = [];
-    function sendOnStart(m) {
-        if (app.active()) {
-            app.send(m);
-        }
-        else {
-            mQueue.push(m);
-        }
-    }
-    app.attachStartCallback(function () {
-        mQueue.forEach(m => app.send(m));
-    });
     let resources = {};
     function resourceTiming(entry) {
         if (entry.duration < 0 || !(0, utils_js_1.isURL)(entry.name) || app.isServiceURL(entry.name))
@@ -89,15 +77,24 @@ function default_1(app, opts) {
         if (resources !== null) {
             resources[entry.name] = entry.startTime + entry.duration;
         }
-        sendOnStart(new index_js_1.ResourceTiming(entry.startTime + performance.timing.navigationStart, entry.duration, entry.responseStart && entry.startTime
+        app.send(new index_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));
     }
     const observer = new PerformanceObserver((list) => list.getEntries().forEach(resourceTiming));
-    performance.getEntriesByType('resource').forEach(resourceTiming);
-    observer.observe({ entryTypes: ['resource'] });
+    let prevSessionID;
+    app.attachStartCallback(function ({ sessionID }) {
+        if (sessionID !== prevSessionID) { // Send past page resources on a newly started session
+            performance.getEntriesByType('resource').forEach(resourceTiming);
+            prevSessionID = sessionID;
+        }
+        observer.observe({ entryTypes: ['resource'] });
+    });
+    app.attachStopCallback(function () {
+        observer.disconnect();
+    });
     let firstPaint = 0, firstContentfulPaint = 0;
     if (options.capturePageLoadTimings) {
         let pageLoadTimingSent = false;

package/lib/app/index.d.ts

@@ -8,16 +8,18 @@ import type { Options as ObserverOptions } from "./observer/top_observer.js";
 import type { Options as SanitizerOptions } from "./sanitizer.js";
 import type { Options as LoggerOptions } from "./logger.js";
 import type { Options as WebworkerOptions } from "../../webworker/types.js";
-export interface OnStartInfo {
-    sessionID: string;
-    sessionToken: string;
-    userUUID: string;
-}
 export interface StartOptions {
     userID?: string;
     metadata?: Record<string, string>;
     forceNew?: boolean;
 }
+export interface OnStartInfo {
+    sessionID: string;
+    sessionToken: string;
+    userUUID: string;
+}
+declare type StartCallback = (i: OnStartInfo) => void;
+declare type CommitCallback = (messages: Array<Message>) => void;
 declare type AppOptions = {
     revID: string;
     node_id: string;
@@ -31,11 +33,9 @@ declare type AppOptions = {
     __is_snippet: boolean;
     __debug_report_edp: string | null;
     __debug__?: LoggerOptions;
-    onStart?: (info: OnStartInfo) => void;
+    onStart?: StartCallback;
 } & WebworkerOptions;
 export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
-declare type Callback = () => void;
-declare type CommitCallback = (messages: Array<Message>) => void;
 export declare const CANCELED = "canceled";
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
@@ -58,13 +58,12 @@ export default class App {
     private readonly worker?;
     constructor(projectKey: string, sessionToken: string | null | undefined, options: Partial<Options>);
     private _debug;
-    private readonly preStartMessages;
     send(message: Message, urgent?: boolean): void;
     private commit;
     safe<T extends (...args: any[]) => void>(fn: T): T;
     attachCommitCallback(cb: CommitCallback): void;
-    attachStartCallback(cb: Callback): void;
-    attachStopCallback(cb: Callback): void;
+    attachStartCallback(cb: StartCallback): void;
+    attachStopCallback(cb: Function): void;
     attachEventListener(target: EventTarget, type: string, listener: EventListener, useSafe?: boolean, useCapture?: boolean): void;
     checkRequiredVersion(version: string): boolean;
     private getStartInfo;

package/lib/app/index.js

@@ -26,8 +26,7 @@ export default class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '3.5.9'; // TODO: version compatability check inside each plugin.
-        this.preStartMessages = [];
+        this.version = '3.5.10'; // TODO: version compatability check inside each plugin.
         this.projectKey = projectKey;
         this.options = Object.assign({
             revID: '',
@@ -100,15 +99,12 @@ export default class App {
         if (this.activityState === ActivityState.NotActive) {
             return;
         }
-        if (this.activityState === ActivityState.Starting) {
-            this.preStartMessages.push(message);
-        }
-        if (this.preStartMessages.length) {
-            this.messages.push(...this.preStartMessages);
-            this.preStartMessages.length = 0;
-        }
         this.messages.push(message);
-        if (urgent) {
+        // TODO: commit on start if there were `urgent` sends; 
+        // Clearify where urgent can be used for;
+        // Clearify workflow for each type of message in case it was sent before start 
+        //      (like Fetch before start; maybe add an option "preCapture: boolean" or sth alike)
+        if (this.activityState === ActivityState.Active && urgent) {
             this.commit();
         }
     }
@@ -289,12 +285,12 @@ export default class App {
                 beaconSizeLimit
             };
             this.worker.postMessage(startWorkerMsg);
-            this.startCallbacks.forEach((cb) => cb());
+            const onStartInfo = { sessionToken: token, userUUID, sessionID };
+            this.startCallbacks.forEach((cb) => cb(onStartInfo));
             this.observer.observe();
             this.ticker.start();
             this.notify.log("OpenReplay tracking started.");
             // TODO: get rid of onStart
-            const onStartInfo = { sessionToken: token, userUUID, sessionID };
             if (typeof this.options.onStart === 'function') {
                 this.options.onStart(onStartInfo);
             }

package/lib/index.js

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

package/lib/modules/timing.js

@@ -68,18 +68,6 @@ export default function (app, opts) {
     if (!options.captureResourceTimings) {
         return;
     } // Resources are necessary for all timings
-    const mQueue = [];
-    function sendOnStart(m) {
-        if (app.active()) {
-            app.send(m);
-        }
-        else {
-            mQueue.push(m);
-        }
-    }
-    app.attachStartCallback(function () {
-        mQueue.forEach(m => app.send(m));
-    });
     let resources = {};
     function resourceTiming(entry) {
         if (entry.duration < 0 || !isURL(entry.name) || app.isServiceURL(entry.name))
@@ -87,15 +75,24 @@ export default function (app, opts) {
         if (resources !== null) {
             resources[entry.name] = entry.startTime + entry.duration;
         }
-        sendOnStart(new ResourceTiming(entry.startTime + performance.timing.navigationStart, entry.duration, entry.responseStart && entry.startTime
+        app.send(new 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));
     }
     const observer = new PerformanceObserver((list) => list.getEntries().forEach(resourceTiming));
-    performance.getEntriesByType('resource').forEach(resourceTiming);
-    observer.observe({ entryTypes: ['resource'] });
+    let prevSessionID;
+    app.attachStartCallback(function ({ sessionID }) {
+        if (sessionID !== prevSessionID) { // Send past page resources on a newly started session
+            performance.getEntriesByType('resource').forEach(resourceTiming);
+            prevSessionID = sessionID;
+        }
+        observer.observe({ entryTypes: ['resource'] });
+    });
+    app.attachStopCallback(function () {
+        observer.disconnect();
+    });
     let firstPaint = 0, firstContentfulPaint = 0;
     if (options.capturePageLoadTimings) {
         let pageLoadTimingSent = false;

package/package.json

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