feat: add cancelled status on incomingPayment

packages/backend/src/graphql/schema.graphql

@@ -1044,6 +1044,8 @@ enum IncomingPaymentState {
   COMPLETED
   "The payment has expired before completion, and no further funds will be accepted."
   EXPIRED
+  "The payment is cancelled before completion, and no further funds will be accepted."
+  CANCELLED
 }
 
 type Amount {

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

@@ -116,7 +116,11 @@ describe('Models', (): void => {
         })
       })
 
-      test.each([IncomingPaymentState.Completed, IncomingPaymentState.Expired])(
+      test.each([
+        IncomingPaymentState.Completed,
+        IncomingPaymentState.Expired,
+        IncomingPaymentState.Cancelled
+      ])(
         'returns incoming payment with existing methods if payment state is %s',
         async (paymentState): Promise<void> => {
           incomingPayment.state = paymentState

packages/backend/src/open_payments/payment/incoming/model.ts

@@ -33,7 +33,10 @@ export enum IncomingPaymentState {
   Completed = 'COMPLETED',
   // If the payment expires before it is completed then the state will move to `EXPIRED`
   // and no further payments will be accepted.
-  Expired = 'EXPIRED'
+  Expired = 'EXPIRED',
+  // If the payment is cancelled before it is completed then the state will move to `CANCELLED`
+  // and no further payments will be accepted.
+  Cancelled = 'CANCELLED'
 }
 
 export interface IncomingPaymentResponse {
@@ -116,7 +119,10 @@ export class IncomingPayment
   public cancellationReason?: string | null
 
   public get completed(): boolean {
-    return this.state === IncomingPaymentState.Completed
+    return (
+      this.state === IncomingPaymentState.Completed ||
+      this.state === IncomingPaymentState.Cancelled
+    )
   }
 
   public get incomingAmount(): Amount | undefined {
@@ -163,7 +169,8 @@ export class IncomingPayment
         })
         .whereNotIn('state', [
           IncomingPaymentState.Expired,
-          IncomingPaymentState.Completed
+          IncomingPaymentState.Completed,
+          IncomingPaymentState.Cancelled
         ])
     } else {
       incomingPayment = await IncomingPayment.query()
@@ -172,7 +179,8 @@ export class IncomingPayment
         })
         .whereNotIn('state', [
           IncomingPaymentState.Expired,
-          IncomingPaymentState.Completed
+          IncomingPaymentState.Completed,
+          IncomingPaymentState.Cancelled
         ])
     }
     if (incomingPayment) {
@@ -184,7 +192,8 @@ export class IncomingPayment
   public isExpiredOrComplete(): boolean {
     return (
       this.state === IncomingPaymentState.Expired ||
-      this.state === IncomingPaymentState.Completed
+      this.state === IncomingPaymentState.Completed ||
+      this.state === IncomingPaymentState.Cancelled
     )
   }
 

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

@@ -310,6 +310,9 @@ describe('Incoming Payment Service', (): void => {
         assert.ok(!isIncomingPaymentError(canceledIncomingPayment))
         expect(canceledIncomingPayment.id).toBe(incomingPayment.id)
         expect(canceledIncomingPayment.cancelledAt).toBeDefined()
+        expect(canceledIncomingPayment.state).toBe(
+          IncomingPaymentState.Cancelled
+        )
         expect(!canceledIncomingPayment.approvedAt).toBeTruthy()
       })
 
@@ -330,6 +333,9 @@ describe('Incoming Payment Service', (): void => {
         assert.ok(!isIncomingPaymentError(canceledIncomingPayment))
         expect(canceledIncomingPayment.id).toBe(incomingPayment.id)
         expect(canceledIncomingPayment.cancelledAt).toBeDefined()
+        expect(canceledIncomingPayment.state).toBe(
+          IncomingPaymentState.Cancelled
+        )
         expect(!canceledIncomingPayment.approvedAt).toBeTruthy()
         expect(canceledIncomingPayment.cancellationReason).toBe(reason)
       })

packages/backend/src/open_payments/payment/incoming/service.ts

@@ -341,7 +341,8 @@ async function processNextIncomingPayment(
     }
     if (
       incomingPayment.state === IncomingPaymentState.Expired ||
-      incomingPayment.state === IncomingPaymentState.Completed
+      incomingPayment.state === IncomingPaymentState.Completed ||
+      incomingPayment.state === IncomingPaymentState.Cancelled
     ) {
       await handleDeactivated(deps, incomingPayment)
     } else {
@@ -512,7 +513,8 @@ async function cancelIncomingPayment(
     if (!payment.cancelledAt) {
       await payment.$query(trx).patch({
         cancelledAt: new Date(Date.now()),
-        cancellationReason: cancellationReason
+        cancellationReason: cancellationReason,
+        state: IncomingPaymentState.Cancelled
       })
     }