Remove deprecated props

docs/Upgrade.md

@@ -924,6 +924,35 @@ The `<InputHelperText>` component no longer accepts a `touched` prop. This prop
 
 If you were using this prop, you can safely remove it.
 
+## `disableNotification` Param of `useCheckAuth` Was Removed
+
+The `useCheckAuth` hook no longer accepts the deprecated `disableNotification` param. To disabe the notification at the `checkAuth` call, `authProvider.checkAuth()` should return a rejected promise with a `falsy` message:
+
+```ts
+const authProvider: AuthProvider = {
+ //...
+ checkAuth: () => Promise.reject({ message: false }),
+}
+```
+
+## `disableNotification` Param of `useLogoutIfAccessDenied` Was Removed
+
+The `useLogoutIfAccessDenied` hook no longer accepts the deprecated `disableNotification` param. To disabe the notification at the `checkError` call, `authProvider.checkError()` should return a rejected promise with a `falsy` message:
+
+```ts
+const authProvider: AuthProvider = {
+ //...
+ checkError: () => Promise.reject({ message: false }),
+}
+```
+
+Or the `useLogoutIfAccessDenied` hook could be called with an error param as follows:
+
+```ts
+const logoutIfAccessDenied = useLogoutIfAccessDenied();
+logoutIfAccessDenied(new Error('Denied'));
+```
+
 ## Upgrading to v4
 
 If you are on react-admin v3, follow the [Upgrading to v4](https://marmelab.com/react-admin/doc/4.16/Upgrade.html) guide before upgrading to v5.

packages/ra-core/src/auth/useCheckAuth.spec.tsx

@@ -21,20 +21,18 @@ const TestComponent = ({
  params,
  logoutOnFailure,
  redirectTo,
- disableNotification,
 }: {
  params?: any;
  logoutOnFailure?: boolean;
  redirectTo?: string;
- disableNotification?: boolean;
 }) => {
  const [authenticated, setAuthenticated] = useState(true);
  const checkAuth = useCheckAuth();
  useEffect(() => {
- checkAuth(params, logoutOnFailure, redirectTo, disableNotification)
+ checkAuth(params, logoutOnFailure, redirectTo)
  .then(() => setAuthenticated(true))
  .catch(() => setAuthenticated(false));
- }, [params, logoutOnFailure, redirectTo, disableNotification, checkAuth]);
+ }, [params, logoutOnFailure, redirectTo, checkAuth]);
  return <div>{authenticated ? 'authenticated' : 'not authenticated'}</div>;
 };
 
@@ -132,32 +130,6 @@ describe('useCheckAuth', () => {
  });
  });
 
- it('should logout without showing a notification when disableNotification is true', async () => {
- let location: Location;
- render(
- <TestMemoryRouter
- initialEntries={['/']}
- locationCallback={l => {
- location = l;
- }}
- >
- <AuthContext.Provider value={authProvider}>
- <QueryClientProvider client={queryClient}>
- <TestComponent
- params={{ token: false }}
- disableNotification
- />
- </QueryClientProvider>
- </AuthContext.Provider>
- </TestMemoryRouter>
- );
- await waitFor(() => {
- expect(notify).toHaveBeenCalledTimes(0);
- expect(screen.queryByText('authenticated')).toBeNull();
- expect(location.pathname).toBe('/login');
- });
- });
-
  it('should logout without showing a notification when authProvider returns error with message false', async () => {
  let location: Location;
  render(

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

@@ -52,12 +52,7 @@ export const useCheckAuth = (): CheckAuth => {
  );
 
  const checkAuth = useCallback(
- (
- params: any = {},
- logoutOnFailure = true,
- redirectTo = loginUrl,
- disableNotification = false
- ) =>
+ (params: any = {}, logoutOnFailure = true, redirectTo = loginUrl) =>
  authProvider.checkAuth(params).catch(error => {
  if (logoutOnFailure) {
  logout(
@@ -66,9 +61,7 @@ export const useCheckAuth = (): CheckAuth => {
  ? error.redirectTo
  : redirectTo
  );
- const shouldSkipNotify =
- disableNotification ||
- (error && error.message === false);
+ const shouldSkipNotify = error && error.message === false;
  !shouldSkipNotify &&
  notify(
  getErrorMessage(error, 'ra.auth.auth_check_error'),
@@ -92,16 +85,13 @@ const checkAuthWithoutAuthProvider = () => Promise.resolve();
  * @param {Object} params The parameters to pass to the authProvider
  * @param {boolean} logoutOnFailure Whether the user should be logged out if the authProvider fails to authenticate them. True by default.
  * @param {string} redirectTo The login form url. Defaults to '/login'
- * @param {boolean} disableNotification Avoid showing a notification after the user is logged out. false by default.
  *
  * @return {Promise} Resolved to the authProvider response if the user passes the check, or rejected with an error otherwise
  */
 export type CheckAuth = (
  params?: any,
  logoutOnFailure?: boolean,
- redirectTo?: string,
- /** @deprecated to disable the notification, authProvider.checkAuth() should return an object with an error property set to true */
- disableNotification?: boolean
+ redirectTo?: string
 ) => Promise<any>;
 
 const getErrorMessage = (error, defaultMessage) =>

packages/ra-core/src/auth/useLogoutIfAccessDenied.spec.tsx

@@ -39,18 +39,12 @@ const authProvider: AuthProvider = {
  getPermissions: () => Promise.reject('bad method'),
 };
 
-const TestComponent = ({
- error,
- disableNotification,
-}: {
- error?: any;
- disableNotification?: boolean;
-}) => {
+const TestComponent = ({ error }: { error?: any }) => {
  const [loggedOut, setLoggedOut] = useSafeSetState(false);
  const logoutIfAccessDenied = useLogoutIfAccessDenied();
  useEffect(() => {
- logoutIfAccessDenied(error, disableNotification).then(setLoggedOut);
- }, [error, disableNotification, logoutIfAccessDenied, setLoggedOut]);
+ logoutIfAccessDenied(error).then(setLoggedOut);
+ }, [error, logoutIfAccessDenied, setLoggedOut]);
  return <div>{loggedOut ? '' : 'logged in'}</div>;
 };
 
@@ -169,28 +163,6 @@ describe('useLogoutIfAccessDenied', () => {
  expect(screen.queryByText('logged in')).toBeNull();
  });
 
- it('should logout without showing a notification if disableAuthentication is true', async () => {
- render(
- <Route
- path="/"
- element={
- <TestComponent
- error={new Error('denied')}
- disableNotification
- />
- }
- />,
- {
- wrapper: TestWrapper,
- }
- );
- await waitFor(() => {
- expect(authProvider.logout).toHaveBeenCalledTimes(1);
- expect(notify).toHaveBeenCalledTimes(0);
- expect(screen.queryByText('logged in')).toBeNull();
- });
- });
-
  it('should logout without showing a notification if authProvider returns error with message false', async () => {
  render(
  <TestMemoryRouter>
@@ -203,14 +175,7 @@ describe('useLogoutIfAccessDenied', () => {
  }}
  >
  <Routes>
- <Route
- path="/"
- element={
- <>
- <TestComponent />
- </>
- }
- />
+ <Route path="/" element={<TestComponent />} />
  </Routes>
  </AuthContext.Provider>
  </TestMemoryRouter>
@@ -222,6 +187,22 @@ describe('useLogoutIfAccessDenied', () => {
  });
  });
 
+ it('should logout without showing a notification if it has been called with error param', async () => {
+ render(
+ <Route
+ path="/"
+ element={<TestComponent error={new Error('Error')} />}
+ />,
+ {
+ wrapper: TestWrapper,
+ }
+ );
+ await waitFor(() => {
+ expect(authProvider.logout).toHaveBeenCalledTimes(0);
+ expect(notify).toHaveBeenCalledTimes(0);
+ });
+ });
+
  it('should notify if passed an error with a message that makes the authProvider throw', async () => {
  render(
  <Route

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

@@ -44,13 +44,12 @@ const useLogoutIfAccessDenied = (): LogoutIfAccessDenied => {
  const notify = useNotify();
  const navigate = useNavigate();
  const logoutIfAccessDenied = useCallback(
- (error?: any, disableNotification?: boolean) =>
+ (error?: any) =>
  authProvider
  .checkError(error)
  .then(() => false)
  .catch(async e => {
  const logoutUser = e?.logoutUser ?? true;
-
  //manual debounce
  if (timer) {
  // side effects already triggered in this tick, exit
@@ -68,7 +67,6 @@ const useLogoutIfAccessDenied = (): LogoutIfAccessDenied => {
  : undefined;
 
  const shouldNotify = !(
- disableNotification ||
  (e && e.message === false) ||
  (error && error.message === false) ||
  redirectTo?.startsWith('http')
@@ -127,15 +125,10 @@ const logoutIfAccessDeniedWithoutProvider = () => Promise.resolve(false);
  * If the authProvider rejects the call, logs the user out and shows a logged out notification.
  *
  * @param {Error} error An Error object (usually returned by the dataProvider)
- * @param {boolean} disableNotification Avoid showing a notification after the user is logged out. false by default.
  *
  * @return {Promise} Resolved to true if there was a logout, false otherwise
  */
-type LogoutIfAccessDenied = (
- error?: any,
- /** @deprecated to disable the notification, authProvider.checkAuth() should return an object with an error property set to true */
- disableNotification?: boolean
-) => Promise<boolean>;
+type LogoutIfAccessDenied = (error?: any) => Promise<boolean>;
 
 const getErrorMessage = (error, defaultMessage) =>
  typeof error === 'string'