Starting to refactor the payment code!

package.json

@@ -35,7 +35,7 @@
     "test": "jest --setupFiles dotenv/config"
   },
   "dependencies": {
-    "@beabee/beabee-common": "^0.21.0",
+    "@beabee/beabee-common": "^0.21.1-alpha.2",
     "@captchafox/node": "^1.2.0",
     "@inquirer/prompts": "^3.3.0",
     "@sendgrid/mail": "^8.1.0",
@@ -131,10 +131,10 @@
     "rimraf": "^5.0.5",
     "sass": "1.57.*",
     "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
     "tsc-watch": "^6.0.4",
     "tsconfig": "^7.0.0",
-    "typescript": "^5.3.3",
-    "ts-node": "^10.9.2"
+    "typescript": "^5.3.3"
   },
   "browserslist": [
     "last 1 versions",
@@ -155,4 +155,4 @@
       "postcss": "8.4.32"
     }
   }
-}
+}

src/api/dto/PaymentFlowDto.ts

@@ -1,7 +1,6 @@
+import { PaymentFlowParams } from "@beabee/beabee-common";
 import { IsOptional, IsString } from "class-validator";
 
-import { PaymentFlowParams } from "@type/index";
-
 export class GetPaymentFlowDto implements PaymentFlowParams {
   @IsOptional()
   @IsString()

src/core/providers/payment/GCProvider.ts

@@ -8,7 +8,6 @@ import moment from "moment";
 
 import gocardless from "@core/lib/gocardless";
 import { log as mainLogger } from "@core/logging";
-import { getActualAmount } from "@core/utils";
 import {
   updateSubscription,
   createSubscription,
@@ -17,19 +16,20 @@ import {
 } from "@core/utils/payment/gocardless";
 import { calcRenewalDate } from "@core/utils/payment";
 
+import NoPaymentMethod from "@api/errors/NoPaymentMethod";
+
 import { PaymentProvider } from ".";
 
 import Contact from "@models/Contact";
 
-import NoPaymentMethod from "@api/errors/NoPaymentMethod";
-
 import config from "@config";
 
 import {
   CompletedPaymentFlow,
   ContributionInfo,
   PaymentForm,
-  UpdateContributionResult
+  UpdateContributionResult,
+  UpdatePaymentMethodResult
 } from "@type/index";
 
 const log = mainLogger.child({ app: "gc-payment-provider" });
@@ -153,18 +153,11 @@ export default class GCProvider extends PaymentProvider {
       expiryDate
     });
 
-    this.data.subscriptionId = subscription.id!;
-    this.data.payFee = paymentForm.payFee;
-    this.data.nextAmount = startNow
-      ? null
-      : {
-          monthly: paymentForm.monthlyAmount,
-          chargeable: Number(subscription.amount)
-        };
-
-    await this.updateData();
-
-    return { startNow, expiryDate: moment.utc(expiryDate).toDate() };
+    return {
+      startNow,
+      expiryDate: moment.utc(expiryDate).toDate(),
+      subscriptionId: subscription.id!
+    };
   }
 
   async cancelContribution(keepMandate: boolean): Promise<void> {
@@ -191,36 +184,31 @@ export default class GCProvider extends PaymentProvider {
 
   async updatePaymentMethod(
     completedPaymentFlow: CompletedPaymentFlow
-  ): Promise<void> {
+  ): Promise<UpdatePaymentMethodResult> {
     log.info("Update payment source for " + this.contact.id, {
-      userId: this.contact.id,
       data: this.data,
       completedPaymentFlow
     });
 
     const hadSubscription = !!this.data.subscriptionId;
     const mandateId = this.data.mandateId;
 
-    this.data.subscriptionId = null;
-    this.data.customerId = completedPaymentFlow.customerId;
-    this.data.mandateId = completedPaymentFlow.mandateId;
-
-    // Save before cancelling to stop the webhook triggering a cancelled email
-    await this.updateData();
-
     if (mandateId) {
       // This will also cancel the subscription
       await gocardless.mandates.cancel(mandateId);
     }
 
     // Recreate the subscription if the user had one
     if (hadSubscription && this.data.period && this.data.monthlyAmount) {
-      await this.updateContribution({
+      const res = await this.updateContribution({
         monthlyAmount: this.data.monthlyAmount,
         period: this.data.period,
         payFee: !!this.data.payFee,
         prorate: false
       });
+      return { subscriptionId: res.subscriptionId };
+    } else {
+      return {};
     }
   }
 

src/core/providers/payment/ManualProvider.ts

@@ -1,11 +1,13 @@
 import Contact from "@models/Contact";
+
 import { PaymentProvider } from ".";
 
 import {
   CompletedPaymentFlow,
   ContributionInfo,
   PaymentForm,
-  UpdateContributionResult
+  UpdateContributionResult,
+  UpdatePaymentMethodResult
 } from "@type/index";
 
 export default class ManualProvider extends PaymentProvider {
@@ -36,7 +38,7 @@ export default class ManualProvider extends PaymentProvider {
   }
   async updatePaymentMethod(
     completedPaymentFlow: CompletedPaymentFlow
-  ): Promise<void> {
+  ): Promise<UpdatePaymentMethodResult> {
     throw new Error("Method not implemented.");
   }
   async permanentlyDeleteContact(): Promise<void> {

src/core/providers/payment/StripeProvider.ts

@@ -2,15 +2,13 @@ import { ContributionType, PaymentSource } from "@beabee/beabee-common";
 import { add } from "date-fns";
 import Stripe from "stripe";
 
-import { PaymentProvider } from ".";
-
 import { stripe } from "@core/lib/stripe";
 import { log as mainLogger } from "@core/logging";
-import { getActualAmount } from "@core/utils";
-import { calcRenewalDate, getChargeableAmount } from "@core/utils/payment";
+import { calcRenewalDate } from "@core/utils/payment";
 import {
   createSubscription,
   deleteSubscription,
+  getCustomerDataFromCompletedFlow,
   manadateToSource,
   updateSubscription
 } from "@core/utils/payment/stripe";
@@ -19,13 +17,16 @@ import Contact from "@models/Contact";
 
 import NoPaymentMethod from "@api/errors/NoPaymentMethod";
 
+import { PaymentProvider } from ".";
+
 import config from "@config";
 
 import {
   CompletedPaymentFlow,
   ContributionInfo,
   PaymentForm,
-  UpdateContributionResult
+  UpdateContributionResult,
+  UpdatePaymentMethodResult
 } from "@type/index";
 
 const log = mainLogger.child({ app: "stripe-payment-provider" });
@@ -74,33 +75,22 @@ export default class StripeProvider extends PaymentProvider {
     await this.updateData();
   }
 
-  async updatePaymentMethod(flow: CompletedPaymentFlow): Promise<void> {
-    const paymentMethod = await stripe.paymentMethods.retrieve(flow.mandateId);
-    const address = paymentMethod.billing_details.address;
-
-    const customerData: Stripe.CustomerUpdateParams = {
-      invoice_settings: {
-        default_payment_method: flow.mandateId
-      },
-      address: address
-        ? {
-            line1: address.line1 || "",
-            ...(address.city && { city: address.city }),
-            ...(address.country && { country: address.country }),
-            ...(address.line2 && { line2: address.line2 }),
-            ...(address.postal_code && { postal_code: address.postal_code }),
-            ...(address.state && { state: address.state })
-          }
-        : null
-    };
+  async updatePaymentMethod(
+    flow: CompletedPaymentFlow
+  ): Promise<UpdatePaymentMethodResult> {
+    const customerData = await getCustomerDataFromCompletedFlow(flow);
+    let customerId = this.data.customerId;
 
-    if (this.data.customerId) {
-      log.info("Attach new payment source to " + this.data.customerId);
+    // Attach payment method to existing customer
+    if (customerId) {
+      log.info("Attach new payment source to " + customerId);
       await stripe.paymentMethods.attach(flow.mandateId, {
-        customer: this.data.customerId
+        customer: customerId
       });
-      await stripe.customers.update(this.data.customerId, customerData);
-    } else {
+      await stripe.customers.update(customerId, customerData);
+    }
+    // Create a new customer
+    else {
       log.info("Create new customer");
       const customer = await stripe.customers.create({
         email: this.contact.email,
@@ -117,7 +107,7 @@ export default class StripeProvider extends PaymentProvider {
         // }),
         ...customerData
       });
-      this.data.customerId = customer.id;
+      customerId = customer.id;
     }
 
     if (this.data.mandateId) {
@@ -127,7 +117,7 @@ export default class StripeProvider extends PaymentProvider {
 
     this.data.mandateId = flow.mandateId;
 
-    await this.updateData();
+    return { customerId };
   }
 
   async updateContribution(
@@ -148,7 +138,7 @@ export default class StripeProvider extends PaymentProvider {
         this.data.customerId,
         {
           ...paymentForm,
-          monthlyAmount: this.contact.contributionMonthlyAmount || 0
+          monthlyAmount: this.data.monthlyAmount || 0
         },
         this.method,
         calcRenewalDate(this.contact)
@@ -160,23 +150,13 @@ export default class StripeProvider extends PaymentProvider {
     const { subscription, startNow } =
       await this.updateOrCreateContribution(paymentForm);
 
-    this.data.subscriptionId = subscription.id;
-    this.data.payFee = paymentForm.payFee;
-    this.data.nextAmount = startNow
-      ? null
-      : {
-          chargeable: getChargeableAmount(paymentForm, this.method),
-          monthly: paymentForm.monthlyAmount
-        };
-
-    await this.updateData();
-
     return {
       startNow,
       expiryDate: add(
         new Date(subscription.current_period_end * 1000),
         config.gracePeriod
-      )
+      ),
+      subscriptionId: subscription.id
     };
   }
 

src/core/providers/payment/index.ts

@@ -9,7 +9,8 @@ import {
   CompletedPaymentFlow,
   ContributionInfo,
   PaymentForm,
-  UpdateContributionResult
+  UpdateContributionResult,
+  UpdatePaymentMethodResult
 } from "@type/index";
 
 export abstract class PaymentProvider {
@@ -44,7 +45,7 @@ export abstract class PaymentProvider {
 
   abstract updatePaymentMethod(
     completedPaymentFlow: CompletedPaymentFlow
-  ): Promise<void>;
+  ): Promise<UpdatePaymentMethodResult>;
 
   abstract permanentlyDeleteContact(): Promise<void>;
 }