ra-core/src/auth/useLogout.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { useCallback, useEffect, useRef } from 'react';
import { useLocation, useNavigate, Path } from 'react-router-dom';
import { useQueryClient } from '@tanstack/react-query';

import useAuthProvider, { defaultAuthParams } from './useAuthProvider';
import { useResetStore } from '../store';
import { useBasename } from '../routing';
import { removeDoubleSlashes } from '../routing/useCreatePath';

/**
 * Get a callback for calling the authProvider.logout() method,
 * redirect to the login page, and clear the store.
 *
 * @see useAuthProvider
 *
 * @returns {Function} logout callback
 *
 * @example
 *
 * import { useLogout } from 'react-admin';
 *
 * const LogoutButton = () => {
 *     const logout = useLogout();
 *     const handleClick = () => logout();
 *     return <button onClick={handleClick}>Logout</button>;
 * }
 */
const useLogout = (): Logout => {
    const authProvider = useAuthProvider();
    const queryClient = useQueryClient();
    const resetStore = useResetStore();
    const navigate = useNavigate();
    // useNavigate forces rerenders on every navigation, even if we don't use the result
    // see https://github.com/remix-run/react-router/issues/7634
    // so we use a ref to bail out of rerenders when we don't need to
    const navigateRef = useRef(navigate);
    const location = useLocation();
    const locationRef = useRef(location);
    const basename = useBasename();
    const loginUrl = removeDoubleSlashes(
        `${basename}/${defaultAuthParams.loginUrl}`
    );

    /*
     * We need the current location to pass in the router state
     * so that the login hook knows where to redirect to as next route after login.
     *
     * But if we used the location from useLocation as a dependency of the logout
     * function, it would be rebuilt each time the user changes location.
     * Consequently, that would force a rerender of all components using this hook
     * upon navigation (CoreAdminRouter for example).
     *
     * To avoid that, we store the location in a ref.
     */
    useEffect(() => {
        locationRef.current = location;
        navigateRef.current = navigate;
    }, [location, navigate]);

    const logout: Logout = useCallback(
        (
            params = {},
            redirectTo = loginUrl,
            redirectToCurrentLocationAfterLogin = true
        ) => {
            if (authProvider) {
                return authProvider
                    .logout(params)
                    .then(redirectToFromProvider => {
                        if (
                            redirectToFromProvider === false ||
                            redirectTo === false
                        ) {
                            resetStore();
                            queryClient.clear();
                            // do not redirect
                            return;
                        }

                        const finalRedirectTo =
                            redirectToFromProvider || redirectTo;

                        if (finalRedirectTo?.startsWith('http')) {
                            // absolute link (e.g. https://my.oidc.server/login)
                            resetStore();
                            queryClient.clear();
                            window.location.href = finalRedirectTo;
                            return finalRedirectTo;
                        }

                        // redirectTo is an internal location that may contain a query string, e.g. '/login?foo=bar'
                        // we must split it to pass a structured location to navigate()
                        const redirectToParts = finalRedirectTo.split('?');
                        const newLocation: Partial<Path> = {
                            pathname: redirectToParts[0],
                        };
                        let newLocationOptions = {};

                        if (
                            redirectToCurrentLocationAfterLogin &&
                            locationRef.current &&
                            locationRef.current.pathname
                        ) {
                            newLocationOptions = {
                                state: {
                                    nextPathname: locationRef.current.pathname,
                                    nextSearch: locationRef.current.search,
                                },
                            };
                        }
                        if (redirectToParts[1]) {
                            newLocation.search = redirectToParts[1];
                        }
                        navigateRef.current(newLocation, newLocationOptions);
                        resetStore();
                        queryClient.clear();

                        return redirectToFromProvider;
                    });
            } else {
                navigateRef.current(
                    {
                        pathname: loginUrl,
                    },
                    {
                        state: {
                            nextPathname:
                                locationRef.current &&
                                locationRef.current.pathname,
                        },
                    }
                );
                resetStore();
                queryClient.clear();
                return Promise.resolve();
            }
        },
        [authProvider, resetStore, loginUrl, queryClient]
    );

    return logout;
};

/**
 * Log the current user out by calling the authProvider.logout() method,
 * and redirect them to the login screen.
 *
 * @param {Object} params The parameters to pass to the authProvider
 * @param {string} redirectTo The path name to redirect the user to (optional, defaults to login)
 * @param {boolean} redirectToCurrentLocationAfterLogin Whether the button shall record the current location to redirect to it after login. true by default.
 *
 * @return {Promise} The authProvider response
 */
type Logout = (
    params?: any,
    redirectTo?: string | false,
    redirectToCurrentLocationAfterLogin?: boolean
) => Promise<any>;

export default useLogout;