Fix: Compute canRefine on the transformed items (#1568)

* Fix: Compute canRefine on the transformed items Resolves #1524 * Add tests to connectors for ensuring canRefine is based on transformed items * style: run Prettier
algolia · Sep 26, 2018 · c95384f · c95384f
1 parent e914ff6
commit c95384f
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 7 deletions.
diff --git a/packages/react-instantsearch-core/src/connectors/__tests__/connectCurrentRefinements.js b/packages/react-instantsearch-core/src/connectors/__tests__/connectCurrentRefinements.js
@@ -110,4 +110,13 @@ describe('connectCurrentRefinements', () => {
       { id: 2, index: 'something', label: 'cadabra' },
     ]);
   });
+
+  it('computes canRefine based on the length of the transformed items list', () => {
+    const transformItems = () => [];
+    const props = getProvidedProps({ transformItems }, null, null, [
+      { items: [{ label: 'one' }], id: 1, index: 'something' },
+    ]);
+
+    expect(props.canRefine).toEqual(false);
+  });
 });
diff --git a/packages/react-instantsearch-core/src/connectors/__tests__/connectHierarchicalMenu.js b/packages/react-instantsearch-core/src/connectors/__tests__/connectHierarchicalMenu.js
@@ -542,7 +542,25 @@ describe('connectHierarchicalMenu', () => {
         hierarchicalMenu: {},
       });
     });
+
+    it('computes canRefine based on the length of the transformed items list', () => {
+      const transformItems = () => [];
+      const results = {
+        getFacetValues: () => ({ data: [{ id: 'test' }] }),
+        getFacetByName: () => true,
+        hits: [],
+      };
+
+      props = getProvidedProps(
+        { attributes: ['ok'], transformItems },
+        {},
+        { results }
+      );
+
+      expect(props.canRefine).toEqual(false);
+    });
   });
+
   describe('multi index', () => {
     let context = {
       context: {

diff --git a/packages/react-instantsearch-core/src/connectors/__tests__/connectMenu.js b/packages/react-instantsearch-core/src/connectors/__tests__/connectMenu.js
@@ -431,6 +431,25 @@ describe('connectMenu', () => {
         },
       ]);
     });
+
+    it('computes canRefine based on the length of the transformed items list', () => {
+      const transformItems = () => [];
+      const results = {
+        getFacetValues: () => [
+          { count: 1, id: 'test', isRefined: true, name: 'test' },
+        ],
+        getFacetByName: () => true,
+        hits: [],
+      };
+
+      props = getProvidedProps(
+        { attribute: 'ok', transformItems },
+        {},
+        { results }
+      );
+
+      expect(props.canRefine).toEqual(false);
+    });
   });
   describe('multi index', () => {
     let context = {

diff --git a/packages/react-instantsearch-core/src/connectors/__tests__/connectNumericMenu.js b/packages/react-instantsearch-core/src/connectors/__tests__/connectNumericMenu.js
@@ -353,6 +353,21 @@ describe('connectNumericMenu', () => {
         another: { searchState: 'searchState' },
       });
     });
+
+    it('computes canRefine based on the length of the transformed items list', () => {
+      const transformItems = () => [];
+
+      props = getProvidedProps(
+        {
+          items: [{ label: 'Ok', start: 100 }],
+          transformItems,
+        },
+        {},
+        { results }
+      );
+
+      expect(props.canRefine).toEqual(false);
+    });
   });
   describe('multi index', () => {
     let context = {

diff --git a/packages/react-instantsearch-core/src/connectors/__tests__/connectRefinementList.js b/packages/react-instantsearch-core/src/connectors/__tests__/connectRefinementList.js
@@ -422,6 +422,18 @@ describe('connectRefinementList', () => {
         maxFacetHits: 25,
       });
     });
+
+    it('computes canRefine based on the length of the transformed items list', () => {
+      const transformItems = () => [];
+
+      props = getProvidedProps(
+        { attribute: 'ok', transformItems },
+        {},
+        { results }
+      );
+
+      expect(props.canRefine).toEqual(false);
+    });
   });
 
   describe('multi index', () => {

diff --git a/packages/react-instantsearch-core/src/connectors/connectCurrentRefinements.js b/packages/react-instantsearch-core/src/connectors/connectCurrentRefinements.js
@@ -45,9 +45,13 @@ export default createConnector({
       return res;
     }, []);
 
+    const transformedItems = props.transformItems
+      ? props.transformItems(items)
+      : items;
+
     return {
-      items: props.transformItems ? props.transformItems(items) : items,
-      canRefine: items.length > 0,
+      items: transformedItems,
+      canRefine: transformedItems.length > 0,
     };
   },
 

diff --git a/packages/react-instantsearch-core/src/connectors/connectHierarchicalMenu.js b/packages/react-instantsearch-core/src/connectors/connectHierarchicalMenu.js
@@ -204,7 +204,7 @@ export default createConnector({
     return {
       items: truncate(transformedItems, itemsLimit),
       currentRefinement: getCurrentRefinement(props, searchState, this.context),
-      canRefine: items.length > 0,
+      canRefine: transformedItems.length > 0,
     };
   },
 

diff --git a/packages/react-instantsearch-core/src/connectors/connectMenu.js b/packages/react-instantsearch-core/src/connectors/connectMenu.js
@@ -166,7 +166,7 @@ export default createConnector({
       currentRefinement: getCurrentRefinement(props, searchState, this.context),
       isFromSearch,
       searchable,
-      canRefine: items.length > 0,
+      canRefine: transformedItems.length > 0,
     };
   },
 

diff --git a/packages/react-instantsearch-core/src/connectors/connectNumericMenu.js b/packages/react-instantsearch-core/src/connectors/connectNumericMenu.js
@@ -160,11 +160,16 @@ export default createConnector({
       });
     }
 
+    const transformedItems = props.transformItems
+      ? props.transformItems(items)
+      : items;
+
     return {
-      items: props.transformItems ? props.transformItems(items) : items,
+      items: transformedItems,
       currentRefinement,
       canRefine:
-        items.length > 0 && items.some(item => item.noRefinement === false),
+        transformedItems.length > 0 &&
+        transformedItems.some(item => item.noRefinement === false),
     };
   },
 

diff --git a/packages/react-instantsearch-core/src/connectors/connectRefinementList.js b/packages/react-instantsearch-core/src/connectors/connectRefinementList.js
@@ -179,7 +179,7 @@ export default createConnector({
       currentRefinement: getCurrentRefinement(props, searchState, this.context),
       isFromSearch,
       searchable,
-      canRefine: items.length > 0,
+      canRefine: transformedItems.length > 0,
     };
   },