coveo.analytics 2.18.64 → 2.19.1

package/dist/definitions/history.d.ts

@@ -18,10 +18,12 @@ export declare class HistoryStore {
     private cropQueryElement;
     private isValidEntry;
     private stripInternalTime;
+    private stripEmptyQuery;
+    private stripEmptyQueries;
 }
 export interface HistoryElement {
     name: string;
-    value: string;
+    value?: string;
     time: string;
     internalTime?: number;
 }

package/dist/library.es.js

@@ -192,7 +192,7 @@ class HistoryStore {
     }
     addElement(elem) {
         elem.internalTime = new Date().getTime();
-        this.cropQueryElement(elem);
+        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
         let currentHistory = this.getHistoryWithInternalTime();
         if (currentHistory != null) {
             if (this.isValidEntry(elem)) {
@@ -206,7 +206,7 @@ class HistoryStore {
     addElementAsync(elem) {
         return __awaiter(this, void 0, void 0, function* () {
             elem.internalTime = new Date().getTime();
-            this.cropQueryElement(elem);
+            elem = this.cropQueryElement(this.stripEmptyQuery(elem));
             let currentHistory = yield this.getHistoryWithInternalTimeAsync();
             if (currentHistory != null) {
                 if (this.isValidEntry(elem)) {
@@ -220,12 +220,12 @@ class HistoryStore {
     }
     getHistory() {
         const history = this.getHistoryWithInternalTime();
-        return this.stripInternalTime(history);
+        return this.stripEmptyQueries(this.stripInternalTime(history));
     }
     getHistoryAsync() {
         return __awaiter(this, void 0, void 0, function* () {
             const history = yield this.getHistoryWithInternalTimeAsync();
-            return this.stripInternalTime(history);
+            return this.stripEmptyQueries(this.stripInternalTime(history));
         });
     }
     getHistoryWithInternalTime() {
@@ -282,10 +282,11 @@ class HistoryStore {
         }
         return null;
     }
-    cropQueryElement(elem) {
-        if (elem.name && elem.name.toLowerCase() == 'query' && elem.value != null) {
-            elem.value = elem.value.slice(0, MAX_VALUE_SIZE);
+    cropQueryElement(part) {
+        if (part.name && part.value && part.name.toLowerCase() === 'query') {
+            part.value = part.value.slice(0, MAX_VALUE_SIZE);
         }
+        return part;
     }
     isValidEntry(elem) {
         let lastEntry = this.getMostRecentElement();
@@ -300,6 +301,16 @@ class HistoryStore {
             return { name, time, value };
         });
     }
+    stripEmptyQuery(part) {
+        const { name, time, value } = part;
+        if (name && typeof value === 'string' && name.toLowerCase() === 'query' && value.trim() === '') {
+            return { name, time };
+        }
+        return part;
+    }
+    stripEmptyQueries(history) {
+        return history.map((part) => this.stripEmptyQuery(part));
+    }
 }
 
 var history = /*#__PURE__*/Object.freeze({

package/dist/library.js

@@ -475,7 +475,7 @@ var HistoryStore = (function () {
     }
     HistoryStore.prototype.addElement = function (elem) {
         elem.internalTime = new Date().getTime();
-        this.cropQueryElement(elem);
+        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
         var currentHistory = this.getHistoryWithInternalTime();
         if (currentHistory != null) {
             if (this.isValidEntry(elem)) {
@@ -493,7 +493,7 @@ var HistoryStore = (function () {
                 switch (_a.label) {
                     case 0:
                         elem.internalTime = new Date().getTime();
-                        this.cropQueryElement(elem);
+                        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
                         return [4, this.getHistoryWithInternalTimeAsync()];
                     case 1:
                         currentHistory = _a.sent();
@@ -512,7 +512,7 @@ var HistoryStore = (function () {
     };
     HistoryStore.prototype.getHistory = function () {
         var history = this.getHistoryWithInternalTime();
-        return this.stripInternalTime(history);
+        return this.stripEmptyQueries(this.stripInternalTime(history));
     };
     HistoryStore.prototype.getHistoryAsync = function () {
         return tslib.exports.__awaiter(this, void 0, void 0, function () {
@@ -522,7 +522,7 @@ var HistoryStore = (function () {
                     case 0: return [4, this.getHistoryWithInternalTimeAsync()];
                     case 1:
                         history = _a.sent();
-                        return [2, this.stripInternalTime(history)];
+                        return [2, this.stripEmptyQueries(this.stripInternalTime(history))];
                 }
             });
         });
@@ -589,10 +589,11 @@ var HistoryStore = (function () {
         }
         return null;
     };
-    HistoryStore.prototype.cropQueryElement = function (elem) {
-        if (elem.name && elem.name.toLowerCase() == 'query' && elem.value != null) {
-            elem.value = elem.value.slice(0, MAX_VALUE_SIZE);
+    HistoryStore.prototype.cropQueryElement = function (part) {
+        if (part.name && part.value && part.name.toLowerCase() === 'query') {
+            part.value = part.value.slice(0, MAX_VALUE_SIZE);
         }
+        return part;
     };
     HistoryStore.prototype.isValidEntry = function (elem) {
         var lastEntry = this.getMostRecentElement();
@@ -607,6 +608,17 @@ var HistoryStore = (function () {
             return { name: name, time: time, value: value };
         });
     };
+    HistoryStore.prototype.stripEmptyQuery = function (part) {
+        var name = part.name, time = part.time, value = part.value;
+        if (name && typeof value === 'string' && name.toLowerCase() === 'query' && value.trim() === '') {
+            return { name: name, time: time };
+        }
+        return part;
+    };
+    HistoryStore.prototype.stripEmptyQueries = function (history) {
+        var _this = this;
+        return history.map(function (part) { return _this.stripEmptyQuery(part); });
+    };
     return HistoryStore;
 }());
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.18.64",
+    "version": "2.19.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/client/analytics.ts

@@ -320,6 +320,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     async getVisit(): Promise<VisitResponse> {
+        // deepcode ignore Ssrf: url is supplied by script owner
         const response = await fetch(`${this.baseUrl}/analytics/visit`);
         const visit = (await response.json()) as VisitResponse;
         this.visitorId = visit.visitorId;
@@ -327,6 +328,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     async getHealth(): Promise<HealthResponse> {
+        // deepcode ignore Ssrf: url is supplied by script owner
         const response = await fetch(`${this.baseUrl}/analytics/monitoring/health`);
         return (await response.json()) as HealthResponse;
     }

package/src/history.spec.ts

@@ -115,6 +115,44 @@ describe('history', () => {
         }
     });
 
+    it('should strip empty query values when calling getHistoryAsync', async () => {
+        data.name = 'Query';
+        data.value = '';
+        const historyElements: history.HistoryElement[] = [data];
+        historyStore.setHistory(historyElements);
+
+        const history = await historyStore.getHistoryAsync();
+        expect(history[0].value).toBeUndefined();
+    });
+
+    it('should strip empty query values when calling getHistory', () => {
+        data.name = 'Query';
+        data.value = '';
+        const historyElements: history.HistoryElement[] = [data];
+        historyStore.setHistory(historyElements);
+
+        const history = historyStore.getHistory();
+        expect(history[0].value).toBeUndefined();
+    });
+
+    it('should strip empty query from new element (addElement)', () => {
+        data.name = 'Query';
+        data.value = '';
+        historyStore.addElement(data);
+
+        const [_, setData] = storageMock.setItem.mock.calls[0];
+        expect(setData).not.toMatch(/"value"/);
+    });
+
+    it('should strip empty query from new element (addElementAsync)', async () => {
+        data.name = 'Query';
+        data.value = '';
+        await historyStore.addElementAsync(data);
+
+        const [_, setData] = storageMock.setItem.mock.calls[0];
+        expect(setData).not.toMatch(/"value"/);
+    });
+
     it('should remove item when cleared', () => {
         historyStore.clear();
 

package/src/history.ts

@@ -16,7 +16,7 @@ export class HistoryStore {
      */
     addElement(elem: HistoryElement) {
         elem.internalTime = new Date().getTime();
-        this.cropQueryElement(elem);
+        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
         let currentHistory = this.getHistoryWithInternalTime();
         if (currentHistory != null) {
             if (this.isValidEntry(elem)) {
@@ -29,7 +29,7 @@ export class HistoryStore {
 
     async addElementAsync(elem: HistoryElement) {
         elem.internalTime = new Date().getTime();
-        this.cropQueryElement(elem);
+        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
         let currentHistory = await this.getHistoryWithInternalTimeAsync();
         if (currentHistory != null) {
             if (this.isValidEntry(elem)) {
@@ -45,12 +45,12 @@ export class HistoryStore {
      */
     getHistory(): HistoryElement[] {
         const history = this.getHistoryWithInternalTime();
-        return this.stripInternalTime(history);
+        return this.stripEmptyQueries(this.stripInternalTime(history));
     }
 
     async getHistoryAsync(): Promise<HistoryElement[]> {
         const history = await this.getHistoryWithInternalTimeAsync();
-        return this.stripInternalTime(history);
+        return this.stripEmptyQueries(this.stripInternalTime(history));
     }
 
     private getHistoryWithInternalTime(): HistoryElement[] {
@@ -114,10 +114,12 @@ export class HistoryStore {
         return null;
     }
 
-    private cropQueryElement(elem: HistoryElement) {
-        if (elem.name && elem.name.toLowerCase() == 'query' && elem.value != null) {
-            elem.value = elem.value.slice(0, MAX_VALUE_SIZE);
+    private cropQueryElement(part: HistoryElement) {
+        if (part.name && part.value && part.name.toLowerCase() === 'query') {
+            part.value = part.value.slice(0, MAX_VALUE_SIZE);
         }
+
+        return part;
     }
 
     private isValidEntry(elem: HistoryElement): boolean {
@@ -135,11 +137,24 @@ export class HistoryStore {
             return {name, time, value};
         });
     }
+
+    private stripEmptyQuery(part: HistoryElement) {
+        const {name, time, value} = part;
+        if (name && typeof value === 'string' && name.toLowerCase() === 'query' && value.trim() === '') {
+            return {name, time};
+        }
+
+        return part;
+    }
+
+    private stripEmptyQueries(history: HistoryElement[]): HistoryElement[] {
+        return history.map((part) => this.stripEmptyQuery(part));
+    }
 }
 
 export interface HistoryElement {
     name: string;
-    value: string;
+    value?: string;
     time: string;
     internalTime?: number;
 }