Refactor authentication listener to be a hook

The previous authentication listener component was transformed into a `useAuthChangeListener` hook. All relevant functionality was preserved in this transition. The purpose of this change was to improve flexibility and code reusability by enabling the auth listener to be integrated in various parts of the application as needed. The old component was also removed from the exported packages in the `package.json`.
This commit is contained in:
giancarlo
2024-04-22 19:46:45 +08:00
parent a074e1ec3b
commit 8c5b0496da
4 changed files with 32 additions and 39 deletions

View File

@@ -0,0 +1,77 @@
'use client';
import { useEffect } from 'react';
import { usePathname, useRouter } from 'next/navigation';
import { useSupabase } from './use-supabase';
import { useRevalidateUserSession, useUserSession } from './use-user-session';
/**
* @name PRIVATE_PATH_PREFIXES
* @description A list of private path prefixes
*/
const PRIVATE_PATH_PREFIXES = ['/home', '/admin', '/join', '/update-password'];
/**
* @name AuthRedirectListener
* @description A component that listens to auth state changes and redirects users
* @param privatePathPrefixes
* @param appHomePath
*/
export function useAuthChangeListener({
privatePathPrefixes = PRIVATE_PATH_PREFIXES,
appHomePath,
}: {
appHomePath: string;
privatePathPrefixes?: string[];
}) {
const client = useSupabase();
const pathName = usePathname();
const router = useRouter();
const revalidateUserSession = useRevalidateUserSession();
const session = useUserSession();
const accessToken = session.data?.access_token;
useEffect(() => {
// keep this running for the whole session unless the component was unmounted
const listener = client.auth.onAuthStateChange((_, user) => {
// log user out if user is falsy
// and if the current path is a private route
const shouldRedirectUser =
!user && isPrivateRoute(pathName, privatePathPrefixes);
if (shouldRedirectUser) {
// send user away when signed out
window.location.assign('/');
return;
}
if (accessToken) {
const isOutOfSync = user?.access_token !== accessToken;
if (isOutOfSync) {
void router.refresh();
}
}
});
// destroy listener on un-mounts
return () => listener.data.subscription.unsubscribe();
}, [
client.auth,
router,
accessToken,
revalidateUserSession,
pathName,
appHomePath,
]);
}
/**
* Determines if a given path is a private route.
*/
function isPrivateRoute(path: string, privatePathPrefixes: string[]) {
return privatePathPrefixes.some((prefix) => path.startsWith(prefix));
}