Add Email Verification for non-Microsoft/Google Emails

[samyakpiya]

Closes #8240

This PR introduces email verification for non-Microsoft/Google Emails:

Email Verification SignInUp Flow:

Sign.in.or.Create.an.account.1.mp4

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

• Introduce server-level environment variable IS_EMAIL_VERIFICATION_REQUIRED (defaults to false)
• Ensure users joining an existing workspace through an invite are not required to validate their email
• Generate an email verification token
• Store the token in appToken
• Send email containing the verification link
  • Create new email template for email verification
• Create a frontend page to handle verification requests

Sign In Process

• After verifying user credentials, check if user's email is verified and prompt to to verify
• Show an option to resend the verification email

Database

• Rename the emailVerified colum on user to to isEmailVerified for consistency

During Deployment

• 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:

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";`);
  }
}

[github-actions]

	Fails
🚫	node failed.

Log

�[31mError: �[39m SyntaxError: Unexpected token C in JSON at position 0
    at JSON.parse (<anonymous>)
�[90m    at parseJSONFromBytes (node:internal/deps/undici/undici:5584:19)�[39m
�[90m    at successSteps (node:internal/deps/undici/undici:5555:27)�[39m
�[90m    at fullyReadBody (node:internal/deps/undici/undici:1665:9)�[39m
�[90m    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)�[39m
�[90m    at async specConsumeBody (node:internal/deps/undici/undici:5564:7)�[39m
danger-results://tmp/danger-results-cc3a5dfd.json

Generated by 🚫 dangerJS against 5f8d2b5

[samyakpiya]

@FelixMalfait I spent way too long trying to figure out why the frontend couldn't make a mutation request without an auth token. Turns out there was middleware in place even though no auth guards were on the resolver. Probably should’ve just asked someone, lol.

Still need to rename the column to isEmailVerified, but other than that, it’s ready for review!

[greptile-apps]

PR Summary

This PR implements a comprehensive email verification system for non-Microsoft/Google email signups, with configurable settings and secure token handling.

• Added new SendEmailVerificationLinkEmail template with verification link and standardized footer component
• Implemented secure token generation and verification flow in EmailVerificationService with proper expiration handling
• Added frontend verification page and UI components for handling verification states and resending tokens
• Created GraphQL mutations/queries for email verification with proper DTOs and exception handling
• Added environment variables IS_EMAIL_VERIFICATION_REQUIRED and EMAIL_VERIFICATION_TOKEN_EXPIRES_IN for configuration

_{44 file(s) reviewed, 34 comment(s)
Edit PR Review Bot Settings | Greptile}

[samyakpiya]

@FelixMalfait @AMoreaux I've made all the necessary changes based on feedback. Could you go through the unresolved conversations I've responded to and resolve them or let me know if further changes are needed? Thanks!

[samyakpiya]

Ah, this makes sense now! I didn't realize the issue was rooted at the snackbar level. I've been banging my head trying to implement workarounds: avoiding useEffect, steering clear of useRef for state, and adding guards. Thanks for catching this!

[FelixMalfait]

Yes sorry I think I led you in the wrong direction. Initial loading is probably the only case where we'll keep useEffects ; in that case we want this to be done at a high level (page level), not in sub-components.
Solving the double notification at the snackbar level was probably the cleanest way to make it more idempotent in strict mode, even though it's not perfect either

[AMoreaux]

Thanks @samyakpiya 🙏

It's merged 🎉

[samyakpiya]

@AMoreaux Sweet, thank you! 😄