feat: add onSignInError to AuthProvider (#1030)

This new error callback let us have a better control (for giving feedback to the users) when the `signIn` function fails fixes #929 Co-authored-by: berna <[email protected]>
bjerkio · Nov 11, 2023 · 964876f · 964876f
1 parent 32458f0
commit 964876f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/src/AuthContext.tsx b/src/AuthContext.tsx
@@ -100,6 +100,7 @@ export const AuthProvider: FC<PropsWithChildren<AuthProviderProps>> = ({
   onSignIn,
   onSignOut,
   location = window.location,
+  onSignInError,
   ...props
 }) => {
   const [isLoading, setIsLoading] = useState(true);
@@ -132,9 +133,15 @@ export const AuthProvider: FC<PropsWithChildren<AuthProviderProps>> = ({
       if (isMounted && (!user || user.expired)) {
         // If the user is returning back from the OIDC provider, get and set the user data.
         if (hasCodeInUrl(location)) {
-          const user = (await userManager.signinCallback()) || null;
-          setUserData(user);
-          onSignIn && onSignIn(user);
+          const user = await userManager.signinCallback().catch((error) => {
+            if (onSignInError) {
+              onSignInError(error);
+            }
+          });
+          if (user) {
+            setUserData(user);
+            onSignIn && onSignIn(user);
+          }
         }
         // If autoSignIn is enabled, redirect to the OIDC provider.
         else if (autoSignIn) {
@@ -152,7 +159,14 @@ export const AuthProvider: FC<PropsWithChildren<AuthProviderProps>> = ({
       isMounted = false;
       isMountedRef.current = false;
     };
-  }, [location, userManager, autoSignIn, onBeforeSignIn, onSignIn]);
+  }, [
+    location,
+    userManager,
+    autoSignIn,
+    onBeforeSignIn,
+    onSignIn,
+    onSignInError,
+  ]);
 
   /**
    * Registers UserManager event callbacks for handling changes to user state due to automaticSilentRenew, session expiry, etc.

diff --git a/src/AuthContextInterface.ts b/src/AuthContextInterface.ts
@@ -143,6 +143,11 @@ export interface AuthProviderProps {
    * On sign out hook. Can be a async function.
    */
   onSignOut?: (options?: AuthProviderSignOutProps) => Promise<void> | void;
+
+  /**
+   * On sign in error. Can be a async function.
+   */
+  onSignInError?: (error: Error) => void;
 }
 
 export interface AuthContextProps {