refactor(headless): migrate recommendation interface load event (#3471)

* working solution https://coveord.atlassian.net/browse/KIT-2940 * cleaner code https://coveord.atlassian.net/browse/KIT-2940
coveo · Dec 13, 2023 · b644bdf · b644bdf
1 parent a645812
commit b644bdf
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 5 deletions.
diff --git a/packages/headless/src/features/recommendation/recommendation-actions.ts b/packages/headless/src/features/recommendation/recommendation-actions.ts
@@ -20,7 +20,11 @@ import {
 } from '../../utils/validate-payload';
 import {AnalyticsAsyncThunk} from '../analytics/analytics-utils';
 import {fromAnalyticsStateToAnalyticsParams} from '../configuration/analytics-params';
-import {logRecommendationUpdate} from './recommendation-analytics-actions';
+import {SearchAction} from '../search/search-actions';
+import {
+  logRecommendationUpdate,
+  recommendationInterfaceLoad,
+} from './recommendation-analytics-actions';
 
 export type StateNeededByGetRecommendations = ConfigurationSection &
   RecommendationSection &
@@ -59,9 +63,8 @@ export const getRecommendations = createAsyncThunk<
   async (_, {getState, rejectWithValue, extra: {apiClient}}) => {
     const state = getState();
     const startedAt = new Date().getTime();
-    const fetched = await apiClient.recommendations(
-      await buildRecommendationRequest(state)
-    );
+    const request = await buildRecommendationRequest(state);
+    const fetched = await apiClient.recommendations(request);
     const duration = new Date().getTime() - startedAt;
     if (isErrorResponse(fetched)) {
       return rejectWithValue(fetched.error);
@@ -114,11 +117,30 @@ export const buildRecommendationRequest = async (
     visitorId: await getVisitorID(s.configuration.analytics),
   }),
   ...(s.configuration.analytics.enabled &&
-    (await fromAnalyticsStateToAnalyticsParams(s.configuration.analytics))),
+    (await buildAnalyticsSection(s, recommendationInterfaceLoad()))),
   ...(s.configuration.search.authenticationProviders.length && {
     authentication: s.configuration.search.authenticationProviders.join(','),
   }),
   ...(s.pagination && {
     numberOfResults: s.pagination.numberOfResults,
   }),
 });
+
+const buildAnalyticsSection = async (
+  state: StateNeededByGetRecommendations,
+  action: SearchAction
+) => {
+  const eventDescription =
+    state.configuration.analytics.analyticsMode === 'legacy'
+      ? undefined
+      : {
+          customData: action.getEventExtraPayload(state),
+          actionCause: action.actionCause,
+          type: action.actionCause,
+        };
+
+  return await fromAnalyticsStateToAnalyticsParams(
+    state.configuration.analytics,
+    eventDescription
+  );
+};
diff --git a/packages/headless/src/features/recommendation/recommendation-analytics-actions.ts b/packages/headless/src/features/recommendation/recommendation-analytics-actions.ts
@@ -1,5 +1,6 @@
 import {ItemClick} from '@coveo/relay-event-types';
 import {RecommendationAnalyticsProvider} from '../../api/analytics/recommendations-analytics';
+import {SearchAnalyticsProvider} from '../../api/analytics/search-analytics';
 import {Result} from '../../api/search/search/result';
 import {
   ClickAction,
@@ -10,14 +11,25 @@ import {
   LegacySearchAction,
   validateResultPayload,
 } from '../analytics/analytics-utils';
+import {SearchPageEvents} from '../analytics/search-action-cause';
+import {SearchAction} from '../search/search-actions';
 
+//TODO: KIT-2859
 export const logRecommendationUpdate = (): LegacySearchAction =>
   makeAnalyticsAction(
     'analytics/recommendation/update',
     (client) => client.makeRecommendationInterfaceLoad(),
     (getState) => new RecommendationAnalyticsProvider(getState)
   );
 
+export const recommendationInterfaceLoad = (): SearchAction => {
+  return {
+    actionCause: SearchPageEvents.recommendationInterfaceLoad,
+    getEventExtraPayload: (state) =>
+      new SearchAnalyticsProvider(() => state).getBaseMetadata(),
+  };
+};
+
 export const logRecommendationOpen = (result: Result): ClickAction =>
   makeAnalyticsAction({
     prefix: 'analytics/recommendation/open',

diff --git a/packages/headless/src/integration-tests/analytics-migration.test.ts b/packages/headless/src/integration-tests/analytics-migration.test.ts
@@ -75,6 +75,10 @@ import {
   logRecentQueryClick,
   recentQueryClick,
 } from '../features/recent-queries/recent-queries-analytics-actions';
+import {
+  logRecommendationUpdate,
+  recommendationInterfaceLoad,
+} from '../features/recommendation/recommendation-analytics-actions';
 import {executeSearch} from '../features/search/search-actions';
 import {
   logResultsSort,
@@ -916,4 +920,17 @@ describe('Analytics Search Migration', () => {
 
     assertNextEqualsLegacy(callSpy);
   });
+
+  it('analytics/recommendation/update', async () => {
+    const action = executeSearch({
+      legacy: logRecommendationUpdate(),
+      next: recommendationInterfaceLoad(),
+    });
+
+    legacySearchEngine.dispatch(action);
+    nextSearchEngine.dispatch(action);
+    await wait();
+
+    assertNextEqualsLegacy(callSpy);
+  });
 });