Refactor to call useResource hook in components rather than other hooks

djhi · djhi · commit c395af51f5f2 · 2020-11-02T10:47:53.000+01:00
diff --git a/packages/ra-core/src/controller/ListController.tsx b/packages/ra-core/src/controller/ListController.tsx
@@ -4,6 +4,7 @@ import useListController, {
 } from './useListController';
 import { useTranslate } from '../i18n';
 import { Translate } from '../types';
+import { useResourceContext, useResourceDefinition } from '../core';
 
 interface ListControllerComponentProps extends ListControllerProps {
     translate: Translate;
@@ -27,8 +28,16 @@ interface Props extends ListProps {
  * )
  */
 const ListController = ({ children, ...props }: Props) => {
-    const controllerProps = useListController(props);
-    const translate = useTranslate(); // injected for backwards compatibility
+    const { resource } = useResourceContext(props);
+    const { hasCreate } = useResourceDefinition(resource, props);
+    // @deprecated. hasCreate is injected for backward compatibility
+    const controllerProps = useListController({
+        resource,
+        hasCreate,
+        ...props,
+    });
+    // @deprecated. injected for backward compatibility
+    const translate = useTranslate();
     return children({ translate, ...controllerProps });
 };
 
diff --git a/packages/ra-core/src/controller/button/useDeleteWithConfirmController.tsx b/packages/ra-core/src/controller/button/useDeleteWithConfirmController.tsx
@@ -14,7 +14,6 @@ import {
 } from '../../sideEffect';
 import { Record } from '../../types';
 import { OnFailure, OnSuccess } from '../saveModifiers';
-import { useResourceContext } from '../../core';
 
 /**
  * Prepare a set of callbacks for a delete button guarded by confirmation dialog
@@ -74,12 +73,12 @@ const useDeleteWithConfirmController = (
     const {
         record,
         redirect: redirectTo,
+        resource,
         basePath,
         onClick,
         onSuccess,
         onFailure,
     } = props;
-    const { resource } = useResourceContext(props);
     const [open, setOpen] = useState(false);
     const notify = useNotify();
     const redirect = useRedirect();
diff --git a/packages/ra-core/src/controller/button/useDeleteWithUndoController.tsx b/packages/ra-core/src/controller/button/useDeleteWithUndoController.tsx
@@ -9,7 +9,6 @@ import {
 } from '../../sideEffect';
 import { Record } from '../../types';
 import { OnFailure, OnSuccess } from '../saveModifiers';
-import { useResourceContext } from '../../core';
 
 /**
  * Prepare callback for a Delete button with undo support
@@ -55,11 +54,11 @@ const useDeleteWithUndoController = (
         record,
         basePath,
         redirect: redirectTo = 'list',
+        resource,
         onClick,
         onSuccess,
         onFailure,
     } = props;
-    const { resource } = useResourceContext(props);
     const notify = useNotify();
     const redirect = useRedirect();
     const refresh = useRefresh();
diff --git a/packages/ra-core/src/controller/details/CreateController.tsx b/packages/ra-core/src/controller/details/CreateController.tsx
@@ -5,6 +5,7 @@ import {
     CreateProps,
     CreateControllerProps,
 } from './useCreateController';
+import { useResourceContext, useResourceDefinition } from '../../core';
 
 interface CreateControllerComponentProps extends CreateControllerProps {
     translate: Translate;
@@ -28,7 +29,16 @@ interface Props extends CreateProps {
  * );
  */
 export const CreateController = ({ children, ...props }: Props) => {
-    const controllerProps = useCreateController(props);
-    const translate = useTranslate(); // injected for backwards compatibility
+    const { resource } = useResourceContext(props);
+    const { hasEdit, hasShow } = useResourceDefinition(resource, props);
+    // @deprecated. hasEdit and hasShow are injected for backward compatibility
+    const controllerProps = useCreateController({
+        resource,
+        hasEdit,
+        hasShow,
+        ...props,
+    });
+    // @deprecated. injected for backward compatibility
+    const translate = useTranslate();
     return children({ translate, ...controllerProps });
 };
diff --git a/packages/ra-core/src/controller/details/EditController.tsx b/packages/ra-core/src/controller/details/EditController.tsx
@@ -5,6 +5,7 @@ import {
     EditProps,
     EditControllerProps,
 } from './useEditController';
+import { useResourceContext, useResourceDefinition } from '../../core';
 
 interface EditControllerComponentProps extends EditControllerProps {
     translate: Translate;
@@ -28,7 +29,21 @@ interface Props extends EditProps {
  * );
  */
 export const EditController = ({ children, ...props }: Props) => {
-    const controllerProps = useEditController(props);
-    const translate = useTranslate(); // injected for backwards compatibility
+    const { resource } = useResourceContext(props);
+    const { hasCreate, hasEdit, hasList, hasShow } = useResourceDefinition(
+        resource,
+        props
+    );
+    // @deprecated. hasCreate, hasEdit, hasList and hasShow are injected for backward compatibility
+    const controllerProps = useEditController({
+        resource,
+        hasCreate,
+        hasEdit,
+        hasList,
+        hasShow,
+        ...props,
+    });
+    // @deprecated. injected for backward compatibility
+    const translate = useTranslate();
     return children({ translate, ...controllerProps });
 };
diff --git a/packages/ra-core/src/controller/details/ShowController.tsx b/packages/ra-core/src/controller/details/ShowController.tsx
@@ -5,6 +5,7 @@ import {
 } from './useShowController';
 import { Translate } from '../../types';
 import { useTranslate } from '../../i18n';
+import { useResourceContext, useResourceDefinition } from '../../core';
 
 interface ShowControllerComponentProps extends ShowControllerProps {
     translate: Translate;
@@ -28,7 +29,21 @@ interface Props extends ShowProps {
  * );
  */
 export const ShowController = ({ children, ...props }: Props) => {
-    const controllerProps = useShowController(props);
-    const translate = useTranslate(); // injected for backwards compatibility
+    const { resource } = useResourceContext(props);
+    const { hasCreate, hasEdit, hasList, hasShow } = useResourceDefinition(
+        resource,
+        props
+    );
+    // @deprecated. hasCreate, hasEdit, hasList and hasShow are injected for backward compatibility
+    const controllerProps = useShowController({
+        resource,
+        hasCreate,
+        hasEdit,
+        hasList,
+        hasShow,
+        ...props,
+    });
+    // @deprecated. injected for backward compatibility
+    const translate = useTranslate();
     return children({ translate, ...controllerProps });
 };
diff --git a/packages/ra-core/src/controller/details/useCreateController.ts b/packages/ra-core/src/controller/details/useCreateController.ts
@@ -25,7 +25,6 @@ import { useTranslate } from '../../i18n';
 import useVersion from '../useVersion';
 import { CRUD_CREATE } from '../../actions';
 import { Record } from '../../types';
-import { useResourceContext, useResourceDefinition } from '../../core';
 
 export interface CreateProps<RecordType extends Omit<Record, 'id'> = Record> {
     basePath?: string;
@@ -102,15 +101,16 @@ export const useCreateController = <
     useCheckMinimumRequiredProps('Create', ['basePath', 'resource'], props);
     const {
         basePath,
+        hasEdit,
+        hasShow,
         record = {},
+        resource,
         successMessage,
         onSuccess,
         onFailure,
         transform,
     } = props;
 
-    const { resource } = useResourceContext(props);
-    const { hasEdit, hasShow } = useResourceDefinition(resource, props);
     const location = useLocation();
     const translate = useTranslate();
     const notify = useNotify();
diff --git a/packages/ra-core/src/controller/details/useEditController.ts b/packages/ra-core/src/controller/details/useEditController.ts
@@ -22,7 +22,6 @@ import {
     SetTransformData,
     useSaveModifiers,
 } from '../saveModifiers';
-import { useResourceContext, useResourceDefinition } from '../../core';
 
 export interface EditProps {
     basePath?: string;
@@ -95,18 +94,18 @@ export const useEditController = <RecordType extends Record = Record>(
     const {
         basePath,
         hasCreate,
+        hasEdit,
+        hasList,
+        hasShow,
         id,
+        resource,
         successMessage,
         undoable = true,
         onSuccess,
         onFailure,
         transform,
     } = props;
-    const { resource } = useResourceContext(props);
-    const { hasEdit, hasList, hasShow } = useResourceDefinition(
-        resource,
-        props
-    );
+
     const translate = useTranslate();
     const notify = useNotify();
     const redirect = useRedirect();
diff --git a/packages/ra-core/src/controller/details/useShowController.ts b/packages/ra-core/src/controller/details/useShowController.ts
@@ -7,7 +7,6 @@ import { useGetOne } from '../../dataProvider';
 import { useTranslate } from '../../i18n';
 import { useNotify, useRedirect, useRefresh } from '../../sideEffect';
 import { CRUD_GET_ONE } from '../../actions';
-import { useResourceContext, useResourceDefinition } from '../../core';
 
 export interface ShowProps {
     basePath?: string;
@@ -58,12 +57,16 @@ export const useShowController = <RecordType extends Record = Record>(
     props: ShowProps
 ): ShowControllerProps<RecordType> => {
     useCheckMinimumRequiredProps('Show', ['basePath', 'resource'], props);
-    const { basePath, id } = props;
-    const { resource } = useResourceContext(props);
-    const { hasCreate, hasEdit, hasList, hasShow } = useResourceDefinition(
+    const {
+        basePath,
+        hasCreate,
+        hasEdit,
+        hasList,
+        hasShow,
+        id,
         resource,
-        props
-    );
+    } = props;
+
     const translate = useTranslate();
     const notify = useNotify();
     const redirect = useRedirect();
diff --git a/packages/ra-core/src/controller/field/ReferenceArrayFieldController.tsx b/packages/ra-core/src/controller/field/ReferenceArrayFieldController.tsx
@@ -3,6 +3,7 @@ import { FunctionComponent, ReactElement } from 'react';
 import useReferenceArrayFieldController from './useReferenceArrayFieldController';
 import { ListControllerProps } from '../useListController';
 import { Record, SortPayload } from '../../types';
+import { useResourceContext } from '../../core';
 
 interface Props {
     basePath: string;
@@ -24,7 +25,9 @@ interface Props {
  */
 const ReferenceArrayFieldController: FunctionComponent<Props> = props => {
     const { children, ...rest } = props;
+    const { resource } = useResourceContext(props);
     const controllerProps = useReferenceArrayFieldController({
+        resource,
         sort: {
             field: 'id',
             order: 'ASC',
diff --git a/packages/ra-core/src/controller/field/ReferenceManyFieldController.tsx b/packages/ra-core/src/controller/field/ReferenceManyFieldController.tsx
@@ -3,6 +3,7 @@ import { ReactElement, FunctionComponent } from 'react';
 import { Record, SortPayload } from '../../types';
 import useReferenceManyFieldController from './useReferenceManyFieldController';
 import { ListControllerProps } from '../useListController';
+import { useResourceContext } from '../../core';
 
 interface Props {
     basePath: string;
@@ -26,9 +27,11 @@ interface Props {
  */
 export const ReferenceManyFieldController: FunctionComponent<Props> = props => {
     const { children, page = 1, perPage = 25, ...rest } = props;
+    const { resource } = useResourceContext(props);
     const controllerProps = useReferenceManyFieldController({
         page,
         perPage,
+        resource,
         ...rest,
     });
     return children(controllerProps);
diff --git a/packages/ra-core/src/controller/field/useReferenceArrayFieldController.ts b/packages/ra-core/src/controller/field/useReferenceArrayFieldController.ts
@@ -10,7 +10,6 @@ import { useNotify } from '../../sideEffect';
 import usePaginationState from '../usePaginationState';
 import useSelectionState from '../useSelectionState';
 import useSortState from '../useSortState';
-import { useResourceContext } from '../../core';
 
 interface Option {
     basePath: string;
@@ -60,10 +59,10 @@ const useReferenceArrayFieldController = (
         perPage: initialPerPage = 1000,
         record,
         reference,
+        resource,
         sort: initialSort = defaultSort,
         source,
     } = props;
-    const { resource } = useResourceContext(props);
     const notify = useNotify();
     const ids = get(record, source) || [];
     const { data, error, loading, loaded } = useGetMany(reference, ids, {
diff --git a/packages/ra-core/src/controller/field/useReferenceManyFieldController.ts b/packages/ra-core/src/controller/field/useReferenceManyFieldController.ts
@@ -10,7 +10,6 @@ import { ListControllerProps } from '../useListController';
 import usePaginationState from '../usePaginationState';
 import useSelectionState from '../useSelectionState';
 import useSortState from '../useSortState';
-import { useResourceContext } from '../../core';
 
 interface Options {
     basePath: string;
@@ -70,17 +69,17 @@ const useReferenceManyFieldController = (
     props: Options
 ): ListControllerProps => {
     const {
-        reference,
-        record,
-        target,
-        filter = defaultFilter,
-        source,
         basePath,
+        filter = defaultFilter,
         page: initialPage,
         perPage: initialPerPage,
+        record,
+        reference,
+        resource,
         sort: initialSort = { field: 'id', order: 'DESC' },
+        source,
+        target,
     } = props;
-    const { resource } = useResourceContext(props);
     const notify = useNotify();
 
     // pagination logic
diff --git a/packages/ra-core/src/controller/input/ReferenceArrayInputController.tsx b/packages/ra-core/src/controller/input/ReferenceArrayInputController.tsx
@@ -8,6 +8,7 @@ import debounce from 'lodash/debounce';
 
 import { Record, SortPayload, PaginationPayload } from '../../types';
 import useReferenceArrayInputController from './useReferenceArrayInputController';
+import { useResourceContext } from '../../core';
 
 interface ChildrenFuncParams {
     choices: Record[];
@@ -114,18 +115,19 @@ interface Props {
  *     <SelectArrayInput optionText="name" />
  * </ReferenceArrayInput>
  */
-const ReferenceArrayInputController: FunctionComponent<Props> = ({
-    basePath,
-    children,
-    filter = {},
-    input,
-    filterToQuery = searchText => ({ q: searchText }),
-    perPage = 25,
-    reference,
-    resource,
-    sort = { field: 'id', order: 'DESC' },
-    source,
-}) => {
+const ReferenceArrayInputController: FunctionComponent<Props> = props => {
+    const {
+        basePath,
+        children,
+        filter = {},
+        input,
+        filterToQuery = searchText => ({ q: searchText }),
+        perPage = 25,
+        reference,
+        sort = { field: 'id', order: 'DESC' },
+        source,
+    } = props;
+    const { resource } = useResourceContext(props);
     const {
         choices,
         error,
diff --git a/packages/ra-core/src/controller/input/ReferenceInputController.tsx b/packages/ra-core/src/controller/input/ReferenceInputController.tsx
@@ -4,6 +4,7 @@ import {
     FunctionComponent,
     ReactElement,
 } from 'react';
+import { useResourceContext } from '../../core';
 
 import { SortPayload, Record } from '../../types';
 import {
@@ -37,7 +38,10 @@ export const ReferenceInputController: FunctionComponent<Props> = ({
     children,
     ...props
 }) => {
-    return children(useReferenceInputController(props)) as ReactElement;
+    const { resource } = useResourceContext(props);
+    return children(
+        useReferenceInputController({ resource, ...props })
+    ) as ReactElement;
 };
 
 export default ReferenceInputController as ComponentType<Props>;
diff --git a/packages/ra-core/src/controller/input/useReferenceArrayInputController.ts b/packages/ra-core/src/controller/input/useReferenceArrayInputController.ts
diff --git a/packages/ra-core/src/controller/input/useReferenceInputController.ts b/packages/ra-core/src/controller/input/useReferenceInputController.ts
diff --git a/packages/ra-core/src/controller/useListController.ts b/packages/ra-core/src/controller/useListController.ts
diff --git a/packages/ra-ui-materialui/src/button/DeleteWithConfirmButton.tsx b/packages/ra-ui-materialui/src/button/DeleteWithConfirmButton.tsx
diff --git a/packages/ra-ui-materialui/src/button/DeleteWithUndoButton.tsx b/packages/ra-ui-materialui/src/button/DeleteWithUndoButton.tsx
