better error handling

Author: simonkropp

core/src/adapters/property-base-adapter/index.ts

@@ -360,9 +360,7 @@ type GetMaintenanceUnitsByBuildingCodeResponse =
 
 export async function getMaintenanceUnitsByBuildingCode(
   buildingCode: string
-): Promise<
-  AdapterResult<GetMaintenanceUnitsByBuildingCodeResponse, 'unknown'>
-> {
+): Promise<AdapterResult<GetMaintenanceUnitsByBuildingCodeResponse, unknown>> {
   try {
     const fetchResponse = await client().GET(
       '/maintenance-units/by-building-code/{code}',
@@ -375,13 +373,17 @@ export async function getMaintenanceUnitsByBuildingCode(
       return { ok: true, data: fetchResponse.data.content }
     }
 
+    if (fetchResponse.response.status === 404) {
+      return { ok: false, err: 'not-found' }
+    }
+
     return { ok: false, err: 'unknown' }
   } catch (err) {
     logger.error(
       { err },
       '@onecore/property-adapter.getMaintenanceUnitsByBuildingCode'
     )
-    return { ok: false, err: 'unknown' }
+    return { ok: false, err }
   }
 }
 

core/src/adapters/tests/property-base-adapter.test.ts

@@ -536,6 +536,21 @@ describe('@onecore/property-adapter', () => {
       })
     })
 
+    it('returns not-found if building code is not found', async () => {
+      mockServer.use(
+        http.get(
+          `${config.propertyBaseService.url}/maintenance-units/by-building-code/123-123`,
+          () => new HttpResponse(null, { status: 404 })
+        )
+      )
+
+      const result =
+        await propertyBaseAdapter.getMaintenanceUnitsByBuildingCode('123-123')
+
+      expect(result.ok).toBe(false)
+      if (!result.ok) expect(result.err).toBe('not-found')
+    })
+
     it('returns err if request fails', async () => {
       mockServer.use(
         http.get(

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

@@ -1031,6 +1031,12 @@ export const routes = (router: KoaRouter) => {
           )
 
         if (!result.ok) {
+          if (result.err === 'not-found') {
+            ctx.status = 404
+            ctx.body = { error: 'No maintenance units found', ...metadata }
+            return
+          }
+
           logger.error(
             result.err,
             'Error getting maintenance units from property-base',
@@ -1041,6 +1047,12 @@ export const routes = (router: KoaRouter) => {
           return
         }
 
+        if (result.data.length === 0) {
+          ctx.status = 404
+          ctx.body = { error: 'No maintenance units found', ...metadata }
+          return
+        }
+
         ctx.body = {
           content: result.data satisfies Array<schemas.MaintenanceUnit>,
           ...metadata,

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

@@ -420,6 +420,19 @@ describe('@onecore/property-service', () => {
       ).not.toThrow()
     })
 
+    it('returns 404 if building code is not found', async () => {
+      const getMaintenanceUnitsSpy = jest
+        .spyOn(propertyBaseAdapter, 'getMaintenanceUnitsByBuildingCode')
+        .mockResolvedValueOnce({ ok: false, err: 'not-found' })
+
+      const res = await request(app.callback()).get(
+        '/propertyBase/maintenance-units/by-building-code/123-456'
+      )
+
+      expect(res.status).toBe(404)
+      expect(getMaintenanceUnitsSpy).toHaveBeenCalledWith('123-456')
+    })
+
     it('returns 500 if no maintenance units can be retrieved', async () => {
       const getMaintenanceUnitsSpy = jest
         .spyOn(propertyBaseAdapter, 'getMaintenanceUnitsByBuildingCode')