coveo.analytics 2.23.10 → 2.25.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.23.10",
+    "version": "2.25.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -23,18 +23,21 @@
     },
     "license": "MIT",
     "dependencies": {
-        "cross-fetch": "^3.1.5"
+        "cross-fetch": "^3.1.5",
+        "uuid": "^9.0.0"
     },
     "devDependencies": {
         "@rollup/plugin-alias": "^3.1.2",
         "@rollup/plugin-commonjs": "^19.0.0",
         "@rollup/plugin-json": "^4.1.0",
         "@rollup/plugin-node-resolve": "^13.0.0",
+        "@rollup/plugin-replace": "^5.0.2",
         "@types/fetch-mock": "^7.3.2",
         "@types/jest": "^25.1.1",
         "@types/jsdom": "^12.2.4",
         "@types/mime": "0.0.29",
         "@types/node": "^6.0.45",
+        "@types/uuid": "^9.0.0",
         "babel-core": "^6.17.0",
         "babel-loader": "^7.1.4",
         "babel-preset-es2015": "^6.16.0",

package/src/client/analytics.spec.ts

@@ -9,10 +9,10 @@ import * as doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
 
 const aVisitorId = '123';
-
-const uuidv4Mock = jest.fn();
-jest.mock('./crypto', () => ({
-    uuidv4: () => uuidv4Mock(),
+jest.mock('uuid', () => ({
+    v4: () => aVisitorId,
+    validate: jest.requireActual('uuid').validate,
+    v5: jest.requireActual('uuid').v5,
 }));
 
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
@@ -49,7 +49,6 @@ describe('Analytics', () => {
         new CookieStorage().removeItem('visitorId');
         localStorage.clear();
         fetchMock.reset();
-        uuidv4Mock.mockImplementationOnce(() => aVisitorId);
 
         client = new CoveoAnalyticsClient({
             token: aToken,
@@ -66,7 +65,7 @@ describe('Analytics', () => {
 
         expect(fetchMock.called()).toBe(true);
 
-        const [path, {headers, body}] = fetchMock.lastCall();
+        const [path, {headers, body}]: any = fetchMock.lastCall();
         expect(path).toBe(endpointForEventType(EventType.view));
 
         const h = headers as Record<string, string>;
@@ -115,8 +114,8 @@ describe('Analytics', () => {
 
         await Promise.all([firstRequest, secondRequest, thirdRequest]);
 
-        const assertResponseHasCustomDataWithIndex = (response: RequestInit, index: number) => {
-            const parsedBody = JSON.parse(response.body.toString());
+        const assertResponseHasCustomDataWithIndex = (response: RequestInit | undefined, index: number) => {
+            const parsedBody = JSON.parse(response!.body!.toString());
             expect(parsedBody.customData.index).toBe(index);
         };
         const [[, firstResponse], [, secondResponse], [, thirdResponse]] = fetchMock.calls();
@@ -170,7 +169,7 @@ describe('Analytics', () => {
         it('should properly parse empty arguments', async () => {
             await client.sendEvent(specialEventType);
 
-            const [path, {body}] = fetchMock.lastCall();
+            const [path, {body}]: any = fetchMock.lastCall();
             expect(path).toBe(endpointForEventType(EventType.custom));
 
             const parsedBody = JSON.parse(body.toString());
@@ -409,16 +408,16 @@ describe('Analytics', () => {
 
         const call = fetchMock.calls()[0];
         const url = call[0];
-        const options: RequestInit = call[1];
+        const options: RequestInit | undefined = call[1];
 
         const {url: expectedUrl, ...expectedOptions} = processedRequest;
-        expect(clientOrigin).toBe('analyticsFetch');
+        expect(clientOrigin!).toBe('analyticsFetch');
         expect(url).toBe(expectedUrl);
         expect(options).toEqual(expectedOptions);
     });
 
     const getParsedBodyCalls = (): any[] => {
-        return fetchMock.calls().map(([, {body}]) => {
+        return fetchMock.calls().map(([, {body}]: any) => {
             return JSON.parse(body.toString());
         });
     };
@@ -453,3 +452,34 @@ describe('doNotTrack', () => {
         expect(Cookie.get('coveo_visitorId')).not.toBe(aVisitorId);
     });
 });
+
+describe('custom clientId', () => {
+    it('allows setting of a custom clientId', async () => {
+        const client = new CoveoAnalyticsClient({});
+        client.setClientId('c7d57b22-4aa8-487a-a106-be5243885f0a');
+        expect(await client.getCurrentVisitorId()).toBe('c7d57b22-4aa8-487a-a106-be5243885f0a');
+    });
+
+    it('allows setting a custom consistent clientId given a string', async () => {
+        const client = new CoveoAnalyticsClient({});
+        client.setClientId('somestring', 'testNameSpace');
+        //uuid v5 specific uuid generation
+        expect(await client.getCurrentVisitorId()).toBe('2c356915-8223-5773-acb8-e2a34404a559');
+        //check for consistent ids
+        client.setClientId('somestring', 'testNameSpace');
+        expect(await client.getCurrentVisitorId()).toBe('2c356915-8223-5773-acb8-e2a34404a559');
+        client.setClientId('otherstring', 'testNameSpace');
+        expect(await client.getCurrentVisitorId()).not.toBe('2c356915-8223-5773-acb8-e2a34404a559');
+        client.setClientId('somestring', 'otherNameSpace');
+        expect(await client.getCurrentVisitorId()).not.toBe('2c356915-8223-5773-acb8-e2a34404a559');
+    });
+
+    it('errors when not providing a namespace', async () => {
+        const client = new CoveoAnalyticsClient({});
+        expect.assertions(1);
+        await expect(client.setClientId('somestring')).rejects.toEqual(
+            Error('Cannot generate uuid client id without a specific namespace string.')
+        );
+        //uuid v5 specific uuid generation
+    });
+});

package/src/client/analytics.ts

@@ -22,7 +22,8 @@ import {IAnalyticsClientOptions, PreprocessAnalyticsRequest, VisitorIdProvider}
 import {hasWindow, hasDocument} from '../detector';
 import {addDefaultValues} from '../hook/addDefaultValues';
 import {enhanceViewEvent} from '../hook/enhanceViewEvent';
-import {uuidv4} from './crypto';
+import {v4 as uuidv4, v5 as uuidv5, validate as uuidValidate} from 'uuid';
+import {libVersion} from '../version';
 import {
     convertKeysToMeasurementProtocol,
     isMeasurementProtocolKey,
@@ -98,6 +99,7 @@ export interface AnalyticsClient {
     registerAfterSendEventHook(hook: AnalyticsClientSendEventHook): void;
     addEventTypeMapping(eventType: string, eventConfig: EventTypeConfig): void;
     runtime: IRuntimeEnvironment;
+    version: string;
     /**
      * @deprecated
      */
@@ -118,6 +120,11 @@ export function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version)
     return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${apiVersion}`;
 }
 
+// Note: Changing this value will destroy the mapping from tracking string to clientId for all customers
+// using the setClientId() api. It will have the same effect as every visitor for those customers clearing
+// their cookie store at the same time, with corresponding downstream effects.
+const COVEO_NAMESPACE = '38824e1f-37f5-42d3-8372-a4b8fa9df946';
+
 export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider {
     private get defaultOptions(): ClientOptions {
         return {
@@ -130,6 +137,9 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     public runtime: IRuntimeEnvironment;
+    public get version(): string {
+        return libVersion;
+    }
     private visitorId: string;
     private bufferedRequests: BufferedRequest[];
     private beforeSendHooks: AnalyticsClientSendEventHook[];
@@ -209,6 +219,17 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         await this.storage.setItem('visitorId', visitorId);
     }
 
+    async setClientId(value: string, namespace?: string) {
+        if (uuidValidate(value)) {
+            this.setCurrentVisitorId(value);
+        } else {
+            if (!namespace) {
+                throw Error('Cannot generate uuid client id without a specific namespace string.');
+            }
+            this.setCurrentVisitorId(uuidv5(value, uuidv5(namespace, COVEO_NAMESPACE)));
+        }
+    }
+
     async getParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload) {
         return await this.resolveParameters(eventType, ...payload);
     }

package/src/client/analyticsBeaconClient.spec.ts

@@ -124,7 +124,7 @@ describe('AnalyticsBeaconClient', () => {
 
         await client.sendEvent(EventType.collect, {});
 
-        expect(clientOrigin).toBe('analyticsBeacon');
+        expect(clientOrigin!).toBe('analyticsBeacon');
         expect(sendBeaconMock).toHaveBeenCalledWith(processedRequest.url, processedRequest.body);
     });
 

package/src/client/noopAnalytics.ts

@@ -17,6 +17,7 @@ import {
     PreparedViewEventRequest,
     ViewEventRequest,
 } from '../events';
+import {libVersion} from '../version';
 import {NoopRuntime} from './runtimeEnvironment';
 
 export class NoopAnalytics implements AnalyticsClient {
@@ -68,5 +69,8 @@ export class NoopAnalytics implements AnalyticsClient {
     registerAfterSendEventHook(): void {}
     addEventTypeMapping(): void {}
     runtime = new NoopRuntime();
+    public get version(): string {
+        return libVersion;
+    }
     currentVisitorId = '';
 }

package/src/cookieutils.ts

@@ -1,50 +1,27 @@
 interface CookieDetails {
     name: string;
     value: string;
-    expires: string;
-    domain: string;
+    expirationDate?: Date;
+    domain?: string;
 }
 
-// Code originally taken from : https://developers.livechatinc.com/blog/setting-cookies-to-subdomains-in-javascript/
+// Code originally modified from : https://developers.livechatinc.com/blog/setting-cookies-to-subdomains-in-javascript/
 export class Cookie {
-    static set(name: string, value: string, expiration?: number) {
-        var domain: string, domainParts: string[], date: any, expires: string, host: string;
-
-        if (expiration) {
-            date = new Date();
-            date.setTime(date.getTime() + expiration);
-            expires = '; expires=' + date.toGMTString();
-        } else {
-            expires = '';
+    static set(name: string, value: string, expire?: number) {
+        var domain: string, expirationDate: Date | undefined, domainParts: string[], host: string;
+        if (expire) {
+            expirationDate = new Date();
+            expirationDate.setTime(expirationDate.getTime() + expire);
         }
-
         host = window.location.hostname;
         if (host.indexOf('.') === -1) {
-            // no "." in a domain - it's localhost or something similar
-            document.cookie = name + '=' + value + expires + '; path=/';
+            // no "." in a domain - single domain name, it's localhost or something similar
+            writeCookie(name, value, expirationDate);
         } else {
-            // Remember the cookie on all subdomains.
-            //
-            // Start with trying to set cookie to the top domain.
-            // (example: if user is on foo.com, try to set
-            //  cookie to domain ".com")
-            //
-            // If the cookie will not be set, it means ".com"
-            // is a top level domain and we need to
-            // set the cookie to ".foo.com"
             domainParts = host.split('.');
-            domainParts.shift();
-            domain = '.' + domainParts.join('.');
-
-            writeCookie({name, value, expires, domain});
-
-            // check if cookie was successfuly set to the given domain
-            // (otherwise it was a Top-Level Domain)
-            if (Cookie.get(name) == null || Cookie.get(name) != value) {
-                // append "." to current domain
-                domain = '.' + host;
-                writeCookie({name, value, expires, domain});
-            }
+            // we always have at least 2 domain parts
+            domain = domainParts[domainParts.length - 2] + '.' + domainParts[domainParts.length - 1];
+            writeCookie(name, value, expirationDate, domain);
         }
     }
 
@@ -53,9 +30,8 @@ export class Cookie {
         var cookieArray = document.cookie.split(';');
         for (var i = 0; i < cookieArray.length; i++) {
             var cookie = cookieArray[i];
-            cookie = cookie.replace(/^\s+/, '');
-
-            if (cookie.indexOf(cookiePrefix) == 0) {
+            cookie = cookie.replace(/^\s+/, ''); //strip whitespace from front of cookie only
+            if (cookie.lastIndexOf(cookiePrefix, 0) === 0) {
                 return cookie.substring(cookiePrefix.length, cookie.length);
             }
         }
@@ -67,7 +43,10 @@ export class Cookie {
     }
 }
 
-function writeCookie(details: CookieDetails) {
-    const {name, value, expires, domain} = details;
-    document.cookie = `${name}=${value}${expires}; path=/; domain=${domain}; SameSite=Lax`;
+function writeCookie(name: string, value: string, expirationDate?: Date, domain?: string) {
+    document.cookie =
+        `${name}=${value}` +
+        (expirationDate ? `;expires=${expirationDate.toUTCString()}` : '') +
+        (domain ? `;domain=${domain}` : '') +
+        ';SameSite=Lax';
 }

package/src/coveoua/browser.ts

@@ -4,13 +4,13 @@ import handleOneAnalyticsEvent from './simpleanalytics';
 declare const self: any;
 
 const promise = (window as any)['Promise'];
-if (!(promise instanceof Function)) {
+if (!(promise instanceof Function) && !global) {
     console.error(
         `This script uses window.Promise which is not supported in your browser. Consider adding a polyfill like "es6-promise".`
     );
 }
 const fetch = (window as any)['fetch'];
-if (!(fetch instanceof Function)) {
+if (!(fetch instanceof Function) && !global) {
     console.error(
         `This script uses window.fetch which is not supported in your browser. Consider adding a polyfill like "fetch".`
     );

package/src/coveoua/plugins.ts

@@ -20,7 +20,7 @@ export class Plugins {
                 `No plugin named "${name}" is currently registered. If you use a custom plugin, use 'provide' first.`
             );
         }
-        this.requiredPlugins[name] = new pluginClass(options);
+        this.requiredPlugins[name] = new (pluginClass as any)(options);
     }
 
     provide(name: string, plugin: PluginClass) {

package/src/coveoua/simpleanalytics.spec.ts

@@ -1,15 +1,14 @@
 import coveoua from './simpleanalytics';
 import {createAnalyticsClientMock, visitorIdMock} from '../../tests/analyticsClientMock';
 import {TestPlugin} from '../../tests/pluginMock';
-import {uuidv4} from '../client/crypto';
+import {v4 as uuidv4} from 'uuid';
 import {PluginOptions} from '../plugins/BasePlugin';
 import {mockFetch} from '../../tests/fetchMock';
 import {CookieStorage} from '../storage';
+import {libVersion} from '../version';
 
 const uuidv4Mock = jest.fn();
-jest.mock('../client/crypto', () => ({
-    uuidv4: () => uuidv4Mock(),
-}));
+jest.mock('uuid', () => ({v4: () => uuidv4Mock()}));
 
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 
@@ -376,6 +375,13 @@ describe('simpleanalytics', () => {
         });
     });
 
+    describe('version', () => {
+        it('returns the current version string', () => {
+            coveoua('init', 'MYTOKEN');
+            expect(coveoua('version')).toBe(libVersion);
+        });
+    });
+
     describe('callPlugin', () => {
         it('resolves properly plugin actions', () => {
             coveoua('provide', 'test', TestPluginWithSpy);
@@ -468,7 +474,7 @@ describe('simpleanalytics', () => {
         coveoua('init', 'SOME TOKEN', {plugins: ['svc']});
 
         expect(() => coveoua('potato')).toThrow(
-            `The action "potato" does not exist. Available actions: init, set, send, onLoad, callPlugin, reset, require, provide.`
+            `The action "potato" does not exist. Available actions: init, set, send, onLoad, callPlugin, reset, require, provide, version.`
         );
     });
 

package/src/coveoua/simpleanalytics.ts

@@ -3,6 +3,7 @@ import {AnalyticsClient, CoveoAnalyticsClient, Endpoints} from '../client/analyt
 import {Plugins} from './plugins';
 import {PluginOptions} from '../plugins/BasePlugin';
 import {PluginClass} from '../plugins/BasePlugin';
+import {libVersion} from '../version';
 
 export type AvailableActions = keyof CoveoUA;
 
@@ -137,6 +138,10 @@ export class CoveoUA {
         this.plugins = new Plugins();
         this.params = {};
     }
+
+    version(): string {
+        return libVersion;
+    }
 }
 
 export const coveoua = new CoveoUA();
@@ -160,6 +165,7 @@ export const handleOneAnalyticsEvent = (command: string, ...params: any[]) => {
             'reset',
             'require',
             'provide',
+            'version',
         ];
         throw new Error(`The action "${command}" does not exist. Available actions: ${actions.join(', ')}.`);
     }

package/src/plugins/BasePlugin.ts

@@ -1,7 +1,6 @@
 import {AnalyticsClient} from '../client/analytics';
-import {uuidv4} from '../client/crypto';
+import {v4 as uuidv4} from 'uuid';
 import {getFormattedLocation} from '../client/location';
-import {UAPluginOptions} from '../coveoua/plugins';
 import {hasDocument} from '../detector';
 
 type PluginWithId = {
@@ -67,7 +66,7 @@ export abstract class BasePlugin {
     public getDefaultContextInformation(eventType: string) {
         const documentContext = {
             title: hasDocument() ? document.title : '',
-            encoding: hasDocument() ? document.characterSet :'UTF-8',
+            encoding: hasDocument() ? document.characterSet : 'UTF-8',
         };
         const screenContext = {
             screenResolution: `${screen.width}x${screen.height}`,
@@ -103,7 +102,7 @@ export abstract class BasePlugin {
     }
 
     /*
-        When calling getPayload or getParameters, we need to return what would be sent by the API without updating our internal reference. 
+        When calling getPayload or getParameters, we need to return what would be sent by the API without updating our internal reference.
         For instance, if you getPayload("pageview"), we want to return the same payload as if you did coveoua("send", "pageview").
     */
     private getNextValues(eventType: string, payload: any) {

package/src/plugins/ec.spec.ts

@@ -25,7 +25,7 @@ describe('EC plugin', () => {
     beforeEach(() => {
         jest.clearAllMocks();
         client = createAnalyticsClientMock();
-        ec = new ECPlugin({client, uuidGenerator: someUUIDGenerator});
+        ec = new ECPlugin({client, uuidGenerator: someUUIDGenerator as any});
     });
 
     it('should register a hook in the client', () => {

package/src/plugins/ec.ts

@@ -1,5 +1,5 @@
 import {EventType} from '../events';
-import {uuidv4} from '../client/crypto';
+import {v4 as uuidv4} from 'uuid';
 import {
     convertProductToMeasurementProtocol,
     convertImpressionListToMeasurementProtocol,

package/src/plugins/svc.spec.ts

@@ -25,7 +25,7 @@ describe('SVC plugin', () => {
     beforeEach(() => {
         jest.clearAllMocks();
         client = createAnalyticsClientMock();
-        svc = new SVCPlugin({client, uuidGenerator: someUUIDGenerator});
+        svc = new SVCPlugin({client, uuidGenerator: someUUIDGenerator as any});
     });
 
     it('should register a hook in the client', () => {

package/src/plugins/svc.ts

@@ -1,5 +1,5 @@
 import {EventType} from '../events';
-import {uuidv4} from '../client/crypto';
+import {v4 as uuidv4} from 'uuid';
 import {convertTicketToMeasurementProtocol} from '../client/measurementProtocolMapping/serviceMeasurementProtocolMapper';
 import {BasePlugin, BasePluginEventTypes, PluginClass, PluginOptions} from './BasePlugin';
 

package/src/react-native/react-native-runtime.ts

@@ -2,7 +2,7 @@ import {WebStorage} from '../storage';
 import {AnalyticsFetchClient} from '../client/analyticsFetchClient';
 import {IRuntimeEnvironment} from '../client/runtimeEnvironment';
 import {PreprocessAnalyticsRequest} from '../client/analyticsRequestClient';
-import {uuidv4} from '../client/crypto';
+import {v4 as uuidv4} from 'uuid';
 import {buildBaseUrl} from '../client/analytics';
 
 export type ReactNativeStorage = WebStorage;

package/src/storage.spec.ts

@@ -1,4 +1,5 @@
 import {CookieStorage, CookieAndLocalStorage} from './storage';
+import {Cookie} from './cookieutils';
 
 describe('CookieStorage', () => {
     const key = 'wow';
@@ -16,6 +17,13 @@ describe('CookieStorage', () => {
         storage.removeItem(key);
         expect(storage.getItem(key)).toBe(null);
     });
+
+    it('honors expiration date', async () => {
+        const storage = new CookieStorage();
+        storage.setItem(key, someData, 1000);
+        await new Promise((res) => setTimeout(res, 1000)); // wait for 1 sec
+        expect(storage.getItem(key)).toBe(null);
+    });
 });
 
 describe('CookieAndLocalStorage', () => {

package/src/storage.ts

@@ -33,8 +33,8 @@ export class CookieStorage implements WebStorage {
     removeItem(key: string) {
         Cookie.erase(`${CookieStorage.prefix}${key}`);
     }
-    setItem(key: string, data: string): void {
-        Cookie.set(`${CookieStorage.prefix}${key}`, data);
+    setItem(key: string, data: string, expire?: number): void {
+        Cookie.set(`${CookieStorage.prefix}${key}`, data, expire);
     }
 }
 
@@ -52,7 +52,7 @@ export class CookieAndLocalStorage implements WebStorage {
 
     setItem(key: string, data: string): void {
         localStorage.setItem(key, data);
-        this.cookieStorage.setItem(key, data);
+        this.cookieStorage.setItem(key, data, 31556926000); // 1 year first party cookie
     }
 }
 

package/src/version.ts

@@ -0,0 +1 @@
+export const libVersion = process.env.PKG_VERSION || 'local'; // processed by @rollup/plugin-replace

package/dist/definitions/client/crypto.d.ts

@@ -1 +0,0 @@
-export declare const uuidv4: (a?: string | number | undefined) => string;

package/src/client/crypto.ts

@@ -1,21 +0,0 @@
-import {hasCryptoRandomValues} from '../detector';
-
-export const uuidv4 = (a?: number | string): string => {
-    if (!!a) {
-        return (Number(a) ^ (getRandomValues(new Uint8Array(1))[0] % 16 >> (Number(a) / 4))).toString(16);
-    }
-    return (`${1e7}` + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, uuidv4);
-};
-
-const getRandomValues = (rnds: Uint8Array) => {
-    if (hasCryptoRandomValues()) {
-        return crypto.getRandomValues(rnds);
-    }
-    for (var i = 0, r = 0; i < rnds.length; i++) {
-        if ((i & 0x03) === 0) {
-            r = Math.random() * 0x100000000;
-        }
-        rnds[i] = (r >>> ((i & 0x03) << 3)) & 0xff;
-    }
-    return rnds;
-};