Handle card-link fail cases in CloudPayments

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.4.12",
+  "version": "1.4.13",
   "main": "index.ts",
   "license": "BUSL-1.1",
   "scripts": {

src/billing/cloudpayments.ts

@@ -22,8 +22,7 @@
   BusinessOperationType,
   ConfirmedMemberDBScheme,
   PayloadOfWorkspacePlanPurchase,
-  PlanDBScheme,
-  PlanProlongationPayload
+  PlanDBScheme
 } from '@hawk.so/types';
 import WorkspaceModel from '../models/workspace';
 import HawkCatcher from '@hawk.so/nodejs';
@@ -88,7 +87,7 @@
     return router;
   }
 
   /**
    * Generates invoice id for payment
    *
    * @param tariffPlan - tariff plan to generate invoice id
@@ -205,7 +204,7 @@
     telegram.sendMessage(`🤗 [Billing / Check] All checks passed successfully «${workspace.name}»`, TelegramBotURLs.Money)
       .catch(e => console.error('Error while sending message to Telegram: ' + e));
 
     HawkCatcher.send(new Error('[Billing / Check] All checks passed successfully'), body as any);
 
     res.json({
       code: CheckCodes.SUCCESS,
@@ -487,7 +486,7 @@
    */
   private async fail(req: express.Request, res: express.Response): Promise<void> {
     const body: FailRequest = req.body;
-    let data: PlanProlongationPayload;
+    let data: PaymentData;
 
     console.log('💎 CloudPayments /fail request', body);
 
@@ -507,12 +506,29 @@
      * @todo handle card linking and update business operation status
      */
 
-    if (!data.workspaceId || !data.userId || !data.tariffPlanId) {
-      this.sendError(res, FailCodes.SUCCESS, `[Billing / Fail] No workspace or user id or plan id in request body`, body);
+    if (!data.workspaceId) {
+      this.sendError(res, FailCodes.SUCCESS, `[Billing / Fail] No workspace id in request body`, body);
 
       return;
     }
 
+    if (!data.userId) {
+      this.sendError(res, FailCodes.SUCCESS, `[Billing / Fail] No user id in request body`, body);
+
+      return;
+    }
+
+    /**
+     * In card linking mode tariff plan id is taken from workspace.
+     */
+    if (!data.isCardLinkOperation) {
+      if (!data.tariffPlanId) {
+        this.sendError(res, FailCodes.SUCCESS, `[Billing / Fail] No tariffPlanId in request body`, body);
+
+        return;
+      }
+    }
+
     try {
       businessOperation = await this.getBusinessOperation(req, body.TransactionId.toString());
       workspace = await this.getWorkspace(req, data.workspaceId);
@@ -555,7 +571,7 @@
 
     this.handleSendingToTelegramError(telegram.sendMessage(`❌ [Billing / Fail] Transaction failed for «${workspace.name}»`, TelegramBotURLs.Money));
 
     HawkCatcher.send(new Error('[Billing / Fail] Transaction failed'), body as any);
 
     res.json({
       code: FailCodes.SUCCESS,
@@ -737,7 +753,7 @@
    * @param errorText - error description
    * @param backtrace - request data and error data
    */
   private sendError(res: express.Response, errorCode: CheckCodes | PayCodes | FailCodes | RecurrentCodes, errorText: string, backtrace: { [key: string]: any }): void {
     res.json({
       code: errorCode,
     });
@@ -802,7 +818,7 @@
     promise.catch(e => console.error('Error while sending message to Telegram: ' + e));
   }
 
   /**
    * Parses body and returns card data
    * @param request - request body to parse
    */

test/integration/cases/billing/fail.test.ts

@@ -2,10 +2,11 @@ import { apiInstance } from '../../utils';
 import { FailCodes, FailRequest } from '../../../../src/billing/types';
 import { CardType, Currency, OperationType, ReasonCode, ReasonCodesTranscript } from '../../../../src/billing/types/enums';
 import { Collection, ObjectId, Db } from 'mongodb';
-import { BusinessOperationDBScheme, BusinessOperationStatus, PlanDBScheme, BusinessOperationType, UserDBScheme, WorkspaceDBScheme, UserNotificationType, PlanProlongationPayload } from '@hawk.so/types';
+import { BusinessOperationDBScheme, BusinessOperationStatus, PlanDBScheme, BusinessOperationType, UserDBScheme, WorkspaceDBScheme, UserNotificationType } from '@hawk.so/types';
 import { WorkerPaths } from '../../../../src/rabbitmq';
 import { PaymentFailedNotificationTask, SenderWorkerTaskType } from '../../../../src/types/personalNotifications';
 import checksumService from '../../../../src/utils/checksumService';
+import jwt, { Secret } from 'jsonwebtoken';
 import type { Global } from '@jest/types';
 
 declare var global: Global.Global;
@@ -215,6 +216,35 @@ describe('Fail webhook', () => {
       expect(message && JSON.parse(message.content.toString())).toStrictEqual(expectedLimiterTask);
       expect(apiResponse.data.code).toBe(FailCodes.SUCCESS);
     });
+
+    test('Should change business operation status to rejected for card linking payload without tariff plan id', async () => {
+      const apiResponse = await apiInstance.post('/billing/fail', {
+        ...validRequest,
+        Data: JSON.stringify({
+          checksum: await checksumService.generateChecksum({
+            isCardLinkOperation: true,
+            userId: user._id.toString(),
+            workspaceId: workspace._id.toString(),
+            nextPaymentDate: new Date().toString(),
+          }),
+          cloudPayments: {
+            recurrent: {
+              interval: 'Month',
+              period: 1,
+              amount: 100,
+              startDate: new Date().toISOString(),
+            },
+          },
+        }),
+      });
+
+      const updatedBusinessOperation = await businessOperationsCollection.findOne({
+        transactionId: transactionId.toString(),
+      });
+
+      expect(apiResponse.data.code).toBe(FailCodes.SUCCESS);
+      expect(updatedBusinessOperation?.status).toBe(BusinessOperationStatus.Rejected);
+    });
   });
 
   describe('With invalid request', () => {
@@ -252,5 +282,33 @@ describe('Fail webhook', () => {
       expect(apiResponse.data.code).toBe(FailCodes.SUCCESS);
       expect(updatedBusinessOperation?.status).toBe(BusinessOperationStatus.Pending);
     });
+
+    test('Should not change business operation status for non-card-link payload without tariff plan id', async () => {
+      const invalidChecksum = jwt.sign({
+        isCardLinkOperation: false,
+        userId: user._id.toString(),
+        workspaceId: workspace._id.toString(),
+        shouldSaveCard: false,
+        nextPaymentDate: new Date().toString(),
+      }, process.env.JWT_SECRET_BILLING_CHECKSUM as Secret, { expiresIn: '30m' });
+
+      const apiResponse = await apiInstance.post('/billing/fail', {
+        ...validRequest,
+        Data: JSON.stringify({
+          checksum: invalidChecksum,
+        }),
+      });
+
+      const updatedBusinessOperation = await businessOperationsCollection.findOne({
+        transactionId: transactionId.toString(),
+      });
+      const message = await global.rabbitChannel.get(WorkerPaths.Email.queue, {
+        noAck: true,
+      });
+
+      expect(apiResponse.data.code).toBe(FailCodes.SUCCESS);
+      expect(message).toBeFalsy();
+      expect(updatedBusinessOperation?.status).toBe(BusinessOperationStatus.Pending);
+    });
   });
 });