coveo.analytics 2.30.44 → 2.30.45

package/src/caseAssist/caseAssistClient.spec.ts

@@ -11,6 +11,7 @@ import {TicketProperties} from '../plugins/svc';
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 import doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
+import {PartialDocumentInformation} from '../searchPage/searchPageEvents';
 jest.mock('../donottrack', () => {
     return {
         default: jest.fn(),
@@ -19,17 +20,31 @@ jest.mock('../donottrack', () => {
 });
 
 describe('CaseAssistClient', () => {
-    const defaultSearchHub = 'origin-level-1';
+    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: () => defaultSearchHub,
+        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',
         });
@@ -76,18 +91,18 @@ describe('CaseAssistClient', () => {
         };
     };
 
-    const fakeDocumentSuggestion = (): DocumentSuggestion => {
-        return {
-            responseId: 'document-suggestion-response-id',
-            suggestionId: 'document-suggestion-id',
-            suggestion: {
-                documentPosition: 0,
-                documentTitle: 'the document title',
-                documentUri: 'some-document-uri',
-                documentUriHash: 'documenturihash',
-                documentUrl: 'some-document-url',
-            },
-        };
+    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) => {
@@ -96,7 +111,23 @@ describe('CaseAssistClient', () => {
 
         expectMatchActionPayload(content, actionName, actionData);
         expectMatchTicketPayload(content, ticket);
-        expectMatchProperty(content, 'searchHub', defaultSearchHub);
+        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 = (
@@ -241,33 +272,26 @@ describe('CaseAssistClient', () => {
 
     it('should send proper payload for #logSelectDocumentSuggestion', async () => {
         await client.logSelectDocumentSuggestion({
-            suggestion: fakeDocumentSuggestion(),
+            suggestion: fakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
-        expectMatchPayload(CaseAssistActions.suggestionClick, fakeDocumentSuggestion(), fakeTicket);
-    });
-
-    it('should send proper payload for #logSelectDocumentSuggestion when the fromQuickview property is set to true', async () => {
-        const myFakeDocumentSuggestion = fakeDocumentSuggestion();
-        myFakeDocumentSuggestion.fromQuickview = true;
-        await client.logSelectDocumentSuggestion({
-            suggestion: myFakeDocumentSuggestion,
-            ticket: fakeTicket,
+        expectMatchDocumentPayload(CaseAssistActions.documentSuggestionClick, fakeDocumentSuggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: fakeDocumentSuggestion.permanentId,
         });
-
-        expectMatchPayload(CaseAssistActions.suggestionClick, myFakeDocumentSuggestion, fakeTicket);
     });
 
-    it('should send proper payload for #logSelectDocumentSuggestion when the openDocument property is set to true', async () => {
-        const myFakeDocumentSuggestion = fakeDocumentSuggestion();
-        myFakeDocumentSuggestion.openDocument = true;
-        await client.logSelectDocumentSuggestion({
-            suggestion: myFakeDocumentSuggestion,
+    it('should send proper payload for #logQuickviewDocumentSuggestion', async () => {
+        await client.logQuickviewDocumentSuggestion({
+            suggestion: fakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
-        expectMatchPayload(CaseAssistActions.suggestionClick, myFakeDocumentSuggestion, fakeTicket);
+        expectMatchDocumentPayload(CaseAssistActions.documentSuggestionQuickview, fakeDocumentSuggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: fakeDocumentSuggestion.permanentId,
+        });
     });
 
     it('should send proper payload for #logRateDocumentSuggestion', async () => {
@@ -275,14 +299,14 @@ describe('CaseAssistClient', () => {
 
         await client.logRateDocumentSuggestion({
             rating,
-            suggestion: fakeDocumentSuggestion(),
+            suggestion: fakeDocumentSuggestion,
             ticket: fakeTicket,
         });
 
         expectMatchPayload(
             CaseAssistActions.suggestionRate,
             {
-                ...fakeDocumentSuggestion(),
+                ...fakeDocumentSuggestion,
                 rate: rating,
             },
             fakeTicket

package/src/caseAssist/caseAssistClient.ts

@@ -1,7 +1,9 @@
 import CoveoAnalyticsClient, {AnalyticsClient, ClientOptions} from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import doNotTrack from '../donottrack';
+import {ClickEventRequest} from '../events';
 import {SVCPlugin} from '../plugins/svc';
+import {DocumentIdentifier, PartialDocumentInformation, SearchPageEvents} from '../searchPage/searchPageEvents';
 import {
     CaseAssistActions,
     CaseAssistEvents,
@@ -19,6 +21,12 @@ import {
 
 export interface CaseAssistClientProvider {
     getOriginLevel1: () => string;
+    getOriginLevel2: () => string;
+    getOriginLevel3: () => string;
+    getOriginContext: () => string;
+    getIsAnonymous: () => boolean;
+    getSearchUID: () => string;
+    getLanguage: () => string;
 }
 
 export interface CaseAssistClientOptions extends ClientOptions {
@@ -67,9 +75,17 @@ export class CaseAssistClient {
     }
 
     public logSelectDocumentSuggestion(meta: SelectDocumentSuggestionMetadata) {
-        this.svc.setAction(CaseAssistActions.suggestionClick, meta.suggestion);
-        this.svc.setTicket(meta.ticket);
-        return this.sendClickEvent();
+        return this.logClickEvent(CaseAssistActions.documentSuggestionClick, meta.suggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: meta.suggestion.permanentId,
+        });
+    }
+
+    public logQuickviewDocumentSuggestion(meta: SelectDocumentSuggestionMetadata) {
+        return this.logClickEvent(CaseAssistActions.documentSuggestionQuickview, meta.suggestion.suggestion, {
+            contentIDKey: 'permanentId',
+            contentIDValue: meta.suggestion.permanentId,
+        });
     }
 
     public logRateDocumentSuggestion(meta: RateDocumentSuggestionMetadata) {
@@ -136,4 +152,46 @@ export class CaseAssistClient {
                 : null
         );
     }
+
+    private async getBaseEventRequest(metadata?: Record<string, any>) {
+        const customData = {...metadata};
+        return {
+            ...this.getOrigins(),
+            customData,
+            language: this.provider?.getLanguage(),
+            anonymous: this.provider?.getIsAnonymous(),
+            clientId: await this.getClientId(),
+        };
+    }
+
+    private getClientId() {
+        return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
+            ? this.coveoAnalyticsClient.getCurrentVisitorId()
+            : undefined;
+    }
+
+    private getOrigins() {
+        return {
+            originContext: this.provider?.getOriginContext?.(),
+            originLevel1: this.provider?.getOriginLevel1(),
+            originLevel2: this.provider?.getOriginLevel2(),
+            originLevel3: this.provider?.getOriginLevel3(),
+        };
+    }
+
+    private async logClickEvent(
+        event: CaseAssistActions,
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        metadata?: Record<string, any>
+    ) {
+        const payload: ClickEventRequest = {
+            ...info,
+            ...(await this.getBaseEventRequest({...identifier, ...metadata})),
+            searchQueryUid: this.provider?.getSearchUID() ?? '',
+            actionCause: event,
+        };
+
+        return this.coveoAnalyticsClient.sendClickEvent(payload);
+    }
 }