@openreplay/tracker 14.0.9 → 14.0.10-beta.2

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 14.0.10
+
+- adjust timestamps for messages from tracker instances inside child iframes (if they were loaded later)
+- restart child trackers if parent tracker is restarted
+- fixes for general stability of crossdomain iframe tracking
+
 # 14.0.9
 
 - more stable crossdomain iframe tracking (refactored child/parent process discovery)

package/cjs/app/index.d.ts

@@ -18,6 +18,12 @@ export interface StartOptions {
     forceNew?: boolean;
     sessionHash?: string;
     assistOnly?: boolean;
+    /**
+     * @deprecated We strongly advise to use .start().then instead.
+     *
+     * This method is kept for snippet compatibility only
+     * */
+    startCallback?: (result: StartPromiseReturn) => void;
 }
 interface OnStartInfo {
     sessionID: string;
@@ -37,6 +43,12 @@ declare const SuccessfulStart: (body: OnStartInfo) => SuccessfulStart;
 export type StartPromiseReturn = SuccessfulStart | UnsuccessfulStart;
 type StartCallback = (i: OnStartInfo) => void;
 type CommitCallback = (messages: Array<Message>) => void;
+declare enum ActivityState {
+    NotActive = 0,
+    Starting = 1,
+    Active = 2,
+    ColdStart = 3
+}
 type AppOptions = {
     revID: string;
     node_id: string;
@@ -94,12 +106,18 @@ type AppOptions = {
         parentDomain?: string;
     };
     network?: NetworkOptions;
+    /**
+     * use this flag if you're using Angular
+     * basically goes around window.Zone api changes to mutation observer
+     * and event listeners
+     * */
+    angularMode?: boolean;
 } & WebworkerOptions & SessOptions;
 export type Options = AppOptions & ObserverOptions & SanitizerOptions;
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
     private readonly signalError;
-    private readonly insideIframe;
+    readonly insideIframe: boolean;
     readonly nodes: Nodes;
     readonly ticker: Ticker;
     readonly projectKey: string;
@@ -140,18 +158,29 @@ export default class App {
     private rootId;
     private pageFrames;
     private frameOderNumber;
-    private readonly initialHostName;
     private features;
     constructor(projectKey: string, sessionToken: string | undefined, options: Partial<Options>, signalError: (error: string, apis: string[]) => void, insideIframe: boolean);
     /** used by child iframes for crossdomain only */
     parentActive: boolean;
     checkStatus: () => boolean;
-    /** used by child iframes for crossdomain only */
-    /** track app instances in crossdomain child iframes */
-    crossdomainIframesModule: () => void;
+    parentCrossDomainFrameListener: (event: MessageEvent) => void;
+    /**
+     * context ids for iframes,
+     * order is not so important as long as its consistent
+     * */
+    trackedFrames: string[];
+    crossDomainIframeListener: (event: MessageEvent) => void;
+    /**
+     * { command : [remaining iframes] }
+     * + order of commands
+     **/
+    pollingQueue: Record<string, any>;
+    private readonly addCommand;
+    bootChildrenFrames: () => Promise<void>;
+    killChildrenFrames: () => void;
     signalIframeTracker: () => void;
     startTimeout: ReturnType<typeof setTimeout> | null;
-    private allowAppStart;
+    allowAppStart(): void;
     private checkNodeId;
     private initWorker;
     private handleWorkerMsg;
@@ -176,9 +205,9 @@ export default class App {
     timestamp(): number;
     safe<T extends (this: any, ...args: any[]) => void>(fn: T): T;
     attachCommitCallback(cb: CommitCallback): void;
-    attachStartCallback(cb: StartCallback, useSafe?: boolean): void;
-    attachStopCallback(cb: () => any, useSafe?: boolean): void;
-    attachEventListener(target: EventTarget, type: string, listener: EventListener, useSafe?: boolean, useCapture?: boolean): void;
+    attachStartCallback: (cb: StartCallback, useSafe?: boolean) => void;
+    attachStopCallback: (cb: () => any, useSafe?: boolean) => void;
+    attachEventListener: (target: EventTarget, type: string, listener: EventListener, useSafe?: boolean, useCapture?: boolean) => void;
     checkRequiredVersion(version: string): boolean;
     private getTrackerInfo;
     getSessionInfo(): {
@@ -260,6 +289,7 @@ export default class App {
     getUxtId(): number | null;
     waitStart(): Promise<unknown>;
     waitStarted(): Promise<unknown>;
+    waitStatus(status: ActivityState): Promise<unknown>;
     /**
      * basically we ask other tabs during constructor
      * and here we just apply 10ms delay just in case