♻️ refactor: Login and Registration component Improvement (#2716)

* ♻️ refactor: Login form improvement

* display error message when API is down
* add loading animation to Login form while fetching data
* optimize startupConfig to fetch data only on initial render to prevent unnecessary API calls

* 🚑 fix: clear authentication error messages on successful login

* ♻️ refactor: componentize duplicate codes on registration and login screens

* chore: update types

* refactor: layout rendering order

* refactor: startup title fix

* refactor: reset/request-reset-password under new AuthLayout

* ci: fix Login.spec.ts

* ci: fix registration.spec.tsx

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
This commit is contained in:
Yuichi Oneda 2024-05-28 05:25:07 -07:00 committed by GitHub
parent 2b7a973a33
commit 9f2538fcd9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 775 additions and 750 deletions

View file

@ -1,17 +1,16 @@
import { useForm } from 'react-hook-form';
import { useNavigate } from 'react-router-dom';
import React, { useState, useEffect } from 'react';
import { useRegisterUserMutation, useGetStartupConfig } from 'librechat-data-provider/react-query';
import type { TRegisterUser } from 'librechat-data-provider';
import { GoogleIcon, FacebookIcon, OpenIDIcon, GithubIcon, DiscordIcon } from '~/components';
import { ThemeSelector } from '~/components/ui';
import SocialButton from './SocialButton';
import { useNavigate, useOutletContext } from 'react-router-dom';
import { useRegisterUserMutation } from 'librechat-data-provider/react-query';
import type { TRegisterUser, TError } from 'librechat-data-provider';
import type { TLoginLayoutContext } from '~/common';
import { ErrorMessage } from './ErrorMessage';
import { useLocalize } from '~/hooks';
const Registration: React.FC = () => {
const navigate = useNavigate();
const { data: startupConfig } = useGetStartupConfig();
const localize = useLocalize();
const { startupConfig, startupConfigError, isFetching } = useOutletContext<TLoginLayoutContext>();
const {
register,
@ -31,10 +30,8 @@ const Registration: React.FC = () => {
navigate('/c/new');
} catch (error) {
setError(true);
//@ts-ignore - error is of type unknown
if (error.response?.data?.message) {
//@ts-ignore - error is of type unknown
setErrorMessage(error.response?.data?.message);
if ((error as TError).response?.data?.message) {
setErrorMessage((error as TError).response?.data?.message ?? '');
}
}
};
@ -45,12 +42,6 @@ const Registration: React.FC = () => {
}
}, [startupConfig, navigate]);
if (!startupConfig) {
return null;
}
const socialLogins = startupConfig.socialLogins ?? [];
const renderInput = (id: string, label: string, type: string, validation: object) => (
<div className="mb-2">
<div className="relative">
@ -67,7 +58,7 @@ const Registration: React.FC = () => {
className="webkit-dark-styles peer block w-full appearance-none rounded-md border border-gray-300 bg-transparent px-3.5 pb-3.5 pt-4 text-sm text-gray-900 focus:border-green-500 focus:outline-none focus:ring-0 dark:border-gray-600 dark:text-white dark:focus:border-green-500"
placeholder=" "
data-testid={id}
></input>
/>
<label
htmlFor={id}
className="absolute start-1 top-2 z-10 origin-[0] -translate-y-4 scale-75 transform bg-white px-3 text-sm text-gray-500 duration-100 peer-placeholder-shown:top-1/2 peer-placeholder-shown:-translate-y-1/2 peer-placeholder-shown:scale-100 peer-focus:top-2 peer-focus:-translate-y-4 peer-focus:scale-75 peer-focus:px-3 peer-focus:text-green-600 dark:bg-gray-900 dark:text-gray-400 dark:peer-focus:text-green-500 rtl:peer-focus:left-auto rtl:peer-focus:translate-x-1/4"
@ -83,120 +74,16 @@ const Registration: React.FC = () => {
</div>
);
const providerComponents = {
discord: (
<SocialButton
key="discord"
enabled={startupConfig.discordLoginEnabled}
serverDomain={startupConfig.serverDomain}
oauthPath="discord"
Icon={DiscordIcon}
label={localize('com_auth_discord_login')}
id="discord"
/>
),
facebook: (
<SocialButton
key="facebook"
enabled={startupConfig.facebookLoginEnabled}
serverDomain={startupConfig.serverDomain}
oauthPath="facebook"
Icon={FacebookIcon}
label={localize('com_auth_facebook_login')}
id="facebook"
/>
),
github: (
<SocialButton
key="github"
enabled={startupConfig.githubLoginEnabled}
serverDomain={startupConfig.serverDomain}
oauthPath="github"
Icon={GithubIcon}
label={localize('com_auth_github_login')}
id="github"
/>
),
google: (
<SocialButton
key="google"
enabled={startupConfig.googleLoginEnabled}
serverDomain={startupConfig.serverDomain}
oauthPath="google"
Icon={GoogleIcon}
label={localize('com_auth_google_login')}
id="google"
/>
),
openid: (
<SocialButton
key="openid"
enabled={startupConfig.openidLoginEnabled}
serverDomain={startupConfig.serverDomain}
oauthPath="openid"
Icon={() =>
startupConfig.openidImageUrl ? (
<img src={startupConfig.openidImageUrl} alt="OpenID Logo" className="h-5 w-5" />
) : (
<OpenIDIcon />
)
}
label={startupConfig.openidLabel}
id="openid"
/>
),
};
const privacyPolicy = startupConfig.interface?.privacyPolicy;
const termsOfService = startupConfig.interface?.termsOfService;
const privacyPolicyRender = privacyPolicy?.externalUrl && (
<a
className="text-sm text-green-500"
href={privacyPolicy.externalUrl}
target={privacyPolicy.openNewTab ? '_blank' : undefined}
rel="noreferrer"
>
{localize('com_ui_privacy_policy')}
</a>
);
const termsOfServiceRender = termsOfService?.externalUrl && (
<a
className="text-sm text-green-500"
href={termsOfService.externalUrl}
target={termsOfService.openNewTab ? '_blank' : undefined}
rel="noreferrer"
>
{localize('com_ui_terms_of_service')}
</a>
);
return (
<div className="relative flex min-h-screen flex-col bg-white dark:bg-gray-900">
<div className="mt-12 h-24 w-full bg-cover">
<img src="/assets/logo.svg" className="h-full w-full object-contain" alt="Logo" />
</div>
<div className="absolute bottom-0 left-0 md:m-4">
<ThemeSelector />
</div>
<div className="flex flex-grow items-center justify-center">
<div className="w-authPageWidth overflow-hidden bg-white px-6 py-4 dark:bg-gray-900 sm:max-w-md sm:rounded-lg">
<h1
className="mb-4 text-center text-3xl font-semibold text-black dark:text-white"
style={{ userSelect: 'none' }}
>
{localize('com_auth_create_account')}
</h1>
{error && (
<div
className="rounded-md border border-red-500 bg-red-500/10 px-3 py-2 text-sm text-gray-600 dark:text-gray-200"
role="alert"
data-testid="registration-error"
>
{localize('com_auth_error_create')} {errorMessage}
</div>
)}
<>
{error && (
<ErrorMessage>
{localize('com_auth_error_create')} {errorMessage}
</ErrorMessage>
)}
{!startupConfigError && !isFetching && (
<>
<form
className="mt-6"
aria-label="Registration form"
@ -251,7 +138,8 @@ const Registration: React.FC = () => {
},
})}
{renderInput('confirm_password', 'com_auth_password_confirm', 'password', {
validate: (value) => value === password || localize('com_auth_password_not_match'),
validate: (value: string) =>
value === password || localize('com_auth_password_not_match'),
})}
<div className="mt-6">
<button
@ -264,39 +152,16 @@ const Registration: React.FC = () => {
</button>
</div>
</form>
<p className="my-4 text-center text-sm font-light text-gray-700 dark:text-white">
{localize('com_auth_already_have_account')}{' '}
<a href="/login" aria-label="Login" className="p-1 text-green-500">
{localize('com_auth_login')}
</a>
</p>
{startupConfig.socialLoginEnabled && (
<>
{startupConfig.emailLoginEnabled && (
<>
<div className="relative mt-6 flex w-full items-center justify-center border border-t border-gray-300 uppercase dark:border-gray-600">
<div className="absolute bg-white px-3 text-xs text-black dark:bg-gray-900 dark:text-white">
Or
</div>
</div>
<div className="mt-8" />
</>
)}
<div className="mt-2">
{socialLogins.map((provider) => providerComponents[provider] || null)}
</div>
</>
)}
</div>
</div>
<div className="align-end m-4 flex justify-center gap-2">
{privacyPolicyRender}
{privacyPolicyRender && termsOfServiceRender && (
<div className="border-r-[1px] border-gray-300 dark:border-gray-600" />
)}
{termsOfServiceRender}
</div>
</div>
</>
)}
</>
);
};