Closes twentyhq/twenty#8240 This PR introduces email verification for non-Microsoft/Google Emails: ## Email Verification SignInUp Flow: https://github.com/user-attachments/assets/740e9714-5413-4fd8-b02e-ace728ea47ef The email verification link is sent as part of the `SignInUpStep.EmailVerification`. The email verification token validation is handled on a separate page (`AppPath.VerifyEmail`). A verification email resend can be triggered from both pages. ## Email Verification Flow Screenshots (In Order):    ## Sent Email Details (Subject & Template):   ### Successful Email Verification Redirect:  ### Unsuccessful Email Verification (invalid token, invalid email, token expired, user does not exist, etc.):  ### Force Sign In When Email Not Verified:  # TODOs: ## Sign Up Process - [x] Introduce server-level environment variable IS_EMAIL_VERIFICATION_REQUIRED (defaults to false) - [x] Ensure users joining an existing workspace through an invite are not required to validate their email - [x] Generate an email verification token - [x] Store the token in appToken - [x] Send email containing the verification link - [x] Create new email template for email verification - [x] Create a frontend page to handle verification requests ## Sign In Process - [x] After verifying user credentials, check if user's email is verified and prompt to to verify - [x] Show an option to resend the verification email ## Database - [x] Rename the `emailVerified` colum on `user` to to `isEmailVerified` for consistency ## During Deployment - [x] Run a script/sql query to set `isEmailVerified` to `true` for all users with a Google/Microsoft email and all users that show an indication of a valid subscription (e.g. linked credit card) - I have created a draft migration file below that shows one possible approach to implementing this change: ```typescript import { MigrationInterface, QueryRunner } from 'typeorm'; export class UpdateEmailVerifiedForActiveUsers1733318043628 implements MigrationInterface { name = 'UpdateEmailVerifiedForActiveUsers1733318043628'; public async up(queryRunner: QueryRunner): Promise<void> { await queryRunner.query(` CREATE TABLE core."user_email_verified_backup" AS SELECT id, email, "isEmailVerified" FROM core."user" WHERE "deletedAt" IS NULL; `); await queryRunner.query(` -- Update isEmailVerified for users who have been part of workspaces with active subscriptions UPDATE core."user" u SET "isEmailVerified" = true WHERE EXISTS ( -- Check if user has been part of a workspace through userWorkspace table SELECT 1 FROM core."userWorkspace" uw JOIN core."workspace" w ON uw."workspaceId" = w.id WHERE uw."userId" = u.id -- Check for valid subscription indicators AND ( w."activationStatus" = 'ACTIVE' -- Add any other subscription-related conditions here ) ) AND u."deletedAt" IS NULL; `); } public async down(queryRunner: QueryRunner): Promise<void> { await queryRunner.query(` UPDATE core."user" u SET "isEmailVerified" = b."isEmailVerified" FROM core."user_email_verified_backup" b WHERE u.id = b.id; `); await queryRunner.query(`DROP TABLE core."user_email_verified_backup";`); } } ``` --------- Co-authored-by: Antoine Moreaux <moreaux.antoine@gmail.com> Co-authored-by: Félix Malfait <felix@twenty.com>
69 lines
2.2 KiB
TypeScript
69 lines
2.2 KiB
TypeScript
import { useAuth } from '@/auth/hooks/useAuth';
|
|
import { AppPath } from '@/types/AppPath';
|
|
import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/SnackBar';
|
|
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
|
|
|
|
import { useReadCaptchaToken } from '@/captcha/hooks/useReadCaptchaToken';
|
|
import { useEffect, useState } from 'react';
|
|
import { useNavigate, useSearchParams } from 'react-router-dom';
|
|
import { EmailVerificationSent } from '../sign-in-up/components/EmailVerificationSent';
|
|
|
|
export const VerifyEmailEffect = () => {
|
|
const { getLoginTokenFromEmailVerificationToken } = useAuth();
|
|
|
|
const { enqueueSnackBar } = useSnackBar();
|
|
|
|
const [searchParams] = useSearchParams();
|
|
const [isError, setIsError] = useState(false);
|
|
const email = searchParams.get('email');
|
|
const emailVerificationToken = searchParams.get('emailVerificationToken');
|
|
|
|
const navigate = useNavigate();
|
|
const { readCaptchaToken } = useReadCaptchaToken();
|
|
|
|
useEffect(() => {
|
|
const verifyEmailToken = async () => {
|
|
if (!email || !emailVerificationToken) {
|
|
enqueueSnackBar(`Invalid email verification link.`, {
|
|
dedupeKey: 'email-verification-link-dedupe-key',
|
|
variant: SnackBarVariant.Error,
|
|
});
|
|
return navigate(AppPath.SignInUp);
|
|
}
|
|
|
|
const captchaToken = await readCaptchaToken();
|
|
|
|
try {
|
|
const { loginToken } = await getLoginTokenFromEmailVerificationToken(
|
|
emailVerificationToken,
|
|
captchaToken,
|
|
);
|
|
|
|
enqueueSnackBar('Email verified.', {
|
|
dedupeKey: 'email-verification-dedupe-key',
|
|
variant: SnackBarVariant.Success,
|
|
});
|
|
|
|
navigate(`${AppPath.Verify}?loginToken=${loginToken.token}`);
|
|
} catch (error) {
|
|
enqueueSnackBar('Email verification failed.', {
|
|
dedupeKey: 'email-verification-dedupe-key',
|
|
variant: SnackBarVariant.Error,
|
|
});
|
|
setIsError(true);
|
|
}
|
|
};
|
|
|
|
verifyEmailToken();
|
|
|
|
// Verify email only needs to run once at mount
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, []);
|
|
|
|
if (isError) {
|
|
return <EmailVerificationSent email={email} isError={true} />;
|
|
}
|
|
|
|
return <></>;
|
|
};
|