Feat/1467 create response types poc (#60)

* feat:1443 refactor current tests to use factories

* feat: 1443 handle upcoming housing contracts

* feat: 1443 clean

* Feat: 1467 use detailedApplicant response type

package.json

@@ -60,6 +60,7 @@
     "koa-bodyparser": "^4.4.1",
     "koa-pino-logger": "^4.0.0",
     "mssql": "^9.3.2",
+    "onecore-types": "^1.18.0",
     "personnummer": "^3.2.1",
     "prettier": "^3.2.5",
     "randexp": "^0.5.3",

src/services/lease-service/index.ts

@@ -1,5 +1,10 @@
 import KoaRouter from '@koa/router'
-import { Applicant, ApplicantStatus, Listing } from 'onecore-types'
+import {
+  Applicant,
+  ApplicantStatus,
+  Listing,
+  DetailedApplicant,
+} from 'onecore-types'
 
 import {
   getContactByContactCode,
@@ -509,7 +514,7 @@ export const routes = (router: KoaRouter) => {
         return
       }
 
-      const applicants: any = []
+      const applicants: DetailedApplicant[] = []
 
       if (listing.applicants) {
         for (const applicant of listing.applicants) {

src/services/lease-service/priority-list-service.ts

@@ -6,6 +6,7 @@
 
 import {
   Applicant,
+  DetailedApplicant,
   Lease,
   Listing,
   ParkingSpaceApplicationCategory,
@@ -20,7 +21,9 @@ import {
 } from './adapters/xpand/tenant-lease-adapter'
 import { leaseTypes } from '../../constants/leaseTypes'
 
-const getDetailedApplicantInformation = async (applicant: Applicant) => {
+const getDetailedApplicantInformation = async (
+  applicant: Applicant
+): Promise<DetailedApplicant> => {
   try {
     const applicantFromXpand = await getContactByContactCode(
       applicant.contactCode,
@@ -76,7 +79,6 @@ const getDetailedApplicantInformation = async (applicant: Applicant) => {
 
     const parkingSpaces = parseLeasesForParkingSpaces(activeAndUpcomingLeases)
 
-    //todo: define the proper interface type to return
     return {
       ...applicant,
       queuePoints: waitingListForInternalParkingSpace.queuePoints,
@@ -91,12 +93,11 @@ const getDetailedApplicantInformation = async (applicant: Applicant) => {
   }
 }
 
-//todo: should use and return defined interface type
 const addPriorityToApplicantsBasedOnRentalRules = (
   listing: Listing,
-  applicants: any[]
+  applicants: DetailedApplicant[]
 ) => {
-  const applicantsWithAssignedPriority: any[] = [] //todo: use defined interface
+  const applicantsWithAssignedPriority: DetailedApplicant[] = []
   for (const applicant of applicants) {
     applicantsWithAssignedPriority.push(
       assignPriorityToApplicantBasedOnRentalRules(listing, applicant)
@@ -106,23 +107,30 @@ const addPriorityToApplicantsBasedOnRentalRules = (
   return applicantsWithAssignedPriority
 }
 
-const sortApplicantsBasedOnRentalRules = (applicants: any[]): any[] => {
+const sortApplicantsBasedOnRentalRules = (
+  applicants: DetailedApplicant[]
+): DetailedApplicant[] => {
   return Array.from(applicants).sort((a, b) => {
+    //undefined priority is the lowest priority
+    const aPriority =
+      a.priority !== undefined ? a.priority : Number.MAX_SAFE_INTEGER
+    const bPriority =
+      b.priority !== undefined ? b.priority : Number.MAX_SAFE_INTEGER
+
     //sort by priority (ascending)
-    if (a.priority !== b.priority) {
-      return a.priority - b.priority
+    if (aPriority !== bPriority) {
+      return aPriority - bPriority
     }
 
     //sort by queue points (descending)
     return b.queuePoints - a.queuePoints
   })
 }
 
-//todo: should use and return defined interface type from onecore-types
 const assignPriorityToApplicantBasedOnRentalRules = (
   listing: Listing,
-  applicant: any
-): any => {
+  applicant: DetailedApplicant
+): DetailedApplicant => {
   if (applicant.listingId !== listing.id) {
     throw new Error(
       `applicant ${applicant.contactCode} does not belong to listing ${listing.id}`
@@ -132,10 +140,10 @@ const assignPriorityToApplicantBasedOnRentalRules = (
   //priority  1
 
   //Applicant has no active parking space contract and is tenant in same area as listing
-  if (!applicant.parkingSpaceContracts.length) {
+  if (!applicant.parkingSpaceContracts?.length) {
     if (applicant.currentHousingContract) {
       if (
-        applicant.currentHousingContract.residentialArea.code ===
+        applicant.currentHousingContract?.residentialArea?.code ===
         listing.districtCode
       ) {
         return {
@@ -148,7 +156,7 @@ const assignPriorityToApplicantBasedOnRentalRules = (
     //Applicant has no active parking space contract and has upcoming housing contract in same area as listing
     if (applicant.upcomingHousingContract) {
       if (
-        applicant.upcomingHousingContract.residentialArea.code ===
+        applicant.upcomingHousingContract?.residentialArea?.code ===
         listing.districtCode
       ) {
         return {
@@ -161,7 +169,7 @@ const assignPriorityToApplicantBasedOnRentalRules = (
 
   //Applicant has 1 active contract for parking space and wishes to replace current parking space
   if (
-    applicant.parkingSpaceContracts.length === 1 &&
+    applicant.parkingSpaceContracts?.length === 1 &&
     applicant.applicationType === 'Replace'
   ) {
     return {
@@ -174,7 +182,7 @@ const assignPriorityToApplicantBasedOnRentalRules = (
 
   //Applicant has 1 active parking space contract and wishes to rent an additional parking space
   if (
-    applicant.parkingSpaceContracts.length === 1 &&
+    applicant.parkingSpaceContracts?.length === 1 &&
     applicant.applicationType === 'Additional'
   ) {
     return {
@@ -185,6 +193,7 @@ const assignPriorityToApplicantBasedOnRentalRules = (
 
   //Applicant has more than 1 active parking space contract and wishes to replace 1 parking space contract
   if (
+    applicant.parkingSpaceContracts &&
     applicant.parkingSpaceContracts.length > 1 &&
     applicant.applicationType === 'Replace'
   ) {
@@ -196,11 +205,20 @@ const assignPriorityToApplicantBasedOnRentalRules = (
 
   //priority 3
 
-  //Applicant has more 2 or more active parking space and wishes to rent an additional parking space
+  //Applicant has 2 or more active parking space and wishes to rent an additional parking space
+  if (
+    applicant.parkingSpaceContracts &&
+    applicant.parkingSpaceContracts.length >= 2
+  ) {
+    return {
+      ...applicant,
+      priority: 3,
+    }
+  }
 
   return {
     ...applicant,
-    priority: 3,
+    priority: undefined,
   }
 }
 

src/services/lease-service/tests/factory.ts

@@ -1,5 +1,6 @@
 import { Factory } from 'fishery'
 import {
+  DetailedApplicant,
   Lease,
   LeaseStatus,
   Listing,
@@ -41,32 +42,32 @@ const LeaseFactory = Factory.define<Lease>(({ sequence }) => ({
   },
 }))
 
-//todo: use properly defined interface
-const ApplicantFactory = Factory.define<any, { currentHousingContract: Lease }>(
-  ({ sequence, params }) => ({
-    id: `${sequence}`,
+const DetailedApplicantFactory = Factory.define<DetailedApplicant>(
+  ({ sequence }) => ({
+    id: sequence,
     name: 'Test Testsson',
+    nationalRegistrationNumber: '199404084924',
     contactCode: `P${158769 + sequence}`,
-    applicationDate: new Date().toISOString(),
+    applicationDate: new Date(),
     applicationType: 'Additional',
     status: 1,
-    listingId: `${sequence}`,
+    listingId: sequence, //maybe keep as undefined?
     queuePoints: 10,
     address: {
       street: 'Aromas väg 8B',
       number: '',
       postalCode: '73439',
       city: 'Hallstahammar',
     },
-    currentHousingContract: params.currentHousingContract,
-    upcomingHousingContract: params.upcomingHousingContract,
+    currentHousingContract: undefined,
+    upcomingHousingContract: undefined,
     parkingSpaceContracts: [],
-    priority: 0,
+    priority: undefined,
   })
 )
 
 const ListingFactory = Factory.define<Listing>(({ sequence }) => ({
-  id: sequence + 1,
+  id: sequence,
   rentalObjectCode: `R${sequence + 1000}`,
   address: 'Sample Address',
   monthlyRent: 1000,
@@ -91,11 +92,11 @@ const OfferFactory = Factory.define<Offer>(({ sequence }) => ({
   expiresAt: new Date(),
   id: sequence,
   listingId: 1,
-  offeredApplicant: ApplicantFactory.build(),
+  offeredApplicant: DetailedApplicantFactory.build(),
   selectedApplicants: [],
   sentAt: null,
   status: OfferStatus.Active,
   createdAt: new Date(),
 }))
 
-export { LeaseFactory, ApplicantFactory, ListingFactory, OfferFactory }
+export { LeaseFactory, DetailedApplicantFactory, ListingFactory, OfferFactory }

src/services/lease-service/tests/offers.test.ts

@@ -57,7 +57,9 @@ describe('offers', () => {
       const expected = { ...offer, expiresAt: offer.expiresAt.toISOString() }
 
       expect(res.status).toBe(201)
-      expect(res.body.data).toEqual(expected)
+      expect(res.body.data.createdAt).toBeDefined()
+      expect(res.body.data.listingId).toEqual(expected.listingId)
+      expect(res.body.data.expiresAt).toEqual(expected.expiresAt)
     })
   })
 })