Check that minimum required props are passed to controllers

marmelab · Jan 17, 2019 · d2e9f9d · d2e9f9d
1 parent 987014d
commit d2e9f9d
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 1 deletion.
diff --git a/packages/ra-core/src/controller/CreateController.js b/packages/ra-core/src/controller/CreateController.js
@@ -7,6 +7,7 @@ import { parse } from 'query-string';
 
 import translate from '../i18n/translate';
 import { crudCreate as crudCreateAction } from '../actions';
+import checkMinimumRequiredProps from './checkMinimumRequiredProps';
 
 /**
  * Page component for the Create view
@@ -139,9 +140,14 @@ function mapStateToProps(state) {
 }
 
 export default compose(
+    checkMinimumRequiredProps('Create', [
+        'basePath',
+        'location',
+        'resource',
+    ]),
     connect(
         mapStateToProps,
         { crudCreate: crudCreateAction }
     ),
-    translate
+    translate,
 )(CreateController);
diff --git a/packages/ra-core/src/controller/EditController.js b/packages/ra-core/src/controller/EditController.js
@@ -7,6 +7,7 @@ import { reset } from 'redux-form';
 import translate from '../i18n/translate';
 import { crudGetOne, crudUpdate, startUndoable } from '../actions';
 import { REDUX_FORM_NAME } from '../form';
+import checkMinimumRequiredProps from './checkMinimumRequiredProps';
 
 /**
  * Page component for the Edit view
@@ -175,6 +176,11 @@ function mapStateToProps(state, props) {
 }
 
 export default compose(
+    checkMinimumRequiredProps('Edit', [
+        'basePath',
+        'location',
+        'resource',
+    ]),
     connect(
         mapStateToProps,
         {

diff --git a/packages/ra-core/src/controller/ListController.js b/packages/ra-core/src/controller/ListController.js
@@ -27,6 +27,7 @@ import {
 } from '../actions/listActions';
 import translate from '../i18n/translate';
 import removeKey from '../util/removeKey';
+import checkMinimumRequiredProps from './checkMinimumRequiredProps';
 
 /**
  * List page component
@@ -439,7 +440,14 @@ function mapStateToProps(state, props) {
     };
 }
 
+
+
 export default compose(
+    checkMinimumRequiredProps('List', [
+        'basePath',
+        'location',
+        'resource',
+    ]),
     connect(
         mapStateToProps,
         {

diff --git a/packages/ra-core/src/controller/ShowController.js b/packages/ra-core/src/controller/ShowController.js
@@ -5,6 +5,7 @@ import compose from 'recompose/compose';
 import inflection from 'inflection';
 import translate from '../i18n/translate';
 import { crudGetOne as crudGetOneAction } from '../actions';
+import checkMinimumRequiredProps from './checkMinimumRequiredProps';
 
 /**
  * Page component for the Show view
@@ -132,6 +133,11 @@ function mapStateToProps(state, props) {
 }
 
 export default compose(
+    checkMinimumRequiredProps('Show', [
+        'basePath',
+        'location',
+        'resource',
+    ]),
     connect(
         mapStateToProps,
         { crudGetOne: crudGetOneAction }

diff --git a/packages/ra-core/src/controller/checkMinimumRequiredProps.js b/packages/ra-core/src/controller/checkMinimumRequiredProps.js
@@ -0,0 +1,23 @@
+import React from 'react';
+
+const checkMinimumRequiredProps = (displayName, requiredProps) => WrappedComponent => (props) => {
+    const propNames = Object.keys(props);
+    const missingProps = requiredProps.filter(prop => !propNames.includes(prop));
+
+    if (missingProps.length > 0) {
+        console.error(
+`<${displayName}> component is not properly configured, some essential props are missing.
+Be sure to pass the props from the parent. Example:
+
+const My${displayName} = props => (
+    <${displayName} {...props}></${displayName}>
+);
+
+The missing props are: ${missingProps.join(', ')}`);
+        return null;
+    }
+
+    return <WrappedComponent {...props} />;
+};
+
+export default checkMinimumRequiredProps;