feat(headless): added redux analytics actions for attach citations feature

packages/headless/src/features/analytics/search-action-cause.ts

@@ -180,6 +180,10 @@ export enum SearchPageEvents {
    * Identifies the custom event that gets logged when a user clicks the Detach From Case result action.
    */
   caseDetach = 'caseDetach',
+  /**
+   * Identifies the click event that gets logged when a user attaches a generated answer citation to a case.
+   */
+  generatedAnswerCitationDocumentAttach = 'generatedAnswerCitationDocumentAttach',
   /**
    * Identifies the cause of a search request being retried in order to regenerate an answer stream that failed.
    */

packages/headless/src/features/attached-results/attached-results-actions.ts

@@ -38,6 +38,7 @@ const attachedResultPayloadDefinition = {
   source: nonEmptyString,
   title: requiredNonEmptyString,
   uriHash: nonEmptyString,
+  isCitation: new BooleanValue({required: false, default: false}),
 };
 
 const RequiredAttachedResultRecord = new RecordValue({
@@ -48,7 +49,7 @@ const RequiredAttachedResultRecord = new RecordValue({
 });
 
 export const setAttachedResults = createAction(
-  'insight/attachToCase/setAttachedResults',
+  'insight/attachedResults/setAttachedResults',
   (payload: SetAttachedResultsActionCreatorPayload) =>
     validatePayload(payload, {
       results: new ArrayValue({
@@ -62,12 +63,12 @@ export const setAttachedResults = createAction(
 );
 
 export const attachResult = createAction(
-  'insight/attachToCase/attach',
+  'insight/attachedResults/attach',
   (payload: AttachedResult) => validatePayloadAndPermanentIdOrUriHash(payload)
 );
 
 export const detachResult = createAction(
-  'insight/attachToCase/detach',
+  'insight/attachedResults/detach',
   (payload: AttachedResult) => validatePayloadAndPermanentIdOrUriHash(payload)
 );
 

packages/headless/src/features/attached-results/attached-results-analytics-actions.test.ts

@@ -13,19 +13,25 @@ import {getConfigurationInitialState} from '../configuration/configuration-state
 import {
   logCaseAttach,
   logCaseDetach,
+  logCitationDocumentAttach,
 } from './attached-results-analytics-actions.js';
 
 const mockLogCaseAttach = vi.fn();
 const mockLogCaseDetach = vi.fn();
+const mockLogGeneratedAnswerCitationDocumentAttach = vi.fn();
 const emit = vi.fn();
 
 vi.mock('@coveo/relay');
 
 vi.mock('coveo.analytics');
-vi.mocked(CoveoInsightClient).mockImplementation(function () {
+vi.mocked(CoveoInsightClient).mockImplementation(function (
+  this: CoveoInsightClient
+) {
   this.disable = () => {};
   this.logCaseAttach = mockLogCaseAttach;
   this.logCaseDetach = mockLogCaseDetach;
+  this.logGeneratedAnswerCitationDocumentAttach =
+    mockLogGeneratedAnswerCitationDocumentAttach;
 });
 
 vi.mocked(createRelay).mockReturnValue({
@@ -166,6 +172,36 @@ describe('attached results analytics actions', () => {
         );
       });
     });
+
+    describe('logCitationDocumentAttach', () => {
+      it('should call coveo.analytics.logGeneratedAnswerCitationDocumentAttach properly', async () => {
+        await logCitationDocumentAttach(testResult)()(
+          engine.dispatch,
+          () => engine.state,
+          {} as ThunkExtraArguments
+        );
+
+        expect(
+          mockLogGeneratedAnswerCitationDocumentAttach
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          mockLogGeneratedAnswerCitationDocumentAttach.mock.calls[0][0]
+        ).toStrictEqual(expectedDocumentInfo);
+        expect(
+          mockLogGeneratedAnswerCitationDocumentAttach.mock.calls[0][1]
+        ).toStrictEqual({
+          generativeQuestionAnsweringId: 'unknown',
+          citationId: 'example documentUriHash',
+          documentId: {
+            contentIdKey: 'permanentid',
+            contentIdValue: 'example contentIDValue',
+          },
+        });
+        expect(
+          mockLogGeneratedAnswerCitationDocumentAttach.mock.calls[0][2]
+        ).toStrictEqual(expectedMetadata);
+      });
+    });
   });
 
   describe('when analyticsMode is `next`', () => {

packages/headless/src/features/attached-results/attached-results-analytics-actions.ts

@@ -10,6 +10,7 @@ import {
 import {analyticsEventCaseContext} from '../analytics/insight-analytics-utils.js';
 import {SearchPageEvents} from '../analytics/search-action-cause.js';
 import {getCaseContextAnalyticsMetadata} from '../case-context/case-context-state.js';
+import {generativeQuestionAnsweringIdSelector} from '../generated-answer/generated-answer-selectors.js';
 
 export const logCaseAttach = (result: Result) =>
   makeInsightAnalyticsActionFactory(SearchPageEvents.caseAttach)({
@@ -55,3 +56,30 @@ export const logCaseDetach = (result: Result) =>
       };
     },
   });
+
+export const logCitationDocumentAttach = (result: Result) =>
+  makeInsightAnalyticsActionFactory(
+    SearchPageEvents.generatedAnswerCitationDocumentAttach
+  )({
+    prefix: 'insight/generatedAnswerCitationDocumentAttach',
+    __legacy__getBuilder: (client, state) => {
+      validateResultPayload(result);
+      const metadata = getCaseContextAnalyticsMetadata(
+        state.insightCaseContext
+      );
+      const citation = {
+        generativeQuestionAnsweringId:
+          generativeQuestionAnsweringIdSelector(state) || 'unknown',
+        citationId: result.raw.urihash || result.raw.permanentid || 'unknown',
+        documentId: {
+          contentIdKey: 'permanentid',
+          contentIdValue: result.raw.permanentid || result.uniqueId,
+        },
+      };
+      return client.logGeneratedAnswerCitationDocumentAttach(
+        partialDocumentInformation(result, state),
+        citation,
+        metadata
+      );
+    },
+  });

packages/headless/src/features/attached-results/attached-results-slice.test.ts

@@ -35,7 +35,7 @@ describe('attached results slice', () => {
     });
     const finalState = attachedResultsReducer(state, action);
     expect(finalState.results).toBe(action.payload.results);
-    expect(finalState.results.length).toEqual(1);
+    expect(finalState.results.length).toBe(1);
     expect(finalState.results).toContainEqual(testAttachedResult);
   });
 
@@ -46,15 +46,15 @@ describe('attached results slice', () => {
     });
     const finalState = attachedResultsReducer(state, action);
     expect(finalState).toStrictEqual(action.payload);
-    expect(finalState.results.length).toEqual(0);
+    expect(finalState.results.length).toBe(0);
     expect(finalState.loading).toBe(true);
   });
 
   it('#attachResult correctly adds a result in the attached state', () => {
     const testAttachedResult = createMockAttachedResult();
     const action = attachResult(testAttachedResult);
     const finalState = attachedResultsReducer(state, action);
-    expect(finalState.results.length).toEqual(1);
+    expect(finalState.results.length).toBe(1);
     expect(finalState.results).toStrictEqual([testAttachedResult]);
   });
 
@@ -71,7 +71,7 @@ describe('attached results slice', () => {
       finalState = attachedResultsReducer(finalState, action);
     });
 
-    expect(finalState.results.length).toEqual(attachedResults.length);
+    expect(finalState.results.length).toBe(attachedResults.length);
     expect(finalState.results).toStrictEqual([...attachedResults]);
   });
 
@@ -91,7 +91,7 @@ describe('attached results slice', () => {
     const action = detachResult(testDetachResult);
 
     const finalState = attachedResultsReducer(state, action);
-    expect(finalState.results.length).toEqual(0);
+    expect(finalState.results.length).toBe(0);
   });
 
   it('#detachResult will detach an attached result', () => {
@@ -106,7 +106,7 @@ describe('attached results slice', () => {
     const detachAction = detachResult(testDetachResult);
     const finalState = attachedResultsReducer(intermediateState, detachAction);
 
-    expect(finalState.results.length).toEqual(0);
+    expect(finalState.results.length).toBe(0);
   });
 
   it('#detachResult will detach the correct result among multiple attached results', () => {

packages/headless/src/features/attached-results/attached-results-state.ts

@@ -39,6 +39,10 @@ export interface AttachedResult {
    * The uriHash of the attached result.
    */
   uriHash?: string;
+  /**
+   * Whether the attached result is a citation.
+   */
+  isCitation?: boolean;
 }
 
 export interface AttachedResultsState {