Combined auth error message generator, removed redundant type

Author: kevin-pierce

frontend/src/APIClients/AuthAPIClient.ts

@@ -5,8 +5,7 @@ import {
 } from "@apollo/client";
 import { AxiosError } from "axios";
 import { 
-  getLoginErrMessage,
-  getRegisterErrMessage
+  getAuthErrMessage
 } 
 from "../helper/authError";
 import AUTHENTICATED_USER_KEY from "../constants/AuthConstants";
@@ -37,7 +36,7 @@ const login = async (
     if (axiosErr.response && axiosErr.response.status === 401) {
       return {
         errCode: axiosErr.response.status,
-        errMessage: getLoginErrMessage(axiosErr.response),
+        errMessage: getAuthErrMessage(axiosErr.response, 'LOGIN'),
       };
     }
     return {
@@ -116,7 +115,7 @@ const register = async (
     if (axiosErr.response && axiosErr.response.status === 409) {
       return {
         errCode: axiosErr.response.status,
-        errMessage: getRegisterErrMessage(axiosErr.response),
+        errMessage: getAuthErrMessage(axiosErr.response, 'SIGNUP'),
       };
     }
     return null;

frontend/src/APIClients/CommonAPIClient.ts

@@ -2,7 +2,7 @@ import { AxiosError } from "axios";
 import AUTHENTICATED_USER_KEY from "../constants/AuthConstants";
 import { getLocalStorageObjProperty } from "../utils/LocalStorageUtils";
 import baseAPIClient from "./BaseAPIClient";
-import { UserStatusErrorResponse } from '../types/UserTypes'
+import { ErrorResponse } from "../types/AuthTypes";
 
 const inviteUser = async (
   email: string,
@@ -26,7 +26,7 @@ const inviteUser = async (
   }
 };
 
-const getUserStatus = async (email: string): Promise<string | UserStatusErrorResponse> => {
+const getUserStatus = async (email: string): Promise<string | ErrorResponse> => {
   try {
     if (email === "") {
       return "";

frontend/src/components/forms/Signup.tsx

@@ -14,16 +14,8 @@ import { HOME_PAGE, LOGIN_PAGE } from "../../constants/Routes";
 import AuthContext from "../../contexts/AuthContext";
 import commonApiClient from "../../APIClients/CommonAPIClient";
 import AUTHENTICATED_USER_KEY from "../../constants/AuthConstants";
-import { UserStatusErrorResponse } from "../../types/UserTypes";
-import { ErrorResponse } from "../../types/AuthTypes";
 import { isAuthErrorResponse } from "../../helper/authError";
 
-const isUserStatusErrorResponse = (
-  res: string | UserStatusErrorResponse,
-): res is UserStatusErrorResponse => {
-  return res !== null && typeof res !== 'string' && "errCode" in res;
-};
-
 type SignupProps = {
   email: string;
   setEmail: (email: string) => void;
@@ -88,7 +80,7 @@ const Signup = ({
 
     const isInvited = await commonApiClient.isUserInvited(email);
     if (isInvited !== "Not Invited") {
-      if (isUserStatusErrorResponse(isInvited)) {
+      if (isAuthErrorResponse(isInvited)) {
         setEmailErrorStr(isInvited.errMessage)
         setEmailError(true)
       }

frontend/src/helper/authError.ts

@@ -1,23 +1,15 @@
 import { AxiosError } from "axios";
-import { AuthTokenResponse, ErrorResponse } from "../types/AuthTypes";
+import { AuthTokenResponse, ErrorResponse, AuthFlow } from "../types/AuthTypes";
 
-// Helper to get login error message
-export const getLoginErrMessage = (axiosErrRes: AxiosError["response"]): string => {
+export const getAuthErrMessage = (axiosErrRes: AxiosError["response"], flow: AuthFlow): string => {
   if (axiosErrRes && axiosErrRes.data && axiosErrRes.data.error) {
     return axiosErrRes.data.error;
   }
-  return "Error logging in. Please try again later.";
-};
-
-export const getRegisterErrMessage = (axiosErrRes: AxiosError["response"]): string => {
-  if (axiosErrRes && axiosErrRes.data && axiosErrRes.data.error) {
-    return axiosErrRes.data.error;
-  }
-  return "Error signing up. Please try again later.";
-};
+  return `Error ${flow === 'LOGIN' ? "logging in" : "signing up"}. Please try again later.`;
+}
 
 export const isAuthErrorResponse = (
-  res: AuthTokenResponse | ErrorResponse,
+  res: string | AuthTokenResponse | ErrorResponse,
 ): res is ErrorResponse => {
-  return res !== null && "errCode" in res;
+  return res !== null && typeof res !== 'string' && "errCode" in res;
 };

frontend/src/types/AuthTypes.ts

@@ -27,3 +27,5 @@ export type ErrorResponse = {
   errCode: number;
   errMessage: string;
 };
+
+export type AuthFlow = 'LOGIN' | 'SIGNUP';

frontend/src/types/UserTypes.ts

@@ -34,8 +34,3 @@ export enum UserStatus {
   ACTIVE = "Active",
   DEACTIVATED = "Deactivated",
 }
-
-export type UserStatusErrorResponse = {
-  errCode: number;
-  errMessage: string;
-}