@openreplay/tracker 7.0.2-beta.1 → 7.0.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 7.0.2
+
+- fixed header sanitization for axios causing empty string in some cases
+
 # 7.0.1
 
 - fix time inputs capturing

package/cjs/modules/axiosSpy.d.ts

@@ -33,6 +33,7 @@ interface AxiosResponse<T = any> {
     response?: AxiosRequestConfig;
 }
 export interface AxiosInstance extends Record<string, any> {
+    getUri: (config?: AxiosRequestConfig) => string;
     interceptors: {
         request: AxiosInterceptorManager<InternalAxiosRequestConfig>;
         response: AxiosInterceptorManager<AxiosResponse>;

package/cjs/modules/axiosSpy.js

@@ -2,15 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const messages_gen_js_1 = require("../app/messages.gen.js");
 const utils_js_1 = require("../utils.js");
+const exception_js_1 = require("./exception.js");
 function default_1(app, instance, opts, sanitize, stringify) {
+    app.debug.log('Openreplay: attaching axios spy to instance', instance);
     function captureResponseData(axiosResponseObj) {
-        const { headers: reqHs, data: reqData, method, url } = axiosResponseObj.config;
+        app.debug.log('Openreplay: capturing axios response data', axiosResponseObj);
+        const { headers: reqHs, data: reqData, method, url, baseURL } = axiosResponseObj.config;
         const { data: rData, headers: rHs, status: globStatus, response } = axiosResponseObj;
         const { data: resData, headers: resHs, status: resStatus } = response || {};
         const ihOpt = opts.ignoreHeaders;
-        const isHIgnoring = Array.isArray(ihOpt)
-            ? (name) => ihOpt.includes(name)
-            : () => ihOpt;
+        const isHIgnoring = Array.isArray(ihOpt) ? (name) => ihOpt.includes(name) : () => ihOpt;
         function writeHeader(hsObj, header) {
             if (!isHIgnoring(header[0])) {
                 hsObj[header[0]] = header[1];
@@ -60,13 +61,16 @@ function default_1(app, instance, opts, sanitize, stringify) {
             },
         });
         if (!reqResInfo) {
+            app.debug.log('Openreplay: empty request/response info, skipping');
             return;
         }
         const requestStart = axiosResponseObj.config.__openreplay_timing;
         const duration = performance.now() - requestStart;
+        app.debug.log('Openreplay: final req object', reqResInfo);
         app.send((0, messages_gen_js_1.NetworkRequest)('xhr', String(method), String(reqResInfo.url), stringify(reqResInfo.request), stringify(reqResInfo.response), reqResInfo.status, requestStart + (0, utils_js_1.getTimeOrigin)(), duration));
     }
     function getStartTime(config) {
+        app.debug.log('Openreplay: capturing API request', config);
         config.__openreplay_timing = performance.now();
         if (opts.sessionTokenHeader) {
             const header = typeof opts.sessionTokenHeader === 'string'
@@ -86,10 +90,21 @@ function default_1(app, instance, opts, sanitize, stringify) {
         return response;
     }
     function captureNetworkError(error) {
-        captureResponseData(error);
+        app.debug.log('Openreplay: capturing API request error', error);
+        if (isAxiosError(error)) {
+            captureResponseData(error.response);
+        }
+        else if (error instanceof Error) {
+            app.send((0, exception_js_1.getExceptionMessage)(error, []));
+        }
         return Promise.reject(error);
     }
-    const reqInt = instance.interceptors.request.use(getStartTime, null, { synchronous: true });
+    function logRequestError(ev) {
+        app.debug.log('Openreplay: failed API request, skipping', ev);
+    }
+    const reqInt = instance.interceptors.request.use(getStartTime, logRequestError, {
+        synchronous: true,
+    });
     const resInt = instance.interceptors.response.use(captureNetworkRequest, captureNetworkError, {
         synchronous: true,
     });
@@ -100,3 +115,9 @@ function default_1(app, instance, opts, sanitize, stringify) {
     });
 }
 exports.default = default_1;
+function isAxiosError(payload) {
+    return isObject(payload) && payload.isAxiosError === true;
+}
+function isObject(thing) {
+    return thing !== null && typeof thing === 'object';
+}

package/cjs/modules/network.js

@@ -160,14 +160,16 @@ function default_1(app, opts = {}) {
             xhr.addEventListener('load', app.safe((e) => {
                 const { headers: reqHs, body: reqBody } = getXHRRequestDataObject(xhr);
                 const duration = startTime > 0 ? e.timeStamp - startTime : 0;
-                const hString = ignoreHeaders ? '' : xhr.getAllResponseHeaders(); // might be null (though only if no response received though)
-                const resHs = hString
-                    ? hString
-                        .split('\r\n')
-                        .map((h) => h.split(':'))
-                        .filter((entry) => !isHIgnored(entry[0]))
-                        .reduce((hds, [name, value]) => (Object.assign(Object.assign({}, hds), { [name]: value })), {})
-                    : {};
+                const hString = xhr.getAllResponseHeaders() || ''; // might be null (though only if no response received though)
+                const headersArr = hString.trim().split(/[\r\n]+/);
+                const headerMap = {};
+                headersArr.forEach(function (line) {
+                    const parts = line.split(': ');
+                    const header = parts.shift();
+                    if (!isHIgnored(header)) {
+                        headerMap[header] = parts.join(': ');
+                    }
+                });
                 const method = strMethod(initMethod);
                 const reqResInfo = sanitize({
                     url: String(url),
@@ -178,7 +180,7 @@ function default_1(app, opts = {}) {
                         body: reqBody,
                     },
                     response: {
-                        headers: resHs,
+                        headers: headerMap,
                         body: xhr.response,
                     },
                 });

package/lib/modules/axiosSpy.d.ts

@@ -33,6 +33,7 @@ interface AxiosResponse<T = any> {
     response?: AxiosRequestConfig;
 }
 export interface AxiosInstance extends Record<string, any> {
+    getUri: (config?: AxiosRequestConfig) => string;
     interceptors: {
         request: AxiosInterceptorManager<InternalAxiosRequestConfig>;
         response: AxiosInterceptorManager<AxiosResponse>;

package/lib/modules/axiosSpy.js

@@ -1,14 +1,15 @@
 import { NetworkRequest } from '../app/messages.gen.js';
 import { getTimeOrigin } from '../utils.js';
+import { getExceptionMessage } from './exception.js';
 export default function (app, instance, opts, sanitize, stringify) {
+    app.debug.log('Openreplay: attaching axios spy to instance', instance);
     function captureResponseData(axiosResponseObj) {
-        const { headers: reqHs, data: reqData, method, url } = axiosResponseObj.config;
+        app.debug.log('Openreplay: capturing axios response data', axiosResponseObj);
+        const { headers: reqHs, data: reqData, method, url, baseURL } = axiosResponseObj.config;
         const { data: rData, headers: rHs, status: globStatus, response } = axiosResponseObj;
         const { data: resData, headers: resHs, status: resStatus } = response || {};
         const ihOpt = opts.ignoreHeaders;
-        const isHIgnoring = Array.isArray(ihOpt)
-            ? (name) => ihOpt.includes(name)
-            : () => ihOpt;
+        const isHIgnoring = Array.isArray(ihOpt) ? (name) => ihOpt.includes(name) : () => ihOpt;
         function writeHeader(hsObj, header) {
             if (!isHIgnoring(header[0])) {
                 hsObj[header[0]] = header[1];
@@ -58,13 +59,16 @@ export default function (app, instance, opts, sanitize, stringify) {
             },
         });
         if (!reqResInfo) {
+            app.debug.log('Openreplay: empty request/response info, skipping');
             return;
         }
         const requestStart = axiosResponseObj.config.__openreplay_timing;
         const duration = performance.now() - requestStart;
+        app.debug.log('Openreplay: final req object', reqResInfo);
         app.send(NetworkRequest('xhr', String(method), String(reqResInfo.url), stringify(reqResInfo.request), stringify(reqResInfo.response), reqResInfo.status, requestStart + getTimeOrigin(), duration));
     }
     function getStartTime(config) {
+        app.debug.log('Openreplay: capturing API request', config);
         config.__openreplay_timing = performance.now();
         if (opts.sessionTokenHeader) {
             const header = typeof opts.sessionTokenHeader === 'string'
@@ -84,10 +88,21 @@ export default function (app, instance, opts, sanitize, stringify) {
         return response;
     }
     function captureNetworkError(error) {
-        captureResponseData(error);
+        app.debug.log('Openreplay: capturing API request error', error);
+        if (isAxiosError(error)) {
+            captureResponseData(error.response);
+        }
+        else if (error instanceof Error) {
+            app.send(getExceptionMessage(error, []));
+        }
         return Promise.reject(error);
     }
-    const reqInt = instance.interceptors.request.use(getStartTime, null, { synchronous: true });
+    function logRequestError(ev) {
+        app.debug.log('Openreplay: failed API request, skipping', ev);
+    }
+    const reqInt = instance.interceptors.request.use(getStartTime, logRequestError, {
+        synchronous: true,
+    });
     const resInt = instance.interceptors.response.use(captureNetworkRequest, captureNetworkError, {
         synchronous: true,
     });
@@ -97,3 +112,9 @@ export default function (app, instance, opts, sanitize, stringify) {
         (_d = (_c = instance.interceptors.response).eject) === null || _d === void 0 ? void 0 : _d.call(_c, resInt);
     });
 }
+function isAxiosError(payload) {
+    return isObject(payload) && payload.isAxiosError === true;
+}
+function isObject(thing) {
+    return thing !== null && typeof thing === 'object';
+}

package/lib/modules/network.js

@@ -158,14 +158,16 @@ export default function (app, opts = {}) {
             xhr.addEventListener('load', app.safe((e) => {
                 const { headers: reqHs, body: reqBody } = getXHRRequestDataObject(xhr);
                 const duration = startTime > 0 ? e.timeStamp - startTime : 0;
-                const hString = ignoreHeaders ? '' : xhr.getAllResponseHeaders(); // might be null (though only if no response received though)
-                const resHs = hString
-                    ? hString
-                        .split('\r\n')
-                        .map((h) => h.split(':'))
-                        .filter((entry) => !isHIgnored(entry[0]))
-                        .reduce((hds, [name, value]) => (Object.assign(Object.assign({}, hds), { [name]: value })), {})
-                    : {};
+                const hString = xhr.getAllResponseHeaders() || ''; // might be null (though only if no response received though)
+                const headersArr = hString.trim().split(/[\r\n]+/);
+                const headerMap = {};
+                headersArr.forEach(function (line) {
+                    const parts = line.split(': ');
+                    const header = parts.shift();
+                    if (!isHIgnored(header)) {
+                        headerMap[header] = parts.join(': ');
+                    }
+                });
                 const method = strMethod(initMethod);
                 const reqResInfo = sanitize({
                     url: String(url),
@@ -176,7 +178,7 @@ export default function (app, opts = {}) {
                         body: reqBody,
                     },
                     response: {
-                        headers: resHs,
+                        headers: headerMap,
                         body: xhr.response,
                     },
                 });

package/package.json

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