chore(backend): update OpenAPI specs

.github/workflows/lint_test_build.yml

@@ -26,6 +26,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ./.github/workflows/rafiki/env-setup
       - run: pnpm --filter backend build:deps
+      - run: pnpm --filter backend fetch-schemas
       - run: pnpm --filter backend test
 
   frontend:

README.md

@@ -81,8 +81,9 @@ pnpm --filter open-api test
 # run all tests
 pnpm -r --workspace-concurrency=1 test
 
-# pull in latest openapi specs for auth server:
+# pull in latest openapi specs:
 pnpm --filter auth fetch-schemas
+pnpm --filter backend fetch-schemas
 
 # format and lint code:
 pnpm format

packages/backend/.gitignore

@@ -4,3 +4,5 @@ build
 .env
 src/coverage
 tmp
+/src/openapi/resource-server.yaml
+/src/openapi/schemas.yaml

packages/backend/package.json

@@ -8,6 +8,7 @@
     "build": "pnpm build:deps && tsc --build tsconfig.json && pnpm copy-files",
     "clean": "rm -fr dist/",
     "copy-files": "cp src/graphql/schema.graphql dist/graphql/",
+    "fetch-schemas": "./scripts/get-op-schema.sh",
     "prepack": "pnpm build"
   },
   "devDependencies": {

packages/backend/scripts/get-op-schema.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+## https://stackoverflow.com/questions/59895/how-do-i-get-the-directory-where-a-bash-script-is-located-from-within-the-script
+SOURCE=${BASH_SOURCE[0]}
+while [ -L "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+  SOURCE=$(readlink "$SOURCE")
+  [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+OUTDIR=$( cd -P "$( dirname "$SOURCE" )/../src/openapi" >/dev/null 2>&1 && pwd )
+
+curl -o "$OUTDIR/resource-server.yaml" https://raw.githubusercontent.com/interledger/open-payments/b363d33038fe789e5388f04f80ddd06a4fa97093/openapi/resource-server.yaml
+curl -o "$OUTDIR/schemas.yaml" https://raw.githubusercontent.com/interledger/open-payments/b363d33038fe789e5388f04f80ddd06a4fa97093/openapi/schemas.yaml

packages/backend/src/app.ts

@@ -259,7 +259,7 @@ export class App {
     )
     const quoteRoutes = await this.container.use('quoteRoutes')
     const connectionRoutes = await this.container.use('connectionRoutes')
-    const openApi = await this.container.use('openApi')
+    const { resourceServerSpec } = await this.container.use('openApi')
     const toRouterPath = (path: string): string =>
       path.replace(/{/g, ':').replace(/}/g, '')
 
@@ -293,8 +293,8 @@ export class App {
       [AccessAction.ListAll]: 'list'
     }
 
-    for (const path in openApi.paths) {
-      for (const method in openApi.paths[path]) {
+    for (const path in resourceServerSpec.paths) {
+      for (const method in resourceServerSpec.paths[path]) {
         if (isHttpMethod(method)) {
           const action = toAction({ path, method })
           assert.ok(action)
@@ -315,10 +315,13 @@ export class App {
               route = connectionRoutes.get
               router[method](
                 toRouterPath(path),
-                createValidatorMiddleware<ContextType<typeof route>>(openApi, {
-                  path,
-                  method
-                }),
+                createValidatorMiddleware<ContextType<typeof route>>(
+                  resourceServerSpec,
+                  {
+                    path,
+                    method
+                  }
+                ),
                 route
               )
             } else if (path !== '/' || method !== HttpMethod.GET) {
@@ -330,10 +333,13 @@ export class App {
           router[method](
             PAYMENT_POINTER_PATH + toRouterPath(path),
             createPaymentPointerMiddleware(),
-            createValidatorMiddleware<ContextType<typeof route>>(openApi, {
-              path,
-              method
-            }),
+            createValidatorMiddleware<ContextType<typeof route>>(
+              resourceServerSpec,
+              {
+                path,
+                method
+              }
+            ),
             createAuthMiddleware({
               type,
               action
@@ -349,7 +355,7 @@ export class App {
     router.get(
       PAYMENT_POINTER_PATH + '/jwks.json',
       createPaymentPointerMiddleware(),
-      createValidatorMiddleware<PaymentPointerContext>(openApi, {
+      createValidatorMiddleware<PaymentPointerContext>(resourceServerSpec, {
         path: '/jwks.json',
         method: HttpMethod.GET
       }),
@@ -364,7 +370,7 @@ export class App {
     router.get(
       PAYMENT_POINTER_PATH,
       createPaymentPointerMiddleware(),
-      createValidatorMiddleware<PaymentPointerContext>(openApi, {
+      createValidatorMiddleware<PaymentPointerContext>(resourceServerSpec, {
         path: '/',
         method: HttpMethod.GET
       }),

packages/backend/src/config/app.ts

@@ -109,14 +109,6 @@ export const Config = {
   signatureVersion: envInt('SIGNATURE_VERSION', 1),
   bypassSignatureValidation: envBool('BYPASS_SIGNATURE_VALIDATION', false),
 
-  openPaymentsSpec: envString(
-    'OPEN_PAYMENTS_SPEC',
-    'https://raw.githubusercontent.com/interledger/open-payments/f365dbec4b9dec98b9f622bc49a92aea9ee01568/openapi/RS/openapi.yaml'
-  ),
-  authServerSpec: envString(
-    'AUTH_SERVER_SPEC',
-    'https://raw.githubusercontent.com/interledger/open-payments/77462cd0872be8d0fa487a4b233defe2897a7ee4/auth-server-open-api-spec.yaml'
-  ),
   keyId: envString('KEY_ID', 'rafiki'),
   privateKey: parseOrProvisionKey(envString('PRIVATE_KEY_FILE', undefined)),
 

packages/backend/src/index.ts

@@ -1,5 +1,6 @@
 import { EventEmitter } from 'events'
 import { Server } from 'http'
+import path from 'path'
 import createLogger from 'pino'
 import { knex } from 'knex'
 import { Model } from 'objection'
@@ -109,13 +110,17 @@ export function initIocContainer(
       replica_addresses: config.tigerbeetleReplicaAddresses
     })
   })
-  container.singleton('openApi', async (deps) => {
-    const config = await deps.use('config')
-    return await createOpenAPI(config.openPaymentsSpec)
-  })
-  container.singleton('authOpenApi', async (deps) => {
-    const config = await deps.use('config')
-    return await createOpenAPI(config.authServerSpec)
+  container.singleton('openApi', async () => {
+    const authServerSpec = await createOpenAPI(
+      path.resolve(__dirname, './openapi/auth-server.yaml')
+    )
+    const resourceServerSpec = await createOpenAPI(
+      path.resolve(__dirname, './openapi/resource-server.yaml')
+    )
+    return {
+      authServerSpec,
+      resourceServerSpec
+    }
   })
   container.singleton('openPaymentsClient', async (deps) => {
     const config = await deps.use('config')
@@ -170,10 +175,11 @@ export function initIocContainer(
   })
   container.singleton('authService', async (deps) => {
     const config = await deps.use('config')
+    const { authServerSpec } = await deps.use('openApi')
     return await createAuthService({
       logger: await deps.use('logger'),
       authServerIntrospectionUrl: config.authServerIntrospectionUrl,
-      authOpenApi: await deps.use('authOpenApi')
+      authServerSpec
     })
   })
   container.singleton('paymentPointerService', async (deps) => {

packages/backend/src/open_payments/auth/middleware.test.ts

@@ -126,9 +126,9 @@ describe('Auth Middleware', (): void => {
       type: AccessType.IncomingPayment,
       action: AccessAction.Read
     })
-    const authOpenApi = await deps.use('authOpenApi')
+    const { authServerSpec } = await deps.use('openApi')
     requestPath = '/introspect'
-    validateRequest = authOpenApi.createRequestValidator({
+    validateRequest = authServerSpec.createRequestValidator({
       path: requestPath,
       method: HttpMethod.POST
     })

packages/backend/src/open_payments/auth/service.ts

@@ -38,7 +38,7 @@ export interface AuthService {
 
 interface ServiceDependencies {
   authServerIntrospectionUrl: string
-  authOpenApi: OpenAPI
+  authServerSpec: OpenAPI
   logger: Logger
   validateResponse: ResponseValidator<TokenInfoJSON>
 }
@@ -50,7 +50,7 @@ export async function createAuthService(
     service: 'AuthService'
   })
   const validateResponse =
-    deps_.authOpenApi.createResponseValidator<TokenInfoJSON>({
+    deps_.authServerSpec.createResponseValidator<TokenInfoJSON>({
       path: '/introspect',
       method: HttpMethod.POST
     })

packages/backend/src/open_payments/connection/routes.test.ts

@@ -37,7 +37,8 @@ describe('Connection Routes', (): void => {
     appContainer = await createTestApp(deps)
     knex = await deps.use('knex')
     grantReferenceService = await deps.use('grantReferenceService')
-    jestOpenAPI(await deps.use('openApi'))
+    const { resourceServerSpec } = await deps.use('openApi')
+    jestOpenAPI(resourceServerSpec)
   })
 
   const asset = {

packages/backend/src/open_payments/payment/incoming/routes.test.ts

@@ -36,7 +36,8 @@ describe('Incoming Payment Routes', (): void => {
     deps = await initIocContainer(config)
     appContainer = await createTestApp(deps)
     knex = await deps.use('knex')
-    jestOpenAPI(await deps.use('openApi'))
+    const { resourceServerSpec } = await deps.use('openApi')
+    jestOpenAPI(resourceServerSpec)
   })
 
   const asset = {

packages/backend/src/open_payments/payment/outgoing/routes.test.ts

@@ -62,7 +62,8 @@ describe('Outgoing Payment Routes', (): void => {
     config = await deps.use('config')
     outgoingPaymentRoutes = await deps.use('outgoingPaymentRoutes')
     outgoingPaymentService = await deps.use('outgoingPaymentService')
-    jestOpenAPI(await deps.use('openApi'))
+    const { resourceServerSpec } = await deps.use('openApi')
+    jestOpenAPI(resourceServerSpec)
   })
 
   beforeEach(async (): Promise<void> => {

packages/backend/src/open_payments/payment_pointer/routes.test.ts

@@ -25,7 +25,8 @@ describe('Payment Pointer Routes', (): void => {
     deps = await initIocContainer(config)
     appContainer = await createTestApp(deps)
     knex = await deps.use('knex')
-    jestOpenAPI(await deps.use('openApi'))
+    const { resourceServerSpec } = await deps.use('openApi')
+    jestOpenAPI(resourceServerSpec)
   })
 
   beforeEach(async (): Promise<void> => {

packages/backend/src/open_payments/quote/routes.test.ts

@@ -68,7 +68,8 @@ describe('Quote Routes', (): void => {
     config = await deps.use('config')
     quoteRoutes = await deps.use('quoteRoutes')
     quoteService = await deps.use('quoteService')
-    jestOpenAPI(await deps.use('openApi'))
+    const { resourceServerSpec } = await deps.use('openApi')
+    jestOpenAPI(resourceServerSpec)
   })
 
   beforeEach(async (): Promise<void> => {

packages/backend/src/openapi/auth-server.yaml

@@ -0,0 +1 @@
+../../../auth/src/openapi/resource-server.yaml

packages/backend/src/paymentPointerKey/routes.test.ts

@@ -38,7 +38,8 @@ describe('Payment Pointer Keys Routes', (): void => {
     deps.bind('messageProducer', async () => mockMessageProducer)
     appContainer = await createTestApp(deps)
     knex = await deps.use('knex')
-    jestOpenAPI(await deps.use('openApi'))
+    const { resourceServerSpec } = await deps.use('openApi')
+    jestOpenAPI(resourceServerSpec)
     paymentPointerKeyService = await deps.use('paymentPointerKeyService')
   })