feat(headless): executeSearch action for insight refactored to be com…

…patible with the new event protocol (#3678) ## [SFINT-5418](https://coveord.atlassian.net/browse/SFINT-5418) In this PR: - I adapted the `ExecuteSearch` action for the insight use case to be compatible with the new event protocol, instead of accepting an insight analytics action as a parameter now it accepts a transitive action: ``` interface TransitiveInsightSearchAction { legacy: LegacyInsightAction; next?: InsightSearchAction; } ``` when the analytics mode will be set to `legacy`, the `ExecuteSearch` action will keep working exactly how it was before by executing the search and logging a search event. However, when the analytics mode will be set to `next`, we will no longer send search event. - I refactored the logic executed inside the `ExecuteSearch` insight action to make it follow the pattern of the `ExecuteSearch` search action. This new pattern implements the class `AsyncInsightSearchThunkProcessor`, this class will take care of doing the search query and will take care of properly processing its response. This new logic allows us to better structure and organize the code and it makes it easier to test the logic executed by the `ExecuteSearch` insight action [SFINT-5418]: https://coveord.atlassian.net/browse/SFINT-5418?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Sylvie Allain <58052881+sallainCoveo@users.noreply.github.com>
coveo · Mar 11, 2024 · b18d0ce · b18d0ce
1 parent a3f5b9c
commit b18d0ce
Show file tree

Hide file tree

Showing 26 changed files with 1,105 additions and 296 deletions.
diff --git a/packages/headless/src/app/insight-engine/insight-engine.ts b/packages/headless/src/app/insight-engine/insight-engine.ts
@@ -116,7 +116,7 @@ export function buildInsightEngine(
         return;
       }
 
-      engine.dispatch(executeSearch(analyticsEvent));
+      engine.dispatch(executeSearch({legacy: analyticsEvent}));
     },
   };
 }

diff --git a/...eadless/src/controllers/insight/breadcrumb-manager/headless-insight-breadcrumb-manager.ts b/...eadless/src/controllers/insight/breadcrumb-manager/headless-insight-breadcrumb-manager.ts
@@ -107,7 +107,7 @@ export function buildBreadcrumbManager(
         dispatch(
           updateFreezeCurrentValues({facetId, freezeCurrentValues: false})
         );
-        dispatch(executeSearch(analyticsAction));
+        dispatch(executeSearch({legacy: analyticsAction}));
       },
       executeToggleExclude: ({facetId, selection}) => {
         const analyticsAction = logFacetBreadcrumb({
@@ -118,7 +118,7 @@ export function buildBreadcrumbManager(
         dispatch(
           updateFreezeCurrentValues({facetId, freezeCurrentValues: false})
         );
-        dispatch(executeSearch(analyticsAction));
+        dispatch(executeSearch({legacy: analyticsAction}));
       },
       facetValuesSelector: facetResponseActiveValuesSelector,
     };
@@ -133,11 +133,11 @@ export function buildBreadcrumbManager(
       facetSet: getState().numericFacetSet,
       executeToggleSelect: (payload) => {
         dispatch(toggleSelectNumericFacetValue(payload));
-        dispatch(executeSearch(logNumericFacetBreadcrumb(payload)));
+        dispatch(executeSearch({legacy: logNumericFacetBreadcrumb(payload)}));
       },
       executeToggleExclude: (payload) => {
         dispatch(toggleExcludeNumericFacetValue(payload));
-        dispatch(executeSearch(logNumericFacetBreadcrumb(payload)));
+        dispatch(executeSearch({legacy: logNumericFacetBreadcrumb(payload)}));
       },
       facetValuesSelector: numericFacetActiveValuesSelector,
     };
@@ -152,11 +152,11 @@ export function buildBreadcrumbManager(
         facetSet: getState().dateFacetSet,
         executeToggleSelect: (payload) => {
           dispatch(toggleSelectDateFacetValue(payload));
-          dispatch(executeSearch(logDateFacetBreadcrumb(payload)));
+          dispatch(executeSearch({legacy: logDateFacetBreadcrumb(payload)}));
         },
         executeToggleExclude: (payload) => {
           dispatch(toggleExcludeDateFacetValue(payload));
-          dispatch(executeSearch(logDateFacetBreadcrumb(payload)));
+          dispatch(executeSearch({legacy: logDateFacetBreadcrumb(payload)}));
         },
         facetValuesSelector: dateFacetActiveValuesSelector,
       };
@@ -176,14 +176,14 @@ export function buildBreadcrumbManager(
       deselect: () => {
         dispatch(deselectAllCategoryFacetValues(facetId));
         dispatch(
-          executeSearch(
-            logCategoryFacetBreadcrumb({
+          executeSearch({
+            legacy: logCategoryFacetBreadcrumb({
               categoryFacetPath: path.map(
                 (categoryFacetValue) => categoryFacetValue.value
               ),
               categoryFacetId: facetId,
-            })
-          )
+            }),
+          })
         );
       },
     };
@@ -229,7 +229,7 @@ export function buildBreadcrumbManager(
         } else if (value.state === 'excluded') {
           dispatch(toggleExcludeStaticFilterValue({id, value}));
         }
-        dispatch(executeSearch(analytics));
+        dispatch(executeSearch({legacy: analytics}));
       },
     };
   };
@@ -260,7 +260,7 @@ export function buildBreadcrumbManager(
 
     deselectAll: () => {
       controller.deselectAll();
-      dispatch(executeSearch(logClearBreadcrumbs()));
+      dispatch(executeSearch({legacy: logClearBreadcrumbs()}));
     },
   };
 }

diff --git a/packages/headless/src/controllers/insight/did-you-mean/headless-insight-did-you-mean.ts b/packages/headless/src/controllers/insight/did-you-mean/headless-insight-did-you-mean.ts
@@ -33,7 +33,7 @@ export function buildDidYouMean(engine: InsightEngine): DidYouMean {
 
     applyCorrection() {
       controller.applyCorrection();
-      dispatch(executeSearch(logDidYouMeanClick()));
+      dispatch(executeSearch({legacy: logDidYouMeanClick()}));
     },
   };
 }
diff --git a/...headless/src/controllers/insight/facets/category-facet/headless-insight-category-facet.ts b/...headless/src/controllers/insight/facets/category-facet/headless-insight-category-facet.ts
@@ -92,20 +92,23 @@ export function buildCategoryFacet(
         getFacetId(),
         selection
       );
-      dispatch(executeSearch(analyticsAction));
+      dispatch(executeSearch({legacy: analyticsAction}));
     },
 
     deselectAll() {
       coreController.deselectAll();
-      dispatch(executeSearch(logFacetClearAll(getFacetId())));
+      dispatch(executeSearch({legacy: logFacetClearAll(getFacetId())}));
     },
 
     sortBy(criterion: CategoryFacetSortCriterion) {
       coreController.sortBy(criterion);
       dispatch(
-        executeSearch(
-          logFacetUpdateSort({facetId: getFacetId(), sortCriterion: criterion})
-        )
+        executeSearch({
+          legacy: logFacetUpdateSort({
+            facetId: getFacetId(),
+            sortCriterion: criterion,
+          }),
+        })
       );
     },
 
@@ -115,12 +118,12 @@ export function buildCategoryFacet(
 
     showMoreValues() {
       coreController.showMoreValues();
-      dispatch(fetchFacetValues(logFacetShowMore(getFacetId())));
+      dispatch(fetchFacetValues({legacy: logFacetShowMore(getFacetId())}));
     },
 
     showLessValues() {
       coreController.showLessValues();
-      dispatch(fetchFacetValues(logFacetShowLess(getFacetId())));
+      dispatch(fetchFacetValues({legacy: logFacetShowLess(getFacetId())}));
     },
 
     get state() {

diff --git a/packages/headless/src/controllers/insight/facets/facet/headless-insight-facet.ts b/packages/headless/src/controllers/insight/facets/facet/headless-insight-facet.ts
@@ -127,23 +127,26 @@ export function buildFacet(engine: InsightEngine, props: FacetProps): Facet {
     toggleSelect(selection) {
       coreController.toggleSelect(selection);
       dispatch(
-        executeSearch(
-          getInsightAnalyticsActionForToggleFacetSelect(getFacetId(), selection)
-        )
+        executeSearch({
+          legacy: getInsightAnalyticsActionForToggleFacetSelect(
+            getFacetId(),
+            selection
+          ),
+        })
       );
     },
 
     deselectAll() {
       coreController.deselectAll();
-      dispatch(executeSearch(logFacetClearAll(getFacetId())));
+      dispatch(executeSearch({legacy: logFacetClearAll(getFacetId())}));
     },
 
     sortBy(sortCriterion: FacetSortCriterion) {
       coreController.sortBy(sortCriterion);
       dispatch(
-        executeSearch(
-          logFacetUpdateSort({facetId: getFacetId(), sortCriterion})
-        )
+        executeSearch({
+          legacy: logFacetUpdateSort({facetId: getFacetId(), sortCriterion}),
+        })
       );
     },
 
@@ -153,12 +156,12 @@ export function buildFacet(engine: InsightEngine, props: FacetProps): Facet {
 
     showMoreValues() {
       coreController.showMoreValues();
-      dispatch(fetchFacetValues(logFacetShowMore(getFacetId())));
+      dispatch(fetchFacetValues({legacy: logFacetShowMore(getFacetId())}));
     },
 
     showLessValues() {
       coreController.showLessValues();
-      dispatch(fetchFacetValues(logFacetShowLess(getFacetId())));
+      dispatch(fetchFacetValues({legacy: logFacetShowLess(getFacetId())}));
     },
 
     get state() {

diff --git a/...less/src/controllers/insight/facets/range-facet/date-facet/headless-insight-date-facet.ts b/...less/src/controllers/insight/facets/range-facet/date-facet/headless-insight-date-facet.ts
@@ -50,27 +50,27 @@ export function buildDateFacet(
 
     deselectAll() {
       coreController.deselectAll();
-      dispatch(executeSearch(logFacetClearAll(getFacetId())));
+      dispatch(executeSearch({legacy: logFacetClearAll(getFacetId())}));
     },
 
     sortBy(sortCriterion: RangeFacetSortCriterion) {
       coreController.sortBy(sortCriterion);
       dispatch(
-        executeSearch(
-          logFacetUpdateSort({facetId: getFacetId(), sortCriterion})
-        )
+        executeSearch({
+          legacy: logFacetUpdateSort({facetId: getFacetId(), sortCriterion}),
+        })
       );
     },
 
     toggleSelect: (selection: DateFacetValue) => {
       coreController.toggleSelect(selection);
       dispatch(
-        executeSearch(
-          getInsightAnalyticsActionForToggleRangeFacetSelect(
+        executeSearch({
+          legacy: getInsightAnalyticsActionForToggleRangeFacetSelect(
             getFacetId(),
             selection
-          )
-        )
+          ),
+        })
       );
     },
 

diff --git a/...ess/src/controllers/insight/facets/range-facet/date-facet/headless-insight-date-filter.ts b/...ess/src/controllers/insight/facets/range-facet/date-facet/headless-insight-date-filter.ts
@@ -54,18 +54,18 @@ export function buildDateFilter(
     ...coreController,
     clear: () => {
       coreController.clear();
-      dispatch(executeSearch(logFacetClearAll(getFacetId())));
+      dispatch(executeSearch({legacy: logFacetClearAll(getFacetId())}));
     },
     setRange: (range) => {
       const success = coreController.setRange(range);
       if (success) {
         dispatch(
-          executeSearch(
-            logFacetSelect({
+          executeSearch({
+            legacy: logFacetSelect({
               facetId: getFacetId(),
               facetValue: `${range.start}..${range.end}`,
-            })
-          )
+            }),
+          })
         );
       }
       return success;

diff --git a/...rc/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-facet.ts b/...rc/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-facet.ts
@@ -49,27 +49,27 @@ export function buildNumericFacet(
 
     deselectAll() {
       coreController.deselectAll();
-      dispatch(executeSearch(logFacetClearAll(getFacetId())));
+      dispatch(executeSearch({legacy: logFacetClearAll(getFacetId())}));
     },
 
     sortBy(sortCriterion: RangeFacetSortCriterion) {
       coreController.sortBy(sortCriterion);
       dispatch(
-        executeSearch(
-          logFacetUpdateSort({facetId: getFacetId(), sortCriterion})
-        )
+        executeSearch({
+          legacy: logFacetUpdateSort({facetId: getFacetId(), sortCriterion}),
+        })
       );
     },
 
     toggleSelect: (selection: NumericFacetValue) => {
       coreController.toggleSelect(selection);
       dispatch(
-        executeSearch(
-          getInsightAnalyticsActionForToggleRangeFacetSelect(
+        executeSearch({
+          legacy: getInsightAnalyticsActionForToggleRangeFacetSelect(
             getFacetId(),
             selection
-          )
-        )
+          ),
+        })
       );
     },
 

diff --git a/...c/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-filter.ts b/...c/controllers/insight/facets/range-facet/numeric-facet/headless-insight-numeric-filter.ts
@@ -41,18 +41,18 @@ export function buildNumericFilter(
     ...coreController,
     clear: () => {
       coreController.clear();
-      dispatch(executeSearch(logFacetClearAll(getFacetId())));
+      dispatch(executeSearch({legacy: logFacetClearAll(getFacetId())}));
     },
     setRange: (range) => {
       const success = coreController.setRange(range);
       if (success) {
         dispatch(
-          executeSearch(
-            logFacetSelect({
+          executeSearch({
+            legacy: logFacetSelect({
               facetId: getFacetId(),
               facetValue: `${range.start}..${range.end}`,
-            })
-          )
+            }),
+          })
         );
       }
       return success;

diff --git a/...es/headless/src/controllers/insight/generated-answer/headless-insight-generated-answer.ts b/...es/headless/src/controllers/insight/generated-answer/headless-insight-generated-answer.ts
@@ -45,20 +45,22 @@ export function buildGeneratedAnswer(
 
     retry() {
       dispatch(
-        executeSearch(
-          generatedAnswerInsightAnalyticsClient.logRetryGeneratedAnswer()
-        )
+        executeSearch({
+          legacy:
+            generatedAnswerInsightAnalyticsClient.logRetryGeneratedAnswer(),
+        })
       );
     },
 
     rephrase(responseFormat: GeneratedResponseFormat) {
       controller.rephrase(responseFormat);
       dispatch(
-        executeSearch(
-          generatedAnswerInsightAnalyticsClient.logRephraseGeneratedAnswer(
-            responseFormat
-          )
-        )
+        executeSearch({
+          legacy:
+            generatedAnswerInsightAnalyticsClient.logRephraseGeneratedAnswer(
+              responseFormat
+            ),
+        })
       );
     },
   };

diff --git a/packages/headless/src/controllers/insight/pager/headless-insight-pager.ts b/packages/headless/src/controllers/insight/pager/headless-insight-pager.ts
@@ -39,17 +39,17 @@ export function buildPager(
 
     selectPage(page: number) {
       pager.selectPage(page);
-      dispatch(fetchPage(logPageNumber()));
+      dispatch(fetchPage({legacy: logPageNumber()}));
     },
 
     nextPage() {
       pager.nextPage();
-      dispatch(fetchPage(logPageNext()));
+      dispatch(fetchPage({legacy: logPageNext()}));
     },
 
     previousPage() {
       pager.previousPage();
-      dispatch(fetchPage(logPagePrevious()));
+      dispatch(fetchPage({legacy: logPagePrevious()}));
     },
   };
 }
diff --git a/...es/headless/src/controllers/insight/results-per-page/headless-insight-results-per-page.ts b/...es/headless/src/controllers/insight/results-per-page/headless-insight-results-per-page.ts
@@ -41,7 +41,7 @@ export function buildResultsPerPage(
 
     set(num: number) {
       coreController.set(num);
-      dispatch(executeSearch(logPagerResize()));
+      dispatch(executeSearch({legacy: logPagerResize()}));
     },
   };
 }
diff --git a/packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts b/packages/headless/src/controllers/insight/search-box/headless-insight-search-box.ts
@@ -80,7 +80,7 @@ export function buildSearchBox(
     ...props,
     executeSearchActionCreator: executeSearch,
     fetchQuerySuggestionsActionCreator: fetchQuerySuggestions,
-    isNextAnalyticsReady: false,
+    isNextAnalyticsReady: true,
   });
 
   return {

diff --git a/...controllers/insight/search-parameter-manager/headless-insight-search-parameter-manager.ts b/...controllers/insight/search-parameter-manager/headless-insight-search-parameter-manager.ts
@@ -47,7 +47,9 @@ export function buildSearchParameterManager(
         return;
       }
       controller.synchronize(parameters);
-      dispatch(executeSearch(logParametersChange(oldParams, newParams)));
+      dispatch(
+        executeSearch({legacy: logParametersChange(oldParams, newParams)})
+      );
     },
 
     get state() {