feat(connectStateResults): expose isSearchStalled through the connector

algolia · Feb 2, 2018 · b571f7a · b571f7a
1 parent c39c19b
commit b571f7a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/packages/react-instantsearch/src/connectors/connectStateResults.js b/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,

diff --git a/packages/react-instantsearch/src/connectors/connectStateResults.test.js b/packages/react-instantsearch/src/connectors/connectStateResults.test.js
@@ -16,22 +16,25 @@ describe('connectStateResults', () => {
       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,
       };
 
       const expectation = {
         searchState,
         searchResults: searchResults.results,
         allSearchResults: searchResults.results,
+        props: { props: 'props' },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
-        props: { props: 'props' },
       };
 
       const actual = getProvidedProps(
@@ -58,6 +61,7 @@ describe('connectStateResults', () => {
       const searchState = { state: 'state' };
       const error = 'error';
       const searching = true;
+      const isSearchStalled = true;
       const searchingForFacetValues = true;
       const searchResults = {
         results: {
@@ -66,17 +70,19 @@ describe('connectStateResults', () => {
         },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
       };
 
       const expectation = {
         searchState,
         searchResults: searchResults.results.first,
         allSearchResults: searchResults.results,
+        props: { props: 'props' },
         error,
         searching,
+        isSearchStalled,
         searchingForFacetValues,
-        props: { props: 'props' },
       };
 
       const actual = getProvidedProps(