10466 design debt

shared/src/business/entities/ChangePasswordForm.test.ts

@@ -82,6 +82,23 @@ describe('ChangePasswordForm', () => {
         email: 'Enter a valid email address',
       });
     });
+
+    it('should not be valid when an email in the correct format is not present', () => {
+      const inValidChangePasswordForm = {
+        confirmPassword: 'TestPassword!1',
+        email: 'myemailaddress',
+        password: 'TestPassword!1',
+      };
+
+      const changePasswordForm = new ChangePasswordForm(
+        inValidChangePasswordForm,
+      );
+
+      expect(changePasswordForm.isValid()).toBe(false);
+      expect(changePasswordForm.getFormattedValidationErrors()).toMatchObject({
+        email: 'Enter email address in format: [email protected]',
+      });
+    });
   });
 
   describe('Password Requirements', () => {

shared/src/business/entities/ChangePasswordForm.ts

@@ -23,7 +23,8 @@ export class ChangePasswordForm extends JoiValidationEntity {
       .messages({ '*': 'Passwords must match' }),
     email: JoiValidationConstants.EMAIL.required()
       .messages({
-        '*': 'Enter a valid email address',
+        'any.required': 'Enter a valid email address',
+        'string.email': 'Enter email address in format: [email protected]',
         'string.max': 'Email address must contain fewer than 100 characters',
       })
       .description('Email of user'),

shared/src/business/entities/UpdateUserEmail.test.ts → shared/src/business/entities/EmailForm.test.ts

@@ -1,89 +1,89 @@
-import { UpdateUserEmail } from './UpdateUserEmail';
+import { EmailForm } from './EmailForm';
 
-describe('UpdateUserEmail', () => {
+describe('UpdateUserEmailForm', () => {
   describe('validation', () => {
     it('should fail validation when email is not provided', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: '[email protected]',
         email: undefined as any,
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeFalsy();
-      expect(updateUserEmailEntity.getFormattedValidationErrors()).toEqual({
+      expect(updateUserEmailFormEntity.isValid()).toBeFalsy();
+      expect(updateUserEmailFormEntity.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Email addresses do not match',
         email: 'Enter a valid email address',
       });
     });
 
     it('should fail validation when confirmEmail is not provided', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: undefined as any,
         email: '[email protected]',
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeFalsy();
-      expect(updateUserEmailEntity.getFormattedValidationErrors()).toEqual({
+      expect(updateUserEmailFormEntity.isValid()).toBeFalsy();
+      expect(updateUserEmailFormEntity.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Enter a valid email address',
       });
     });
 
     it('should fail validation when confirmEmail does not match email', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: '[email protected]',
         email: '[email protected]',
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeFalsy();
-      expect(updateUserEmailEntity.getFormattedValidationErrors()).toEqual({
+      expect(updateUserEmailFormEntity.isValid()).toBeFalsy();
+      expect(updateUserEmailFormEntity.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Email addresses do not match',
       });
     });
 
     it('should fail validation when email and confirmEmail are not provided', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: undefined as any,
         email: undefined as any,
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeFalsy();
-      expect(updateUserEmailEntity.getFormattedValidationErrors()).toEqual({
+      expect(updateUserEmailFormEntity.isValid()).toBeFalsy();
+      expect(updateUserEmailFormEntity.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Enter a valid email address',
         email: 'Enter a valid email address',
       });
     });
 
     it('should fail validation when email is NOT a valid email address and confirmEmail is valid', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: '[email protected]',
         email: 'testexample.com',
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeFalsy();
-      expect(updateUserEmailEntity.getFormattedValidationErrors()).toEqual({
+      expect(updateUserEmailFormEntity.isValid()).toBeFalsy();
+      expect(updateUserEmailFormEntity.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Email addresses do not match',
-        email: 'Enter a valid email address',
+        email: 'Enter email address in format: [email protected]',
       });
     });
 
     it('should fail validation when confirmEmail is NOT a valid email address and email is valid', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: 'testexample.com',
         email: '[email protected]',
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeFalsy();
-      expect(updateUserEmailEntity.getFormattedValidationErrors()).toEqual({
-        confirmEmail: 'Enter a valid email address',
+      expect(updateUserEmailFormEntity.isValid()).toBeFalsy();
+      expect(updateUserEmailFormEntity.getFormattedValidationErrors()).toEqual({
+        confirmEmail: 'Enter email address in format: [email protected]',
       });
     });
 
     it('should pass validation when email and confirmEmail are provided and match', () => {
-      const updateUserEmailEntity = new UpdateUserEmail({
+      const updateUserEmailFormEntity = new EmailForm({
         confirmEmail: '[email protected]',
         email: '[email protected]',
       });
 
-      expect(updateUserEmailEntity.isValid()).toBeTruthy();
+      expect(updateUserEmailFormEntity.isValid()).toBeTruthy();
     });
   });
 });

shared/src/business/entities/UpdateUserEmail.ts → shared/src/business/entities/EmailForm.ts

@@ -2,15 +2,15 @@ import { JoiValidationConstants } from './JoiValidationConstants';
 import { JoiValidationEntity } from '@shared/business/entities/JoiValidationEntity';
 import joi from 'joi';
 
-export class UpdateUserEmail extends JoiValidationEntity {
+export class EmailForm extends JoiValidationEntity {
   public confirmEmail: string;
   public email: string;
 
-  constructor(rawUpdateUserEmail: { email: string; confirmEmail: string }) {
-    super('UpdateUserEmail');
+  constructor(rawEmail: { email: string; confirmEmail: string }) {
+    super('EmailForm');
 
-    this.email = rawUpdateUserEmail.email;
-    this.confirmEmail = rawUpdateUserEmail.confirmEmail;
+    this.email = rawEmail.email;
+    this.confirmEmail = rawEmail.confirmEmail;
   }
 
   static VALIDATION_RULES = {
@@ -19,16 +19,17 @@ export class UpdateUserEmail extends JoiValidationEntity {
       .messages({
         'any.only': 'Email addresses do not match',
         'any.required': 'Enter a valid email address',
-        'string.email': 'Enter a valid email address',
+        'string.email': 'Enter email address in format: [email protected]',
       }),
     email: JoiValidationConstants.EMAIL.required().messages({
-      '*': 'Enter a valid email address',
+      'any.required': 'Enter a valid email address',
+      'string.email': 'Enter email address in format: [email protected]',
     }),
   };
 
   getValidationRules() {
-    return UpdateUserEmail.VALIDATION_RULES;
+    return EmailForm.VALIDATION_RULES;
   }
 }
 
-export type RawUpdateUserEmail = ExcludeMethods<UpdateUserEmail>;
+export type RawEmailForm = ExcludeMethods<EmailForm>;

shared/src/business/entities/NewPetitionerUser.test.ts

@@ -17,17 +17,42 @@ describe('NewPetitionerUser', () => {
   });
 
   describe('Email', () => {
-    it('should return error message for email', () => {
+    it('should return an error message for email when no email is provided', () => {
       const formEntity = new NewPetitionerUser({
         ...validEntity,
-        email: 'hello',
+        email: undefined,
       });
 
       expect(formEntity.isValid()).toBeFalsy();
       expect(formEntity.getValidationErrors()).toEqual({
         email: 'Enter a valid email address',
       });
     });
+
+    it('should return an error message for email when an invalid email format is provided', () => {
+      const formEntity = new NewPetitionerUser({
+        ...validEntity,
+        email: 'hello',
+      });
+
+      expect(formEntity.isValid()).toBeFalsy();
+      expect(formEntity.getValidationErrors()).toEqual({
+        email: 'Enter email address in format: [email protected]',
+      });
+    });
+
+    it('should return an error message for email when an email address exceeding the maximum number of characters is provided', () => {
+      const formEntity = new NewPetitionerUser({
+        ...validEntity,
+        email:
+          'horatio_says_tis_but_our_fantasy_and_will_not_let_belief_take_hold_of_him_touching_this_dreaded_sight_twice_seen_of_us@denmarkemailservice.com',
+      });
+
+      expect(formEntity.isValid()).toBeFalsy();
+      expect(formEntity.getValidationErrors()).toEqual({
+        email: 'Email address must contain fewer than 100 characters',
+      });
+    });
   });
 
   describe('Name', () => {

shared/src/business/entities/NewPetitionerUser.ts

@@ -25,8 +25,9 @@ export class NewPetitionerUser extends JoiValidationEntity {
       .messages({ '*': 'Passwords must match' }),
     email: JoiValidationConstants.EMAIL.required()
       .messages({
-        '*': 'Enter a valid email address',
-        'string.max': 'Email address must contain fewer than 100 characters', //todo test
+        'any.required': 'Enter a valid email address',
+        'string.email': 'Enter email address in format: [email protected]',
+        'string.max': 'Email address must contain fewer than 100 characters',
       })
       .description('Email of user'),
     entityName:

shared/src/business/entities/NewPractitioner.test.ts

@@ -48,7 +48,7 @@ describe('NewPractitioner', () => {
 
     expect(user.isValid()).toBeFalsy();
     expect(user.getFormattedValidationErrors()).toMatchObject({
-      email: 'Enter email address',
+      email: 'Enter a valid email address',
     });
   });
 
@@ -92,7 +92,7 @@ describe('NewPractitioner', () => {
       expect(validNewPractitioner.isValid()).toBeFalsy();
       expect(validNewPractitioner.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Enter a valid email address',
-        email: 'Enter email address',
+        email: 'Enter email address in format: [email protected]',
       });
     });
 
@@ -112,7 +112,7 @@ describe('NewPractitioner', () => {
 
       expect(validNewPractitioner.isValid()).toBeFalsy();
       expect(validNewPractitioner.getFormattedValidationErrors()).toEqual({
-        confirmEmail: 'Enter a valid email address',
+        confirmEmail: 'Enter email address in format: [email protected]',
       });
     });
 

shared/src/business/entities/NewPractitioner.ts

@@ -23,10 +23,11 @@ export class NewPractitioner extends Practitioner {
     }).messages({
       'any.only': 'Email addresses do not match',
       'any.required': 'Enter a valid email address',
-      'string.email': 'Enter a valid email address',
+      'string.email': 'Enter email address in format: [email protected]',
     }),
     email: JoiValidationConstants.EMAIL.required().messages({
-      '*': 'Enter email address',
+      'any.required': 'Enter a valid email address',
+      'string.email': 'Enter email address in format: [email protected]',
     }),
     firstName: JoiValidationConstants.STRING.max(100)
       .required()

shared/src/business/entities/Practitioner.test.ts

@@ -254,7 +254,7 @@ describe('Practitioner', () => {
       expect(validPractitioner.isValid()).toBeFalsy();
       expect(validPractitioner.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Email addresses do not match',
-        updatedEmail: 'Enter a valid email address',
+        updatedEmail: 'Enter email address in format: [email protected]',
       });
     });
 
@@ -274,7 +274,7 @@ describe('Practitioner', () => {
 
       expect(validPractitioner.isValid()).toBeFalsy();
       expect(validPractitioner.getFormattedValidationErrors()).toEqual({
-        confirmEmail: 'Enter a valid email address',
+        confirmEmail: 'Enter email address in format: [email protected]',
       });
     });
 
@@ -305,7 +305,7 @@ describe('Practitioner', () => {
       expect(validPractitioner.isValid()).toBeFalsy();
       expect(validPractitioner.getFormattedValidationErrors()).toEqual({
         confirmEmail: 'Enter a valid email address',
-        updatedEmail: 'Enter a valid email address',
+        updatedEmail: 'Enter email address in format: [email protected]',
       });
     });
   });

shared/src/business/entities/Practitioner.ts

@@ -113,7 +113,7 @@ export class Practitioner extends User {
     }).messages({
       'any.only': 'Email addresses do not match',
       'any.required': 'Enter a valid email address',
-      'string.email': 'Enter a valid email address',
+      'string.email': 'Enter email address in format: [email protected]',
     }),
     entityName: JoiValidationConstants.STRING.valid('Practitioner').required(),
     firmName: JoiValidationConstants.STRING.max(100)
@@ -183,7 +183,10 @@ export class Practitioner extends User {
         otherwise: JoiValidationConstants.EMAIL.optional().allow(null),
         then: JoiValidationConstants.EMAIL.required(),
       })
-      .messages({ '*': 'Enter a valid email address' }),
+      .messages({
+        'any.required': 'Enter a valid email address',
+        'string.email': 'Enter email address in format: [email protected]',
+      }),
   };
 
   getValidationRules() {

shared/src/business/entities/contacts/Contact.test.ts

@@ -14,7 +14,7 @@ describe('Contact', () => {
       );
 
       expect(contact.getFormattedValidationErrors()!.email).toEqual(
-        '"email" is required',
+        'Enter a valid email address',
       );
     });
 

shared/src/business/entities/contacts/Contact.ts

@@ -87,6 +87,10 @@ export class Contact extends JoiValidationEntity {
       is: true,
       otherwise: joi.optional(),
       then: joi.required(),
+    }).messages({
+      'any.required': 'Enter a valid email address',
+      'string.email': 'Enter email address in format: [email protected]',
+      'string.empty': 'Enter a valid email address',
     }),
     hasConsentedToEService: joi
       .boolean()
@@ -108,7 +112,9 @@ export class Contact extends JoiValidationEntity {
     paperPetitionEmail: JoiValidationConstants.EMAIL.optional()
       .allow(null)
       .description('Email provided by the petitioner on their petition form')
-      .messages({ '*': 'Enter email address in format: [email protected]' }),
+      .messages({
+        'string.email': 'Enter email address in format: [email protected]',
+      }),
     phone: JoiValidationConstants.STRING.max(100)
       .when('contactType', {
         is: CONTACT_TYPES.secondary,

shared/src/business/entities/contacts/Petitioner.ts

@@ -78,6 +78,9 @@ export class Petitioner extends JoiValidationEntity {
       is: true,
       otherwise: joi.optional(),
       then: joi.required(),
+    }).messages({
+      'any.required': 'Enter a valid email address',
+      'string.email': 'Enter email address in format: [email protected]',
     }),
     hasConsentedToEService: joi
       .boolean()
@@ -97,9 +100,11 @@ export class Petitioner extends JoiValidationEntity {
       '*': 'Enter name',
       'string.max': 'Limit is 100 characters. Enter 100 or fewer characters.',
     }),
-    paperPetitionEmail: JoiValidationConstants.EMAIL.optional().description(
-      'Email provided by the petitioner on a paper petition',
-    ),
+    paperPetitionEmail: JoiValidationConstants.EMAIL.optional()
+      .description('Email provided by the petitioner on a paper petition')
+      .messages({
+        'string.email': 'Enter email address in format: [email protected]',
+      }),
     sealedAndUnavailable: joi.boolean().optional(),
     serviceIndicator: JoiValidationConstants.STRING.valid(
       ...Object.values(SERVICE_INDICATOR_TYPES),