feat(connectStateResults): add component props (#434)

deprecation warning about createConnector in favor of connectStateResults is fired only when mounting a component.
algolia · Oct 9, 2017 · c629b97 · c629b97
1 parent 81d1af8
commit c629b97
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 32 deletions.
diff --git a/packages/react-instantsearch/src/connectors/connectStateResults.js b/packages/react-instantsearch/src/connectors/connectStateResults.js
@@ -13,6 +13,7 @@ import { getResults } from '../core/indexUtils';
  * @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} searchingForFacetValues - If there is a search in a list in progress. 
+ * @providedPropType {boolean} props - component props.
  * @example
  * import React from 'react';
  *
@@ -57,6 +58,7 @@ export default createConnector({
       searching: searchResults.searching,
       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
@@ -21,14 +21,15 @@ describe('connectStateResults', () => {
         searchingForFacetValues,
       };
 
-      props = getProvidedProps({}, searchState, searchResults);
+      props = getProvidedProps({ props: 'props' }, searchState, searchResults);
       expect(props).toEqual({
         searchState,
         searchResults: searchResults.results,
         allSearchResults: searchResults.results,
         error,
         searching,
         searchingForFacetValues,
+        props: { props: 'props' },
       });
     });
   });
@@ -55,14 +56,15 @@ describe('connectStateResults', () => {
         searchingForFacetValues,
       };
 
-      props = getProvidedProps({}, searchState, searchResults);
+      props = getProvidedProps({ props: 'props' }, searchState, searchResults);
       expect(props).toEqual({
         searchState,
         searchResults: searchResults.results.first,
         allSearchResults: searchResults.results,
         error,
         searching,
         searchingForFacetValues,
+        props: { props: 'props' },
       });
     });
   });

diff --git a/packages/react-instantsearch/src/core/createConnector.js b/packages/react-instantsearch/src/core/createConnector.js
@@ -81,6 +81,35 @@ export default function createConnector(connectorDesc) {
         if (isWidget) {
           this.unregisterWidget = widgetsManager.registerWidget(this);
         }
+        if (process.env.NODE_ENV === 'development') {
+          const onlyGetProvidedPropsUsage = !Object.keys(connectorDesc).find(
+            key =>
+              [
+                'getMetadata',
+                'getSearchParameters',
+                'refine',
+                'cleanUp',
+              ].indexOf(key) > -1
+          );
+
+          if (
+            onlyGetProvidedPropsUsage &&
+            !connectorDesc.displayName.startsWith('Algolia')
+          ) {
+            // eslint-disable-next-line no-console
+            console.warn(
+              'react-instantsearch: it seems that you are using the `createConnector` api ' +
+                'only to access the `searchState` and the `searchResults` through `getProvidedProps`.' +
+                'We are now provided a dedicated API' +
+                ' the `connectStateResults` connector that you should use instead. The `createConnector` API will be ' +
+                'soon deprecated and will break in future next major versions.' +
+                '\n\n' +
+                'See more at https://community.algolia.com/react-instantsearch/connectors/connectStateResults.html' +
+                '\n' +
+                'and https://community.algolia.com/react-instantsearch/guide/Conditional_display.html'
+            );
+          }
+        }
       }
 
       getMetadata(nextWidgetsState) {
@@ -272,36 +301,6 @@ export default function createConnector(connectorDesc) {
             }
           : {};
 
-        if (process.env.NODE_ENV === 'development') {
-          const onlyGetProvidedPropsUsage = !Object.keys(connectorDesc).find(
-            key =>
-              [
-                'getMetadata',
-                'getSearchParameters',
-                'refine',
-                'cleanUp',
-              ].indexOf(key) > -1
-          );
-
-          if (
-            onlyGetProvidedPropsUsage &&
-            !connectorDesc.displayName.startsWith('Algolia')
-          ) {
-            // eslint-disable-next-line no-console
-            console.warn(
-              'react-instantsearch: it seems that you are using the `createConnector` api ' +
-                'only to access the `searchState` and the `searchResults` through `getProvidedProps`.' +
-                'We are now provided a dedicated API' +
-                ' the `connectStateResults` connector that you should use instead. The `createConnector` API will be ' +
-                'soon deprecated and will break in future next major versions.' +
-                '\n\n' +
-                'See more at https://community.algolia.com/react-instantsearch/connectors/connectStateResults.html' +
-                '\n' +
-                'and https://community.algolia.com/react-instantsearch/guide/Conditional_display.html'
-            );
-          }
-        }
-
         return (
           <Composed
             {...this.props}