feat(open-payments): add list incoming payments

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

@@ -2,6 +2,7 @@ import {
   completeIncomingPayment,
   createIncomingPayment,
   createIncomingPaymentRoutes,
+  listIncomingPayment,
   getIncomingPayment,
   validateCompletedIncomingPayment,
   validateCreatedIncomingPayment,
@@ -13,10 +14,22 @@ import {
   defaultAxiosInstance,
   mockILPStreamConnection,
   mockIncomingPayment,
+  mockIncomingPaymentPaginationResult,
   mockOpenApiResponseValidators,
   silentLogger
 } from '../test/helpers'
 import nock from 'nock'
+import { v4 as uuid } from 'uuid'
+import * as requestors from './requests'
+import { getRSPath } from '../types'
+
+jest.mock('./requests', () => {
+  return {
+    // https://jestjs.io/docs/jest-object#jestmockmodulename-factory-options
+    __esModule: true,
+    ...jest.requireActual('./requests')
+  }
+})
 
 describe('incoming-payment', (): void => {
   let openApi: OpenAPI
@@ -74,6 +87,21 @@ describe('incoming-payment', (): void => {
         method: HttpMethod.POST
       })
     })
+
+    test('creates listIncomingPaymentsOpenApiValidator', async (): Promise<void> => {
+      jest.spyOn(openApi, 'createResponseValidator')
+
+      createIncomingPaymentRoutes({
+        axiosInstance,
+        openApi,
+        logger
+      })
+
+      expect(openApi.createResponseValidator).toHaveBeenCalledWith({
+        path: '/incoming-payments',
+        method: HttpMethod.GET
+      })
+    })
   })
 
   describe('getIncomingPayment', (): void => {
@@ -322,6 +350,156 @@ describe('incoming-payment', (): void => {
     })
   })
 
+  describe('listIncomingPayment', (): void => {
+    const paymentPointer = `${baseUrl}/.well-known/pay`
+
+    describe('forward pagination', (): void => {
+      test.each`
+        first        | cursor
+        ${undefined} | ${undefined}
+        ${1}         | ${undefined}
+        ${5}         | ${uuid()}
+      `(
+        'returns incoming payments list',
+        async ({ first, cursor }): Promise<void> => {
+          const incomingPaymentPaginationResult =
+            mockIncomingPaymentPaginationResult({
+              result: Array(first).fill(mockIncomingPayment())
+            })
+
+          const scope = nock(paymentPointer)
+            .get('/incoming-payments')
+            .query({
+              ...(first ? { first } : {}),
+              ...(cursor ? { cursor } : {})
+            })
+            .reply(200, incomingPaymentPaginationResult)
+
+          const result = await listIncomingPayment(
+            {
+              axiosInstance,
+              logger
+            },
+            {
+              paymentPointer,
+              accessToken: 'accessToken'
+            },
+            openApiValidators.successfulValidator,
+            {
+              first,
+              cursor
+            }
+          )
+
+          expect(result).toStrictEqual(incomingPaymentPaginationResult)
+          scope.done()
+        }
+      )
+    })
+
+    describe('backward pagination', (): void => {
+      test.each`
+        last         | cursor
+        ${undefined} | ${uuid()}
+        ${5}         | ${uuid()}
+      `(
+        'returns incoming payments list',
+        async ({ last, cursor }): Promise<void> => {
+          const incomingPaymentPaginationResult =
+            mockIncomingPaymentPaginationResult({
+              result: Array(last).fill(mockIncomingPayment())
+            })
+
+          const scope = nock(paymentPointer)
+            .get('/incoming-payments')
+            .query({
+              ...(last ? { last } : {}),
+              cursor
+            })
+            .reply(200, incomingPaymentPaginationResult)
+
+          const result = await listIncomingPayment(
+            {
+              axiosInstance,
+              logger
+            },
+            {
+              paymentPointer,
+              accessToken: 'accessToken'
+            },
+            openApiValidators.successfulValidator,
+            {
+              last,
+              cursor
+            }
+          )
+
+          expect(result).toStrictEqual(incomingPaymentPaginationResult)
+          scope.done()
+        }
+      )
+    })
+
+    test('throws if an incoming payment does not pass validation', async (): Promise<void> => {
+      const incomingPayment = mockIncomingPayment({
+        incomingAmount: {
+          assetCode: 'USD',
+          assetScale: 2,
+          value: '10'
+        },
+        receivedAmount: {
+          assetCode: 'USD',
+          assetScale: 4,
+          value: '0'
+        }
+      })
+
+      const incomingPaymentPaginationResult =
+        mockIncomingPaymentPaginationResult({
+          result: [incomingPayment]
+        })
+
+      const scope = nock(paymentPointer)
+        .get('/incoming-payments')
+        .reply(200, incomingPaymentPaginationResult)
+
+      await expect(() =>
+        listIncomingPayment(
+          {
+            axiosInstance,
+            logger
+          },
+          {
+            paymentPointer,
+            accessToken: 'accessToken'
+          },
+          openApiValidators.successfulValidator
+        )
+      ).rejects.toThrow('Could not validate incoming payment')
+
+      scope.done()
+    })
+
+    test('throws if an incoming payment does not pass open api validation', async (): Promise<void> => {
+      const incomingPaymentPaginationResult =
+        mockIncomingPaymentPaginationResult()
+
+      const scope = nock(paymentPointer)
+        .get('/incoming-payments')
+        .reply(200, incomingPaymentPaginationResult)
+
+      await expect(() =>
+        listIncomingPayment(
+          { axiosInstance, logger },
+          { paymentPointer, accessToken: 'accessToken' },
+          openApiValidators.failedValidator
+        )
+      ).rejects.toThrowError()
+
+      scope.done()
+    })
+  })
+
   describe('validateIncomingPayment', (): void => {
     test('returns incoming payment if passes validation', async (): Promise<void> => {
       const incomingPayment = mockIncomingPayment({
@@ -536,4 +714,44 @@ describe('incoming-payment', (): void => {
       )
     })
   })
+
+  describe('routes', (): void => {
+    describe('list', (): void => {
+      test('calls get method with correct validator', async (): Promise<void> => {
+        const mockResponseValidator = ({ path, method }) =>
+          path === '/incoming-payments' && method === HttpMethod.GET
+
+        const incomingPaymentPaginationResult =
+          mockIncomingPaymentPaginationResult({
+            result: [mockIncomingPayment()]
+          })
+        const paymentPointer = `${baseUrl}/.well-known/pay`
+        const url = `${paymentPointer}${getRSPath('/incoming-payments')}`
+
+        jest
+          .spyOn(openApi, 'createResponseValidator')
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          .mockImplementation(mockResponseValidator as any)
+
+        const getSpy = jest
+          .spyOn(requestors, 'get')
+          .mockResolvedValueOnce(incomingPaymentPaginationResult)
+
+        await createIncomingPaymentRoutes({
+          openApi,
+          axiosInstance,
+          logger
+        }).list({ paymentPointer, accessToken: 'accessToken' })
+
+        expect(getSpy).toHaveBeenCalledWith(
+          {
+            axiosInstance,
+            logger
+          },
+          { url, accessToken: 'accessToken' },
+          true
+        )
+      })
+    })
+  })
 })

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

@@ -1,6 +1,12 @@
 import { HttpMethod, ResponseValidator } from 'openapi'
 import { BaseDeps, RouteDeps } from '.'
-import { IncomingPayment, getRSPath, CreateIncomingPaymentArgs } from '../types'
+import {
+  IncomingPayment,
+  getRSPath,
+  CreateIncomingPaymentArgs,
+  PaginationArgs,
+  IncomingPaymentPaginationResult
+} from '../types'
 import { get, post } from './requests'
 
 interface GetArgs {
@@ -14,10 +20,19 @@ interface PostArgs<T = undefined> {
   accessToken: string
 }
 
+interface ListGetArgs {
+  paymentPointer: string
+  accessToken: string
+}
+
 export interface IncomingPaymentRoutes {
   get(args: GetArgs): Promise<IncomingPayment>
   create(args: PostArgs<CreateIncomingPaymentArgs>): Promise<IncomingPayment>
   complete(args: PostArgs): Promise<IncomingPayment>
+  list(
+    args: ListGetArgs,
+    pagination?: PaginationArgs
+  ): Promise<IncomingPaymentPaginationResult>
 }
 
 export const createIncomingPaymentRoutes = (
@@ -43,6 +58,12 @@ export const createIncomingPaymentRoutes = (
       method: HttpMethod.POST
     })
 
+  const listIncomingPaymentOpenApiValidator =
+    openApi.createResponseValidator<IncomingPaymentPaginationResult>({
+      path: getRSPath('/incoming-payments'),
+      method: HttpMethod.GET
+    })
+
   return {
     get: (args: GetArgs) =>
       getIncomingPayment(
@@ -61,6 +82,13 @@ export const createIncomingPaymentRoutes = (
         { axiosInstance, logger },
         args,
         completeIncomingPaymentOpenApiValidator
+      ),
+    list: (args: ListGetArgs, pagination?: PaginationArgs) =>
+      listIncomingPayment(
+        { axiosInstance, logger },
+        args,
+        listIncomingPaymentOpenApiValidator,
+        pagination
       )
   }
 }
@@ -137,6 +165,48 @@ export const completeIncomingPayment = async (
   }
 }
 
+export const listIncomingPayment = async (
+  deps: BaseDeps,
+  args: ListGetArgs,
+  validateOpenApiResponse: ResponseValidator<IncomingPaymentPaginationResult>,
+  pagination?: PaginationArgs
+) => {
+  const { axiosInstance, logger } = deps
+  const { accessToken, paymentPointer } = args
+
+  const url = `${paymentPointer}${getRSPath('/incoming-payments')}`
+
+  const incomingPayments = await get(
+    { axiosInstance, logger },
+    {
+      url,
+      accessToken,
+      ...(pagination ? { queryParams: { ...pagination } } : {})
+    },
+    validateOpenApiResponse
+  )
+
+  for (const incomingPayment of incomingPayments.result) {
+    try {
+      validateIncomingPayment(incomingPayment)
+    } catch (error) {
+      const errorMessage = 'Could not validate incoming payment'
+      logger.error(
+        {
+          url,
+          validateError: error?.message,
+          incomingPaymentId: incomingPayment.id
+        },
+        errorMessage
+      )
+
+      throw new Error(errorMessage)
+    }
+  }
+
+  return incomingPayments
+}
+
 export const validateIncomingPayment = (
   payment: IncomingPayment
 ): IncomingPayment => {

packages/open-payments/src/test/helpers.ts

@@ -10,6 +10,7 @@ import {
   NonInteractiveGrant,
   OutgoingPayment,
   OutgoingPaymentPaginationResult,
+  IncomingPaymentPaginationResult,
   AccessToken
 } from '../types'
 import base64url from 'base64url'
@@ -71,6 +72,26 @@ export const mockIncomingPayment = (
   ...overrides
 })
 
+export const mockIncomingPaymentPaginationResult = (
+  overrides?: Partial<IncomingPaymentPaginationResult>
+): IncomingPaymentPaginationResult => {
+  const result = overrides?.result || [
+    mockIncomingPayment(),
+    mockIncomingPayment(),
+    mockIncomingPayment()
+  ]
+
+  return {
+    result,
+    pagination: overrides?.pagination || {
+      startCursor: result[0].id,
+      hasNextPage: true,
+      hasPreviousPage: true,
+      endCursor: result[result.length - 1].id
+    }
+  }
+}
+
 export const mockOutgoingPayment = (
   overrides?: Partial<OutgoingPayment>
 ): OutgoingPayment => ({