Add a phone number column to the user_accounts table (bloom-housing#2134

) * Merge pull request #710 from CityOfDetroit/feature/add-phonenumber-to-user-entity Add phone number to user accounts. * Merge pull request #728 from CityOfDetroit/fix/modify-phone-number-test Fix user E2E tests. * Merge pull request #728 from CityOfDetroit/fix/modify-phone-number-test Fix user E2E tests. * fix: add validation groups to phoneNumber
CityOfDetroit · Nov 9, 2021 · 2647df9 · 2647df9
1 parent 96edc3b
commit 2647df9
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 2 deletions.
diff --git a/backend/core/src/auth/dto/user-profile.dto.ts b/backend/core/src/auth/dto/user-profile.dto.ts
@@ -26,6 +26,7 @@ export class UserProfileUpdateDto extends PickType(User, [
   "createdAt",
   "updatedAt",
   "language",
+  "phoneNumber",
 ] as const) {
   @Expose()
   @IsOptional({ groups: [ValidationsGroupsEnum.default] })

diff --git a/backend/core/src/auth/entities/user.entity.ts b/backend/core/src/auth/entities/user.entity.ts
@@ -12,7 +12,16 @@ import {
 } from "typeorm"
 import { Listing } from "../../listings/entities/listing.entity"
 import { Expose, Type } from "class-transformer"
-import { IsDate, IsEmail, IsEnum, IsOptional, IsString, IsUUID, MaxLength } from "class-validator"
+import {
+  IsDate,
+  IsEmail,
+  IsEnum,
+  IsOptional,
+  IsPhoneNumber,
+  IsString,
+  IsUUID,
+  MaxLength,
+} from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
 import { ApiProperty } from "@nestjs/swagger"
 import { Language } from "../../shared/types/language-enum"
@@ -77,6 +86,12 @@ export class User {
   @Type(() => Date)
   dob?: Date | null
 
+  @Column("varchar", { nullable: true })
+  @Expose()
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @IsPhoneNumber(null, { groups: [ValidationsGroupsEnum.default] })
+  phoneNumber?: string
+
   @CreateDateColumn()
   @Expose()
   @IsDate({ groups: [ValidationsGroupsEnum.default] })

diff --git a/backend/core/src/migration/1634848388161-add-phone-number.ts b/backend/core/src/migration/1634848388161-add-phone-number.ts
@@ -0,0 +1,13 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+
+export class addPhoneNumber1634848388161 implements MigrationInterface {
+  name = "addPhoneNumber1634848388161"
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "user_accounts" ADD "phone_number" character varying`)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "user_accounts" DROP COLUMN "phone_number"`)
+  }
+}
diff --git a/backend/core/test/user/user.e2e-spec.ts b/backend/core/test/user/user.e2e-spec.ts
@@ -411,7 +411,7 @@ describe("Applications", () => {
     expect(token).toBeDefined()
   })
 
-  it("should allow user to update user profile throguh PUT /userProfile/:id endpoint", async () => {
+  it("should allow user to update user profile through PUT /userProfile/:id endpoint", async () => {
     const userCreateDto: UserCreateDto = {
       password: "Abcdef1!",
       passwordConfirmation: "Abcdef1!",
@@ -452,6 +452,7 @@ describe("Applications", () => {
       ...userCreateDto,
       currentPassword: userCreateDto.password,
       firstName: "NewFirstName",
+      phoneNumber: "+12025550194",
     }
 
     await supertest(app.getHttpServer())

diff --git a/backend/core/types/src/backend-swagger.ts b/backend/core/types/src/backend-swagger.ts
@@ -3893,6 +3893,9 @@ export interface User {
   /**  */
   dob?: Date
 
+  /**  */
+  phoneNumber?: string
+
   /**  */
   createdAt: Date
 
@@ -3936,6 +3939,9 @@ export interface UserCreate {
 
   /**  */
   dob?: Date
+
+  /**  */
+  phoneNumber?: string
 }
 
 export interface UserBasic {
@@ -3972,6 +3978,9 @@ export interface UserBasic {
   /**  */
   dob?: Date
 
+  /**  */
+  phoneNumber?: string
+
   /**  */
   createdAt: Date
 
@@ -4072,6 +4081,9 @@ export interface UserUpdate {
 
   /**  */
   dob?: Date
+
+  /**  */
+  phoneNumber?: string
 }
 
 export interface UserFilterParams {
@@ -4131,6 +4143,9 @@ export interface UserInvite {
 
   /**  */
   dob?: Date
+
+  /**  */
+  phoneNumber?: string
 }
 
 export interface UserProfileUpdate {