fix(headless): ensure each folded result keep a reference of its 'sou…

…rce' searchId V2 (#4629)

Backporting #4628
https://coveord.atlassian.net/browse/KIT-3703

packages/headless/src/features/folding/folding-actions.ts

@@ -47,6 +47,7 @@ export interface LoadCollectionFulfilledReturn {
   results: Result[];
   collectionId: CollectionId;
   rootResult: ResultWithFolding;
+  searchUid: string;
 }
 
 export const foldingOptionsSchemaDefinition: SchemaDefinition<
@@ -105,6 +106,7 @@ export const loadCollection = createAsyncThunk<
     return {
       collectionId,
       results: response.success.results,
+      searchUid: response.success.searchUid,
       rootResult: state.folding.collections[collectionId]!
         .result as ResultWithFolding,
     };

packages/headless/src/features/folding/folding-slice.test.ts

@@ -166,6 +166,7 @@ describe('folding slice', () => {
         collectionId: results[0].raw.collection!,
         results,
         rootResult,
+        searchUid: 'some-search-uid',
       });
     }
 
@@ -205,6 +206,30 @@ describe('folding slice', () => {
         );
       };
 
+      it('when a fetchPage fulfilled is received, new results should contain the latest search #searchUid', () => {
+        const indexedResults = buildMockResultsFromHierarchy(
+          'thread',
+          testThreadHierarchy
+        );
+        const rootResult = emulateAPIFolding(indexedResults);
+        const response = {
+          ...buildMockSearchResponse({results: [rootResult]}),
+          searchUid: 'a_new_id',
+        };
+        const search = buildMockSearch({
+          response,
+        });
+
+        const finalState = foldingReducer(
+          state,
+          fetchMoreResults.fulfilled(search, '')
+        );
+
+        expect(finalState.collections.thread.children[0].result.searchUid).toBe(
+          'a_new_id'
+        );
+      });
+
       it('uses #cq with correct expression to obtain the full collection', async () => {
         await doLoadCollection();
         expect(apiClient.search).toHaveBeenCalledWith(
@@ -257,7 +282,7 @@ describe('folding slice', () => {
         );
       });
 
-      it('does not uses facets to get the full collection', async () => {
+      it('does not use facets to get the full collection', async () => {
         await doLoadCollection();
         expect(apiClient.search).toHaveBeenCalledWith(
           expect.not.objectContaining({

packages/headless/src/features/folding/folding-slice.ts

@@ -66,13 +66,16 @@ function resolveChildrenFromFields(
         getParentField(result, fields) === sourceChildValue;
       return isChildOfSource && !isSameResultAsSource;
     })
-    .map((result) => ({
-      result,
-      children: resolveChildrenFromFields(result, results, fields, [
-        ...resolvedAncestors,
-        sourceChildValue,
-      ]),
-    }));
+    .map((result) => {
+      const extendedResult = {...result, searchUid: parent.searchUid};
+      return {
+        result: extendedResult,
+        children: resolveChildrenFromFields(extendedResult, results, fields, [
+          ...resolvedAncestors,
+          sourceChildValue,
+        ]),
+      };
+    });
 }
 
 function resolveRootFromFields(
@@ -101,6 +104,7 @@ function resolveRootFromParentResult(
 function createCollectionFromResult(
   relevantResult: ResultWithFolding,
   fields: FoldingFields,
+  searchUid: string,
   rootResult?: ResultWithFolding
 ): FoldedCollection {
   const resultsInCollection = getAllIncludedResultsFrom(relevantResult);
@@ -110,10 +114,12 @@ function createCollectionFromResult(
     resolveRootFromFields(resultsInCollection, fields) ??
     resolveRootFromParentResult(relevantResult);
 
+  const extendedResultToUseAsRoot = {...resultToUseAsRoot, searchUid};
+
   return {
-    result: resultToUseAsRoot,
+    result: extendedResultToUseAsRoot,
     children: resolveChildrenFromFields(
-      resultToUseAsRoot,
+      extendedResultToUseAsRoot,
       resultsInCollection,
       fields
     ),
@@ -125,6 +131,7 @@ function createCollectionFromResult(
 function createCollections(
   results: ResultWithFolding[],
   fields: FoldingFields,
+  searchUid: string,
   rootResult?: ResultWithFolding
 ) {
   const collections: Record<CollectionId, FoldedCollection> = {};
@@ -139,6 +146,7 @@ function createCollections(
     collections[collectionId] = createCollectionFromResult(
       result,
       fields,
+      searchUid,
       rootResult
     );
   });
@@ -168,15 +176,17 @@ export const foldingReducer = createReducer(
         state.collections = state.enabled
           ? createCollections(
               payload.response.results as ResultWithFolding[],
-              state.fields
+              state.fields,
+              payload.response.searchUid
             )
           : {};
       })
       .addCase(fetchPage.fulfilled, (state, {payload}) => {
         state.collections = state.enabled
           ? createCollections(
               payload.response.results as ResultWithFolding[],
-              state.fields
+              state.fields,
+              payload.response.searchUid
             )
           : {};
       })
@@ -186,7 +196,8 @@ export const foldingReducer = createReducer(
               ...state.collections,
               ...createCollections(
                 payload.response.results as ResultWithFolding[],
-                state.fields
+                state.fields,
+                payload.response.searchUid
               ),
             }
           : {};
@@ -222,10 +233,11 @@ export const foldingReducer = createReducer(
       })
       .addCase(
         loadCollection.fulfilled,
-        (state, {payload: {collectionId, results, rootResult}}) => {
+        (state, {payload: {collectionId, results, rootResult, searchUid}}) => {
           const newCollections = createCollections(
             results as ResultWithFolding[],
             state.fields,
+            searchUid,
             rootResult
           );
           if (!newCollections || !newCollections[collectionId]) {

packages/headless/src/features/folding/insight-folding-actions.ts

@@ -61,6 +61,7 @@ export const loadCollection = createAsyncThunk<
     return {
       collectionId,
       results: response.success.results,
+      searchUid: response.success.searchUid,
       rootResult: state.folding.collections[collectionId]!
         .result as ResultWithFolding,
     };

packages/headless/src/features/search/search-slice.test.ts

@@ -236,6 +236,25 @@ describe('search-slice', () => {
       expect(finalState.results[1].searchUid).toBe('a_new_id');
     });
 
+    it('when a fetchPage fulfilled is received, new results should contain the latest search #searchUid', () => {
+      state.results = state.results.map((result) => ({
+        ...result,
+        searchUid: 'an_initial_id',
+      }));
+      const response = buildMockSearchResponse({results: [newResult]});
+      response.searchUid = 'a_new_id';
+      const search = buildMockSearch({
+        response,
+      });
+
+      const finalState = searchReducer(
+        state,
+        fetchPage.fulfilled(search, '', {legacy: logPageNext()})
+      );
+
+      expect(finalState.results[0].searchUid).toBe('a_new_id');
+    });
+
     it('when a fetchMoreResults fulfilled is received, keeps the previous #questionAnswer', () => {
       const originalQuestionAnswers = buildMockQuestionsAnswers({
         question: 'Why?',

packages/headless/src/features/search/search-slice.ts

@@ -94,7 +94,12 @@ export const searchReducer = createReducer(
     });
     builder.addCase(fetchPage.fulfilled, (state, action) => {
       handleFulfilledSearch(state, action);
-      state.results = action.payload.response.results;
+      state.results = [
+        ...action.payload.response.results.map((result) => ({
+          ...result,
+          searchUid: action.payload.response.searchUid,
+        })),
+      ];
     });
     builder.addCase(fetchFacetValues.fulfilled, (state, action) => {
       state.response.facets = action.payload.response.facets;