refactor(lodash): replace find (#2446)

Chosen to duplicate the funciton in core & dom, because we have no good way to share functionality otherwise IFW-740
algolia · Aug 19, 2019 · 060980d · 060980d
1 parent 6bd5858
commit 060980d
Show file tree

Hide file tree

Showing 8 changed files with 117 additions and 8 deletions.
diff --git a/packages/react-instantsearch-core/src/connectors/connectNumericMenu.js b/packages/react-instantsearch-core/src/connectors/connectNumericMenu.js
@@ -1,6 +1,7 @@
-import { find, isEmpty } from 'lodash';
+import { isEmpty } from 'lodash';
 import PropTypes from 'prop-types';
 import createConnector from '../core/createConnector';
+import { find } from '../core/utils';
 import {
   cleanUpValue,
   refineValue,

diff --git a/packages/react-instantsearch-core/src/connectors/connectToggleRefinement.js b/packages/react-instantsearch-core/src/connectors/connectToggleRefinement.js
@@ -1,5 +1,5 @@
-import { find } from 'lodash';
 import PropTypes from 'prop-types';
+import { find } from '../core/utils';
 import createConnector from '../core/createConnector';
 import {
   cleanUpValue,

diff --git a/packages/react-instantsearch-core/src/core/__tests__/utils.js b/packages/react-instantsearch-core/src/core/__tests__/utils.js
@@ -156,4 +156,42 @@ describe('utils', () => {
       ]);
     });
   });
+
+  describe('find', () => {
+    test('returns the first match based on the comparator', () => {
+      expect(
+        utils.find([1], function() {
+          return true;
+        })
+      ).toBe(1);
+      expect(
+        utils.find([1, 2], function() {
+          return true;
+        })
+      ).toBe(1);
+
+      expect(
+        utils.find([{ nice: false }, { nice: true }], function(el) {
+          return el.nice;
+        })
+      ).toEqual({ nice: true });
+    });
+
+    test('returns undefined in non-found cases', () => {
+      expect(
+        utils.find([], function() {
+          return false;
+        })
+      ).toBeUndefined();
+      expect(
+        utils.find(undefined, function() {
+          return false;
+        })
+      ).toBeUndefined();
+
+      expect(function() {
+        utils.find([1, 2, 3], undefined);
+      }).toThrow();
+    });
+  });
 });
diff --git a/packages/react-instantsearch-core/src/core/utils.ts b/packages/react-instantsearch-core/src/core/utils.ts
@@ -15,7 +15,6 @@ export const shallowEqual = (objA, objB) => {
 
   // Test for A's keys different from B.
   const hasOwn = Object.prototype.hasOwnProperty;
-  // tslint:disable-next-line: prefer-for-of
   for (let i = 0; i < keysA.length; i++) {
     if (!hasOwn.call(objB, keysA[i]) || objA[keysA[i]] !== objB[keysA[i]]) {
       return false;
@@ -70,3 +69,19 @@ export function addQueryID(hits, queryID) {
     __queryID: queryID,
   }));
 }
+
+export function find<T = any>(
+  array: T[],
+  comparator: (item: T) => boolean
+): T | undefined {
+  if (!Array.isArray(array)) {
+    return undefined;
+  }
+
+  for (let i = 0; i < array.length; i++) {
+    if (comparator(array[i])) {
+      return array[i];
+    }
+  }
+  return undefined;
+}
diff --git a/packages/react-instantsearch-dom/src/components/MenuSelect.js b/packages/react-instantsearch-dom/src/components/MenuSelect.js
@@ -1,9 +1,8 @@
-import { find } from 'lodash';
 import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 import classNames from 'classnames';
 import { translatable } from 'react-instantsearch-core';
-import { createClassNames } from '../core/utils';
+import { createClassNames, find } from '../core/utils';
 
 const cx = createClassNames('MenuSelect');
 
@@ -31,7 +30,10 @@ class MenuSelect extends Component {
   };
 
   get selectedValue() {
-    const { value } = find(this.props.items, { isRefined: true }) || {
+    const { value } = find(
+      this.props.items,
+      item => item.isRefined === true
+    ) || {
       value: 'ais__see__all__option',
     };
     return value;

diff --git a/packages/react-instantsearch-dom/src/components/RatingMenu.js b/packages/react-instantsearch-dom/src/components/RatingMenu.js
@@ -1,9 +1,8 @@
-import { find } from 'lodash';
 import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 import classNames from 'classnames';
 import { translatable } from 'react-instantsearch-core';
-import { createClassNames, range } from '../core/utils';
+import { createClassNames, find, range } from '../core/utils';
 
 const cx = createClassNames('RatingMenu');
 

diff --git a/packages/react-instantsearch-dom/src/core/__tests__/utils.js b/packages/react-instantsearch-dom/src/core/__tests__/utils.js
@@ -78,4 +78,42 @@ describe('utils', () => {
       ]);
     });
   });
+
+  describe('find', () => {
+    test('returns the first match based on the comparator', () => {
+      expect(
+        utils.find([1], function() {
+          return true;
+        })
+      ).toBe(1);
+      expect(
+        utils.find([1, 2], function() {
+          return true;
+        })
+      ).toBe(1);
+
+      expect(
+        utils.find([{ nice: false }, { nice: true }], function(el) {
+          return el.nice;
+        })
+      ).toEqual({ nice: true });
+    });
+
+    test('returns undefined in non-found cases', () => {
+      expect(
+        utils.find([], function() {
+          return false;
+        })
+      ).toBeUndefined();
+      expect(
+        utils.find(undefined, function() {
+          return false;
+        })
+      ).toBeUndefined();
+
+      expect(function() {
+        utils.find([1, 2, 3], undefined);
+      }).toThrow();
+    });
+  });
 });
diff --git a/packages/react-instantsearch-dom/src/core/utils.ts b/packages/react-instantsearch-dom/src/core/utils.ts
@@ -50,3 +50,19 @@ export function range({ start = 0, end, step = 1 }: RangeOptions): number[] {
     (_, current) => (start + current) * limitStep
   );
 }
+
+export function find<T = any>(
+  array: T[],
+  comparator: (item: T) => boolean
+): T | undefined {
+  if (!Array.isArray(array)) {
+    return undefined;
+  }
+
+  for (let i = 0; i < array.length; i++) {
+    if (comparator(array[i])) {
+      return array[i];
+    }
+  }
+  return undefined;
+}