Use openapi-client to talk to onecore-work-order (#286)

Co-authored-by: Henrik Persson <henrik.persson@iteam.com>

Author: henrikhenrikpersson

package.json

@@ -18,7 +18,9 @@
     "ts:watch": "tsc --watch --noEmit",
     "test:ci": "TZ=UTC jest --silent",
     "ts:ci": "tsc --noEmit",
-    "generate-types:property-base": "npx openapi-typescript http://localhost:5050/swagger.json -o ./src/adapters/property-base-adapter/generated/api-types.ts"
+    "generate-types:property-base": "npx openapi-typescript http://localhost:5050/swagger.json -o ./src/adapters/property-base-adapter/generated/api-types.ts",
+    "generate-types:work-order": "npx openapi-typescript http://localhost:5070/swagger.json -o ./src/adapters/work-order-adapter/generated/api-types.ts",
+    "generate-types": "npm run generate-types:property-base & npm run generate-types:work-order"
   },
   "author": "",
   "license": "MIT",

src/adapters/property-management-adapter.ts

@@ -32,10 +32,13 @@ const getRentalProperty = async (
 //todo: modify calling code to use a pattern like in "getRentalPropertyInfoFromXpand"
 const getRentalPropertyInfo = async (
   rentalPropertyId: string
-): Promise<RentalPropertyInfo> => {
+): Promise<RentalPropertyInfo | null> => {
   const propertyResponse = await axios(
     propertyManagementServiceUrl + '/rentalPropertyInfo/' + rentalPropertyId
   )
+  if (propertyResponse.status === 404) {
+    return null
+  }
 
   return propertyResponse.data.content
 }

src/adapters/tests/work-order-adapter.test.ts

@@ -1,16 +1,34 @@
-import nock from 'nock'
+import { http, HttpResponse } from 'msw'
+import { setupServer } from 'msw/node'
 
 import config from '../../common/config'
 import * as workOrderAdapter from '../work-order-adapter'
 import * as factory from '../../../test/factories'
 
+const mockServer = setupServer()
+
 describe('work-order-adapter', () => {
+  beforeAll(() => {
+    mockServer.listen()
+  })
+
+  afterEach(() => {
+    mockServer.resetHandlers()
+  })
+
+  afterAll(() => {
+    mockServer.close()
+  })
+
   describe(workOrderAdapter.getWorkOrdersByContactCode, () => {
-    const workOrderMock = factory.workOrder.build()
+    const workOrderMock = factory.workOrder.buildList(2)
     it('returns err if request fails', async () => {
-      nock(config.workOrderService.url)
-        .get('/workOrders/contactCode/CC123')
-        .reply(500)
+      mockServer.use(
+        http.get(
+          `${config.workOrderService.url}/workOrders/contactCode/CC123`,
+          () => new HttpResponse(null, { status: 500 })
+        )
+      )
 
       const result = await workOrderAdapter.getWorkOrdersByContactCode('CC123')
 
@@ -19,37 +37,55 @@ describe('work-order-adapter', () => {
     })
 
     it('returns work order data', async () => {
-      nock(config.workOrderService.url)
-        .get('/workOrders/contactCode/CC123')
-        .reply(200, {
-          content: { workOrders: [workOrderMock] },
-        })
+      mockServer.use(
+        http.get(
+          `${config.workOrderService.url}/workOrders/contactCode/CC123`,
+          () =>
+            HttpResponse.json(
+              {
+                content: { workOrders: workOrderMock },
+              },
+              { status: 200 }
+            )
+        )
+      )
 
       const result = await workOrderAdapter.getWorkOrdersByContactCode('CC123')
 
       expect(result).toMatchObject({
         ok: true,
-        data: [workOrderMock],
+        data: workOrderMock,
       })
     })
   })
 
   describe(workOrderAdapter.createWorkOrder, () => {
     const createWorkOrderMock = factory.createWorkOrder.build()
     it('returns err if request fails', async () => {
-      nock(config.workOrderService.url).post('/workOrders').reply(500)
+      mockServer.use(
+        http.post(
+          `${config.workOrderService.url}/workOrders`,
+          () => new HttpResponse(null, { status: 500 })
+        )
+      )
 
       const result = await workOrderAdapter.createWorkOrder(createWorkOrderMock)
 
       expect(result.ok).toBe(false)
-      if (!result.ok)
-        expect(result.err).toBe('Request failed with status code 500')
+      if (!result.ok) expect(result.err).toBe('unknown')
     })
 
     it('returns work order data', async () => {
-      nock(config.workOrderService.url)
-        .post('/workOrders')
-        .reply(200, { content: { newWorkOrderId: 1 } })
+      mockServer.use(
+        http.post(`${config.workOrderService.url}/workOrders`, () =>
+          HttpResponse.json(
+            {
+              content: { newWorkOrderId: 1 },
+            },
+            { status: 200 }
+          )
+        )
+      )
 
       const result = await workOrderAdapter.createWorkOrder(createWorkOrderMock)
 
@@ -59,24 +95,33 @@ describe('work-order-adapter', () => {
   })
 
   describe(workOrderAdapter.updateWorkOrder, () => {
-    it('returns err if request fails', async () => {
-      nock(config.workOrderService.url).post('/workOrders/1/update').reply(500)
+    it.only('returns err if request fails', async () => {
+      mockServer.use(
+        http.post(
+          `${config.workOrderService.url}/workOrders/1/update`,
+          () => new HttpResponse(null, { status: 500 })
+        )
+      )
 
-      const result = await workOrderAdapter.updateWorkOrder(1, 'Test message')
+      const result = await workOrderAdapter.updateWorkOrder('1', 'Test message')
 
       expect(result.ok).toBe(false)
-      if (!result.ok)
-        expect(result.err).toBe('Request failed with status code 500')
+      if (!result.ok) expect(result.err).toBe('unknown')
     })
 
     it('returns updated work order data', async () => {
-      nock(config.workOrderService.url)
-        .post('/workOrders/1/update')
-        .reply(200, {
-          content: { message: 'Message added to work order with ID 1' },
-        })
-
-      const result = await workOrderAdapter.updateWorkOrder(1, 'Test message')
+      mockServer.use(
+        http.post(`${config.workOrderService.url}/workOrders/1/update`, () =>
+          HttpResponse.json(
+            {
+              content: { message: 'Message added to work order with ID 1' },
+            },
+            { status: 200 }
+          )
+        )
+      )
+
+      const result = await workOrderAdapter.updateWorkOrder('1', 'Test message')
 
       expect(result.ok).toBe(true)
       if (result.ok)
@@ -88,23 +133,33 @@ describe('work-order-adapter', () => {
 
   describe(workOrderAdapter.closeWorkOrder, () => {
     it('returns err if request fails', async () => {
-      nock(config.workOrderService.url).post('/workOrders/1/close').reply(500)
+      mockServer.use(
+        http.post(
+          `${config.workOrderService.url}/workOrders/1/close`,
+          () => new HttpResponse(null, { status: 500 })
+        )
+      )
 
-      const result = await workOrderAdapter.closeWorkOrder(1)
+      const result = await workOrderAdapter.closeWorkOrder('1')
 
       expect(result.ok).toBe(false)
       if (!result.ok)
         expect(result.err).toBe('Request failed with status code 500')
     })
 
     it('returns closed work order data', async () => {
-      nock(config.workOrderService.url)
-        .post('/workOrders/1/close')
-        .reply(200, {
-          content: { message: 'Work order with ID 1 updated successfully' },
-        })
-
-      const result = await workOrderAdapter.closeWorkOrder(1)
+      mockServer.use(
+        http.post(`${config.workOrderService.url}/workOrders/1/close`, () =>
+          HttpResponse.json(
+            {
+              content: { message: 'Work order with ID 1 updated successfully' },
+            },
+            { status: 200 }
+          )
+        )
+      )
+
+      const result = await workOrderAdapter.closeWorkOrder('1')
 
       expect(result.ok).toBe(true)
       if (result.ok)