PM-1099 - imporve logging

Author: vas3a

src/api/webhooks/trolley/handlers/payment.handler.ts

@@ -1,4 +1,4 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 import {
   PaymentProcessedEventData,
   PaymentWebhookEvent,
@@ -10,6 +10,8 @@ import { PrismaService } from 'src/shared/global/prisma.service';
 
 @Injectable()
 export class PaymentHandler {
+  private readonly logger = new Logger(PaymentHandler.name);
+
   constructor(
     private readonly prisma: PrismaService,
     private readonly paymentsService: PaymentsService,
@@ -27,37 +29,54 @@ export class PaymentHandler {
     const winningIds = (payload.externalId ?? '').split(',').slice(0, -1);
 
     if (!winningIds.length) {
-      console.error(
-        `No matching payments in our db to process for incoming payment.processed with memo '${payload.memo}'.`,
+      this.logger.error(
+        `No valid winning IDs found in the externalId: ${payload.externalId}`,
       );
     }
 
     if (payload.status !== 'processed') {
-      await this.prisma.$transaction(async (tx) => {
+      await this.updatePaymentStates(
+        winningIds,
+        payload.id,
+        payment_status.PROCESSING,
+        'FAILED',
+      );
+
+      return;
+    }
+
+    await this.updatePaymentStates(
+      winningIds,
+      payload.id,
+      payment_status.PAID,
+      'PROCESSED',
+    );
+  }
+
+  private async updatePaymentStates(
+    winningIds: string[],
+    paymentId: string,
+    processingState: payment_status,
+    releaseState: string,
+  ): Promise<void> {
+    await this.prisma.$transaction(async (tx) => {
+      try {
         await this.paymentsService.updatePaymentProcessingState(
           winningIds,
-          payment_status.PROCESSING,
+          processingState,
           tx,
         );
 
         await this.paymentsService.updatePaymentReleaseState(
-          payload.id,
-          'FAILED',
+          paymentId,
+          releaseState,
         );
-      });
-    }
-
-    await this.prisma.$transaction(async (tx) => {
-      await this.paymentsService.updatePaymentProcessingState(
-        winningIds,
-        payment_status.PAID,
-        tx,
-      );
-
-      await this.paymentsService.updatePaymentReleaseState(
-        payload.id,
-        'PROCESSED',
-      );
+      } catch (error) {
+        this.logger.error(
+          `Failed to update payment statuses: ${error.message}`,
+        );
+        throw error;
+      }
     });
   }
 }

src/api/withdrawal/withdrawal.service.ts

@@ -1,4 +1,4 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 import { ENV_CONFIG } from 'src/config';
 import { PrismaService } from 'src/shared/global/prisma.service';
 import { TaxFormRepository } from '../repository/taxForm.repo';
@@ -23,6 +23,8 @@ interface ReleasableWinningRow {
 
 @Injectable()
 export class WithdrawalService {
+  private readonly logger = new Logger(WithdrawalService.name);
+
   constructor(
     private readonly prisma: PrismaService,
     private readonly taxFormRepo: TaxFormRepository,
@@ -89,7 +91,7 @@ export class WithdrawalService {
   }
 
   async withdraw(userId: string, userHandle: string, winningsIds: string[]) {
-    console.info('Processing withdrawal request');
+    this.logger.log('Processing withdrawal request');
     const hasActiveTaxForm = await this.taxFormRepo.hasActiveTaxForm(userId);
 
     if (!hasActiveTaxForm) {
@@ -114,7 +116,7 @@ export class WithdrawalService {
 
     const totalAmount = this.checkTotalAmount(winnings);
 
-    console.info('Begin processing payments', winnings);
+    this.logger.log('Begin processing payments', winnings);
     await this.prisma.$transaction(async (tx) => {
       const recipient = await this.getTrolleyRecipientByUserId(userId);
 
@@ -133,15 +135,17 @@ export class WithdrawalService {
         return;
       }
 
-      const updatedPaymentToProcessingError =
+      try {
         await this.paymentsService.updatePaymentProcessingState(
           winningsIds,
           payment_status.PROCESSING,
           tx,
         );
-
-      if (updatedPaymentToProcessingError) {
-        throw new Error('Failed to update payment processing state');
+      } catch (e) {
+        this.logger.error(
+          `Failed to update payment processing state: ${e.message}`,
+        );
+        throw new Error('Failed to update payment processing state!');
       }
 
       const paymentRelease = await tx.payment_releases.create({
@@ -160,7 +164,7 @@ export class WithdrawalService {
           },
         },
       });
-      console.info(
+      this.logger.log(
         `Payment release created successfully. ID: ${paymentRelease.payment_release_id}`,
       );
 

src/shared/payments/payments.service.ts

@@ -119,10 +119,14 @@ export class PaymentsService {
       });
 
       if (r.count === 0 || r.count !== winningsIds.length) {
-        return 'Failed to set payment processing state! Not all rows were updated! Please check the provided winnings IDs and status.';
+        throw new Error(
+          'Failed to set payment processing state! Not all rows were updated! Please check the provided winnings IDs and status.',
+        );
       }
     } catch (error) {
-      return `Error updating payment processing state: '${error.message}'`;
+      throw new Error(
+        `Error updating payment processing state: '${error.message}'`,
+      );
     }
   }
 
@@ -143,10 +147,14 @@ export class PaymentsService {
       });
 
       if (r.count === 0) {
-        return 'Failed to update payment release status! No rows were updated. Please check the provided externalTransaction ID and status.';
+        throw new Error(
+          'Failed to update payment release status! No rows were updated. Please check the provided externalTransaction ID and status.',
+        );
       }
     } catch (error) {
-      return `Error updating payment release processing state: '${error.message}'`;
+      throw new Error(
+        `Error updating payment release processing state: '${error.message}'`,
+      );
     }
   }
 }