Adds Jurisdiction to listings, users, translations (replaces countyCode)

CHANGELOG.md

@@ -58,6 +58,7 @@ All notable changes to this project will be documented in this file. The format
   - Adds `roles` property to `UserDto [#1575](https://github.com/bloom-housing/bloom/pull/1575)
   - Adds UnitAmiChartOverride entity and implements ami chart overriding at Unit level [#1575](https://github.com/bloom-housing/bloom/pull/1575)
   - Adds `authz.e2e-spec.ts` test cover for preventing user from voluntarily changing his associated `roles` object [#1575](https://github.com/bloom-housing/bloom/pull/1575)
+  - Adds Jurisdictions to users, listings and translations. The migration script assigns the first alpha sorted jurisdiction to users, so this piece may need to be changed for Detroit, if they have more than Detroit in their DB. [#1776](https://github.com/bloom-housing/bloom/pull/1776)
 
 - Changed:
 

backend/core/archer.ts

@@ -1,13 +1,14 @@
 import {
   AmiChart,
-  CountyCode,
   CSVFormattingType,
   Listing,
   ListingReviewOrder,
   ListingStatus,
   UnitStatus,
 } from "./types"
 
+import { CountyCode } from "./src/shared/types/county-code"
+
 export const SanMateoHUD2019: AmiChart = {
   id: "ami_chart_id",
   createdAt: new Date(),
@@ -253,6 +254,10 @@ export const ArcherListing: Listing = {
   applicationDropOffAddressOfficeHours: null,
   applicationMailingAddress: null,
   countyCode: CountyCode["San Jose"],
+  jurisdiction: {
+    id: "id",
+    name: "San Jose",
+  },
   depositMax: "",
   disableUnitsAccordion: false,
   events: [],

backend/core/src/app.module.ts

@@ -5,7 +5,9 @@ try {
 } catch {
   // Pass
 }
-import "newrelic"
+if (process.env.NEW_RELIC_APP_NAME && process.env.NEW_RELIC_LICENSE_KEY) {
+  require("newrelic")
+}
 import { ClassSerializerInterceptor, DynamicModule, INestApplication, Module } from "@nestjs/common"
 import { TypeOrmModule } from "@nestjs/typeorm"
 // Use require because of the CommonJS/AMD style export.

backend/core/src/auth/auth.module.ts

@@ -15,6 +15,7 @@ import { UserService } from "./services/user.service"
 import { UserController } from "./controllers/user.controller"
 import { EmailModule } from "../shared/email/email.module"
 import { PasswordService } from "./services/password.service"
+import { JurisdictionsModule } from "../jurisdictions/jurisdictions.module"
 
 @Module({
   imports: [
@@ -31,6 +32,7 @@ import { PasswordService } from "./services/password.service"
     }),
     TypeOrmModule.forFeature([RevokedToken, User]),
     SharedModule,
+    JurisdictionsModule,
     EmailModule,
   ],
   providers: [LocalStrategy, JwtStrategy, AuthService, AuthzService, UserService, PasswordService],

backend/core/src/auth/dto/user.dto.ts

@@ -16,17 +16,20 @@ import {
 } from "class-validator"
 import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enum"
 import { IdNameDto } from "../../shared/dto/idName.dto"
+import { IdDto } from "../../shared/dto/id.dto"
 import { Match } from "../../shared/decorators/match.decorator"
 import { passwordRegex } from "../../shared/password-regex"
 import { PaginationFactory, PaginationAllowsAllQueryParams } from "../../shared/dto/pagination.dto"
 import { UserRolesDto } from "./user-roles.dto"
+import { JurisdictionDto } from "../../jurisdictions/dto/jurisdiction.dto"
 
 export class UserDto extends OmitType(User, [
   "leasingAgentInListings",
   "passwordHash",
   "resetToken",
   "confirmationToken",
   "roles",
+  "jurisdictions",
 ] as const) {
   @Expose()
   @IsOptional()
@@ -40,6 +43,12 @@ export class UserDto extends OmitType(User, [
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @Type(() => UserRolesDto)
   roles?: UserRolesDto | null
+
+  @Expose()
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  @Type(() => JurisdictionDto)
+  jurisdictions: JurisdictionDto[]
 }
 
 export class UserBasicDto extends OmitType(User, [
@@ -48,12 +57,19 @@ export class UserBasicDto extends OmitType(User, [
   "confirmationToken",
   "resetToken",
   "roles",
+  "jurisdictions",
 ] as const) {
   @Expose()
   @IsDefined({ groups: [ValidationsGroupsEnum.default] })
   @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
   @Type(() => UserRolesDto)
   roles: UserRolesDto
+
+  @Expose()
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  @Type(() => JurisdictionDto)
+  jurisdictions: JurisdictionDto[]
 }
 
 export class UserDtoWithAccessToken extends UserDto {
@@ -79,6 +95,7 @@ export class UserCreateDto extends OmitType(UserDto, [
   "updatedAt",
   "leasingAgentInListings",
   "roles",
+  "jurisdictions",
 ] as const) {
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
@@ -104,6 +121,12 @@ export class UserCreateDto extends OmitType(UserDto, [
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(256, { groups: [ValidationsGroupsEnum.default] })
   appUrl?: string | null
+
+  @Expose()
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  @Type(() => JurisdictionDto)
+  jurisdictions?: JurisdictionDto[]
 }
 
 export class UserUpdateDto extends OmitType(UserDto, [
@@ -112,6 +135,7 @@ export class UserUpdateDto extends OmitType(UserDto, [
   "updatedAt",
   "leasingAgentInListings",
   "roles",
+  "jurisdictions",
 ] as const) {
   @Expose()
   @IsOptional({ groups: [ValidationsGroupsEnum.default] })
@@ -143,6 +167,12 @@ export class UserUpdateDto extends OmitType(UserDto, [
   @ValidateIf((o) => o.password, { groups: [ValidationsGroupsEnum.default] })
   @IsNotEmpty({ groups: [ValidationsGroupsEnum.default] })
   currentPassword?: string
+
+  @Expose()
+  @IsDefined({ groups: [ValidationsGroupsEnum.default] })
+  @ValidateNested({ groups: [ValidationsGroupsEnum.default], each: true })
+  @Type(() => IdDto)
+  jurisdictions: IdDto[]
 }
 
 export class UserListQueryParams extends PaginationAllowsAllQueryParams {}

backend/core/src/auth/entities/user.entity.ts

@@ -3,6 +3,7 @@ import {
   CreateDateColumn,
   Entity,
   Index,
+  JoinTable,
   ManyToMany,
   OneToOne,
   PrimaryGeneratedColumn,
@@ -16,6 +17,7 @@ import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enu
 import { ApiProperty } from "@nestjs/swagger"
 import { Language } from "../../shared/types/language-enum"
 import { UserRoles } from "./user-roles.entity"
+import { Jurisdiction } from "../../jurisdictions/entities/jurisdiction.entity"
 
 @Entity({ name: "user_accounts" })
 @Unique(["email"])
@@ -101,4 +103,8 @@ export class User {
   @IsEnum(Language, { groups: [ValidationsGroupsEnum.default] })
   @ApiProperty({ enum: Language, enumName: "Language" })
   language?: Language | null
+
+  @ManyToMany(() => Jurisdiction, { cascade: true, eager: true })
+  @JoinTable()
+  jurisdictions: Jurisdiction[]
 }

backend/core/src/auth/services/user.service.spec.ts

@@ -8,6 +8,7 @@ import { EmailService } from "../../shared/email/email.service"
 import { AuthService } from "./auth.service"
 import { AuthzService } from "./authz.service"
 import { PasswordService } from "./password.service"
+import { JurisdictionResolverService } from "../../jurisdictions/services/jurisdiction-resolver.service"
 
 // Cypress brings in Chai types for the global expect, but we want to use jest
 // expect here so we need to re-declare it.
@@ -37,6 +38,12 @@ describe("UserService", () => {
           provide: AuthService,
           useValue: { generateAccessToken: jest.fn().mockReturnValue("accessToken") },
         },
+        {
+          provide: JurisdictionResolverService,
+          useValue: {
+            getJurisdiction: jest.fn(),
+          },
+        },
         AuthzService,
         PasswordService,
       ],

backend/core/src/auth/services/user.service.ts

@@ -24,6 +24,7 @@ import { ForgotPasswordDto } from "../dto/forgot-password.dto"
 
 import { AuthContext } from "../types/auth-context"
 import { PasswordService } from "./password.service"
+import { JurisdictionResolverService } from "../../jurisdictions/services/jurisdiction-resolver.service"
 
 @Injectable({ scope: Scope.REQUEST })
 export class UserService {
@@ -32,7 +33,8 @@ export class UserService {
     private readonly emailService: EmailService,
     private readonly authService: AuthService,
     private readonly authzService: AuthzService,
-    private readonly passwordService: PasswordService
+    private readonly passwordService: PasswordService,
+    private readonly jurisdictionResolverService: JurisdictionResolverService
   ) {}
 
   public async findByEmail(email: string) {
@@ -100,6 +102,20 @@ export class UserService {
       delete dto.password
     }
 
+    /**
+     * jurisdictions should be filtered based off of what the authContext user has
+     */
+    if (authContext.user.jurisdictions) {
+      if (dto.jurisdictions) {
+        dto.jurisdictions = dto.jurisdictions.filter(
+          (jurisdiction) =>
+            authContext.user.jurisdictions.findIndex((val) => val.id === jurisdiction.id) > -1
+        )
+      }
+    } else {
+      delete dto.jurisdictions
+    }
+
     assignDefined(user, {
       ...dto,
       passwordHash,
@@ -159,7 +175,6 @@ export class UserService {
         ...dto,
       })
     }
-
     let user = await this.findByEmail(dto.email)
     if (user) {
       throw new HttpException(USER_ERRORS.EMAIL_IN_USE.message, USER_ERRORS.EMAIL_IN_USE.status)
@@ -172,6 +187,10 @@ export class UserService {
     user.dob = dto.dob
     user.email = dto.email
     user.language = dto.language
+    // if coming from partners dto.jurisdictions can be set
+    user.jurisdictions = dto.jurisdictions
+      ? dto.jurisdictions
+      : [await this.jurisdictionResolverService.getJurisdiction()]
     try {
       user.passwordHash = await this.passwordService.passwordToHash(password)
       user = await this.repo.save(user)

backend/core/src/jurisdictions/entities/jurisdiction.entity.ts

@@ -6,7 +6,7 @@ import { ValidationsGroupsEnum } from "../../shared/types/validations-groups-enu
 
 @Entity({ name: "jurisdictions" })
 export class Jurisdiction extends AbstractEntity {
-  @Column({ type: "text" })
+  @Column({ type: "text", unique: true })
   @Expose()
   @IsString({ groups: [ValidationsGroupsEnum.default] })
   @MaxLength(256, { groups: [ValidationsGroupsEnum.default] })

backend/core/src/jurisdictions/jurisdictions.controller.ts

@@ -16,7 +16,7 @@ import { AuthzGuard } from "../auth/guards/authz.guard"
 import { ResourceType } from "../auth/decorators/resource-type.decorator"
 import { mapTo } from "../shared/mapTo"
 import { defaultValidationPipeOptions } from "../shared/default-validation-pipe-options"
-import { JurisdictionsService } from "./jurisdictions.service"
+import { JurisdictionsService } from "./services/jurisdictions.service"
 import {
   JurisdictionCreateDto,
   JurisdictionDto,

backend/core/src/jurisdictions/jurisdictions.module.ts

@@ -1,13 +1,15 @@
-import { Module } from "@nestjs/common"
+import { forwardRef, Module } from "@nestjs/common"
 import { TypeOrmModule } from "@nestjs/typeorm"
 import { AuthModule } from "../auth/auth.module"
 import { Jurisdiction } from "./entities/jurisdiction.entity"
 import { JurisdictionsController } from "./jurisdictions.controller"
-import { JurisdictionsService } from "./jurisdictions.service"
+import { JurisdictionsService } from "./services/jurisdictions.service"
+import { JurisdictionResolverService } from "./services/jurisdiction-resolver.service"
 
 @Module({
-  imports: [TypeOrmModule.forFeature([Jurisdiction]), AuthModule],
+  imports: [TypeOrmModule.forFeature([Jurisdiction]), forwardRef(() => AuthModule)],
   controllers: [JurisdictionsController],
-  providers: [JurisdictionsService],
+  providers: [JurisdictionsService, JurisdictionResolverService],
+  exports: [JurisdictionResolverService],
 })
 export class JurisdictionsModule {}

backend/core/src/jurisdictions/services/jurisdiction-resolver.service.ts

@@ -0,0 +1,28 @@
+import { Inject, Injectable, NotFoundException, Scope } from "@nestjs/common"
+import { REQUEST } from "@nestjs/core"
+import { InjectRepository } from "@nestjs/typeorm"
+import { Request as ExpressRequest } from "express"
+import { Repository } from "typeorm"
+import { Jurisdiction } from "../entities/jurisdiction.entity"
+
+@Injectable({ scope: Scope.REQUEST })
+export class JurisdictionResolverService {
+  constructor(
+    @Inject(REQUEST) private req: ExpressRequest,
+    @InjectRepository(Jurisdiction)
+    private readonly jurisdictionRepository: Repository<Jurisdiction>
+  ) {}
+
+  async getJurisdiction(): Promise<Jurisdiction> {
+    const jurisdictionName = this.req.get("jurisdictionName")
+    const jurisdiction = await this.jurisdictionRepository.findOne({
+      where: { name: jurisdictionName },
+    })
+
+    if (jurisdiction === undefined) {
+      throw new NotFoundException("The jurisdiction is not configured.")
+    }
+
+    return jurisdiction
+  }
+}

backend/core/src/jurisdictions/services/jurisdictions.service.ts

@@ -0,0 +1,9 @@
+import { AbstractServiceFactory } from "../../shared/services/abstract-service"
+import { Jurisdiction } from "../entities/jurisdiction.entity"
+import { JurisdictionCreateDto, JurisdictionUpdateDto } from "../dto/jurisdiction.dto"
+
+export class JurisdictionsService extends AbstractServiceFactory<
+  Jurisdiction,
+  JurisdictionCreateDto,
+  JurisdictionUpdateDto
+>(Jurisdiction) {}