fix workflow steps for reporting order failures

Author: jdnichollsc

apps/order/src/app/activities/activities.service.ts

@@ -12,4 +12,8 @@ export class ActivitiesService {
   async createOrder(data: OrderWorkflowData) {
     return await this.orderService.createOrder(data);
   }
+
+  async reportPaymentFailed(orderId: number) {
+    return this.orderService.reportPaymentFailed(orderId);
+  }
 }

apps/order/src/app/order/order.service.ts

@@ -1,6 +1,7 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { OrderWorkflowData } from '@projectx/core';
 import { OrderRepositoryService } from '@projectx/db';
+import { OrderStatus } from '@projectx/models';
 import { StripeService } from '@projectx/payment';
 
 @Injectable()
@@ -35,4 +36,14 @@ export class OrderService {
       clientSecret: paymentIntent.client_secret,
     };
   }
+
+  async reportPaymentFailed(orderId: number) {
+    this.logger.log(`reportPaymentFailed(${orderId})`);
+    const updatedOrder = await this.orderRepositoryService.updateOrderStatus(
+      orderId,
+      OrderStatus.Failed
+    );
+    // TODO: Send email notification to user about payment failure
+    return updatedOrder;
+  }
 }

apps/order/src/workflows/order.workflow.ts

@@ -23,8 +23,8 @@ import { cancelWorkflowSignal } from '../../../../libs/backend/core/src/lib/work
 import type { OrderStatusResponseDto } from '../../../../libs/models/src/order/order.dto';
 import type { ActivitiesService } from '../main';
 
-const { createOrder: createOrderActivity } = proxyActivities<ActivitiesService>(
-  {
+const { createOrder: createOrderActivity, reportPaymentFailed } =
+  proxyActivities<ActivitiesService>({
     startToCloseTimeout: '5 seconds',
     retry: {
       initialInterval: '2s',
@@ -33,8 +33,7 @@ const { createOrder: createOrderActivity } = proxyActivities<ActivitiesService>(
       backoffCoefficient: 1.5,
       nonRetryableErrorTypes: [OrderWorkflowNonRetryableErrors.UNKNOWN_ERROR],
     },
-  }
-);
+  });
 import { processPayment } from './process-payment.workflow';
 
 export enum OrderStatus {
@@ -97,8 +96,9 @@ export async function createOrder(
     });
     const processPaymentResult = await processPaymentWorkflow.result();
     if (processPaymentResult.status !== OrderProcessPaymentStatus.SUCCESS) {
+      // Report payment failure before throwing the error
+      await reportPaymentFailed(state.orderId);
       state.status = OrderStatus.Failed;
-      // TODO: Send email to the user
       throw ApplicationFailure.nonRetryable(
         OrderWorkflowNonRetryableErrors.UNKNOWN_ERROR,
         'Payment failed'

apps/web/app/routes/checkout.$referenceId.tsx

@@ -1,6 +1,6 @@
 import type { LoaderFunctionArgs, MetaFunction } from '@remix-run/node';
 import { useLoaderData } from '@remix-run/react';
-import { useEffect, useState } from 'react';
+import { useEffect, useRef, useState } from 'react';
 import { useCart } from 'react-use-cart';
 import invariant from 'tiny-invariant';
 
@@ -41,14 +41,17 @@ export default function Checkout() {
     (workflow) => workflow.referenceId === referenceId
   );
   // Trigger actions to manage the workflow
-  const { handleRun } = useWorkflowActions<OrderWorkflow>({
+  const { handleRun, handleClear } = useWorkflowActions<OrderWorkflow>({
     workflowType: WorkflowTypes.ORDER,
   });
+  const workflowInitiatedRef = useRef(false);
   const [clientSecret, setClientSecret] = useState('');
+  const [error, setError] = useState<Error>();
 
   // Trigger the creation of the order workflow
   useEffect(() => {
-    if (!currentCheckoutWorkflow && !clientSecret && items.length > 0) {
+    if (!workflowInitiatedRef.current && !currentCheckoutWorkflow && items.length > 0) {
+      workflowInitiatedRef.current = true;
       handleRun({
         workflow: {
           referenceId,
@@ -67,16 +70,25 @@ export default function Checkout() {
           },
         },
       });
+      // Clear the cart after the workflow is triggered
       emptyCart();
     }
-  }, [currentCheckoutWorkflow, clientSecret, items]);
+  }, [currentCheckoutWorkflow, items]);
 
   useEffect(() => {
     if (!clientSecret && currentCheckoutWorkflow?.data?.response?.clientSecret) {
       setClientSecret(currentCheckoutWorkflow.data.response.clientSecret);
     }
   }, [currentCheckoutWorkflow?.data?.response?.clientSecret, clientSecret]);
 
+  // Manage errors with the current workflow
+  useEffect(() => {
+    if (currentCheckoutWorkflow?.error) {
+      setError(currentCheckoutWorkflow.error);
+      handleClear({ workflow: currentCheckoutWorkflow });
+    }
+  }, [currentCheckoutWorkflow?.error]);
+
   return (
     <PageLayout title="Checkout">
       <CheckoutPage clientSecret={clientSecret} />

libs/backend/db/prisma/schema.prisma

@@ -253,6 +253,7 @@ enum OrderStatus {
   Shipped
   Delivered
   Cancelled
+  Failed
 }
 
 enum PaymentStatus {

libs/backend/db/src/lib/order/order-repository.service.ts

@@ -1,6 +1,6 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { CreateOrderDto } from '@projectx/models';
-import { Prisma, OrderStatus } from '@prisma/client';
+import { Prisma, OrderStatus, Order } from '@prisma/client';
 
 import { PrismaService } from '../prisma.service';
 
@@ -63,4 +63,12 @@ export class OrderRepositoryService {
       return order;
     });
   }
+
+  async updateOrderStatus(orderId: number, status: OrderStatus): Promise<Order> {
+    this.logger.verbose(`updateOrderStatus(${orderId}) - status: ${status}`);
+    return this.prisma.order.update({
+      where: { id: orderId },
+      data: { status },
+    });
+  }
 }