fix(cache): support nested hierarchical refinements (#6283)

algolia · Jul 12, 2024 · 8a0ae01 · 8a0ae01
1 parent 6022197
commit 8a0ae01
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 5 deletions.
diff --git a/packages/algoliasearch-helper/src/requestBuilder.js b/packages/algoliasearch-helper/src/requestBuilder.js
@@ -109,11 +109,10 @@ var requestBuilder = {
             params.facetFilters = filteredFacetFilters.concat(
               parent.attribute + ':' + parent.value
             );
+          } else if (filteredFacetFilters.length > 0) {
+            params.facetFilters = filteredFacetFilters;
           } else {
-            params.facetFilters =
-              filteredFacetFilters.length > 0
-                ? filteredFacetFilters
-                : undefined;
+            delete params.facetFilters;
           }
 
           queries.push({ indexName: index, params: params });

diff --git a/packages/instantsearch.js/src/lib/__tests__/server.test.ts b/packages/instantsearch.js/src/lib/__tests__/server.test.ts
@@ -3,7 +3,11 @@ import {
   createSearchClient,
 } from '@instantsearch/mocks';
 
-import { connectConfigure, connectSearchBox } from '../../connectors';
+import {
+  connectConfigure,
+  connectHierarchicalMenu,
+  connectSearchBox,
+} from '../../connectors';
 import instantsearch from '../../index.es';
 import { index } from '../../widgets';
 import { getInitialResults, waitForResults } from '../server';
@@ -347,4 +351,74 @@ describe('getInitialResults', () => {
       expectedInitialResults
     );
   });
+
+  test('returns correct requestParams with nested hierarchical facets', async () => {
+    const search = instantsearch({
+      indexName: 'indexName',
+      searchClient: createSearchClient(),
+      initialUiState: {
+        indexName: {
+          hierarchicalMenu: {
+            'hierarchicalCategories.lvl0': ['Appliances', 'Fans'],
+          },
+        },
+      },
+    });
+
+    search.addWidgets([
+      connectHierarchicalMenu(() => {})({
+        attributes: [
+          'hierarchicalCategories.lvl0',
+          'hierarchicalCategories.lvl1',
+        ],
+      }),
+    ]);
+
+    search.start();
+
+    const requestParams = await waitForResults(search);
+
+    expect(requestParams).toMatchInlineSnapshot(`
+      [
+        {
+          "facetFilters": [
+            [
+              "hierarchicalCategories.lvl1:Appliances > Fans",
+            ],
+          ],
+          "facets": [
+            "hierarchicalCategories.lvl0",
+            "hierarchicalCategories.lvl1",
+          ],
+          "maxValuesPerFacet": 10,
+        },
+        {
+          "analytics": false,
+          "clickAnalytics": false,
+          "facetFilters": [
+            [
+              "hierarchicalCategories.lvl0:Appliances",
+            ],
+          ],
+          "facets": [
+            "hierarchicalCategories.lvl0",
+            "hierarchicalCategories.lvl1",
+          ],
+          "hitsPerPage": 0,
+          "maxValuesPerFacet": 10,
+          "page": 0,
+        },
+        {
+          "analytics": false,
+          "clickAnalytics": false,
+          "facets": [
+            "hierarchicalCategories.lvl0",
+          ],
+          "hitsPerPage": 0,
+          "maxValuesPerFacet": 10,
+          "page": 0,
+        },
+      ]
+    `);
+  });
 });