@openreplay/tracker 3.6.0-beta.0 → 3.6.0

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

@@ -3,7 +3,8 @@ import App from '../index.js';
 export interface Options {
     captureIFrames: boolean;
 }
-declare type ContextCallback = (context: Window & typeof globalThis) => void;
+declare type Context = Window & typeof globalThis;
+declare type ContextCallback = (context: Context) => void;
 declare type Offset = {
     top: number;
     left: number;
@@ -12,6 +13,7 @@ export default class TopObserver extends Observer {
     private readonly options;
     constructor(app: App, options: Partial<Options>);
     private readonly contextCallbacks;
+    private readonly contextsSet;
     attachContextCallback(cb: ContextCallback): void;
     getDocumentOffset(doc: Document): Offset;
     private iframeObservers;

package/lib/app/observer/top_observer.js

@@ -13,6 +13,8 @@ export default class TopObserver extends Observer {
     constructor(app, options) {
         super(app, true);
         this.contextCallbacks = [];
+        // Attached once per Tracker instance
+        this.contextsSet = new Set();
         this.iframeObservers = [];
         this.shadowRootObservers = [];
         this.options = Object.assign({
@@ -33,7 +35,6 @@ export default class TopObserver extends Observer {
             }
         });
     }
-    // Attached once per Tracker instance
     attachContextCallback(cb) {
         this.contextCallbacks.push(cb);
     }
@@ -68,7 +69,12 @@ export default class TopObserver extends Observer {
                     };
                 };
             }
-            if (currentWin && currentWin !== win) {
+            if (currentWin &&
+                // Sometimes currentWin.window is null (not in specification). Such window object is not functional
+                currentWin === currentWin.window &&
+                !this.contextsSet.has(currentWin) // for each context callbacks called once per Tracker (TopObserver) instance
+            ) {
+                this.contextsSet.add(currentWin);
                 //@ts-ignore https://github.com/microsoft/TypeScript/issues/41684
                 this.contextCallbacks.forEach((cb) => cb(currentWin));
                 win = currentWin;

package/lib/app/session.d.ts

@@ -4,6 +4,7 @@ interface SessionInfo {
     metadata: Record<string, string>;
     userID: string | null;
     timestamp: number;
+    projectID?: string;
 }
 declare type OnUpdateCallback = (i: Partial<SessionInfo>) => void;
 export declare type Options = {
@@ -12,12 +13,13 @@ export declare type Options = {
 };
 export default class Session {
     private readonly app;
-    private options;
+    private readonly options;
     private metadata;
     private userID;
     private sessionID;
     private readonly callbacks;
     private timestamp;
+    private projectID;
     constructor(app: App, options: Options);
     attachUpdateCallback(cb: OnUpdateCallback): void;
     private handleUpdate;
@@ -29,7 +31,7 @@ export default class Session {
     getSessionToken(): string | undefined;
     setSessionToken(token: string): void;
     applySessionHash(hash: string): void;
-    getSessionHash(): string;
+    getSessionHash(): string | undefined;
     getInfo(): SessionInfo;
     reset(): void;
 }

package/lib/app/session.js

@@ -33,6 +33,9 @@ export default class Session {
         if (newInfo.timestamp !== undefined) {
             this.timestamp = newInfo.timestamp;
         }
+        if (newInfo.projectID !== undefined) {
+            this.projectID = newInfo.projectID;
+        }
         this.handleUpdate(newInfo);
     }
     setMetadata(key, value) {
@@ -68,7 +71,13 @@ export default class Session {
         this.app.sessionStorage.setItem(this.options.session_token_key, token);
     }
     applySessionHash(hash) {
-        const [pageNoStr, token] = decodeURI(hash).split('&');
+        const hashParts = decodeURI(hash).split('&');
+        let token = hash;
+        let pageNoStr = '100500'; // back-compat for sessionToken
+        if (hashParts.length == 2) {
+            ;
+            [token, pageNoStr] = hashParts;
+        }
         if (!pageNoStr || !token) {
             return;
         }
@@ -79,9 +88,9 @@ export default class Session {
         const pageNo = this.getPageNumber();
         const token = this.getSessionToken();
         if (pageNo === undefined || token === undefined) {
-            return '';
+            return;
         }
-        return encodeURI(String(pageNo) + "&" + token);
+        return encodeURI(String(pageNo) + '&' + token);
     }
     getInfo() {
         return {
@@ -89,6 +98,7 @@ export default class Session {
             metadata: this.metadata,
             userID: this.userID,
             timestamp: this.timestamp,
+            projectID: this.projectID,
         };
     }
     reset() {

package/lib/common/messages.gen.d.ts

@@ -1,4 +1,4 @@
-export declare enum Type {
+export declare const enum Type {
     BatchMetadata = 81,
     PartitionedMessage = 82,
     Timestamp = 0,
@@ -56,327 +56,327 @@ export declare enum Type {
     AdoptedSSRemoveOwner = 77
 }
 export declare type BatchMetadata = [
-    type: Type.BatchMetadata,
-    version: number,
-    pageNo: number,
-    firstIndex: number,
-    timestamp: number,
-    location: string
+    Type.BatchMetadata,
+    number,
+    number,
+    number,
+    number,
+    string
 ];
 export declare type PartitionedMessage = [
-    type: Type.PartitionedMessage,
-    partNo: number,
-    partTotal: number
+    Type.PartitionedMessage,
+    number,
+    number
 ];
 export declare type Timestamp = [
-    type: Type.Timestamp,
-    timestamp: number
+    Type.Timestamp,
+    number
 ];
 export declare type SetPageLocation = [
-    type: Type.SetPageLocation,
-    url: string,
-    referrer: string,
-    navigationStart: number
+    Type.SetPageLocation,
+    string,
+    string,
+    number
 ];
 export declare type SetViewportSize = [
-    type: Type.SetViewportSize,
-    width: number,
-    height: number
+    Type.SetViewportSize,
+    number,
+    number
 ];
 export declare type SetViewportScroll = [
-    type: Type.SetViewportScroll,
-    x: number,
-    y: number
+    Type.SetViewportScroll,
+    number,
+    number
 ];
 export declare type CreateDocument = [
-    type: Type.CreateDocument
+    Type.CreateDocument
 ];
 export declare type CreateElementNode = [
-    type: Type.CreateElementNode,
-    id: number,
-    parentID: number,
-    index: number,
-    tag: string,
-    svg: boolean
+    Type.CreateElementNode,
+    number,
+    number,
+    number,
+    string,
+    boolean
 ];
 export declare type CreateTextNode = [
-    type: Type.CreateTextNode,
-    id: number,
-    parentID: number,
-    index: number
+    Type.CreateTextNode,
+    number,
+    number,
+    number
 ];
 export declare type MoveNode = [
-    type: Type.MoveNode,
-    id: number,
-    parentID: number,
-    index: number
+    Type.MoveNode,
+    number,
+    number,
+    number
 ];
 export declare type RemoveNode = [
-    type: Type.RemoveNode,
-    id: number
+    Type.RemoveNode,
+    number
 ];
 export declare type SetNodeAttribute = [
-    type: Type.SetNodeAttribute,
-    id: number,
-    name: string,
-    value: string
+    Type.SetNodeAttribute,
+    number,
+    string,
+    string
 ];
 export declare type RemoveNodeAttribute = [
-    type: Type.RemoveNodeAttribute,
-    id: number,
-    name: string
+    Type.RemoveNodeAttribute,
+    number,
+    string
 ];
 export declare type SetNodeData = [
-    type: Type.SetNodeData,
-    id: number,
-    data: string
+    Type.SetNodeData,
+    number,
+    string
 ];
 export declare type SetNodeScroll = [
-    type: Type.SetNodeScroll,
-    id: number,
-    x: number,
-    y: number
+    Type.SetNodeScroll,
+    number,
+    number,
+    number
 ];
 export declare type SetInputTarget = [
-    type: Type.SetInputTarget,
-    id: number,
-    label: string
+    Type.SetInputTarget,
+    number,
+    string
 ];
 export declare type SetInputValue = [
-    type: Type.SetInputValue,
-    id: number,
-    value: string,
-    mask: number
+    Type.SetInputValue,
+    number,
+    string,
+    number
 ];
 export declare type SetInputChecked = [
-    type: Type.SetInputChecked,
-    id: number,
-    checked: boolean
+    Type.SetInputChecked,
+    number,
+    boolean
 ];
 export declare type MouseMove = [
-    type: Type.MouseMove,
-    x: number,
-    y: number
+    Type.MouseMove,
+    number,
+    number
 ];
 export declare type ConsoleLog = [
-    type: Type.ConsoleLog,
-    level: string,
-    value: string
+    Type.ConsoleLog,
+    string,
+    string
 ];
 export declare type PageLoadTiming = [
-    type: Type.PageLoadTiming,
-    requestStart: number,
-    responseStart: number,
-    responseEnd: number,
-    domContentLoadedEventStart: number,
-    domContentLoadedEventEnd: number,
-    loadEventStart: number,
-    loadEventEnd: number,
-    firstPaint: number,
-    firstContentfulPaint: number
+    Type.PageLoadTiming,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
 ];
 export declare type PageRenderTiming = [
-    type: Type.PageRenderTiming,
-    speedIndex: number,
-    visuallyComplete: number,
-    timeToInteractive: number
+    Type.PageRenderTiming,
+    number,
+    number,
+    number
 ];
 export declare type JSException = [
-    type: Type.JSException,
-    name: string,
-    message: string,
-    payload: string
+    Type.JSException,
+    string,
+    string,
+    string
 ];
 export declare type RawCustomEvent = [
-    type: Type.RawCustomEvent,
-    name: string,
-    payload: string
+    Type.RawCustomEvent,
+    string,
+    string
 ];
 export declare type UserID = [
-    type: Type.UserID,
-    id: string
+    Type.UserID,
+    string
 ];
 export declare type UserAnonymousID = [
-    type: Type.UserAnonymousID,
-    id: string
+    Type.UserAnonymousID,
+    string
 ];
 export declare type Metadata = [
-    type: Type.Metadata,
-    key: string,
-    value: string
+    Type.Metadata,
+    string,
+    string
 ];
 export declare type CSSInsertRule = [
-    type: Type.CSSInsertRule,
-    id: number,
-    rule: string,
-    index: number
+    Type.CSSInsertRule,
+    number,
+    string,
+    number
 ];
 export declare type CSSDeleteRule = [
-    type: Type.CSSDeleteRule,
-    id: number,
-    index: number
+    Type.CSSDeleteRule,
+    number,
+    number
 ];
 export declare type Fetch = [
-    type: Type.Fetch,
-    method: string,
-    url: string,
-    request: string,
-    response: string,
-    status: number,
-    timestamp: number,
-    duration: number
+    Type.Fetch,
+    string,
+    string,
+    string,
+    string,
+    number,
+    number,
+    number
 ];
 export declare type Profiler = [
-    type: Type.Profiler,
-    name: string,
-    duration: number,
-    args: string,
-    result: string
+    Type.Profiler,
+    string,
+    number,
+    string,
+    string
 ];
 export declare type OTable = [
-    type: Type.OTable,
-    key: string,
-    value: string
+    Type.OTable,
+    string,
+    string
 ];
 export declare type StateAction = [
-    type: Type.StateAction,
-    type: string
+    Type.StateAction,
+    string
 ];
 export declare type Redux = [
-    type: Type.Redux,
-    action: string,
-    state: string,
-    duration: number
+    Type.Redux,
+    string,
+    string,
+    number
 ];
 export declare type Vuex = [
-    type: Type.Vuex,
-    mutation: string,
-    state: string
+    Type.Vuex,
+    string,
+    string
 ];
 export declare type MobX = [
-    type: Type.MobX,
-    type: string,
-    payload: string
+    Type.MobX,
+    string,
+    string
 ];
 export declare type NgRx = [
-    type: Type.NgRx,
-    action: string,
-    state: string,
-    duration: number
+    Type.NgRx,
+    string,
+    string,
+    number
 ];
 export declare type GraphQL = [
-    type: Type.GraphQL,
-    operationKind: string,
-    operationName: string,
-    variables: string,
-    response: string
+    Type.GraphQL,
+    string,
+    string,
+    string,
+    string
 ];
 export declare type PerformanceTrack = [
-    type: Type.PerformanceTrack,
-    frames: number,
-    ticks: number,
-    totalJSHeapSize: number,
-    usedJSHeapSize: number
+    Type.PerformanceTrack,
+    number,
+    number,
+    number,
+    number
 ];
 export declare type ResourceTiming = [
-    type: Type.ResourceTiming,
-    timestamp: number,
-    duration: number,
-    ttfb: number,
-    headerSize: number,
-    encodedBodySize: number,
-    decodedBodySize: number,
-    url: string,
-    initiator: string
+    Type.ResourceTiming,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    string,
+    string
 ];
 export declare type ConnectionInformation = [
-    type: Type.ConnectionInformation,
-    downlink: number,
-    type: string
+    Type.ConnectionInformation,
+    number,
+    string
 ];
 export declare type SetPageVisibility = [
-    type: Type.SetPageVisibility,
-    hidden: boolean
+    Type.SetPageVisibility,
+    boolean
 ];
 export declare type LongTask = [
-    type: Type.LongTask,
-    timestamp: number,
-    duration: number,
-    context: number,
-    containerType: number,
-    containerSrc: string,
-    containerId: string,
-    containerName: string
+    Type.LongTask,
+    number,
+    number,
+    number,
+    number,
+    string,
+    string,
+    string
 ];
 export declare type SetNodeAttributeURLBased = [
-    type: Type.SetNodeAttributeURLBased,
-    id: number,
-    name: string,
-    value: string,
-    baseURL: string
+    Type.SetNodeAttributeURLBased,
+    number,
+    string,
+    string,
+    string
 ];
 export declare type SetCSSDataURLBased = [
-    type: Type.SetCSSDataURLBased,
-    id: number,
-    data: string,
-    baseURL: string
+    Type.SetCSSDataURLBased,
+    number,
+    string,
+    string
 ];
 export declare type TechnicalInfo = [
-    type: Type.TechnicalInfo,
-    type: string,
-    value: string
+    Type.TechnicalInfo,
+    string,
+    string
 ];
 export declare type CustomIssue = [
-    type: Type.CustomIssue,
-    name: string,
-    payload: string
+    Type.CustomIssue,
+    string,
+    string
 ];
 export declare type CSSInsertRuleURLBased = [
-    type: Type.CSSInsertRuleURLBased,
-    id: number,
-    rule: string,
-    index: number,
-    baseURL: string
+    Type.CSSInsertRuleURLBased,
+    number,
+    string,
+    number,
+    string
 ];
 export declare type MouseClick = [
-    type: Type.MouseClick,
-    id: number,
-    hesitationTime: number,
-    label: string,
-    selector: string
+    Type.MouseClick,
+    number,
+    number,
+    string,
+    string
 ];
 export declare type CreateIFrameDocument = [
-    type: Type.CreateIFrameDocument,
-    frameID: number,
-    id: number
+    Type.CreateIFrameDocument,
+    number,
+    number
 ];
 export declare type AdoptedSSReplaceURLBased = [
-    type: Type.AdoptedSSReplaceURLBased,
-    sheetID: number,
-    text: string,
-    baseURL: string
+    Type.AdoptedSSReplaceURLBased,
+    number,
+    string,
+    string
 ];
 export declare type AdoptedSSInsertRuleURLBased = [
-    type: Type.AdoptedSSInsertRuleURLBased,
-    sheetID: number,
-    rule: string,
-    index: number,
-    baseURL: string
+    Type.AdoptedSSInsertRuleURLBased,
+    number,
+    string,
+    number,
+    string
 ];
 export declare type AdoptedSSDeleteRule = [
-    type: Type.AdoptedSSDeleteRule,
-    sheetID: number,
-    index: number
+    Type.AdoptedSSDeleteRule,
+    number,
+    number
 ];
 export declare type AdoptedSSAddOwner = [
-    type: Type.AdoptedSSAddOwner,
-    sheetID: number,
-    id: number
+    Type.AdoptedSSAddOwner,
+    number,
+    number
 ];
 export declare type AdoptedSSRemoveOwner = [
-    type: Type.AdoptedSSRemoveOwner,
-    sheetID: number,
-    id: number
+    Type.AdoptedSSRemoveOwner,
+    number,
+    number
 ];
 declare type Message = BatchMetadata | PartitionedMessage | Timestamp | SetPageLocation | SetViewportSize | SetViewportScroll | CreateDocument | CreateElementNode | CreateTextNode | MoveNode | RemoveNode | SetNodeAttribute | RemoveNodeAttribute | SetNodeData | SetNodeScroll | SetInputTarget | SetInputValue | SetInputChecked | MouseMove | ConsoleLog | PageLoadTiming | PageRenderTiming | JSException | RawCustomEvent | UserID | UserAnonymousID | Metadata | CSSInsertRule | CSSDeleteRule | Fetch | Profiler | OTable | StateAction | Redux | Vuex | MobX | NgRx | GraphQL | PerformanceTrack | ResourceTiming | ConnectionInformation | SetPageVisibility | LongTask | SetNodeAttributeURLBased | SetCSSDataURLBased | TechnicalInfo | CustomIssue | CSSInsertRuleURLBased | MouseClick | CreateIFrameDocument | AdoptedSSReplaceURLBased | AdoptedSSInsertRuleURLBased | AdoptedSSDeleteRule | AdoptedSSAddOwner | AdoptedSSRemoveOwner;
 export default Message;