Merge pull request #320 from beabee-communityrm/feat/monthly-to-annual

feat!: allow monthly to annual contributions

src/api/controllers/ContactController.ts

@@ -62,10 +62,9 @@ import {
   StartJoinFlowData
 } from "@api/data/JoinFlowData";
 import {
-  SetContributionData,
   StartContributionData,
-  UpdateContributionData,
-  ForceUpdateContributionData
+  ForceUpdateContributionData,
+  UpdateContributionData
 } from "@api/data/ContributionData";
 import {
   mergeRules,
@@ -251,19 +250,11 @@ export class ContactController {
     @TargetUser() target: Contact,
     @Body() data: UpdateContributionData
   ): Promise<ContributionInfo> {
-    // TODO: can we move this into validators?
-    const contributionData = new SetContributionData();
-    contributionData.amount = data.amount;
-    contributionData.period = target.contributionPeriod!;
-    contributionData.payFee = data.payFee;
-    contributionData.prorate = data.prorate;
-    await validateOrReject(contributionData);
-
-    if (!(await PaymentService.canChangeContribution(target, true))) {
+    if (!(await PaymentService.canChangeContribution(target, true, data))) {
       throw new CantUpdateContribution();
     }
 
-    await ContactsService.updateContactContribution(target, contributionData);
+    await ContactsService.updateContactContribution(target, data);
 
     return await this.getContribution(target);
   }
@@ -372,7 +363,7 @@ export class ContactController {
     target: Contact,
     data: StartContributionData
   ) {
-    if (!(await PaymentService.canChangeContribution(target, false))) {
+    if (!(await PaymentService.canChangeContribution(target, false, data))) {
       throw new CantUpdateContribution();
     }
 
@@ -398,17 +389,23 @@ export class ContactController {
     target: Contact,
     data: CompleteJoinFlowData
   ): Promise<JoinFlow> {
-    if (!(await PaymentService.canChangeContribution(target, false))) {
-      throw new CantUpdateContribution();
-    }
-
     const joinFlow = await PaymentFlowService.getJoinFlowByPaymentId(
       data.paymentFlowId
     );
     if (!joinFlow) {
       throw new NotFoundError();
     }
 
+    if (
+      !(await PaymentService.canChangeContribution(
+        target,
+        false,
+        joinFlow.joinForm
+      ))
+    ) {
+      throw new CantUpdateContribution();
+    }
+
     const completedFlow = await PaymentFlowService.completeJoinFlow(joinFlow);
     await PaymentService.updatePaymentMethod(target, completedFlow);
 

src/api/data/ContributionData.ts

@@ -19,13 +19,7 @@ import ValidPayFee from "@api/validators/ValidPayFee";
 
 import { StartJoinFlowData } from "./JoinFlowData";
 
-interface ContributionData {
-  amount: number;
-  payFee: boolean;
-  prorate: boolean;
-}
-
-export class SetContributionData implements ContributionData {
+export class UpdateContributionData {
   @Validate(MinContributionAmount)
   amount!: number;
 
@@ -46,7 +40,7 @@ export class SetContributionData implements ContributionData {
 }
 
 export class StartContributionData
-  extends SetContributionData
+  extends UpdateContributionData
   implements StartJoinFlowData
 {
   @IsUrl()
@@ -56,17 +50,6 @@ export class StartContributionData
   paymentMethod!: PaymentMethod;
 }
 
-export class UpdateContributionData implements ContributionData {
-  @IsNumber()
-  amount!: number;
-
-  @IsBoolean()
-  payFee!: boolean;
-
-  @IsBoolean()
-  prorate!: boolean;
-}
-
 export class ForceUpdateContributionData {
   @IsIn([ContributionType.Manual, ContributionType.None])
   type!: ContributionType.Manual | ContributionType.None;

src/apps/members/apps/member/apps/contribution/app.ts

@@ -29,7 +29,7 @@ app.get(
 
       res.render("automatic", {
         member: contact,
-        canChange: await PaymentService.canChangeContribution(contact, true),
+        canChange: true, // TODO: remove
         monthsLeft: calcMonthsLeft(contact),
         payments,
         total

src/core/providers/payment/GCProvider.ts

@@ -1,5 +1,6 @@
 import { PaymentMethod } from "@beabee/beabee-common";
 import { Subscription } from "gocardless-nodejs";
+import moment from "moment";
 
 import gocardless from "@core/lib/gocardless";
 import { log as mainLogger } from "@core/logging";
@@ -60,18 +61,21 @@ export default class GCProvider extends PaymentProvider<GCPaymentData> {
     return {
       payFee: this.data.payFee || false,
       hasPendingPayment: pendingPayment,
-      ...(this.data.nextMonthlyAmount &&
+      ...(this.data.nextAmount &&
         this.contact.contributionPeriod && {
           nextAmount: getActualAmount(
-            this.data.nextMonthlyAmount,
+            this.data.nextAmount.monthly,
             this.contact.contributionPeriod
           )
         }),
       ...(paymentSource && { paymentSource })
     };
   }
 
-  async canChangeContribution(useExistingMandate: boolean): Promise<boolean> {
+  async canChangeContribution(
+    useExistingMandate: boolean,
+    paymentForm: PaymentForm
+  ): Promise<boolean> {
     // No payment method available
     if (useExistingMandate && !this.data.mandateId) {
       return false;
@@ -82,11 +86,13 @@ export default class GCProvider extends PaymentProvider<GCPaymentData> {
       return true;
     }
 
-    // Monthly contributors can update their contribution even if they have
-    // pending payments, but they can't always change their mandate as this can
+    // Monthly contributors can update their contribution amount even if they have
+    // pending payments, but they can't always change their period or mandate as this can
     // result in double charging
     return (
-      (useExistingMandate && this.contact.contributionPeriod === "monthly") ||
+      (useExistingMandate &&
+        this.contact.contributionPeriod === "monthly" &&
+        paymentForm.period === "monthly") ||
       !(this.data.mandateId && (await hasPendingPayment(this.data.mandateId)))
     );
   }
@@ -106,26 +112,34 @@ export default class GCProvider extends PaymentProvider<GCPaymentData> {
     let subscription: Subscription | undefined;
 
     if (this.data.subscriptionId) {
-      if (this.contact.membership?.isActive) {
+      if (
+        this.contact.membership?.isActive &&
+        this.contact.contributionPeriod === paymentForm.period
+      ) {
         subscription = await updateSubscription(
           this.data.subscriptionId,
           paymentForm
         );
       } else {
-        // Cancel failed subscriptions, we'll try a new one
+        // Cancel failed subscriptions or when period is changing
         await this.cancelContribution(true);
       }
     }
 
     const renewalDate = calcRenewalDate(this.contact);
+    let expiryDate;
 
-    if (!subscription) {
+    if (subscription) {
+      expiryDate = subscription.upcoming_payments![0].charge_date;
+    } else {
       log.info("Creating new subscription");
       subscription = await createSubscription(
         this.data.mandateId,
         paymentForm,
         renewalDate
       );
+      // The second payment is the first renewal payment when you first create a subscription
+      expiryDate = subscription.upcoming_payments![1].charge_date;
     }
 
     const startNow =
@@ -137,8 +151,6 @@ export default class GCProvider extends PaymentProvider<GCPaymentData> {
         this.contact.contributionMonthlyAmount || 0
       ));
 
-    const expiryDate = await getSubscriptionNextChargeDate(subscription);
-
     log.info("Activate contribution for " + this.contact.id, {
       userId: this.contact.id,
       paymentForm,
@@ -148,11 +160,16 @@ export default class GCProvider extends PaymentProvider<GCPaymentData> {
 
     this.data.subscriptionId = subscription.id!;
     this.data.payFee = paymentForm.payFee;
-    this.data.nextMonthlyAmount = startNow ? null : paymentForm.monthlyAmount;
+    this.data.nextAmount = startNow
+      ? null
+      : {
+          monthly: paymentForm.monthlyAmount,
+          chargeable: Number(subscription.amount)
+        };
 
     await this.updateData();
 
-    return { startNow, expiryDate };
+    return { startNow, expiryDate: moment.utc(expiryDate).toDate() };
   }
 
   async cancelContribution(keepMandate: boolean): Promise<void> {
@@ -161,7 +178,7 @@ export default class GCProvider extends PaymentProvider<GCPaymentData> {
     const subscriptionId = this.data.subscriptionId;
     const mandateId = this.data.mandateId;
 
-    this.data.nextMonthlyAmount = null;
+    this.data.nextAmount = null;
     this.data.subscriptionId = null;
     if (!keepMandate) {
       this.data.mandateId = null;

src/core/providers/payment/StripeProvider.ts

@@ -141,6 +141,7 @@ export default class StripeProvider extends PaymentProvider<StripePaymentData> {
         this.method,
         calcRenewalDate(this.contact)
       );
+      // Set this for the updateOrCreateContribution call below
       this.data.subscriptionId = newSubscription.id;
     }
 

src/core/providers/payment/index.ts

@@ -30,7 +30,10 @@ export abstract class PaymentProvider<T extends PaymentProviderData> {
     });
   }
 
-  abstract canChangeContribution(useExistingMandate: boolean): Promise<boolean>;
+  abstract canChangeContribution(
+    useExistingMandate: boolean,
+    paymentForm: PaymentForm
+  ): Promise<boolean>;
 
   abstract cancelContribution(keepMandate: boolean): Promise<void>;
 

src/core/services/ContactsService.ts

@@ -314,13 +314,9 @@ class ContactsService {
     // prevent proration problems
     if (
       contact.membership?.isActive &&
-      // Manual annual contributors can't change their period
-      ((wasManual &&
-        contact.contributionPeriod === ContributionPeriod.Annually &&
-        paymentForm.period !== ContributionPeriod.Annually) ||
-        // Automated contributors can't either
-        (contact.contributionType === ContributionType.Automatic &&
-          contact.contributionPeriod !== paymentForm.period))
+      // Annual contributors can't change their period
+      contact.contributionPeriod === ContributionPeriod.Annually &&
+      paymentForm.period !== ContributionPeriod.Annually
     ) {
       throw new CantUpdateContribution();
     }

src/core/services/PaymentService.ts

@@ -92,10 +92,11 @@ class PaymentService {
 
   async canChangeContribution(
     contact: Contact,
-    useExistingPaymentSource: boolean
+    useExistingPaymentSource: boolean,
+    paymentForm: PaymentForm
   ): Promise<boolean> {
     const ret = await this.provider(contact, (p) =>
-      p.canChangeContribution(useExistingPaymentSource)
+      p.canChangeContribution(useExistingPaymentSource, paymentForm)
     );
     log.info(
       `User ${contact.id} ${ret ? "can" : "cannot"} change contribution`

src/core/utils/payment/gocardless.ts

@@ -152,7 +152,7 @@ export async function prorateSubscription(
       await gocardless.payments.create({
         amount: Math.floor(prorateAmount * 100).toFixed(0),
         currency: config.currencyCode.toUpperCase() as PaymentCurrency,
-        // TODO: i18n description: "One-off payment to start new contribution",
+        description: "One-off payment to start new contribution",
         links: {
           mandate: mandateId
         }