MIM-530: add residence status (#292)

* add residence status

* improve test

* pr: Update src/services/property-base-service/tests/calculate-residence-status.test.ts

Author: momentiris

src/services/property-base-service/calculate-residence-status.ts

@@ -0,0 +1,24 @@
+import { Lease, LeaseStatus } from 'onecore-types'
+import { z } from 'zod'
+
+import * as schemas from './schemas'
+
+type ResidenceStatus = NonNullable<
+  z.infer<typeof schemas.ResidenceDetailsSchema>['status']
+>
+
+export function calculateResidenceStatus(leases: Lease[]): ResidenceStatus {
+  const leased = leases.some((lease) =>
+    [
+      LeaseStatus.Current,
+      LeaseStatus.Upcoming,
+      LeaseStatus.AboutToEnd,
+    ].includes(lease.status)
+  )
+
+  if (leased) {
+    return 'LEASED'
+  }
+
+  return 'VACANT'
+}

src/services/property-base-service/index.ts

@@ -1,10 +1,12 @@
 import KoaRouter from '@koa/router'
 
 import * as propertyBaseAdapter from '../../adapters/property-base-adapter'
+import * as leasingAdapter from '../../adapters/leasing-adapter'
 
 import { logger, generateRouteMetadata } from 'onecore-utilities'
 import { registerSchema } from '../../utils/openapi'
 import * as schemas from './schemas'
+import { calculateResidenceStatus } from './calculate-residence-status'
 
 /**
  * @swagger
@@ -392,22 +394,51 @@ export const routes = (router: KoaRouter) => {
     const { residenceId } = ctx.params
 
     try {
-      const result = await propertyBaseAdapter.getResidenceDetails(residenceId)
-      if (!result.ok) {
-        if (result.err === 'not-found') {
+      const getResidence =
+        await propertyBaseAdapter.getResidenceDetails(residenceId)
+
+      if (!getResidence.ok) {
+        if (getResidence.err === 'not-found') {
           ctx.status = 404
           ctx.body = { error: 'Residence not found', ...metadata }
           return
         }
 
-        logger.error(result.err, 'Internal server error', metadata)
+        logger.error(getResidence.err, 'Internal server error', metadata)
         ctx.status = 500
         ctx.body = { error: 'Internal server error', ...metadata }
         return
       }
 
+      if (!getResidence.data.propertyObject.rentalId) {
+        ctx.status = 200
+        ctx.body = {
+          content: schemas.ResidenceDetailsSchema.parse({
+            ...getResidence.data,
+            status: null,
+          }),
+          ...metadata,
+        }
+        return
+      }
+
+      const leases = await leasingAdapter.getLeasesForPropertyId(
+        getResidence.data.propertyObject.rentalId,
+        {
+          includeContacts: false,
+          includeTerminatedLeases: false,
+          includeUpcomingLeases: true,
+        }
+      )
+
+      const status = calculateResidenceStatus(leases)
+
+      ctx.status = 200
       ctx.body = {
-        content: schemas.ResidenceDetailsSchema.parse(result.data),
+        content: schemas.ResidenceDetailsSchema.parse({
+          ...getResidence.data,
+          status,
+        }),
         ...metadata,
       }
     } catch (error) {

src/services/property-base-service/schemas.ts

@@ -111,6 +111,7 @@ export const ResidenceDetailsSchema = z.object({
   id: z.string(),
   code: z.string(),
   name: z.string().nullable(),
+  status: z.enum(['VACANT', 'LEASED']).nullable(),
   location: z.string().nullable(),
   accessibility: z.object({
     wheelchairAccessible: z.boolean(),

src/services/property-base-service/tests/calculate-residence-status.test.ts

@@ -0,0 +1,32 @@
+import { LeaseStatus } from 'onecore-types'
+
+import { calculateResidenceStatus } from '../calculate-residence-status'
+import * as factory from '../../../../test/factories'
+
+describe(calculateResidenceStatus, () => {
+  it('returns "LEASED" when lease status is "Current", "Upcoming" or "AboutToEnd"', () => {
+    expect(
+      calculateResidenceStatus([
+        factory.lease.build({ status: LeaseStatus.Current }),
+      ])
+    ).toBe('LEASED')
+
+    expect(
+      calculateResidenceStatus([
+        factory.lease.build({ status: LeaseStatus.Upcoming }),
+      ])
+    ).toBe('LEASED')
+
+    expect(
+      calculateResidenceStatus([
+        factory.lease.build({ status: LeaseStatus.AboutToEnd }),
+      ])
+    ).toBe('LEASED')
+  })
+
+  it('returns "VACANT" when lease status is "Ended"', () => {
+    const leases = [factory.lease.build({ status: LeaseStatus.Ended })]
+    const status = calculateResidenceStatus(leases)
+    expect(status).toBe('VACANT')
+  })
+})

src/services/property-base-service/tests/index.test.ts

@@ -6,6 +6,7 @@ import { z } from 'zod'
 
 import { routes } from '../index'
 import * as propertyBaseAdapter from '../../../adapters/property-base-adapter'
+import * as leasingAdapter from '../../../adapters/leasing-adapter'
 
 import * as factory from '../../../../test/factories'
 import {
@@ -15,6 +16,7 @@ import {
   RoomSchema,
   StaircaseSchema,
 } from '../schemas'
+import { LeaseStatus } from 'onecore-types'
 
 const app = new Koa()
 const router = new KoaRouter()
@@ -144,6 +146,31 @@ describe('property-base-service', () => {
       expect(() => ResidenceSchema.parse(res.body.content)).not.toThrow()
     })
 
+    it('returns 200 and a residence with status', async () => {
+      const residenceDetails = factory.residenceDetails.build({
+        propertyObject: { rentalId: '1234' },
+      })
+      const getResidenceDetailsSpy = jest
+        .spyOn(propertyBaseAdapter, 'getResidenceDetails')
+        .mockResolvedValueOnce({ ok: true, data: residenceDetails })
+
+      const lease = factory.lease.build({ status: LeaseStatus.Current })
+      const getLeasesSpy = jest
+        .spyOn(leasingAdapter, 'getLeasesForPropertyId')
+        .mockResolvedValueOnce([lease])
+
+      const res = await request(app.callback()).get(
+        `/propertyBase/residence/${residenceDetails.id}`
+      )
+
+      expect(res.status).toBe(200)
+      expect(() => ResidenceSchema.parse(res.body.content)).not.toThrow()
+      expect(res.body.content.status).toBe('LEASED')
+
+      expect(getResidenceDetailsSpy).toHaveBeenCalled()
+      expect(getLeasesSpy).toHaveBeenCalled()
+    })
+
     it('returns 404 if no residence is found', async () => {
       const residence = factory.residence.build()
       const getResidenceDetailsSpy = jest