feat(headless): change citation from custom to click event

packages/atomic/cypress/e2e/generated-answer-assertions.ts

@@ -2,7 +2,7 @@ import {should} from './common-assertions';
 import {GeneratedAnswerSelectors} from './generated-answer-selectors';
 
 export function assertLogOpenGeneratedAnswerSource() {
-  cy.expectCustomEvent('generatedAnswer', 'openGeneratedAnswerSource');
+  cy.expectClickEvent('generatedAnswerCitationClick');
 }
 
 export function assertLogGeneratedAnswerSourceHover() {

packages/headless/package.json

@@ -151,7 +151,7 @@
     "@microsoft/fetch-event-source": "2.0.1",
     "@reduxjs/toolkit": "2.2.7",
     "abortcontroller-polyfill": "1.7.5",
-    "coveo.analytics": "2.30.38",
+    "coveo.analytics": "2.30.39",
     "dayjs": "1.11.12",
     "exponential-backoff": "3.1.0",
     "fast-equals": "5.0.1",

packages/headless/src/api/generated-answer/generated-answer-event-payload.ts

@@ -14,6 +14,7 @@ export interface GeneratedAnswerCitation {
   title: string;
   uri: string;
   permanentid: string;
+  source: string;
   clickUri?: string;
   text?: string;
   fields?: Raw;

packages/headless/src/features/analytics/analytics-utils.ts

@@ -44,6 +44,7 @@ import {
   SearchAnalyticsProvider,
   StateNeededBySearchAnalyticsProvider,
 } from '../../api/analytics/search-analytics.js';
+import {GeneratedAnswerCitation} from '../../api/generated-answer/generated-answer-event-payload.js';
 import {PreprocessRequest} from '../../api/preprocess-request.js';
 import {Raw} from '../../api/search/search/raw.js';
 import {Result} from '../../api/search/search/result.js';
@@ -623,6 +624,38 @@ export const partialRecommendationInformation = (
 
   return buildPartialDocumentInformation(result, resultIndex, state);
 };
+
+export const partialCitationInformation = (
+  citation: GeneratedAnswerCitation,
+  state: Partial<SearchAppState>
+): PartialDocumentInformation => {
+  return {
+    sourceName: getCitationSourceName(citation),
+    documentPosition: 1,
+    documentTitle: citation.title,
+    documentUri: citation.uri,
+    documentUrl: citation.clickUri,
+    queryPipeline: state.pipeline || getPipelineInitialState(),
+  };
+};
+
+function getCitationSourceName(citation: GeneratedAnswerCitation) {
+  const source = citation.source;
+  if (isNullOrUndefined(source)) {
+    return 'unknown';
+  }
+  return source;
+}
+
+export const citationDocumentIdentifier = (
+  citation: GeneratedAnswerCitation
+) => {
+  return {
+    contentIdKey: 'permanentid',
+    contentIdValue: citation.permanentid || '',
+  };
+};
+
 function buildPartialDocumentInformation(
   result: Result,
   resultIndex: number,

packages/headless/src/features/generated-answer/__snapshots__/generated-answer-analytics-actions.test.ts.snap

@@ -88,7 +88,7 @@ exports[`generated answer analytics actions > when analyticsMode is \`next\` > s
       "title": "Sample citation",
       "uniqueFieldName": "permanentid",
       "uniqueFieldValue": "citation-permanent-id",
-      "url": undefined,
+      "url": "http://localhost/citations/some-citation-id",
     },
     "responseId": "123",
   },
@@ -114,7 +114,7 @@ exports[`generated answer analytics actions > when analyticsMode is \`next\` > s
       "title": "Sample citation",
       "uniqueFieldName": "permanentid",
       "uniqueFieldValue": "citation-permanent-id",
-      "url": undefined,
+      "url": "http://localhost/citations/some-citation-id",
     },
     "responseId": "123",
   },

packages/headless/src/features/generated-answer/__snapshots__/generated-answer-insight-analytics-actions.test.ts.snap

@@ -88,7 +88,7 @@ exports[`generated answer insight analytics actions > when analyticsMode is \`ne
       "title": "example title",
       "uniqueFieldName": "permanentid",
       "uniqueFieldValue": "citation_permanentid",
-      "url": undefined,
+      "url": "example: click uri",
     },
     "responseId": "123",
   },
@@ -114,7 +114,7 @@ exports[`generated answer insight analytics actions > when analyticsMode is \`ne
       "title": "example title",
       "uniqueFieldName": "permanentid",
       "uniqueFieldValue": "citation_permanentid",
-      "url": undefined,
+      "url": "example: click uri",
     },
     "responseId": "123",
   },

packages/headless/src/features/generated-answer/generated-answer-analytics-actions.test.ts

@@ -33,7 +33,7 @@ const mockMakeGeneratedAnswerFeedbackSubmit = vi.fn(() => ({
 const mockMakeRetryGeneratedAnswer = vi.fn(() => ({
   log: mockLogFunction,
 }));
-const mockMakeOpenGeneratedAnswerSource = vi.fn(() => ({
+const mockMakeGeneratedAnswerCitationClick = vi.fn((..._args) => ({
   log: mockLogFunction,
 }));
 const mockMakeGeneratedAnswerSourceHover = vi.fn(() => ({
@@ -84,7 +84,7 @@ vi.mock('coveo.analytics', () => {
     disable: vi.fn(),
     makeGeneratedAnswerFeedbackSubmit: mockMakeGeneratedAnswerFeedbackSubmit,
     makeRetryGeneratedAnswer: mockMakeRetryGeneratedAnswer,
-    makeOpenGeneratedAnswerSource: mockMakeOpenGeneratedAnswerSource,
+    makeGeneratedAnswerCitationClick: mockMakeGeneratedAnswerCitationClick,
     makeGeneratedAnswerSourceHover: mockMakeGeneratedAnswerSourceHover,
     makeLikeGeneratedAnswer: mockMakeLikeGeneratedAnswer,
     makeDislikeGeneratedAnswer: mockMakeDislikeGeneratedAnswer,
@@ -119,6 +119,22 @@ const exampleCitation: GeneratedAnswerCitation = {
   permanentid: 'citation-permanent-id',
   title: 'Sample citation',
   uri: 'http://localhost/citations/some-citation-id',
+  source: 'source-name',
+  clickUri: 'http://localhost/citations/some-citation-id',
+};
+
+const expectedCitationDocumentInfo = {
+  queryPipeline: '',
+  documentUri: exampleCitation.uri,
+  sourceName: exampleCitation.source,
+  documentPosition: 1,
+  documentTitle: exampleCitation.title,
+  documentUrl: exampleCitation.clickUri,
+};
+
+const exampleDocumentId = {
+  contentIdKey: 'permanentid',
+  contentIdValue: exampleCitation.permanentid,
 };
 
 describe('generated answer analytics actions', () => {
@@ -177,14 +193,20 @@ describe('generated answer analytics actions', () => {
         {} as ThunkExtraArguments
       );
 
-      const mockToUse = mockMakeOpenGeneratedAnswerSource;
+      const mockToUse = mockMakeGeneratedAnswerCitationClick;
 
       expect(mockToUse).toHaveBeenCalledTimes(1);
-      expect(mockToUse).toHaveBeenCalledWith({
+
+      expect(mockToUse.mock.calls[0][0]).toStrictEqual(
+        expectedCitationDocumentInfo
+      );
+
+      expect(mockToUse.mock.calls[0][1]).toStrictEqual({
         generativeQuestionAnsweringId: exampleGenerativeQuestionAnsweringId,
         citationId: exampleCitation.id,
-        permanentId: exampleCitation.permanentid,
+        documentId: exampleDocumentId,
       });
+
       expect(mockLogFunction).toHaveBeenCalledTimes(1);
     });