admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Rename Unintuitive Function Names in Authentication Flow (#9706)

Browse Source 
Resolves #9623

## Description

This PR renames the following functions to better reflect their purpose.

- Backend:
  - Verify → GetAuthTokensFromLoginToken
  - Challenge → GetLoginTokenFromCredentials

- Frontend:
  - challenge → getLoginTokenFromCredentials
  - verify → getAuthTokensFromLoginToken

## Testing
_Sign in works as expected:_


https://github.com/user-attachments/assets/7e8f73c7-2c7d-4cd2-9965-5ad9f5334cd3

_Sign up works as expected:_
  

https://github.com/user-attachments/assets/d1794ee4-8b59-4934-84df-d819eabd5224

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Samyak Piya
2025-01-24 13:19:14 -05:00
committed by GitHub
parent 570b2e3530
commit 55be726105
19 changed files with 300 additions and 259 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
packages/twenty-front/src/modules/auth/hooks/useAuth.ts
View File

@ -22,12 +22,12 @@ import { supportChatState } from '@/client-config/states/supportChatState';
import { ColorScheme } from '@/workspace-member/types/WorkspaceMember';
import { REACT_APP_SERVER_BASE_URL } from '~/config';
import {
useChallengeMutation,
useCheckUserExistsLazyQuery,
useGetAuthTokensFromLoginTokenMutation,
useGetCurrentUserLazyQuery,
useGetLoginTokenFromCredentialsMutation,
useGetLoginTokenFromEmailVerificationTokenMutation,
useSignUpMutation,
useVerifyMutation,
} from '~/generated/graphql';
import { isDefined } from '~/utils/isDefined';
@ -87,9 +87,11 @@ export const useAuth = () => {
const { redirect } = useRedirect();
const { redirectToWorkspaceDomain } = useRedirectToWorkspaceDomain();
const [challenge] = useChallengeMutation();
const [getLoginTokenFromCredentials] =
useGetLoginTokenFromCredentialsMutation();
const [signUp] = useSignUpMutation();
const [verify] = useVerifyMutation();
const [getAuthTokensFromLoginToken] =
useGetAuthTokensFromLoginTokenMutation();
const [getLoginTokenFromEmailVerificationToken] =
useGetLoginTokenFromEmailVerificationTokenMutation();
const [getCurrentUser] = useGetCurrentUserLazyQuery();
@ -166,25 +168,25 @@ export const useAuth = () => {
[client, goToRecoilSnapshot, setLastAuthenticateWorkspaceDomain],
);
const handleChallenge = useCallback(
const handleGetLoginTokenFromCredentials = useCallback(
async (email: string, password: string, captchaToken?: string) => {
try {
const challengeResult = await challenge({
const getLoginTokenResult = await getLoginTokenFromCredentials({
variables: {
email,
password,
captchaToken,
},
});
if (isDefined(challengeResult.errors)) {
throw challengeResult.errors;
if (isDefined(getLoginTokenResult.errors)) {
throw getLoginTokenResult.errors;
}
if (!challengeResult.data?.challenge) {
if (!getLoginTokenResult.data?.getLoginTokenFromCredentials) {
throw new Error('No login token');
}
return challengeResult.data.challenge;
return getLoginTokenResult.data.getLoginTokenFromCredentials;
} catch (error) {
// TODO: Get intellisense for graphql error extensions code (codegen?)
if (
@ -198,7 +200,7 @@ export const useAuth = () => {
throw error;
}
},
[challenge, setSearchParams, setSignInUpStep],
[getLoginTokenFromCredentials, setSearchParams, setSignInUpStep],
);
const handleGetLoginTokenFromEmailVerificationToken = useCallback(
@ -322,41 +324,48 @@ export const useAuth = () => {
setWorkspaces,
]);
const handleVerify = useCallback(
const handleGetAuthTokensFromLoginToken = useCallback(
async (loginToken: string) => {
setIsVerifyPendingState(true);
const verifyResult = await verify({
const getAuthTokensResult = await getAuthTokensFromLoginToken({
variables: { loginToken },
});
if (isDefined(verifyResult.errors)) {
throw verifyResult.errors;
if (isDefined(getAuthTokensResult.errors)) {
throw getAuthTokensResult.errors;
}
if (!verifyResult.data?.verify) {
throw new Error('No verify result');
if (!getAuthTokensResult.data?.getAuthTokensFromLoginToken) {
throw new Error('No getAuthTokensFromLoginToken result');
}
setTokenPair(verifyResult.data?.verify.tokens);
setTokenPair(
getAuthTokensResult.data?.getAuthTokensFromLoginToken.tokens,
);
await loadCurrentUser();
setIsVerifyPendingState(false);
},
[setIsVerifyPendingState, verify, setTokenPair, loadCurrentUser],
[
setIsVerifyPendingState,
getAuthTokensFromLoginToken,
setTokenPair,
loadCurrentUser,
],
);
const handleCredentialsSignIn = useCallback(
async (email: string, password: string, captchaToken?: string) => {
const { loginToken } = await handleChallenge(
const { loginToken } = await handleGetLoginTokenFromCredentials(
email,
password,
captchaToken,
);
await handleVerify(loginToken.token);
await handleGetAuthTokensFromLoginToken(loginToken.token);
},
[handleChallenge, handleVerify],
[handleGetLoginTokenFromCredentials, handleGetAuthTokensFromLoginToken],
);
const handleSignOut = useCallback(async () => {
@ -413,14 +422,16 @@ export const useAuth = () => {
);
}
await handleVerify(signUpResult.data?.signUp.loginToken.token);
await handleGetAuthTokensFromLoginToken(
signUpResult.data?.signUp.loginToken.token,
);
},
[
setIsVerifyPendingState,
signUp,
workspacePublicData,
isMultiWorkspaceEnabled,
handleVerify,
handleGetAuthTokensFromLoginToken,
setSignInUpStep,
setSearchParams,
isEmailVerificationRequired,
@ -486,10 +497,10 @@ export const useAuth = () => {
);
return {
challenge: handleChallenge,
getLoginTokenFromCredentials: handleGetLoginTokenFromCredentials,
getLoginTokenFromEmailVerificationToken:
handleGetLoginTokenFromEmailVerificationToken,
verify: handleVerify,
getAuthTokensFromLoginToken: handleGetAuthTokensFromLoginToken,
loadCurrentUser,