coveo.analytics 2.30.56 → 2.32.0

package/src/caseAssist/caseAssistClient.spec.ts

@@ -1,10 +1,12 @@
+import {vi} from 'vitest';
+import type {Mock} from 'vitest';
 import {CaseAssistClient, CaseAssistClientProvider} from './caseAssistClient';
 import {
-    CaseAssistActions,
-    CaseAssistEvents,
-    CaseCancelledReasons,
-    DocumentSuggestion,
-    FieldSuggestion,
+  CaseAssistActions,
+  CaseAssistEvents,
+  CaseCancelledReasons,
+  DocumentSuggestion,
+  FieldSuggestion,
 } from './caseAssistActions';
 import {mockFetch, lastCallBody} from '../../tests/fetchMock';
 import {TicketProperties} from '../plugins/svc';
@@ -12,351 +14,380 @@ const {fetchMock, fetchMockBeforeEach} = mockFetch();
 import doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
 import {PartialDocumentInformation} from '../searchPage/searchPageEvents';
-jest.mock('../donottrack', () => {
-    return {
-        default: jest.fn(),
-        doNotTrack: jest.fn(),
-    };
+vi.mock('../donottrack', () => {
+  const doNotTrack = vi.fn();
+  return {
+    __esModule: true,
+    default: doNotTrack,
+    doNotTrack,
+    shouldDisableAnalyticsForPrivacy: (disableBrowserPrivacySignals?: boolean) =>
+      disableBrowserPrivacySignals === true ? false : doNotTrack(),
+  };
 });
 
 describe('CaseAssistClient', () => {
-    const exampleSearchHub = 'example origin-level-1';
-    const exampleOriginLevel2 = 'example origin-level-2';
-    const exampleOriginLevel3 = 'example origin-level-3';
-    const exampleOriginContext = 'example origin-context';
-    const exampleSearchUID = 'foo';
-    const exampleLanguage = 'en';
-    const exampleClientId = '123-456';
-
-    let client: CaseAssistClient;
-
-    const provider: CaseAssistClientProvider = {
-        getOriginLevel1: () => exampleSearchHub,
-        getOriginLevel2: () => exampleOriginLevel2,
-        getOriginLevel3: () => exampleOriginLevel3,
-        getOriginContext: () => exampleOriginContext,
-        getIsAnonymous: () => false,
-        getSearchUID: () => exampleSearchUID,
-        getLanguage: () => exampleLanguage,
+  const exampleSearchHub = 'example origin-level-1';
+  const exampleOriginLevel2 = 'example origin-level-2';
+  const exampleOriginLevel3 = 'example origin-level-3';
+  const exampleOriginContext = 'example origin-context';
+  const exampleSearchUID = 'foo';
+  const exampleLanguage = 'en';
+  const exampleClientId = '123-456';
+
+  let client: CaseAssistClient;
+
+  const provider: CaseAssistClientProvider = {
+    getOriginLevel1: () => exampleSearchHub,
+    getOriginLevel2: () => exampleOriginLevel2,
+    getOriginLevel3: () => exampleOriginLevel3,
+    getOriginContext: () => exampleOriginContext,
+    getIsAnonymous: () => false,
+    getSearchUID: () => exampleSearchUID,
+    getLanguage: () => exampleLanguage,
+  };
+
+  beforeEach(() => {
+    fetchMockBeforeEach();
+
+    client = initClient();
+    client.coveoAnalyticsClient.runtime.storage.setItem('visitorId', exampleClientId);
+    fetchMock.mock(/.*/, {
+      visitorId: 'visitor-id',
+    });
+  });
+
+  afterEach(() => {
+    fetchMock.reset();
+  });
+
+  const initClient = () => {
+    return new CaseAssistClient(
+      {
+        enableAnalytics: true,
+      },
+      provider
+    );
+  };
+
+  const noTicket: Record<string, unknown> = undefined;
+  const noActionData: Record<string, unknown> = undefined;
+  const emptyTicket: TicketProperties = {};
+
+  const fakeTicket: TicketProperties = {
+    id: 'the-ticket-id',
+    subject: 'the ticket subject',
+    description: 'the ticket description',
+    category: 'ticket-category',
+    productId: 'some-product-id',
+    custom: {
+      customA: 'custom-a-value',
+      customB: 'custom-b-value',
+    },
+  };
+
+  const fakeFieldSuggestion = (): FieldSuggestion => {
+    return {
+      classification: {
+        value: 'some-field-value',
+        confidence: 0.5,
+      },
+      classificationId: 'field-suggestion-id',
+      fieldName: 'some-field',
+      responseId: 'field-suggestion-response-id',
     };
-
-    beforeEach(() => {
-        fetchMockBeforeEach();
-
-        client = initClient();
-        client.coveoAnalyticsClient.runtime.storage.setItem('visitorId', exampleClientId);
-        fetchMock.mock(/.*/, {
-            visitorId: 'visitor-id',
-        });
+  };
+
+  const fakeDocumentSuggestion: DocumentSuggestion = {
+    responseId: 'document-suggestion-response-id',
+    suggestionId: 'document-suggestion-id',
+    permanentId: 'example permanent-id',
+    suggestion: {
+      documentPosition: 0,
+      documentTitle: 'the document title',
+      documentUri: 'some-document-uri',
+      documentUriHash: 'documenturihash',
+      documentUrl: 'some-document-url',
+      sourceName: 'example source-name',
+    },
+  };
+
+  const expectMatchPayload = (
+    actionName: CaseAssistActions,
+    actionData: object,
+    ticket: TicketProperties
+  ) => {
+    const body: string = lastCallBody(fetchMock);
+    const content = JSON.parse(body);
+
+    expectMatchActionPayload(content, actionName, actionData);
+    expectMatchTicketPayload(content, ticket);
+    expectMatchProperty(content, 'searchHub', exampleSearchHub);
+  };
+
+  const expectMatchDocumentPayload = (
+    actionCause: CaseAssistActions,
+    doc: PartialDocumentInformation,
+    meta = {}
+  ) => {
+    const body: string = lastCallBody(fetchMock);
+    const customData = {...meta};
+    expect(JSON.parse(body.toString())).toMatchObject({
+      actionCause,
+      customData,
+      language: exampleLanguage,
+      clientId: exampleClientId,
+      originContext: exampleOriginContext,
+      originLevel1: exampleSearchHub,
+      originLevel2: exampleOriginLevel2,
+      originLevel3: exampleOriginLevel3,
+      ...doc,
     });
-
-    afterEach(() => {
-        fetchMock.reset();
+  };
+
+  const expectMatchActionPayload = (
+    content: Record<string, unknown>,
+    actionName: CaseAssistActions,
+    actionData: object
+  ) => {
+    expectMatchProperty(content, 'ec', 'svc');
+    expectMatchProperty(content, 'svc_action', actionName);
+    expectMatchProperty(content, 'svc_action_data', actionData);
+
+    const expectedEvent =
+      actionName === CaseAssistActions.enterInterface
+        ? CaseAssistEvents.flowStart
+        : CaseAssistEvents.click;
+    expectMatchProperty(content, 'ea', expectedEvent);
+  };
+
+  const expectMatchTicketPayload = (
+    content: Record<string, unknown>,
+    ticket?: TicketProperties
+  ) => {
+    expectMatchProperty(content, 'svc_ticket_id', ticket?.id);
+    expectMatchProperty(content, 'svc_ticket_subject', ticket?.subject);
+    expectMatchProperty(content, 'svc_ticket_description', ticket?.description);
+    expectMatchProperty(content, 'svc_ticket_category', ticket?.category);
+    expectMatchProperty(content, 'svc_ticket_product_id', ticket?.productId);
+    expectMatchProperty(content, 'svc_ticket_custom', ticket?.custom);
+  };
+
+  const expectMatchProperty = (
+    content: Record<string, unknown>,
+    propName: string,
+    propValue: unknown
+  ) => {
+    if (typeof propValue !== 'undefined') {
+      if (typeof propValue === 'object') {
+        expect(content).toHaveProperty(propName);
+        expect(content[propName]).toMatchObject(propValue as object);
+      } else {
+        expect(content).toHaveProperty(propName, propValue);
+      }
+    } else {
+      expect(content).not.toHaveProperty(propName);
+    }
+  };
+
+  it('should have #enableAnalytics default to #true', async () => {
+    client = new CaseAssistClient({});
+
+    await client.logEnterInterface({
+      ticket: emptyTicket,
     });
 
-    const initClient = () => {
-        return new CaseAssistClient(
-            {
-                enableAnalytics: true,
-            },
-            provider,
-        );
-    };
-
-    const noTicket: Record<string, unknown> = undefined;
-    const noActionData: Record<string, unknown> = undefined;
-    const emptyTicket: TicketProperties = {};
-
-    const fakeTicket: TicketProperties = {
-        id: 'the-ticket-id',
-        subject: 'the ticket subject',
-        description: 'the ticket description',
-        category: 'ticket-category',
-        productId: 'some-product-id',
-        custom: {
-            customA: 'custom-a-value',
-            customB: 'custom-b-value',
-        },
-    };
-
-    const fakeFieldSuggestion = (): FieldSuggestion => {
-        return {
-            classification: {
-                value: 'some-field-value',
-                confidence: 0.5,
-            },
-            classificationId: 'field-suggestion-id',
-            fieldName: 'some-field',
-            responseId: 'field-suggestion-response-id',
-        };
-    };
-
-    const fakeDocumentSuggestion: DocumentSuggestion = {
-        responseId: 'document-suggestion-response-id',
-        suggestionId: 'document-suggestion-id',
-        permanentId: 'example permanent-id',
-        suggestion: {
-            documentPosition: 0,
-            documentTitle: 'the document title',
-            documentUri: 'some-document-uri',
-            documentUriHash: 'documenturihash',
-            documentUrl: 'some-document-url',
-            sourceName: 'example source-name',
-        },
-    };
+    expect(fetchMock.called()).toBe(true);
+  });
 
-    const expectMatchPayload = (actionName: CaseAssistActions, actionData: Object, ticket: TicketProperties) => {
-        const body: string = lastCallBody(fetchMock);
-        const content = JSON.parse(body);
-
-        expectMatchActionPayload(content, actionName, actionData);
-        expectMatchTicketPayload(content, ticket);
-        expectMatchProperty(content, 'searchHub', exampleSearchHub);
-    };
-
-    const expectMatchDocumentPayload = (actionCause: CaseAssistActions, doc: PartialDocumentInformation, meta = {}) => {
-        const body: string = lastCallBody(fetchMock);
-        const customData = {...meta};
-        expect(JSON.parse(body.toString())).toMatchObject({
-            actionCause,
-            customData,
-            language: exampleLanguage,
-            clientId: exampleClientId,
-            originContext: exampleOriginContext,
-            originLevel1: exampleSearchHub,
-            originLevel2: exampleOriginLevel2,
-            originLevel3: exampleOriginLevel3,
-            ...doc,
-        });
-    };
-
-    const expectMatchActionPayload = (
-        content: Record<string, unknown>,
-        actionName: CaseAssistActions,
-        actionData: Object,
-    ) => {
-        expectMatchProperty(content, 'ec', 'svc');
-        expectMatchProperty(content, 'svc_action', actionName);
-        expectMatchProperty(content, 'svc_action_data', actionData);
-
-        const expectedEvent =
-            actionName === CaseAssistActions.enterInterface ? CaseAssistEvents.flowStart : CaseAssistEvents.click;
-        expectMatchProperty(content, 'ea', expectedEvent);
-    };
-
-    const expectMatchTicketPayload = (content: Record<string, unknown>, ticket?: TicketProperties) => {
-        expectMatchProperty(content, 'svc_ticket_id', ticket?.id);
-        expectMatchProperty(content, 'svc_ticket_subject', ticket?.subject);
-        expectMatchProperty(content, 'svc_ticket_description', ticket?.description);
-        expectMatchProperty(content, 'svc_ticket_category', ticket?.category);
-        expectMatchProperty(content, 'svc_ticket_product_id', ticket?.productId);
-        expectMatchProperty(content, 'svc_ticket_custom', ticket?.custom);
-    };
-
-    const expectMatchProperty = (content: Record<string, unknown>, propName: string, propValue: unknown) => {
-        if (typeof propValue !== 'undefined') {
-            if (typeof propValue === 'object') {
-                expect(content).toHaveProperty(propName);
-                expect(content[propName]).toMatchObject(propValue as object);
-            } else {
-                expect(content).toHaveProperty(propName, propValue);
-            }
-        } else {
-            expect(content).not.toHaveProperty(propName);
-        }
-    };
-
-    it('should have #enableAnalytics default to #true', async () => {
-        client = new CaseAssistClient({});
-
-        await client.logEnterInterface({
-            ticket: emptyTicket,
-        });
-
-        expect(fetchMock.called()).toBe(true);
+  it('should not send events when #enableAnalytics option is #false', async () => {
+    client = new CaseAssistClient({
+      enableAnalytics: false,
     });
 
-    it('should not send events when #enableAnalytics option is #false', async () => {
-        client = new CaseAssistClient({
-            enableAnalytics: false,
-        });
-
-        await client.logEnterInterface({
-            ticket: emptyTicket,
-        });
-
-        expect(fetchMock.called()).toBe(false);
+    await client.logEnterInterface({
+      ticket: emptyTicket,
     });
 
-    it('should not send events when doNotTrack is enabled', async () => {
-        (doNotTrack as jest.Mock).mockImplementationOnce(() => true);
+    expect(fetchMock.called()).toBe(false);
+  });
 
-        client = new CaseAssistClient({});
+  it('should not send events when doNotTrack is enabled', async () => {
+    (doNotTrack as Mock).mockImplementationOnce(() => true);
 
-        await client.logEnterInterface({
-            ticket: emptyTicket,
-        });
+    client = new CaseAssistClient({});
 
-        expect(fetchMock.called()).toBe(false);
+    await client.logEnterInterface({
+      ticket: emptyTicket,
     });
 
-    it('should not send events after #disable function is called', async () => {
-        client.disable();
+    expect(fetchMock.called()).toBe(false);
+  });
 
-        await client.logEnterInterface({
-            ticket: emptyTicket,
-        });
+  it('should not send events after #disable function is called', async () => {
+    client.disable();
 
-        expect(fetchMock.called()).toBe(false);
+    await client.logEnterInterface({
+      ticket: emptyTicket,
     });
 
-    it('disabling does not delete the visitorId', () => {
-        const visitorId = 'uuid';
-        Cookie.set('coveo_visitorId', visitorId);
+    expect(fetchMock.called()).toBe(false);
+  });
 
-        expect(Cookie.get('coveo_visitorId')).toBe(visitorId);
-        client.disable();
-        expect(Cookie.get('coveo_visitorId')).toBe(visitorId);
-    });
+  it('disabling does not delete the visitorId', () => {
+    const visitorId = 'uuid';
+    Cookie.set('coveo_visitorId', visitorId);
 
-    it('should send events after #enable function is called', async () => {
-        client = new CaseAssistClient({
-            enableAnalytics: false,
-        });
+    expect(Cookie.get('coveo_visitorId')).toBe(visitorId);
+    client.disable();
+    expect(Cookie.get('coveo_visitorId')).toBe(visitorId);
+  });
 
-        client.enable();
+  it('should send events after #enable function is called', async () => {
+    client = new CaseAssistClient({
+      enableAnalytics: false,
+    });
 
-        await client.logEnterInterface({
-            ticket: emptyTicket,
-        });
+    client.enable();
 
-        expect(fetchMock.called()).toBe(true);
+    await client.logEnterInterface({
+      ticket: emptyTicket,
     });
 
-    it('should send proper payload for #logEnterInterface', async () => {
-        await client.logEnterInterface({
-            ticket: emptyTicket,
-        });
+    expect(fetchMock.called()).toBe(true);
+  });
 
-        expectMatchPayload(CaseAssistActions.enterInterface, noActionData, noTicket);
+  it('should send proper payload for #logEnterInterface', async () => {
+    await client.logEnterInterface({
+      ticket: emptyTicket,
     });
 
-    it('should send proper payload for #logUpdateCaseField', async () => {
-        await client.logUpdateCaseField({
-            fieldName: 'subject',
-            ticket: fakeTicket,
-        });
+    expectMatchPayload(CaseAssistActions.enterInterface, noActionData, noTicket);
+  });
 
-        expectMatchPayload(CaseAssistActions.fieldUpdate, {fieldName: 'subject'}, fakeTicket);
+  it('should send proper payload for #logUpdateCaseField', async () => {
+    await client.logUpdateCaseField({
+      fieldName: 'subject',
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logSelectFieldSuggestion', async () => {
-        await client.logSelectFieldSuggestion({
-            suggestion: fakeFieldSuggestion(),
-            ticket: fakeTicket,
-        });
+    expectMatchPayload(CaseAssistActions.fieldUpdate, {fieldName: 'subject'}, fakeTicket);
+  });
 
-        expectMatchPayload(CaseAssistActions.fieldSuggestionClick, fakeFieldSuggestion(), fakeTicket);
+  it('should send proper payload for #logSelectFieldSuggestion', async () => {
+    await client.logSelectFieldSuggestion({
+      suggestion: fakeFieldSuggestion(),
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logSelectFieldSuggestion when the autoSelection property is set to true', async () => {
-        const myFakeFieldSuggestion = fakeFieldSuggestion();
-        myFakeFieldSuggestion.autoSelection = true;
-        await client.logSelectFieldSuggestion({
-            suggestion: myFakeFieldSuggestion,
-            ticket: fakeTicket,
-        });
+    expectMatchPayload(CaseAssistActions.fieldSuggestionClick, fakeFieldSuggestion(), fakeTicket);
+  });
 
-        expectMatchPayload(CaseAssistActions.fieldSuggestionClick, myFakeFieldSuggestion, fakeTicket);
+  it('should send proper payload for #logSelectFieldSuggestion when the autoSelection property is set to true', async () => {
+    const myFakeFieldSuggestion = fakeFieldSuggestion();
+    myFakeFieldSuggestion.autoSelection = true;
+    await client.logSelectFieldSuggestion({
+      suggestion: myFakeFieldSuggestion,
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logSelectDocumentSuggestion', async () => {
-        await client.logSelectDocumentSuggestion({
-            suggestion: fakeDocumentSuggestion,
-            ticket: fakeTicket,
-        });
+    expectMatchPayload(CaseAssistActions.fieldSuggestionClick, myFakeFieldSuggestion, fakeTicket);
+  });
 
-        expectMatchDocumentPayload(CaseAssistActions.documentSuggestionClick, fakeDocumentSuggestion.suggestion, {
-            contentIDKey: 'permanentId',
-            contentIDValue: fakeDocumentSuggestion.permanentId,
-        });
+  it('should send proper payload for #logSelectDocumentSuggestion', async () => {
+    await client.logSelectDocumentSuggestion({
+      suggestion: fakeDocumentSuggestion,
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logQuickviewDocumentSuggestion', async () => {
-        await client.logQuickviewDocumentSuggestion({
-            suggestion: fakeDocumentSuggestion,
-            ticket: fakeTicket,
-        });
-
-        expectMatchDocumentPayload(CaseAssistActions.documentSuggestionQuickview, fakeDocumentSuggestion.suggestion, {
-            contentIDKey: 'permanentId',
-            contentIDValue: fakeDocumentSuggestion.permanentId,
-        });
+    expectMatchDocumentPayload(
+      CaseAssistActions.documentSuggestionClick,
+      fakeDocumentSuggestion.suggestion,
+      {
+        contentIDKey: 'permanentId',
+        contentIDValue: fakeDocumentSuggestion.permanentId,
+      }
+    );
+  });
+
+  it('should send proper payload for #logQuickviewDocumentSuggestion', async () => {
+    await client.logQuickviewDocumentSuggestion({
+      suggestion: fakeDocumentSuggestion,
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logRateDocumentSuggestion', async () => {
-        const rating = 0.8;
-
-        await client.logRateDocumentSuggestion({
-            rating,
-            suggestion: fakeDocumentSuggestion,
-            ticket: fakeTicket,
-        });
-
-        expectMatchPayload(
-            CaseAssistActions.suggestionRate,
-            {
-                ...fakeDocumentSuggestion,
-                rate: rating,
-            },
-            fakeTicket,
-        );
+    expectMatchDocumentPayload(
+      CaseAssistActions.documentSuggestionQuickview,
+      fakeDocumentSuggestion.suggestion,
+      {
+        contentIDKey: 'permanentId',
+        contentIDValue: fakeDocumentSuggestion.permanentId,
+      }
+    );
+  });
+
+  it('should send proper payload for #logRateDocumentSuggestion', async () => {
+    const rating = 0.8;
+
+    await client.logRateDocumentSuggestion({
+      rating,
+      suggestion: fakeDocumentSuggestion,
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logMoveToNextCaseStep', async () => {
-        const stageName = 'stage 1';
+    expectMatchPayload(
+      CaseAssistActions.suggestionRate,
+      {
+        ...fakeDocumentSuggestion,
+        rate: rating,
+      },
+      fakeTicket
+    );
+  });
+
+  it('should send proper payload for #logMoveToNextCaseStep', async () => {
+    const stageName = 'stage 1';
+
+    await client.logMoveToNextCaseStep({
+      ticket: fakeTicket,
+      stage: stageName,
+    });
 
-        await client.logMoveToNextCaseStep({
-            ticket: fakeTicket,
-            stage: stageName,
-        });
+    expectMatchPayload(CaseAssistActions.nextCaseStep, {stage: stageName}, fakeTicket);
+  });
 
-        expectMatchPayload(CaseAssistActions.nextCaseStep, {stage: stageName}, fakeTicket);
+  it('should send proper payload for #logCaseCancelled', async () => {
+    await client.logCaseCancelled({
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logCaseCancelled', async () => {
-        await client.logCaseCancelled({
-            ticket: fakeTicket,
-        });
-
-        expectMatchPayload(
-            CaseAssistActions.caseCancelled,
-            {
-                reason: CaseCancelledReasons.quit,
-            },
-            fakeTicket,
-        );
+    expectMatchPayload(
+      CaseAssistActions.caseCancelled,
+      {
+        reason: CaseCancelledReasons.quit,
+      },
+      fakeTicket
+    );
+  });
+
+  it('should send proper payload for #logCaseSolved', async () => {
+    await client.logCaseSolved({
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logCaseSolved', async () => {
-        await client.logCaseSolved({
-            ticket: fakeTicket,
-        });
-
-        expectMatchPayload(
-            CaseAssistActions.caseSolved,
-            {
-                reason: CaseCancelledReasons.solved,
-            },
-            fakeTicket,
-        );
+    expectMatchPayload(
+      CaseAssistActions.caseSolved,
+      {
+        reason: CaseCancelledReasons.solved,
+      },
+      fakeTicket
+    );
+  });
+
+  it('should send proper payload for #logCaseCreated', async () => {
+    await client.logCaseCreated({
+      ticket: fakeTicket,
     });
 
-    it('should send proper payload for #logCaseCreated', async () => {
-        await client.logCaseCreated({
-            ticket: fakeTicket,
-        });
-
-        expectMatchPayload(CaseAssistActions.caseCreated, noActionData, fakeTicket);
-    });
+    expectMatchPayload(CaseAssistActions.caseCreated, noActionData, fakeTicket);
+  });
 });