refactor(backend): add optional quoteId to getQuote args

- add runtime check to ilp payment method implementation requireing it

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

@@ -20,6 +20,7 @@ import {
   PaymentMethodHandlerError,
   PaymentMethodHandlerErrorCode
 } from '../../payment-method/handler/errors'
+import { v4 as uuid } from 'uuid'
 
 const MAX_INT64 = BigInt('9223372036854775807')
 
@@ -80,6 +81,22 @@ export type CreateQuoteOptions =
   | QuoteOptionsWithDebitAmount
   | QuoteOptionsWithReceiveAmount
 
+// TODO: refactor
+// - re-model
+//   - [ ] remove IlpQuoteDetails.quoteId FK relation so i can insert that first
+//   - [ ] remove relationship on Quote objection model (and ilp quote details?)
+// - quote service
+//   - [X] make id for quote
+//   - [X] pass id into getQuote
+//   - [X] use id for quote create
+//   ... make payment method service changes
+//   - [ ] dont do anything with additionalFields
+// - payment method service
+//   - [ ] take quoteId
+//   - [ ] insert ilpQuoteDetails at end of method and use the given quoteId
+//   - [ ] remove additionalFields if unused
+// - new tests (in addition to updating tests based on above)
+//   - [ ] ilpQuoteDetails should be checked in payment method getQuote tests. not quote create, as currently
 async function createQuote(
   deps: ServiceDependencies,
   options: CreateQuoteOptions
@@ -114,9 +131,11 @@ async function createQuote(
   try {
     const receiver = await resolveReceiver(deps, options)
     const paymentMethod = receiver.isLocal ? 'LOCAL' : 'ILP'
+    const quoteId = uuid()
     const quote = await deps.paymentMethodHandlerService.getQuote(
       paymentMethod,
       {
+        quoteId,
         walletAddress,
         receiver,
         receiveAmount: options.receiveAmount,

packages/backend/src/payment-method/handler/service.test.ts

@@ -16,6 +16,7 @@ import { IlpPaymentService } from '../ilp/service'
 import { truncateTables } from '../../tests/tableManager'
 import { createOutgoingPaymentWithReceiver } from '../../tests/outgoingPayment'
 import { LocalPaymentService } from '../local/service'
+import { v4 as uuid } from 'uuid'
 
 describe('PaymentMethodHandlerService', (): void => {
   let deps: IocContract<AppServices>
@@ -50,6 +51,7 @@ describe('PaymentMethodHandlerService', (): void => {
       })
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress,
         receiver: await createReceiver(deps, walletAddress),
         debitAmount: {

packages/backend/src/payment-method/handler/service.ts

@@ -7,6 +7,7 @@ import { IlpPaymentService } from '../ilp/service'
 import { LocalPaymentService } from '../local/service'
 
 export interface StartQuoteOptions {
+  quoteId?: string
   walletAddress: WalletAddress
   debitAmount?: Amount
   receiveAmount?: Amount

packages/backend/src/payment-method/ilp/service.test.ts

@@ -23,6 +23,7 @@ import { AccountingService } from '../../accounting/service'
 import { IncomingPayment } from '../../open_payments/payment/incoming/model'
 import { truncateTables } from '../../tests/tableManager'
 import { createOutgoingPaymentWithReceiver } from '../../tests/outgoingPayment'
+import { v4 as uuid } from 'uuid'
 
 const nock = (global as unknown as { nock: typeof import('nock') }).nock
 
@@ -90,6 +91,7 @@ describe('IlpPaymentService', (): void => {
       const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress: walletAddressMap['USD'],
         receiver: await createReceiver(deps, walletAddressMap['USD']),
         debitAmount: {
@@ -108,6 +110,32 @@ describe('IlpPaymentService', (): void => {
       ratesScope.done()
     })
 
+    test('Throws if quoteId is not provided', async (): Promise<void> => {
+      const options: StartQuoteOptions = {
+        walletAddress: walletAddressMap['USD'],
+        receiver: await createReceiver(deps, walletAddressMap['USD']),
+        debitAmount: {
+          assetCode: 'USD',
+          assetScale: 2,
+          value: 100n
+        }
+      }
+
+      expect.assertions(4)
+      try {
+        await ilpPaymentService.getQuote(options)
+      } catch (error) {
+        expect(error).toBeInstanceOf(PaymentMethodHandlerError)
+        expect((error as PaymentMethodHandlerError).message).toBe(
+          'Received error during ILP quoting'
+        )
+        expect((error as PaymentMethodHandlerError).description).toBe(
+          'quoteId is required for ILP quotes'
+        )
+        expect((error as PaymentMethodHandlerError).retryable).toBe(false)
+      }
+    })
+
     test('fails on rate service error', async (): Promise<void> => {
       const ratesService = await deps.use('ratesService')
       jest
@@ -117,6 +145,7 @@ describe('IlpPaymentService', (): void => {
       expect.assertions(4)
       try {
         await ilpPaymentService.getQuote({
+          quoteId: uuid(),
           walletAddress: walletAddressMap['USD'],
           receiver: await createReceiver(deps, walletAddressMap['USD']),
           debitAmount: {
@@ -141,6 +170,7 @@ describe('IlpPaymentService', (): void => {
       const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress: walletAddressMap['USD'],
         receiver: await createReceiver(deps, walletAddressMap['USD']),
         debitAmount: {
@@ -184,6 +214,7 @@ describe('IlpPaymentService', (): void => {
       }
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress: walletAddressMap['USD'],
         receiver: await createReceiver(deps, walletAddressMap['USD'], {
           incomingAmount
@@ -218,6 +249,7 @@ describe('IlpPaymentService', (): void => {
           expect.assertions(4)
           try {
             await ilpPaymentService.getQuote({
+              quoteId: uuid(),
               walletAddress: walletAddressMap['USD'],
               receiver: await createReceiver(deps, walletAddressMap['USD']),
               debitAmount: {
@@ -243,6 +275,7 @@ describe('IlpPaymentService', (): void => {
       const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress: walletAddressMap['USD'],
         receiver: await createReceiver(deps, walletAddressMap['USD'])
       }
@@ -272,6 +305,7 @@ describe('IlpPaymentService', (): void => {
       const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress: walletAddressMap['USD'],
         receiver: await createReceiver(deps, walletAddressMap['USD'], {
           incomingAmount: {
@@ -311,6 +345,7 @@ describe('IlpPaymentService', (): void => {
       const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
+        quoteId: uuid(),
         walletAddress: walletAddressMap['USD'],
         receiver: await createReceiver(deps, walletAddressMap['USD'])
       }
@@ -371,6 +406,7 @@ describe('IlpPaymentService', (): void => {
                 const sendingWalletAddress = walletAddressMap[debitAssetCode]
 
                 const options: StartQuoteOptions = {
+                  quoteId: uuid(),
                   walletAddress: sendingWalletAddress,
                   receiver: await createReceiver(deps, receivingWalletAddress),
                   receiveAmount: {
@@ -430,6 +466,7 @@ describe('IlpPaymentService', (): void => {
                 const sendingWalletAddress = walletAddressMap[debitAssetCode]
 
                 const options: StartQuoteOptions = {
+                  quoteId: uuid(),
                   walletAddress: sendingWalletAddress,
                   receiver: await createReceiver(deps, receivingWalletAddress),
                   debitAmount: {

packages/backend/src/payment-method/ilp/service.ts

@@ -44,6 +44,13 @@ async function getQuote(
   deps: ServiceDependencies,
   options: StartQuoteOptions
 ): Promise<PaymentQuote> {
+  if (!options.quoteId) {
+    throw new PaymentMethodHandlerError('Received error during ILP quoting', {
+      description: 'quoteId is required for ILP quotes',
+      retryable: false
+    })
+  }
+
   const rates = await deps.ratesService
     .rates(options.walletAddress.asset.code)
     .catch((_err: Error) => {