chore(backend): make toOpenPaymentType sync (#1056)

* chore(backend): make toOpenPaymentType sync * chore(backend): make quote.toOpenPaymentsType sync * chore(backend): convert tests to sync * chore(backend): update tests
interledger · Feb 1, 2023 · 5733224 · 5733224
1 parent e5f3c03
commit 5733224
Show file tree

Hide file tree

Showing 16 changed files with 107 additions and 110 deletions.
diff --git a/packages/backend/src/open_payments/payment/incoming/model.ts b/packages/backend/src/open_payments/payment/incoming/model.ts
@@ -130,17 +130,10 @@ export class IncomingPayment
     this.receivedAmountValue = amount.value
   }
 
-  public async getUrl(fetchedPaymentPointer?: PaymentPointer): Promise<string> {
-    const paymentPointer =
-      fetchedPaymentPointer || (await this.getPaymentPointer())
-
+  public getUrl(paymentPointer: PaymentPointer): string {
     return `${paymentPointer.url}${IncomingPayment.urlPath}/${this.id}`
   }
 
-  public async getPaymentPointer(): Promise<PaymentPointer> {
-    return this.paymentPointer ?? (await this.$relatedQuery('paymentPointer'))
-  }
-
   public async onCredit({
     totalReceived
   }: OnCreditOptions): Promise<IncomingPayment> {
@@ -249,29 +242,33 @@ export class IncomingPayment
     return payment
   }
 
-  public async toOpenPaymentsType(): Promise<OpenPaymentsIncomingPayment>
-  public async toOpenPaymentsType(
+  public toOpenPaymentsType(
+    paymentPointer: PaymentPointer
+  ): OpenPaymentsIncomingPayment
+  public toOpenPaymentsType(
+    paymentPointer: PaymentPointer,
     ilpStreamConnection: Connection
-  ): Promise<OpenPaymentsIncomingPaymentWithConnection>
-  public async toOpenPaymentsType(
+  ): OpenPaymentsIncomingPaymentWithConnection
+  public toOpenPaymentsType(
+    paymentPointer: PaymentPointer,
     ilpStreamConnection: string
-  ): Promise<OpenPaymentsIncomingPaymentWithConnectionUrl>
-  public async toOpenPaymentsType(
+  ): OpenPaymentsIncomingPaymentWithConnectionUrl
+  public toOpenPaymentsType(
+    paymentPointer: PaymentPointer,
     ilpStreamConnection?: Connection | string
-  ): Promise<
+  ):
     | OpenPaymentsIncomingPaymentWithConnection
     | OpenPaymentsIncomingPaymentWithConnectionUrl
-  >
-  public async toOpenPaymentsType(
+
+  public toOpenPaymentsType(
+    paymentPointer: PaymentPointer,
     ilpStreamConnection?: Connection | string
-  ): Promise<
+  ):
     | OpenPaymentsIncomingPayment
     | OpenPaymentsIncomingPaymentWithConnection
-    | OpenPaymentsIncomingPaymentWithConnectionUrl
-  > {
-    const paymentPointer = await this.getPaymentPointer()
+    | OpenPaymentsIncomingPaymentWithConnectionUrl {
     const baseIncomingPayment: OpenPaymentsIncomingPayment = {
-      id: await this.getUrl(paymentPointer),
+      id: this.getUrl(paymentPointer),
       paymentPointer: paymentPointer.url,
       incomingAmount: this.incomingAmount
         ? serializeAmount(this.incomingAmount)

diff --git a/packages/backend/src/open_payments/payment/incoming/routes.test.ts b/packages/backend/src/open_payments/payment/incoming/routes.test.ts
@@ -82,9 +82,9 @@ describe('Incoming Payment Routes', (): void => {
           externalRef
         }),
       get: (ctx) => incomingPaymentRoutes.get(ctx),
-      getBody: async (incomingPayment, list) => {
+      getBody: (incomingPayment, list) => {
         return {
-          id: await incomingPayment.getUrl(),
+          id: incomingPayment.getUrl(paymentPointer),
           paymentPointer: paymentPointer.url,
           completed: false,
           incomingAmount:
@@ -265,7 +265,7 @@ describe('Incoming Payment Routes', (): void => {
       await expect(incomingPaymentRoutes.complete(ctx)).resolves.toBeUndefined()
       expect(ctx.response).toSatisfyApiSpec()
       expect(ctx.body).toEqual({
-        id: await incomingPayment.getUrl(),
+        id: incomingPayment.getUrl(paymentPointer),
         paymentPointer: paymentPointer.url,
         incomingAmount: {
           value: '123',

diff --git a/packages/backend/src/open_payments/payment/incoming/routes.ts b/packages/backend/src/open_payments/payment/incoming/routes.ts
@@ -24,6 +24,7 @@ import {
   IncomingPaymentWithConnection as OpenPaymentsIncomingPaymentWithConnection,
   IncomingPaymentWithConnectionUrl as OpenPaymentsIncomingPaymentWithConnectionUrl
 } from 'open-payments'
+import { PaymentPointer } from '../../payment_pointer/model'
 
 // Don't allow creating an incoming payment too far out. Incoming payments with no payments before they expire are cleaned up, since incoming payments creation is unauthenticated.
 // TODO what is a good default value for this?
@@ -75,7 +76,11 @@ async function getIncomingPayment(
   }
   if (!incomingPayment) return ctx.throw(404)
   const connection = deps.connectionService.get(incomingPayment)
-  ctx.body = await incomingPaymentToBody(incomingPayment, connection)
+  ctx.body = incomingPaymentToBody(
+    ctx.paymentPointer,
+    incomingPayment,
+    connection
+  )
 }
 
 export type CreateBody = {
@@ -116,7 +121,11 @@ async function createIncomingPayment(
 
   ctx.status = 201
   const connection = deps.connectionService.get(incomingPaymentOrError)
-  ctx.body = await incomingPaymentToBody(incomingPaymentOrError, connection)
+  ctx.body = incomingPaymentToBody(
+    ctx.paymentPointer,
+    incomingPaymentOrError,
+    connection
+  )
 }
 
 async function completeIncomingPayment(
@@ -138,7 +147,7 @@ async function completeIncomingPayment(
       errorToMessage[incomingPaymentOrError]
     )
   }
-  ctx.body = await incomingPaymentToBody(incomingPaymentOrError)
+  ctx.body = incomingPaymentToBody(ctx.paymentPointer, incomingPaymentOrError)
 }
 
 async function listIncomingPayments(
@@ -149,8 +158,9 @@ async function listIncomingPayments(
     await listSubresource({
       ctx,
       getPaymentPointerPage: deps.incomingPaymentService.getPaymentPointerPage,
-      toBody: async (payment) =>
-        await incomingPaymentToBody(
+      toBody: (payment) =>
+        incomingPaymentToBody(
+          ctx.paymentPointer,
           payment,
           deps.connectionService.getUrl(payment)
         )
@@ -159,13 +169,13 @@ async function listIncomingPayments(
     ctx.throw(500, 'Error trying to list incoming payments')
   }
 }
-async function incomingPaymentToBody(
+function incomingPaymentToBody(
+  paymentPointer: PaymentPointer,
   incomingPayment: IncomingPayment,
   ilpStreamConnection?: Connection | string
-): Promise<
+):
   | OpenPaymentsIncomingPayment
   | OpenPaymentsIncomingPaymentWithConnection
-  | OpenPaymentsIncomingPaymentWithConnectionUrl
-> {
-  return incomingPayment.toOpenPaymentsType(ilpStreamConnection)
+  | OpenPaymentsIncomingPaymentWithConnectionUrl {
+  return incomingPayment.toOpenPaymentsType(paymentPointer, ilpStreamConnection)
 }
diff --git a/packages/backend/src/open_payments/payment/outgoing/model.ts b/packages/backend/src/open_payments/payment/outgoing/model.ts
@@ -72,10 +72,7 @@ export class OutgoingPayment
     return this.quote.assetId
   }
 
-  public async getUrl(fetchedPaymentPointer?: PaymentPointer): Promise<string> {
-    const paymentPointer =
-      fetchedPaymentPointer || (await this.getPaymentPointer())
-
+  public getUrl(paymentPointer: PaymentPointer): string {
     return `${paymentPointer.url}${OutgoingPayment.urlPath}/${this.id}`
   }
 
@@ -188,13 +185,13 @@ export class OutgoingPayment
     return this.paymentPointer ?? (await this.$relatedQuery('paymentPointer'))
   }
 
-  public async toOpenPaymentsType(): Promise<OpenPaymentsOutgoingPayment> {
-    const paymentPointer = await this.getPaymentPointer()
-
+  public toOpenPaymentsType(
+    paymentPointer: PaymentPointer
+  ): OpenPaymentsOutgoingPayment {
     return {
-      id: await this.getUrl(paymentPointer),
+      id: this.getUrl(paymentPointer),
       paymentPointer: paymentPointer.url,
-      quoteId: (await this.quote?.getUrl()) ?? undefined,
+      quoteId: this.quote?.getUrl(paymentPointer) ?? undefined,
       receiveAmount: serializeAmount(this.receiveAmount),
       sendAmount: serializeAmount(this.sendAmount),
       sentAmount: serializeAmount(this.sentAmount),

diff --git a/packages/backend/src/open_payments/payment/outgoing/routes.test.ts b/packages/backend/src/open_payments/payment/outgoing/routes.test.ts
@@ -100,12 +100,12 @@ describe('Outgoing Payment Routes', (): void => {
         return outgoingPayment
       },
       get: (ctx) => outgoingPaymentRoutes.get(ctx),
-      getBody: async (outgoingPayment) => {
+      getBody: (outgoingPayment) => {
         return {
           id: `${paymentPointer.url}/outgoing-payments/${outgoingPayment.id}`,
           paymentPointer: paymentPointer.url,
           receiver: outgoingPayment.receiver,
-          quoteId: await outgoingPayment.quote.getUrl(),
+          quoteId: outgoingPayment.quote.getUrl(paymentPointer),
           sendAmount: serializeAmount(outgoingPayment.sendAmount),
           sentAmount: serializeAmount(outgoingPayment.sentAmount),
           receiveAmount: serializeAmount(outgoingPayment.receiveAmount),

diff --git a/packages/backend/src/open_payments/payment/outgoing/routes.ts b/packages/backend/src/open_payments/payment/outgoing/routes.ts
@@ -9,6 +9,7 @@ import {
   AccessAction,
   OutgoingPayment as OpenPaymentsOutgoingPayment
 } from 'open-payments'
+import { PaymentPointer } from '../../payment_pointer/model'
 
 interface ServiceDependencies {
   config: IAppConfig
@@ -52,7 +53,7 @@ async function getOutgoingPayment(
     ctx.throw(500, 'Error trying to get outgoing payment')
   }
   if (!outgoingPayment) return ctx.throw(404)
-  ctx.body = await outgoingPaymentToBody(outgoingPayment)
+  ctx.body = outgoingPaymentToBody(ctx.paymentPointer, outgoingPayment)
 }
 
 export type CreateBody = {
@@ -86,7 +87,7 @@ async function createOutgoingPayment(
     return ctx.throw(errorToCode[paymentOrErr], errorToMessage[paymentOrErr])
   }
   ctx.status = 201
-  ctx.body = await outgoingPaymentToBody(paymentOrErr)
+  ctx.body = outgoingPaymentToBody(ctx.paymentPointer, paymentOrErr)
 }
 
 async function listOutgoingPayments(
@@ -97,15 +98,16 @@ async function listOutgoingPayments(
     await listSubresource({
       ctx,
       getPaymentPointerPage: deps.outgoingPaymentService.getPaymentPointerPage,
-      toBody: async (payment) => await outgoingPaymentToBody(payment)
+      toBody: (payment) => outgoingPaymentToBody(ctx.paymentPointer, payment)
     })
   } catch (_) {
     ctx.throw(500, 'Error trying to list outgoing payments')
   }
 }
 
-async function outgoingPaymentToBody(
+function outgoingPaymentToBody(
+  paymentPointer: PaymentPointer,
   outgoingPayment: OutgoingPayment
-): Promise<OpenPaymentsOutgoingPayment> {
-  return outgoingPayment.toOpenPaymentsType()
+): OpenPaymentsOutgoingPayment {
+  return outgoingPayment.toOpenPaymentsType(paymentPointer)
 }
diff --git a/packages/backend/src/open_payments/payment/outgoing/service.test.ts b/packages/backend/src/open_payments/payment/outgoing/service.test.ts
@@ -245,11 +245,10 @@ describe('OutgoingPaymentService', (): void => {
 
   beforeEach(async (): Promise<void> => {
     const { id: sendAssetId } = await createAsset(deps, asset)
-    paymentPointerId = (
-      await createPaymentPointer(deps, {
-        assetId: sendAssetId
-      })
-    ).id
+    const paymentPointer = await createPaymentPointer(deps, {
+      assetId: sendAssetId
+    })
+    paymentPointerId = paymentPointer.id
     const { id: destinationAssetId } = await createAsset(deps, destinationAsset)
     receiverPaymentPointer = await createPaymentPointer(deps, {
       assetId: destinationAssetId,
@@ -266,7 +265,7 @@ describe('OutgoingPaymentService', (): void => {
     incomingPayment = await createIncomingPayment(deps, {
       paymentPointerId: receiverPaymentPointer.id
     })
-    receiver = await incomingPayment.getUrl()
+    receiver = incomingPayment.getUrl(receiverPaymentPointer)
 
     amtDelivered = BigInt(0)
   })
@@ -855,12 +854,14 @@ describe('OutgoingPaymentService', (): void => {
             assetScale: receiverPaymentPointer.asset.scale
           }
         })
+
         const fetchedReceiver = connectionService.getUrl(incomingPayment)
         assert.ok(fetchedReceiver)
+        assert.ok(incomingPayment.paymentPointer)
         const paymentId = await setup({
           receiver: toConnection
             ? fetchedReceiver
-            : await incomingPayment.getUrl(),
+            : incomingPayment.getUrl(incomingPayment.paymentPointer),
           receiveAmount
         })
 

diff --git a/packages/backend/src/open_payments/payment_pointer/model.test.ts b/packages/backend/src/open_payments/payment_pointer/model.test.ts
@@ -194,7 +194,7 @@ type RouteTestsOptions<M> = Omit<
 > & {
   getPaymentPointer: () => Promise<PaymentPointer>
   get: (ctx: ReadContext) => Promise<void>
-  getBody: (model: M, list?: boolean) => Promise<Record<string, unknown>>
+  getBody: (model: M, list?: boolean) => Record<string, unknown>
   list?: (ctx: ListContext) => Promise<void>
   urlPath: string
 }
@@ -230,7 +230,7 @@ export const getRouteTests = <M extends PaymentPointerSubresource>({
       expect(ctx.response).toSatisfyApiSpec()
     }
     expect(ctx.body).toEqual({
-      result: expectedMatch ? [await getBody(expectedMatch, true)] : [],
+      result: expectedMatch ? [getBody(expectedMatch, true)] : [],
       pagination: {
         hasPreviousPage: false,
         hasNextPage: false,
@@ -261,7 +261,7 @@ export const getRouteTests = <M extends PaymentPointerSubresource>({
       if (expectedMatch) {
         await expect(get(ctx)).resolves.toBeUndefined()
         expect(ctx.response).toSatisfyApiSpec()
-        expect(ctx.body).toEqual(await getBody(expectedMatch))
+        expect(ctx.body).toEqual(getBody(expectedMatch))
       } else {
         await expect(get(ctx)).rejects.toMatchObject({
           status: 404,
@@ -319,11 +319,9 @@ export const getRouteTests = <M extends PaymentPointerSubresource>({
           expect(ctx.response).toSatisfyApiSpec()
           expect(ctx.body).toEqual({
             pagination,
-            result: await Promise.all(
-              models
-                .slice(startIndex, endIndex + 1)
-                .map(async (model) => await getBody(model, true))
-            )
+            result: models
+              .slice(startIndex, endIndex + 1)
+              .map((model) => getBody(model, true))
           })
         }
       )

diff --git a/packages/backend/src/open_payments/payment_pointer/routes.ts b/packages/backend/src/open_payments/payment_pointer/routes.ts
@@ -40,9 +40,7 @@ export async function getPaymentPointer(
 interface ListSubresourceOptions<M extends PaymentPointerSubresource> {
   ctx: ListContext
   getPaymentPointerPage: PaymentPointerSubresourceService<M>['getPaymentPointerPage']
-  toBody:
-    | ((model: M) => Record<string, unknown>)
-    | ((model: M) => Promise<Record<string, unknown>>)
+  toBody: (model: M) => Record<string, unknown>
 }
 
 export const listSubresource = async <M extends PaymentPointerSubresource>({
@@ -68,7 +66,7 @@ export const listSubresource = async <M extends PaymentPointerSubresource>({
   )
   const result = {
     pagination: pageInfo,
-    result: await Promise.all(page.map(async (item: M) => await toBody(item)))
+    result: page.map((item: M) => toBody(item))
   }
   ctx.body = result
 }
diff --git a/packages/backend/src/open_payments/quote/model.ts b/packages/backend/src/open_payments/quote/model.ts
@@ -47,14 +47,7 @@ export class Quote extends PaymentPointerSubresource {
 
   private sendAmountValue!: bigint
 
-  public async getPaymentPointer(): Promise<PaymentPointer> {
-    return this.paymentPointer ?? (await this.$relatedQuery('paymentPointer'))
-  }
-
-  public async getUrl(fetchedPaymentPointer?: PaymentPointer): Promise<string> {
-    const paymentPointer =
-      fetchedPaymentPointer || (await this.getPaymentPointer())
-
+  public getUrl(paymentPointer: PaymentPointer): string {
     return `${paymentPointer.url}${Quote.urlPath}/${this.id}`
   }
 
@@ -164,11 +157,9 @@ export class Quote extends PaymentPointerSubresource {
     }
   }
 
-  public async toOpenPaymentsType(): Promise<OpenPaymentsQuote> {
-    const paymentPointer = await this.getPaymentPointer()
-
+  public toOpenPaymentsType(paymentPointer: PaymentPointer): OpenPaymentsQuote {
     return {
-      id: await this.getUrl(paymentPointer),
+      id: this.getUrl(paymentPointer),
       paymentPointer: paymentPointer.url,
       receiveAmount: serializeAmount(this.receiveAmount),
       sendAmount: serializeAmount(this.sendAmount),

diff --git a/packages/backend/src/open_payments/quote/routes.test.ts b/packages/backend/src/open_payments/quote/routes.test.ts
@@ -96,7 +96,7 @@ describe('Quote Routes', (): void => {
           client
         }),
       get: (ctx) => quoteRoutes.get(ctx),
-      getBody: async (quote) => {
+      getBody: (quote) => {
         return {
           id: `${paymentPointer.url}/quotes/${quote.id}`,
           paymentPointer: paymentPointer.url,