feat(connectStateResults): expose isSearchStalled (#933)

* refactor(connectStateResults): dont rely on mutable value

* feat(connectStateResults): expose isSearchStalled through the connector

packages/react-instantsearch/src/connectors/connectStateResults.js

@@ -12,6 +12,7 @@ import { getResults } from '../core/indexUtils';
  * @providedPropType {object} allSearchResults - In case of multiple indices you can retrieve all the results
  * @providedPropType {string} error - If the search failed, the error will be logged here.
  * @providedPropType {boolean} searching - If there is a search in progress.
+ * @providedPropType {boolean} isSearchStalled - Flag that indicates if React InstantSearch has detected that searches are stalled.
  * @providedPropType {boolean} searchingForFacetValues - If there is a search in a list in progress.
  * @providedPropType {object} props - component props.
  * @example
@@ -46,11 +47,13 @@ export default createConnector({
 
   getProvidedProps(props, searchState, searchResults) {
     const results = getResults(searchResults, this.context);
+
     return {
       searchState,
       searchResults: results,
       allSearchResults: searchResults.results,
       searching: searchResults.searching,
+      isSearchStalled: searchResults.isSearchStalled,
       error: searchResults.error,
       searchingForFacetValues: searchResults.searchingForFacetValues,
       props,

packages/react-instantsearch/src/connectors/connectStateResults.test.js

@@ -1,50 +1,67 @@
-/* eslint-env jest, jasmine */
-
 import connect from './connectStateResults';
-jest.mock('../core/createConnector');
 
-let props;
+jest.mock('../core/createConnector');
 
 describe('connectStateResults', () => {
   describe('single index', () => {
-    const context = { context: { ais: { mainTargetedIndex: 'index' } } };
+    const context = {
+      context: {
+        ais: { mainTargetedIndex: 'index' },
+      },
+    };
+
     const getProvidedProps = connect.getProvidedProps.bind(context);
+
     it('provides the correct props to the component', () => {
       const searchState = { state: 'state' };
       const error = 'error';
       const searching = true;
+      const isSearchStalled = true;
       const searchingForFacetValues = true;
       const searchResults = {
         results: { nbHits: 25, hits: [] },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
       };
 
-      props = getProvidedProps({ props: 'props' }, searchState, searchResults);
-      expect(props).toEqual({
+      const expectation = {
         searchState,
         searchResults: searchResults.results,
         allSearchResults: searchResults.results,
+        props: { props: 'props' },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
-        props: { props: 'props' },
-      });
+      };
+
+      const actual = getProvidedProps(
+        { props: 'props' },
+        searchState,
+        searchResults
+      );
+
+      expect(actual).toEqual(expectation);
     });
   });
+
   describe('multi index', () => {
     const context = {
       context: {
         ais: { mainTargetedIndex: 'first' },
         multiIndexContext: { targetedIndex: 'first' },
       },
     };
+
     const getProvidedProps = connect.getProvidedProps.bind(context);
+
     it('provides the correct props to the component', () => {
       const searchState = { state: 'state' };
       const error = 'error';
       const searching = true;
+      const isSearchStalled = true;
       const searchingForFacetValues = true;
       const searchResults = {
         results: {
@@ -53,19 +70,28 @@ describe('connectStateResults', () => {
         },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
       };
 
-      props = getProvidedProps({ props: 'props' }, searchState, searchResults);
-      expect(props).toEqual({
+      const expectation = {
         searchState,
         searchResults: searchResults.results.first,
         allSearchResults: searchResults.results,
+        props: { props: 'props' },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
-        props: { props: 'props' },
-      });
+      };
+
+      const actual = getProvidedProps(
+        { props: 'props' },
+        searchState,
+        searchResults
+      );
+
+      expect(actual).toEqual(expectation);
     });
   });
 });