663/mk/open payments validate

.github/labeler.yml

@@ -5,6 +5,7 @@
 'pkg: auth': packages/auth/**/*
 'pkg: openapi': packages/openapi/**/*
 'pkg: map': packages/mock-account-provider/**/*
+'pkg: open-payments': packages/open-payments/**/*
 
 # Add 'type: documentation' label to any change to *.md files
 'type: ci':
@@ -22,6 +23,7 @@
   - packages/frontend/src/**/*
   - packages/auth/src/**/*
   - packages/openapi/src/**/*
+  - packages/open-payments/src/**/*
 
 # Add 'type: tests' label to any change to *.test.ts files
 'type: tests': packages/**/*.test.ts

.github/workflows/lint_test_build.yml

@@ -57,6 +57,15 @@ jobs:
       - uses: ./.github/workflows/rafiki/env-setup
       - run: pnpm --filter openapi test
 
+  open-payments:
+    runs-on: ubuntu-latest
+    needs: checkout
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/workflows/rafiki/env-setup
+      - run: pnpm --filter open-payments test
+
   build:
     runs-on: ubuntu-latest
     timeout-minutes: 5
@@ -65,6 +74,7 @@ jobs:
       - frontend
       - auth
       - openapi
+      - open-payments
     steps:
       - uses: actions/checkout@v2
       - uses: ./.github/workflows/rafiki/env-setup

packages/open-payments/jest.config.js

@@ -0,0 +1,17 @@
+'use strict'
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const baseConfig = require('../../jest.config.base.js')
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageName = require('./package.json').name
+
+module.exports = {
+  ...baseConfig,
+  clearMocks: true,
+  roots: [`<rootDir>/packages/${packageName}`],
+  testRegex: `(packages/${packageName}/.*/__tests__/.*|\\.(test|spec))\\.tsx?$`,
+  moduleDirectories: [`node_modules`, `packages/${packageName}/node_modules`],
+  modulePaths: [`<rootDir>/packages/${packageName}/src/`],
+  id: packageName,
+  displayName: packageName,
+  rootDir: '../..'
+}

packages/open-payments/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "open-payments",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "pnpm clean && tsc --build tsconfig.json",
+    "clean": "rm -fr dist/",
+    "generate:types": "npx ts-node scripts/generate-types.ts",
+    "prepack": "pnpm build",
+    "test": "jest --passWithNoTests"
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.12",
+    "nock": "^13.2.9",
+    "openapi-typescript": "^4.5.0",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.3.0"
+  },
+  "dependencies": {
+    "axios": "^1.1.2",
+    "openapi": "workspace:../openapi"
+  }
+}

packages/open-payments/scripts/generate-types.ts

@@ -0,0 +1,19 @@
+import fs from 'fs'
+import openapiTS from 'openapi-typescript'
+import config from '../src/config'
+;(async () => {
+  try {
+    const output = await openapiTS(config.OPEN_PAYMENTS_OPEN_API_URL)
+    const fileName = 'src/generated/types.ts'
+
+    fs.writeFile(fileName, output, (error) => {
+      if (error) {
+        console.log(`Error when writing types to ${fileName}`, { error })
+      }
+    })
+  } catch (error) {
+    console.log('Error when generating types', {
+      error
+    })
+  }
+})()

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('getIncomingPayment', (): 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/requests.test.ts

@@ -0,0 +1,86 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+import { createAxiosInstance, get } from './requests'
+import nock from 'nock'
+
+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)
+    })
+    test('sets Content-Type header properly', async (): Promise<void> => {
+      expect(
+        createAxiosInstance().defaults.headers.common['Content-Type']
+      ).toBe('application/json')
+    })
+  })
+
+  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
+
+    beforeAll(() => {
+      jest.spyOn(axiosInstance, 'get')
+    })
+
+    test('sets headers properly if accessToken provided', async (): Promise<void> => {
+      nock(baseUrl).get('/incoming-payment').reply(200)
+
+      await get(
+        axiosInstance,
+        {
+          url: `${baseUrl}/incoming-payment`,
+          accessToken: 'accessToken'
+        },
+        successfulValidator
+      )
+
+      expect(axiosInstance.get).toHaveBeenCalledWith(
+        `${baseUrl}/incoming-payment`,
+        {
+          headers: {
+            Authorization: 'GNAP accessToken',
+            Signature: 'TODO',
+            'Signature-Input': 'TODO'
+          }
+        }
+      )
+    })
+
+    test('sets headers properly if accessToken is not provided', async (): Promise<void> => {
+      nock(baseUrl).get('/incoming-payment').reply(200)
+
+      await get(
+        axiosInstance,
+        {
+          url: `${baseUrl}/incoming-payment`
+        },
+        successfulValidator
+      )
+
+      expect(axiosInstance.get).toHaveBeenCalledWith(
+        `${baseUrl}/incoming-payment`,
+        {
+          headers: {}
+        }
+      )
+    })
+
+    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')
+    })
+  })
+})