Merge pull request #125 from jamalsoueidan/payout-log-update

Add orderId and createdAt to Payout Log schema and aggregation logic

Author: jamalsoueidan

openapi/paths/customer/payout-log/_types/payout-log.yaml

@@ -4,6 +4,10 @@ properties:
     type: string
   customerId:
     type: number
+  orderId:
+    type: number
+  orderCreatedAt:
+    type: string
   referenceType:
     $ref: "../_types/payout-log-type.yaml"
   referenceId:
@@ -20,6 +24,8 @@ properties:
 required:
   - _id
   - customerId
+  - orderId
+  - orderCreatedAt
   - referenceType
   - referenceId
   - referenceDocument

src/functions/customer/services/payout-log/paginate.ts

@@ -64,7 +64,12 @@ export const CustomerPayoutLogServicePaginate = async ({
                     $expr: { $eq: ["$line_items.id", "$$lineItemId"] },
                   },
                 },
-                { $project: { line_item: "$line_items", _id: 0 } },
+                {
+                  $project: {
+                    line_item: "$line_items",
+                    _id: 0,
+                  },
+                },
                 { $limit: 1 },
               ],
               as: "referenceDocument",

src/functions/customer/services/payout/balance.spec.ts

@@ -53,6 +53,7 @@ describe("CustomerPayoutServiceBalance", () => {
     await PayoutLogModel.create({
       customerId,
       referenceId: shipping._id,
+      orderId: dummyDataBalance.id,
       referenceType: PayoutLogReferenceType.SHIPPING,
       payout: new mongoose.Types.ObjectId(),
     });
@@ -70,6 +71,7 @@ describe("CustomerPayoutServiceBalance", () => {
     await PayoutLogModel.create({
       customerId,
       referenceId: dumbData.line_items[0].id,
+      orderId: dumbData.id,
       referenceType: PayoutLogReferenceType.LINE_ITEM,
       payout: new mongoose.Types.ObjectId(),
     });
@@ -92,6 +94,7 @@ describe("CustomerPayoutServiceBalance", () => {
     await PayoutLogModel.create({
       customerId,
       referenceId: dumbData.line_items[0].id,
+      orderId: dumbData.id,
       referenceType: PayoutLogReferenceType.LINE_ITEM,
       payout: new mongoose.Types.ObjectId(),
     });

src/functions/customer/services/payout/create.ts

@@ -1,7 +1,11 @@
 import { OrderModel } from "~/functions/order/order.models";
 import { OrderLineItem } from "~/functions/order/order.types";
 import { PayoutModel, PayoutStatus } from "~/functions/payout";
-import { PayoutLogModel, PayoutLogReferenceType } from "~/functions/payout-log";
+import {
+  PayoutLog,
+  PayoutLogModel,
+  PayoutLogReferenceType,
+} from "~/functions/payout-log";
 import { Shipping } from "~/functions/shipping/shipping.types";
 import { NotFoundError } from "~/library/handler";
 import { CustomerPayoutAccountServiceGet } from "../payout-account/get";
@@ -14,11 +18,11 @@ export type CustomerPayoutServiceCreateProps = {
 export const CustomerPayoutServiceCreate = async ({
   customerId,
 }: CustomerPayoutServiceCreateProps) => {
-  const lineItems = await CustomerPayoutServiceGetLineItemsFulfilled({
+  const orders = await CustomerPayoutServiceGetLineItemsFulfilled({
     customerId,
   });
 
-  if (lineItems.length === 0) {
+  if (orders.length === 0) {
     throw new NotFoundError([
       {
         code: "custom",
@@ -39,23 +43,27 @@ export const CustomerPayoutServiceCreate = async ({
     ]);
   }
 
-  const totalLineItems = lineItems.reduce(
+  const totalLineItems = orders.reduce(
     (accumulator, { line_items }) => accumulator + parseFloat(line_items.price),
     0
   );
 
-  const shippings = lineItems
+  const shippings = orders
     .filter((lineItem) => lineItem.shipping)
-    .map(({ shipping }) => shipping);
+    .map(({ id, created_at, shipping }) => ({
+      id,
+      created_at,
+      shipping,
+    }));
 
   let uniqueShippings = Array.from(
     new Map(
-      shippings.map((shipping) => [shipping._id.toString(), shipping])
+      shippings.map((shipping) => [shipping.shipping._id.toString(), shipping])
     ).values()
   );
 
   const totalShippingAmount = uniqueShippings.reduce(
-    (accumulator, { cost }) => accumulator + cost.value,
+    (accumulator, { shipping }) => accumulator + shipping.cost.value,
     0
   );
 
@@ -70,21 +78,31 @@ export const CustomerPayoutServiceCreate = async ({
   });
 
   PayoutLogModel.insertMany(
-    uniqueShippings.map((shipping) => ({
-      customerId,
-      referenceId: shipping._id,
-      referenceType: PayoutLogReferenceType.SHIPPING,
-      payout: payout._id,
-    }))
+    uniqueShippings.map(
+      (shipping) =>
+        ({
+          customerId,
+          referenceId: shipping.shipping._id,
+          orderId: shipping.id,
+          orderCreatedAt: shipping.created_at,
+          referenceType: PayoutLogReferenceType.SHIPPING,
+          payout: payout._id,
+        } as PayoutLog)
+    )
   ).catch((error) => console.error("Error inserting shipping logs:", error)); //<< needs to send to application inisight
 
   PayoutLogModel.insertMany(
-    lineItems.map((lineItem) => ({
-      customerId,
-      referenceId: lineItem.line_items.id,
-      referenceType: PayoutLogReferenceType.LINE_ITEM,
-      payout: payout._id,
-    }))
+    orders.map(
+      (lineItem) =>
+        ({
+          customerId,
+          orderId: lineItem.id,
+          orderCreatedAt: lineItem.created_at,
+          referenceId: lineItem.line_items.id,
+          referenceType: PayoutLogReferenceType.LINE_ITEM,
+          payout: payout._id,
+        } as PayoutLog)
+    )
   ).catch((error) => console.error("Error inserting line item logs:", error)); //<< needs to send to application inisight
 
   return payout.save();
@@ -94,13 +112,17 @@ export const CustomerPayoutServiceGetLineItemsFulfilled = async ({
   customerId,
 }: CustomerPayoutServiceCreateProps) => {
   return OrderModel.aggregate<{
+    id: number;
+    created_at: number;
     line_items: OrderLineItem;
     shipping: Pick<Shipping, "_id" | "cost">;
   }>([
     ...lineItemAggregation({ customerId }),
     ...shippingAggregation,
     {
       $project: {
+        id: "$id",
+        created_at: "$created_at",
         line_items: "$line_items",
         shipping: "$shipping",
       },

src/functions/payout-log/payout-log.schema.ts

@@ -26,6 +26,12 @@ export const PayoutLogMongooseSchema = new mongoose.Schema<
       required: true,
       unique: true,
     },
+    orderId: {
+      type: Number,
+      required: true,
+      index: true,
+    },
+    orderCreatedAt: Date,
     payout: {
       type: mongoose.Schema.Types.ObjectId,
       required: true,

src/functions/payout-log/payout-log.types.ts

@@ -7,9 +7,11 @@ export enum PayoutLogReferenceType {
 }
 
 export const PayoutLogZodSchema = z.object({
-  customerId: NumberOrStringType,
+  customerId: z.number(),
   referenceType: z.nativeEnum(PayoutLogReferenceType),
   referenceId: z.union([NumberOrStringType, ObjectIdType]),
+  orderId: z.number(),
+  orderCreatedAt: z.number().optional(),
   payout: ObjectIdType,
 });