fix(connectToggleRefinement): cast currentRefinement to boolean (#2701)

algolia · Jul 23, 2019 · db934fd · db934fd
1 parent dd8b4e9
commit db934fd
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/packages/react-instantsearch-core/src/connectors/__tests__/connectToggleRefinement.js b/packages/react-instantsearch-core/src/connectors/__tests__/connectToggleRefinement.js
@@ -53,6 +53,16 @@ describe('connectToggleRefinement', () => {
       expect(actual.currentRefinement).toBe(false);
     });
 
+    it('expect `currentRefinement` to be `false` when searchState is a string considered falsy', () => {
+      const props = { attribute: 'shipping', value: true };
+      const searchState = { toggle: { shipping: 'false' } };
+      const searchResults = {};
+
+      const actual = getProvidedProps(props, searchState, searchResults);
+
+      expect(actual.currentRefinement).toBe(false);
+    });
+
     it('expect `currentRefinement` to be `defaultRefinement`', () => {
       const props = {
         defaultRefinement: true,
@@ -406,6 +416,18 @@ describe('connectToggleRefinement', () => {
       expect(actual.currentRefinement).toBe(false);
     });
 
+    it('expect `currentRefinement` to be `false` when searchState is a string considered falsy', () => {
+      const props = { attribute: 'shipping', value: true };
+      const searchState = createMultiIndexSearchState({
+        toggle: { shipping: 'false' },
+      });
+      const searchResults = {};
+
+      const actual = getProvidedProps(props, searchState, searchResults);
+
+      expect(actual.currentRefinement).toBe(false);
+    });
+
     it('expect `currentRefinement` to be `defaultRefinement`', () => {
       const props = {
         defaultRefinement: true,

diff --git a/packages/react-instantsearch-core/src/connectors/connectToggleRefinement.js b/packages/react-instantsearch-core/src/connectors/connectToggleRefinement.js
@@ -15,6 +15,8 @@ function getId(props) {
 
 const namespace = 'toggle';
 
+const falsyStrings = ['0', 'false', 'null', 'undefined'];
+
 function getCurrentRefinement(props, searchState, context) {
   const currentRefinement = getCurrentRefinementValue(
     props,
@@ -24,10 +26,11 @@ function getCurrentRefinement(props, searchState, context) {
     false
   );
 
-  if (currentRefinement) {
-    return currentRefinement;
+  if (falsyStrings.indexOf(currentRefinement) !== -1) {
+    return false;
   }
-  return false;
+
+  return Boolean(currentRefinement);
 }
 
 function refine(props, searchState, nextRefinement, context) {