Merge pull request #8521 from marmelab/deprecate-usePermissionsOptimised

Deprecate usePermissionsOptimised

packages/ra-core/src/auth/WithPermissions.tsx

@@ -3,7 +3,7 @@ import { Location } from 'react-router-dom';
 
 import warning from '../util/warning';
 import { useAuthenticated } from './useAuthenticated';
-import usePermissionsOptimized from './usePermissionsOptimized';
+import usePermissions from './usePermissions';
 
 export interface WithPermissionsChildrenParams {
     permissions: any;
@@ -76,7 +76,7 @@ const WithPermissions = (props: WithPermissionsProps) => {
     );
 
     useAuthenticated(authParams);
-    const { permissions } = usePermissionsOptimized(authParams);
+    const { permissions } = usePermissions(authParams);
     // render even though the usePermissions() call isn't finished (optimistic rendering)
     if (component) {
         return createElement(component, { permissions, ...rest });

packages/ra-core/src/auth/usePermissionsOptimized.ts

@@ -1,79 +1,14 @@
-import { useEffect } from 'react';
-import isEqual from 'lodash/isEqual';
-
-import useGetPermissions from './useGetPermissions';
-import { useSafeSetState } from '../util/hooks';
-
-interface State {
-    permissions?: any;
-    error?: any;
-}
+import usePermissions from './usePermissions';
 
 const emptyParams = {};
 
-// keep a cache of already fetched permissions to initialize state for new
-// components and avoid a useless rerender if the permissions haven't changed
-const alreadyFetchedPermissions = { '{}': undefined };
-
 /**
- * Hook for getting user permissions without the loading state.
- *
- * When compared to usePermissions, this hook doesn't cause a re-render
- * when the permissions haven't changed since the last call.
- *
- * This hook doesn't handle the loading state.
+ * @deprecated use usePermissions instead
  *
  * @see usePermissions
- *
- * Calls the authProvider.getPermissions() method asynchronously.
- * If the authProvider returns a rejected promise, returns empty permissions.
- *
- * The return value updates according to the request state:
- *
- * - start:   { permissions: [previously fetched permissions for these params] }
- * - success: { permissions: [permissions returned by the authProvider (usually the same as on start)] }
- * - error:   { error: [error from provider] }
- *
- * Useful to enable features based on user permissions
- *
- * @param {Object} params Any params you want to pass to the authProvider
- *
- * @returns The current auth check state. Destructure as { permissions, error }.
- *
- * @example
- *     import { usePermissionsOptimized } from 'react-admin';
- *
- *     const PostDetail = props => {
- *         const { permissions } = usePermissionsOptimized();
- *         if (permissions !== 'editor') {
- *             return <Redirect to={`posts/${props.id}/show`} />
- *         } else {
- *             return <PostEdit {...props} />
- *         }
- *     };
  */
 const usePermissionsOptimized = (params = emptyParams) => {
-    const key = JSON.stringify(params);
-    const [state, setState] = useSafeSetState<State>({
-        permissions: alreadyFetchedPermissions[key],
-    });
-    const getPermissions = useGetPermissions();
-    useEffect(() => {
-        getPermissions(params)
-            .then(permissions => {
-                if (!isEqual(permissions, state.permissions)) {
-                    alreadyFetchedPermissions[key] = permissions;
-                    setState({ permissions });
-                }
-            })
-            .catch(error => {
-                setState({
-                    error,
-                });
-            });
-    }, [getPermissions, key]); // eslint-disable-line react-hooks/exhaustive-deps
-
-    return state;
+    return usePermissions(params);
 };
 
 export default usePermissionsOptimized;