663/mk/open payments validate

.github/workflows/lint_test_build.yml

@@ -64,6 +64,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: ./.github/workflows/rafiki/env-setup
+      - run: pnpm --filter openapi build
       - run: pnpm --filter open-payments test
 
   build:

packages/open-payments/package.json

@@ -7,7 +7,8 @@
     "dist/**/*"
   ],
   "scripts": {
-    "build": "pnpm clean && tsc --build tsconfig.json",
+    "build:deps": "pnpm --filter openapi build",
+    "build": "pnpm build:deps && pnpm clean && tsc --build tsconfig.json",
     "clean": "rm -fr dist/",
     "generate:types": "npx ts-node scripts/generate-types.ts",
     "prepack": "pnpm build",
@@ -21,6 +22,7 @@
     "typescript": "^4.3.0"
   },
   "dependencies": {
-    "axios": "^1.1.2"
+    "axios": "^1.1.2",
+    "openapi": "workspace:../openapi"
   }
 }

packages/open-payments/src/client/ilp-stream-connection.test.ts

@@ -0,0 +1,37 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+import { getILPStreamConnection } from './ilp-stream-connection'
+import { OpenAPI, HttpMethod, createOpenAPI } from 'openapi'
+import { createAxiosInstance } from './requests'
+import config from '../config'
+
+jest.mock('./requests', () => ({
+  ...jest.requireActual('./requests'),
+  get: jest.fn()
+}))
+
+describe('ilp-stream-connection', (): void => {
+  let openApi: OpenAPI
+
+  beforeAll(async () => {
+    openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+  })
+
+  const axiosInstance = createAxiosInstance()
+
+  describe('getILPStreamConnection', (): void => {
+    test('calls createResponseValidator properly', async (): Promise<void> => {
+      const createResponseValidatorSpy = jest.spyOn(
+        openApi,
+        'createResponseValidator'
+      )
+
+      await getILPStreamConnection(axiosInstance, openApi, {
+        url: 'http://localhost:1000/incoming-payment'
+      })
+      expect(createResponseValidatorSpy).toHaveBeenCalledWith({
+        path: '/connections/{id}',
+        method: HttpMethod.GET
+      })
+    })
+  })
+})

packages/open-payments/src/client/ilp-stream-connection.ts

@@ -0,0 +1,19 @@
+import { AxiosInstance } from 'axios'
+import { OpenAPI, HttpMethod } from 'openapi'
+import { getPath, ILPStreamConnection } from '../types'
+import { GetArgs, get } from './requests'
+
+export const getILPStreamConnection = async (
+  axios: AxiosInstance,
+  openApi: OpenAPI,
+  args: GetArgs
+): Promise<ILPStreamConnection> => {
+  return get(
+    axios,
+    args,
+    openApi.createResponseValidator({
+      path: getPath('/connections/{id}'),
+      method: HttpMethod.GET
+    })
+  )
+}

packages/open-payments/src/client/incoming-payment.test.ts

@@ -0,0 +1,37 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+import { getIncomingPayment } from './incoming-payment'
+import { OpenAPI, HttpMethod, createOpenAPI } from 'openapi'
+import { createAxiosInstance } from './requests'
+import config from '../config'
+
+jest.mock('./requests', () => ({
+  ...jest.requireActual('./requests'),
+  get: jest.fn()
+}))
+
+describe('incoming-payment', (): void => {
+  let openApi: OpenAPI
+
+  beforeAll(async () => {
+    openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+  })
+
+  const axiosInstance = createAxiosInstance()
+
+  describe('getIncomingPayment', (): void => {
+    test('calls createResponseValidator properly', async (): Promise<void> => {
+      const createResponseValidatorSpy = jest.spyOn(
+        openApi,
+        'createResponseValidator'
+      )
+
+      await getIncomingPayment(axiosInstance, openApi, {
+        url: 'http://localhost:1000/incoming-payment'
+      })
+      expect(createResponseValidatorSpy).toHaveBeenCalledWith({
+        path: '/incoming-payments/{id}',
+        method: HttpMethod.GET
+      })
+    })
+  })
+})

packages/open-payments/src/client/incoming-payment.ts

@@ -0,0 +1,19 @@
+import { AxiosInstance } from 'axios'
+import { OpenAPI, HttpMethod } from 'openapi'
+import { IncomingPayment, getPath } from '../types'
+import { GetArgs, get } from './requests'
+
+export const getIncomingPayment = async (
+  axios: AxiosInstance,
+  openApi: OpenAPI,
+  args: GetArgs
+): Promise<IncomingPayment> => {
+  return get(
+    axios,
+    args,
+    openApi.createResponseValidator({
+      path: getPath('/incoming-payments/{id}'),
+      method: HttpMethod.GET
+    })
+  )
+}

packages/open-payments/src/client/index.ts

@@ -0,0 +1,36 @@
+import { createOpenAPI } from 'openapi'
+
+import { ILPStreamConnection, IncomingPayment } from '../types'
+import config from '../config'
+import { getIncomingPayment } from './incoming-payment'
+import { getILPStreamConnection } from './ilp-stream-connection'
+import { createAxiosInstance, GetArgs } from './requests'
+
+export interface CreateOpenPaymentClientArgs {
+  timeout?: number
+}
+
+export interface OpenPaymentsClient {
+  incomingPayment: {
+    get(args: GetArgs): Promise<IncomingPayment>
+  }
+  ilpStreamConnection: {
+    get(args: GetArgs): Promise<ILPStreamConnection>
+  }
+}
+
+export const createClient = async (
+  args?: CreateOpenPaymentClientArgs
+): Promise<OpenPaymentsClient> => {
+  const axios = createAxiosInstance(args)
+  const openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+
+  return {
+    incomingPayment: {
+      get: (args: GetArgs) => getIncomingPayment(axios, openApi, args)
+    },
+    ilpStreamConnection: {
+      get: (args: GetArgs) => getILPStreamConnection(axios, openApi, args)
+    }
+  }
+}

packages/open-payments/src/client.test.ts → packages/open-payments/src/client/requests.test.ts

@@ -1,7 +1,10 @@
-import { createAxiosInstance, get } from './client'
+/* eslint-disable @typescript-eslint/no-empty-function */
+import { createAxiosInstance, get } from './requests'
 import nock from 'nock'
 
-describe('open-payments', (): void => {
+describe('requests', (): void => {
+  jest.spyOn(console, 'log').mockImplementation(() => {})
+
   describe('createAxiosInstance', (): void => {
     test('sets timeout properly', async (): Promise<void> => {
       expect(createAxiosInstance({ timeout: 1000 }).defaults.timeout).toBe(1000)
@@ -16,22 +19,24 @@ describe('open-payments', (): void => {
   describe('get', (): void => {
     const axiosInstance = createAxiosInstance()
     const baseUrl = 'http://localhost:1000'
+    const successfulValidator = (data: unknown): data is unknown => true
+    const failedValidator = (data: unknown): data is unknown => false
 
-    beforeEach(() => {
+    beforeAll(() => {
       jest.spyOn(axiosInstance, 'get')
     })
 
     test('sets headers properly if accessToken provided', async (): Promise<void> => {
-      nock(baseUrl)
-        .get('/incoming-payment')
-        .reply(200, () => ({
-          validReceiver: 0
-        }))
+      nock(baseUrl).get('/incoming-payment').reply(200)
 
-      await get(axiosInstance, {
-        url: `${baseUrl}/incoming-payment`,
-        accessToken: 'accessToken'
-      })
+      await get(
+        axiosInstance,
+        {
+          url: `${baseUrl}/incoming-payment`,
+          accessToken: 'accessToken'
+        },
+        successfulValidator
+      )
 
       expect(axiosInstance.get).toHaveBeenCalledWith(
         `${baseUrl}/incoming-payment`,
@@ -46,15 +51,15 @@ describe('open-payments', (): void => {
     })
 
     test('sets headers properly if accessToken is not provided', async (): Promise<void> => {
-      nock(baseUrl)
-        .get('/incoming-payment')
-        .reply(200, () => ({
-          validReceiver: 0
-        }))
+      nock(baseUrl).get('/incoming-payment').reply(200)
 
-      await get(axiosInstance, {
-        url: `${baseUrl}/incoming-payment`
-      })
+      await get(
+        axiosInstance,
+        {
+          url: `${baseUrl}/incoming-payment`
+        },
+        successfulValidator
+      )
 
       expect(axiosInstance.get).toHaveBeenCalledWith(
         `${baseUrl}/incoming-payment`,
@@ -63,5 +68,19 @@ describe('open-payments', (): void => {
         }
       )
     })
+
+    test('throws if response validator function fails', async (): Promise<void> => {
+      nock(baseUrl).get('/incoming-payment').reply(200)
+
+      await expect(
+        get(
+          axiosInstance,
+          {
+            url: `${baseUrl}/incoming-payment`
+          },
+          failedValidator
+        )
+      ).rejects.toThrow('Failed to validate OpenApi response')
+    })
   })
 })