@openreplay/tracker 12.0.5 → 12.0.6

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 12.0.6
+
+- allow network sanitizer to return null (will ignore network req)
+
+# 12.0.5
+
+- patch for img.ts srcset detector
+
 # 12.0.4
 
 - patch for email sanitizer (supports + now)

package/cjs/app/index.js

@@ -81,7 +81,7 @@ class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '12.0.5'; // TODO: version compatability check inside each plugin.
+        this.version = '12.0.6'; // TODO: version compatability check inside each plugin.
         this.compressionThreshold = 24 * 1000;
         this.restartAttempts = 0;
         this.bc = null;

package/cjs/index.js

@@ -98,7 +98,7 @@ class API {
             const orig = this.options.ingestPoint || index_js_1.DEFAULT_INGEST_POINT;
             req.open('POST', orig + '/v1/web/not-started');
             req.send(JSON.stringify({
-                trackerVersion: '12.0.5',
+                trackerVersion: '12.0.6',
                 projectKey: this.options.projectKey,
                 doNotTrack,
                 reason,

package/cjs/modules/Network/beaconProxy.d.ts

@@ -6,11 +6,11 @@ export declare class BeaconProxyHandler<T extends typeof navigator.sendBeacon> i
     private readonly sanitize;
     private readonly sendMessage;
     private readonly isServiceUrl;
-    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean);
+    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean);
     apply(target: T, thisArg: T, argsList: any[]): any;
 }
 export default class BeaconProxy {
     static origSendBeacon: (url: string | URL, data?: BodyInit | null | undefined) => boolean;
     static hasSendBeacon(): boolean;
-    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean): any;
+    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean): any;
 }

package/cjs/modules/Network/beaconProxy.js

@@ -65,7 +65,10 @@ class BeaconProxyHandler {
             item.status = 500;
             item.statusText = 'Unknown';
         }
-        this.sendMessage(item.getMessage());
+        const msg = item.getMessage();
+        if (msg) {
+            this.sendMessage(msg);
+        }
         return isSuccess;
     }
 }

package/cjs/modules/Network/fetchProxy.d.ts

@@ -23,12 +23,12 @@ export declare class FetchProxyHandler<T extends typeof fetch> implements ProxyH
     private readonly sendMessage;
     private readonly isServiceUrl;
     private readonly tokenUrlMatcher?;
-    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
+    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
     apply(target: T, _: typeof window, argsList: [RequestInfo | URL, RequestInit]): any;
     protected beforeFetch(item: NetworkMessage, input: RequestInfo | string, init?: RequestInit): void;
     protected afterFetch(item: NetworkMessage): (resp: Response) => Response;
     protected handleResponseBody(resp: Response, item: NetworkMessage): Promise<ArrayBuffer> | Promise<string>;
 }
 export default class FetchProxy {
-    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): typeof fetch;
+    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): typeof fetch;
 }

package/cjs/modules/Network/fetchProxy.js

@@ -264,7 +264,10 @@ class FetchProxyHandler {
                         typeof responseValue === 'string' ? responseValue.length : responseValue.byteLength;
                     item.responseSizeText = (0, utils_js_1.formatByteSize)(item.responseSize);
                     item.response = (0, utils_js_1.getStringResponseByType)(item.responseType, responseValue);
-                    this.sendMessage(item.getMessage());
+                    const msg = item.getMessage();
+                    if (msg) {
+                        this.sendMessage(msg);
+                    }
                 });
             }
             return new Proxy(resp, new ResponseProxyHandler(resp, item));

package/cjs/modules/Network/index.d.ts

@@ -1,3 +1,3 @@
 import { RequestResponseData } from './types.js';
 import { NetworkRequest } from '../../common/messages.gen.js';
-export default function setProxy(context: typeof globalThis, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): void;
+export default function setProxy(context: typeof globalThis, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): void;

package/cjs/modules/Network/networkMessage.d.ts

@@ -39,8 +39,8 @@ export default class NetworkMessage {
         [key: string]: string;
     };
     requestData: string | null;
-    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData);
-    getMessage(): import("../../common/messages.gen.js").NetworkRequest;
+    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null);
+    getMessage(): import("../../common/messages.gen.js").NetworkRequest | undefined;
     writeHeaders(): {
         reqHs: Record<string, string>;
         resHs: Record<string, string>;

package/cjs/modules/Network/networkMessage.js

@@ -53,6 +53,8 @@ class NetworkMessage {
             request,
             response,
         });
+        if (!messageInfo)
+            return;
         return (0, messages_gen_js_1.NetworkRequest)(this.requestType, messageInfo.method, messageInfo.url, JSON.stringify(messageInfo.request), JSON.stringify(messageInfo.response), messageInfo.status, this.startTime + (0, utils_js_1.getTimeOrigin)(), this.duration, this.responseSize);
     }
     writeHeaders() {

package/cjs/modules/Network/xhrProxy.d.ts

@@ -17,7 +17,7 @@ export declare class XHRProxyHandler<T extends XMLHttpRequest> implements ProxyH
     private readonly tokenUrlMatcher?;
     XMLReq: XMLHttpRequest;
     item: NetworkMessage;
-    constructor(XMLReq: XMLHttpRequest, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
+    constructor(XMLReq: XMLHttpRequest, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
     get(target: T, key: string): any;
     set(target: T, key: string, value: (args: any[]) => any): boolean;
     onReadyStateChange(): void;
@@ -35,5 +35,5 @@ export declare class XHRProxyHandler<T extends XMLHttpRequest> implements ProxyH
     protected updateItemByReadyState(): void;
 }
 export default class XHRProxy {
-    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (data: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): any;
+    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (data: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): any;
 }

package/cjs/modules/Network/xhrProxy.js

@@ -106,18 +106,27 @@ class XHRProxyHandler {
             this.item.response = (0, utils_js_1.getStringResponseByType)(this.item.responseType, this.item.response);
         }, 0);
         if (this.XMLReq.readyState === networkMessage_js_1.RequestState.DONE) {
-            this.sendMessage(this.item.getMessage());
+            const msg = this.item.getMessage();
+            if (msg) {
+                this.sendMessage(msg);
+            }
         }
     }
     onAbort() {
         this.item.cancelState = 1;
         this.item.statusText = 'Abort';
-        this.sendMessage(this.item.getMessage());
+        const msg = this.item.getMessage();
+        if (msg) {
+            this.sendMessage(msg);
+        }
     }
     onTimeout() {
         this.item.cancelState = 3;
         this.item.statusText = 'Timeout';
-        this.sendMessage(this.item.getMessage());
+        const msg = this.item.getMessage();
+        if (msg) {
+            this.sendMessage(msg);
+        }
     }
     getOpen(target) {
         const targetFunction = Reflect.get(target, 'open');

package/cjs/modules/network.d.ts

@@ -15,7 +15,7 @@ export interface RequestResponseData {
     request: RequestData;
     response: ResponseData;
 }
-type Sanitizer = (data: RequestResponseData) => RequestResponseData;
+type Sanitizer = (data: RequestResponseData) => RequestResponseData | null;
 export interface Options {
     sessionTokenHeader: string | boolean;
     failuresOnly: boolean;

package/lib/app/index.js

@@ -52,7 +52,7 @@ export default class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '12.0.5'; // TODO: version compatability check inside each plugin.
+        this.version = '12.0.6'; // TODO: version compatability check inside each plugin.
         this.compressionThreshold = 24 * 1000;
         this.restartAttempts = 0;
         this.bc = null;

package/lib/index.js

@@ -67,7 +67,7 @@ export default class API {
             const orig = this.options.ingestPoint || DEFAULT_INGEST_POINT;
             req.open('POST', orig + '/v1/web/not-started');
             req.send(JSON.stringify({
-                trackerVersion: '12.0.5',
+                trackerVersion: '12.0.6',
                 projectKey: this.options.projectKey,
                 doNotTrack,
                 reason,

package/lib/modules/Network/beaconProxy.d.ts

@@ -6,11 +6,11 @@ export declare class BeaconProxyHandler<T extends typeof navigator.sendBeacon> i
     private readonly sanitize;
     private readonly sendMessage;
     private readonly isServiceUrl;
-    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean);
+    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean);
     apply(target: T, thisArg: T, argsList: any[]): any;
 }
 export default class BeaconProxy {
     static origSendBeacon: (url: string | URL, data?: BodyInit | null | undefined) => boolean;
     static hasSendBeacon(): boolean;
-    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean): any;
+    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean): any;
 }

package/lib/modules/Network/beaconProxy.js

@@ -59,7 +59,10 @@ export class BeaconProxyHandler {
             item.status = 500;
             item.statusText = 'Unknown';
         }
-        this.sendMessage(item.getMessage());
+        const msg = item.getMessage();
+        if (msg) {
+            this.sendMessage(msg);
+        }
         return isSuccess;
     }
 }

package/lib/modules/Network/fetchProxy.d.ts

@@ -23,12 +23,12 @@ export declare class FetchProxyHandler<T extends typeof fetch> implements ProxyH
     private readonly sendMessage;
     private readonly isServiceUrl;
     private readonly tokenUrlMatcher?;
-    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
+    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
     apply(target: T, _: typeof window, argsList: [RequestInfo | URL, RequestInit]): any;
     protected beforeFetch(item: NetworkMessage, input: RequestInfo | string, init?: RequestInit): void;
     protected afterFetch(item: NetworkMessage): (resp: Response) => Response;
     protected handleResponseBody(resp: Response, item: NetworkMessage): Promise<string> | Promise<ArrayBuffer>;
 }
 export default class FetchProxy {
-    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): typeof fetch;
+    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (item: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): typeof fetch;
 }

package/lib/modules/Network/fetchProxy.js

@@ -237,7 +237,10 @@ export class FetchProxyHandler {
                         typeof responseValue === 'string' ? responseValue.length : responseValue.byteLength;
                     item.responseSizeText = formatByteSize(item.responseSize);
                     item.response = getStringResponseByType(item.responseType, responseValue);
-                    this.sendMessage(item.getMessage());
+                    const msg = item.getMessage();
+                    if (msg) {
+                        this.sendMessage(msg);
+                    }
                 });
             }
             return new Proxy(resp, new ResponseProxyHandler(resp, item));

package/lib/modules/Network/index.d.ts

@@ -1,3 +1,3 @@
 import { RequestResponseData } from './types.js';
 import { NetworkRequest } from '../../common/messages.gen.js';
-export default function setProxy(context: typeof globalThis, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): void;
+export default function setProxy(context: typeof globalThis, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): void;

package/lib/modules/Network/networkMessage.d.ts

@@ -39,8 +39,8 @@ export default class NetworkMessage {
         [key: string]: string;
     };
     requestData: string | null;
-    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData);
-    getMessage(): import("../../common/messages.gen.js").NetworkRequest;
+    constructor(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null);
+    getMessage(): import("../../common/messages.gen.js").NetworkRequest | undefined;
     writeHeaders(): {
         reqHs: Record<string, string>;
         resHs: Record<string, string>;

package/lib/modules/Network/networkMessage.js

@@ -50,6 +50,8 @@ export default class NetworkMessage {
             request,
             response,
         });
+        if (!messageInfo)
+            return;
         return NetworkRequest(this.requestType, messageInfo.method, messageInfo.url, JSON.stringify(messageInfo.request), JSON.stringify(messageInfo.response), messageInfo.status, this.startTime + getTimeOrigin(), this.duration, this.responseSize);
     }
     writeHeaders() {

package/lib/modules/Network/xhrProxy.d.ts

@@ -17,7 +17,7 @@ export declare class XHRProxyHandler<T extends XMLHttpRequest> implements ProxyH
     private readonly tokenUrlMatcher?;
     XMLReq: XMLHttpRequest;
     item: NetworkMessage;
-    constructor(XMLReq: XMLHttpRequest, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
+    constructor(XMLReq: XMLHttpRequest, ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (message: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: ((url: string) => boolean) | undefined);
     get(target: T, key: string): any;
     set(target: T, key: string, value: (args: any[]) => any): boolean;
     onReadyStateChange(): void;
@@ -35,5 +35,5 @@ export declare class XHRProxyHandler<T extends XMLHttpRequest> implements ProxyH
     protected updateItemByReadyState(): void;
 }
 export default class XHRProxy {
-    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData, sendMessage: (data: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): any;
+    static create(ignoredHeaders: boolean | string[], setSessionTokenHeader: (cb: (name: string, value: string) => void) => void, sanitize: (data: RequestResponseData) => RequestResponseData | null, sendMessage: (data: NetworkRequest) => void, isServiceUrl: (url: string) => boolean, tokenUrlMatcher?: (url: string) => boolean): any;
 }

package/lib/modules/Network/xhrProxy.js

@@ -80,18 +80,27 @@ export class XHRProxyHandler {
             this.item.response = getStringResponseByType(this.item.responseType, this.item.response);
         }, 0);
         if (this.XMLReq.readyState === RequestState.DONE) {
-            this.sendMessage(this.item.getMessage());
+            const msg = this.item.getMessage();
+            if (msg) {
+                this.sendMessage(msg);
+            }
         }
     }
     onAbort() {
         this.item.cancelState = 1;
         this.item.statusText = 'Abort';
-        this.sendMessage(this.item.getMessage());
+        const msg = this.item.getMessage();
+        if (msg) {
+            this.sendMessage(msg);
+        }
     }
     onTimeout() {
         this.item.cancelState = 3;
         this.item.statusText = 'Timeout';
-        this.sendMessage(this.item.getMessage());
+        const msg = this.item.getMessage();
+        if (msg) {
+            this.sendMessage(msg);
+        }
     }
     getOpen(target) {
         const targetFunction = Reflect.get(target, 'open');

package/lib/modules/network.d.ts

@@ -15,7 +15,7 @@ export interface RequestResponseData {
     request: RequestData;
     response: ResponseData;
 }
-type Sanitizer = (data: RequestResponseData) => RequestResponseData;
+type Sanitizer = (data: RequestResponseData) => RequestResponseData | null;
 export interface Options {
     sessionTokenHeader: string | boolean;
     failuresOnly: boolean;

package/package.json

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