feat(headless): started sending response linked event for CRGA with EP (#6211)

Author: mmitiche

packages/headless/src/api/knowledge/stream-answer-api.ts

@@ -7,7 +7,10 @@ import {
   updateCitations,
   updateMessage,
 } from '../../features/generated-answer/generated-answer-actions.js';
-import {logGeneratedAnswerStreamEnd} from '../../features/generated-answer/generated-answer-analytics-actions.js';
+import {
+  logGeneratedAnswerResponseLinked,
+  logGeneratedAnswerStreamEnd,
+} from '../../features/generated-answer/generated-answer-analytics-actions.js';
 import type {AnswerApiQueryParams} from '../../features/generated-answer/generated-answer-request.js';
 import {fetchEventSource} from '../../utils/fetch-event-source/fetch.js';
 import type {EventSourceMessage} from '../../utils/fetch-event-source/parse.js';
@@ -129,6 +132,7 @@ export const updateCacheWithEvent = (
       dispatch(
         logGeneratedAnswerStreamEnd(parsedPayload.answerGenerated ?? false)
       );
+      dispatch(logGeneratedAnswerResponseLinked());
       break;
   }
 };

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

@@ -68,6 +68,16 @@ exports[`generated answer analytics actions > when analyticsMode is \`next\` > s
 ]
 `;
 
+exports[`generated answer analytics actions > when analyticsMode is \`next\` > should log #logGeneratedAnswerResponseLinked with the response id and answer id 1`] = `
+[
+  "Rga.ResponseLinked",
+  {
+    "answerId": "94b77748-2479-4e4b-a4e8-010fa62b04a0",
+    "responseId": "456",
+  },
+]
+`;
+
 exports[`generated answer analytics actions > when analyticsMode is \`next\` > should log #logGeneratedAnswerShowAnswers with the right payload 1`] = `
 [
   "Rga.AnswerAction",

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

@@ -68,6 +68,16 @@ exports[`generated answer insight analytics actions > when analyticsMode is \`ne
 ]
 `;
 
+exports[`generated answer insight analytics actions > when analyticsMode is \`next\` > should log #logGeneratedAnswerResponseLinked with the response id and answer id 1`] = `
+[
+  "Rga.ResponseLinked",
+  {
+    "answerId": "123",
+    "responseId": "456",
+  },
+]
+`;
+
 exports[`generated answer insight analytics actions > when analyticsMode is \`next\` > should log #logGeneratedAnswerShowAnswers with the right payload 1`] = `
 [
   "Rga.AnswerAction",

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

@@ -32,7 +32,10 @@ import {
   requiredNonEmptyString,
   validatePayload,
 } from '../../utils/validate-payload.js';
-import {logGeneratedAnswerStreamEnd} from './generated-answer-analytics-actions.js';
+import {
+  logGeneratedAnswerResponseLinked,
+  logGeneratedAnswerStreamEnd,
+} from './generated-answer-analytics-actions.js';
 import {
   buildStreamingRequest,
   constructAnswerAPIQueryParams,
@@ -264,6 +267,7 @@ export const streamAnswer = createAsyncThunk<
         dispatch(setIsStreaming(false));
         dispatch(setIsAnswerGenerated(isAnswerGenerated));
         dispatch(logGeneratedAnswerStreamEnd(isAnswerGenerated));
+        dispatch(logGeneratedAnswerResponseLinked());
         break;
       }
       default:

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

@@ -17,6 +17,7 @@ import {
   logGeneratedAnswerExpand,
   logGeneratedAnswerFeedback,
   logGeneratedAnswerHideAnswers,
+  logGeneratedAnswerResponseLinked,
   logGeneratedAnswerShowAnswers,
   logGeneratedAnswerStreamEnd,
   logHoverCitation,
@@ -558,5 +559,16 @@ describe('generated answer analytics actions', () => {
         expect(emit.mock.calls[0]).toMatchSnapshot();
       });
     });
+
+    it('should log #logGeneratedAnswerResponseLinked with the response id and answer id', async () => {
+      await logGeneratedAnswerResponseLinked()()(
+        engine.dispatch,
+        () => engine.state,
+        {} as ThunkExtraArguments
+      );
+
+      expect(emit).toHaveBeenCalledTimes(1);
+      expect(emit.mock.calls[0]).toMatchSnapshot();
+    });
   });
 });

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

@@ -248,6 +248,26 @@ export const logGeneratedAnswerStreamEnd = (
     },
   });
 
+export const logGeneratedAnswerResponseLinked = (): CustomAction =>
+  makeAnalyticsAction({
+    prefix: 'analytics/generatedAnswer/responseLinked',
+    __legacy__getBuilder: () => {
+      return null;
+    },
+    analyticsType: 'Rga.ResponseLinked',
+    analyticsPayloadBuilder: (state): Rga.ResponseLinked | undefined => {
+      const generativeQuestionAnsweringId =
+        generativeQuestionAnsweringIdSelector(state);
+      return {
+        answerId: generativeQuestionAnsweringId ?? '',
+        responseId:
+          state.search?.searchResponseId ||
+          state.search?.response.searchUid ||
+          '',
+      };
+    },
+  });
+
 export const logGeneratedAnswerShowAnswers = (): CustomAction =>
   makeAnalyticsAction({
     prefix: 'analytics/generatedAnswer/show',

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

@@ -16,6 +16,7 @@ import {
   logGeneratedAnswerExpand,
   logGeneratedAnswerFeedback,
   logGeneratedAnswerHideAnswers,
+  logGeneratedAnswerResponseLinked,
   logGeneratedAnswerShowAnswers,
   logGeneratedAnswerStreamEnd,
   logHoverCitation,
@@ -549,5 +550,16 @@ describe('generated answer insight analytics actions', () => {
         expect(emit.mock.calls[0]).toMatchSnapshot();
       });
     });
+
+    it('should log #logGeneratedAnswerResponseLinked with the response id and answer id', async () => {
+      await logGeneratedAnswerResponseLinked()()(
+        engine.dispatch,
+        () => engine.state,
+        {} as ThunkExtraArguments
+      );
+
+      expect(emit).toHaveBeenCalledTimes(1);
+      expect(emit.mock.calls[0]).toMatchSnapshot();
+    });
   });
 });

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

@@ -253,6 +253,26 @@ export const logGeneratedAnswerStreamEnd = (
     },
   });
 
+export const logGeneratedAnswerResponseLinked = (): InsightAction =>
+  makeInsightAnalyticsActionFactory(SearchPageEvents.generatedAnswerStreamEnd)({
+    prefix: 'analytics/generatedAnswer/streamEnd',
+    __legacy__getBuilder: () => {
+      return null;
+    },
+    analyticsType: 'Rga.ResponseLinked',
+    analyticsPayloadBuilder: (state): Rga.ResponseLinked | undefined => {
+      const generativeQuestionAnsweringId =
+        generativeQuestionAnsweringIdSelector(state);
+      return {
+        answerId: generativeQuestionAnsweringId ?? '',
+        responseId:
+          state.search?.searchResponseId ||
+          state.search?.response.searchUid ||
+          '',
+      };
+    },
+  });
+
 export const logGeneratedAnswerShowAnswers = (): InsightAction =>
   makeInsightAnalyticsActionFactory(
     SearchPageEvents.generatedAnswerShowAnswers