feat: add handler for round and application stats (#106)

thelostone-mc · web-flow · commit 81e98313c10b · 2025-03-26T09:54:40.000+05:30
# 🤖 Linear closes PAR-943 <img width="1640" alt="image" src="https://github.com/user-attachments/assets/63026e3e-5116-4a57-86ab-107dd8ce099d" /> ## Description ## Checklist before requesting a review - [x] I have conducted a self-review of my code. - [x] I have conducted a QA. - [x] If it is a core feature, I have included comprehensive tests.  ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Donation tracking has been enhanced. The system now automatically updates donation statistics for both rounds and individual applications. - **Refactor** - Donation amounts are now uniformly represented as strings for improved clarity. - **Tests** - Additional tests have been added to ensure reliable processing of donation events and statistics updates for both rounds and applications.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,6 +1,6 @@
 # 🤖 Linear
 
-Closes GIT-XXX
+Closes PAR-XXX
 
 ## Description
 
diff --git a/packages/data-flow/src/data-loader/handlers/application.handlers.ts b/packages/data-flow/src/data-loader/handlers/application.handlers.ts
@@ -31,4 +31,13 @@ export const createApplicationHandlers = (
             txConnection,
         );
     }) satisfies ChangesetHandler<"UpdateApplication">,
+
+    IncrementApplicationDonationStats: (async (changeset, txConnection): Promise<void> => {
+        const { chainId, roundId, applicationId, amountInUsd } = changeset.args;
+        await repository.incrementApplicationDonationStats(
+            { chainId, roundId, id: applicationId },
+            amountInUsd,
+            txConnection,
+        );
+    }) satisfies ChangesetHandler<"IncrementApplicationDonationStats">,
 });
diff --git a/packages/data-flow/src/data-loader/handlers/round.handlers.ts b/packages/data-flow/src/data-loader/handlers/round.handlers.ts
@@ -51,6 +51,18 @@ export const createRoundHandlers = (repository: IRoundRepository): RoundHandlers
         );
     }) satisfies ChangesetHandler<"IncrementRoundFundedAmount">,
 
+    IncrementRoundDonationStats: (async (changeset, txConnection): Promise<void> => {
+        const { chainId, roundId, amountInUsd } = changeset.args;
+        await repository.incrementRoundDonationStats(
+            {
+                chainId,
+                roundId,
+            },
+            amountInUsd,
+            txConnection,
+        );
+    }) satisfies ChangesetHandler<"IncrementRoundDonationStats">,
+
     IncrementRoundTotalDistributed: (async (changeset, txConnection): Promise<void> => {
         const { chainId, roundId, amount } = changeset.args;
         await repository.incrementRoundTotalDistributed(
diff --git a/packages/data-flow/test/data-loader/handlers/application.handlers.spec.ts b/packages/data-flow/test/data-loader/handlers/application.handlers.spec.ts
@@ -13,6 +13,7 @@ describe("Application Handlers", () => {
     const mockRepository = {
         insertApplication: vi.fn(),
         updateApplication: vi.fn(),
+        incrementApplicationDonationStats: vi.fn(),
     } as unknown as IApplicationRepository;
     const mockTxConnection = { query: vi.fn() } as unknown as TransactionConnection;
 
@@ -51,4 +52,24 @@ describe("Application Handlers", () => {
             mockTxConnection,
         );
     });
+
+    it("handle IncrementApplicationDonationStats changeset", async () => {
+        const changeset = {
+            type: "IncrementApplicationDonationStats",
+            args: {
+                chainId: 1 as ChainId,
+                roundId: "round1",
+                applicationId: "0",
+                amountInUsd: "1000",
+            },
+        } as const;
+
+        await handlers.IncrementApplicationDonationStats(changeset);
+
+        expect(mockRepository.incrementApplicationDonationStats).toHaveBeenCalledWith(
+            { chainId: 1 as ChainId, roundId: "round1", id: "0" },
+            "1000",
+            undefined,
+        );
+    });
 });
diff --git a/packages/data-flow/test/data-loader/handlers/round.handlers.spec.ts b/packages/data-flow/test/data-loader/handlers/round.handlers.spec.ts
@@ -19,6 +19,7 @@ describe("Round Handlers", () => {
         deleteManyPendingRoundRoles: vi.fn(),
         insertRoundRole: vi.fn(),
         deleteManyRoundRolesByRoleAndAddress: vi.fn(),
+        incrementRoundDonationStats: vi.fn(),
     } as unknown as IRoundRepository;
     const mockTxConnection = { query: vi.fn() } as unknown as TransactionConnection;
 
@@ -111,6 +112,25 @@ describe("Round Handlers", () => {
         );
     });
 
+    it("handle IncrementRoundDonationStats changeset", async () => {
+        const changeset = {
+            type: "IncrementRoundDonationStats",
+            args: {
+                chainId: 1 as ChainId,
+                roundId: "round-1",
+                amountInUsd: "1000",
+            },
+        } as const;
+
+        await handlers.IncrementRoundDonationStats(changeset);
+
+        expect(mockRepository.incrementRoundDonationStats).toHaveBeenCalledWith(
+            { chainId: 1 as ChainId, roundId: "round-1" },
+            "1000",
+            undefined,
+        );
+    });
+
     it("handle IncrementRoundTotalDistributed changeset", async () => {
         const changeset = {
             type: "IncrementRoundTotalDistributed",
diff --git a/packages/data-flow/test/integration/helpers/dependencies.ts b/packages/data-flow/test/integration/helpers/dependencies.ts
@@ -60,6 +60,7 @@ export const createMockRepositories = (): Pick<
         getRoundMatchTokenAddressById: vi.fn(),
         getRoundRoles: vi.fn(),
         getPendingRoundRoles: vi.fn(),
+        incrementRoundDonationStats: vi.fn(),
     },
     applicationRepository: {
         insertApplication: vi.fn(),
@@ -69,6 +70,7 @@ export const createMockRepositories = (): Pick<
         getApplicationByAnchorAddress: vi.fn(),
         getApplicationByAnchorAddressOrThrow: vi.fn(),
         getApplicationsByRoundId: vi.fn(),
+        incrementApplicationDonationStats: vi.fn(),
     },
     donationRepository: {
         insertDonation: vi.fn(),
diff --git a/packages/data-flow/test/integration/strategy.integration.spec.ts b/packages/data-flow/test/integration/strategy.integration.spec.ts
@@ -661,7 +661,7 @@ describe("Orchestrator Integration - Strategy Events Processing", () => {
                     },
                 ],
                 distributionTransaction: null,
-                totalAmountDonatedInUsd: 0,
+                totalAmountDonatedInUsd: "0",
                 totalDonationsCount: 0,
                 uniqueDonorsCount: 0,
                 tags: ["allo-v2"],
diff --git a/packages/processors/src/processors/strategy/directGrantsLite/handlers/registered.handler.ts b/packages/processors/src/processors/strategy/directGrantsLite/handlers/registered.handler.ts
@@ -78,7 +78,7 @@ export class DGLiteRegisteredHandler implements IEventHandler<"Strategy", "Regis
                 },
             ],
             distributionTransaction: null,
-            totalAmountDonatedInUsd: 0,
+            totalAmountDonatedInUsd: "0",
             totalDonationsCount: 0,
             uniqueDonorsCount: 0,
             timestamp: new Date(blockTimestamp),
diff --git a/packages/processors/src/processors/strategy/directGrantsSimple/handlers/registered.handler.ts b/packages/processors/src/processors/strategy/directGrantsSimple/handlers/registered.handler.ts
@@ -79,7 +79,7 @@ export class DGSimpleRegisteredHandler
                 },
             ],
             distributionTransaction: null,
-            totalAmountDonatedInUsd: 0,
+            totalAmountDonatedInUsd: "0",
             totalDonationsCount: 0,
             uniqueDonorsCount: 0,
             timestamp: new Date(blockTimestamp),
diff --git a/packages/processors/src/processors/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/allocated.handler.ts b/packages/processors/src/processors/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/allocated.handler.ts
@@ -108,6 +108,23 @@ export class DVMDAllocatedHandler implements IEventHandler<"Strategy", "Allocate
                 type: "InsertDonation",
                 args: { donation },
             },
+            {
+                type: "IncrementRoundDonationStats",
+                args: {
+                    chainId: this.chainId,
+                    roundId: round.id,
+                    amountInUsd,
+                },
+            },
+            {
+                type: "IncrementApplicationDonationStats",
+                args: {
+                    chainId: this.chainId,
+                    roundId: round.id,
+                    applicationId: application.id,
+                    amountInUsd,
+                },
+            },
         ];
     }
 
diff --git a/packages/processors/src/processors/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/registered.handler.ts b/packages/processors/src/processors/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/registered.handler.ts
@@ -73,7 +73,7 @@ export class DVMDRegisteredHandler implements IEventHandler<"Strategy", "Registe
                 },
             ],
             distributionTransaction: null,
-            totalAmountDonatedInUsd: 0,
+            totalAmountDonatedInUsd: "0",
             totalDonationsCount: 0,
             uniqueDonorsCount: 0,
             timestamp: new Date(blockTimestamp),
diff --git a/packages/processors/src/processors/strategy/easyRetroFunding/handlers/registered.handler.ts b/packages/processors/src/processors/strategy/easyRetroFunding/handlers/registered.handler.ts
@@ -77,7 +77,7 @@ export class ERFRegisteredHandler implements IEventHandler<"Strategy", "Register
                 },
             ],
             distributionTransaction: null,
-            totalAmountDonatedInUsd: 0,
+            totalAmountDonatedInUsd: "0",
             totalDonationsCount: 0,
             uniqueDonorsCount: 0,
             timestamp: new Date(blockTimestamp),
diff --git a/packages/processors/test/strategy/directGrantsLite/handlers/registered.handler.spec.ts b/packages/processors/test/strategy/directGrantsLite/handlers/registered.handler.spec.ts
@@ -92,7 +92,7 @@ describe("DGLiteRegisteredHandler", () => {
                         },
                     ],
                     distributionTransaction: null,
-                    totalAmountDonatedInUsd: 0,
+                    totalAmountDonatedInUsd: "0",
                     totalDonationsCount: 0,
                     uniqueDonorsCount: 0,
                     tags: ["allo-v2"],
diff --git a/packages/processors/test/strategy/directGrantsSimple/handlers/registered.handler.spec.ts b/packages/processors/test/strategy/directGrantsSimple/handlers/registered.handler.spec.ts
@@ -88,7 +88,7 @@ describe("DGSimpleRegisteredHandler", () => {
                         },
                     ],
                     distributionTransaction: null,
-                    totalAmountDonatedInUsd: 0,
+                    totalAmountDonatedInUsd: "0",
                     totalDonationsCount: 0,
                     uniqueDonorsCount: 0,
                     tags: ["allo-v2"],
diff --git a/packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/allocated.handler.spec.ts b/packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/allocated.handler.spec.ts
@@ -112,6 +112,23 @@ describe("DVMDAllocatedHandler", () => {
                     },
                 },
             },
+            {
+                type: "IncrementRoundDonationStats",
+                args: {
+                    chainId,
+                    roundId: "round1",
+                    amountInUsd: "20000",
+                },
+            },
+            {
+                type: "IncrementApplicationDonationStats",
+                args: {
+                    chainId,
+                    roundId: "round1",
+                    applicationId: "app1",
+                    amountInUsd: "20000",
+                },
+            },
         ]);
     });
 
@@ -175,6 +192,23 @@ describe("DVMDAllocatedHandler", () => {
                     }),
                 },
             },
+            {
+                type: "IncrementRoundDonationStats",
+                args: {
+                    chainId,
+                    roundId: "round1",
+                    amountInUsd: "1500",
+                },
+            },
+            {
+                type: "IncrementApplicationDonationStats",
+                args: {
+                    chainId,
+                    roundId: "round1",
+                    applicationId: "app1",
+                    amountInUsd: "1500",
+                },
+            },
         ]);
     });
 
diff --git a/packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/registered.handler.spec.ts b/packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/registered.handler.spec.ts
@@ -112,7 +112,7 @@ describe("DVMDRegisteredHandler", () => {
                         },
                     ],
                     distributionTransaction: null,
-                    totalAmountDonatedInUsd: 0,
+                    totalAmountDonatedInUsd: "0",
                     totalDonationsCount: 0,
                     uniqueDonorsCount: 0,
                     tags: ["allo-v2"],
diff --git a/packages/processors/test/strategy/easyRetroFunding/handlers/registered.handler.spec.ts b/packages/processors/test/strategy/easyRetroFunding/handlers/registered.handler.spec.ts
@@ -88,7 +88,7 @@ describe("ERFRegisteredHandler", () => {
                         },
                     ],
                     distributionTransaction: null,
-                    totalAmountDonatedInUsd: 0,
+                    totalAmountDonatedInUsd: "0",
                     totalDonationsCount: 0,
                     uniqueDonorsCount: 0,
                     tags: ["allo-v2"],
diff --git a/packages/repository/src/interfaces/applicationRepository.interface.ts b/packages/repository/src/interfaces/applicationRepository.interface.ts
@@ -89,4 +89,17 @@ export interface IApplicationRepository<
         application: PartialApplication,
         tx?: TxConnection,
     ): Promise<void>;
+
+    /**
+     * Increments the donation stats for an application.
+     * @param where An object containing the (id, chainId, and roundId) of the application to update.
+     * @param amountInUsd The amount in USD to increment by.
+     * @param tx Optional transaction connection
+     * @returns A promise that resolves when the increment is complete.
+     */
+    incrementApplicationDonationStats(
+        where: { id: string; chainId: ChainId; roundId: string },
+        amountInUsd: string,
+        tx?: TxConnection,
+    ): Promise<void>;
 }
diff --git a/packages/repository/src/interfaces/roundRepository.interface.ts b/packages/repository/src/interfaces/roundRepository.interface.ts
@@ -137,6 +137,22 @@ export interface IRoundRepository<
         tx?: TxConnection,
     ): Promise<void>;
 
+    /**
+     * Increments the donation stats for a specific round.
+     * @param where An object containing the chainId and roundId of the round to update.
+     * @param amountInUsd The amount in USD to increment by.
+     * @param tx Optional transaction connection
+     * @returns A promise that resolves when the increment is complete.
+     */
+    incrementRoundDonationStats(
+        where: {
+            chainId: ChainId;
+            roundId: string;
+        },
+        amountInUsd: string,
+        tx?: TxConnection,
+    ): Promise<void>;
+
     /**
      * Increments the total distributed amount for a specific round.
      * @param where An object containing the chainId and roundId of the round to update.
diff --git a/packages/repository/src/kysely/repositories/application.repository.ts b/packages/repository/src/kysely/repositories/application.repository.ts
@@ -161,6 +161,35 @@ export class KyselyApplicationRepository implements IApplicationRepository<Kysel
         }
     }
 
+    /* @inheritdoc */
+    async incrementApplicationDonationStats(
+        where: { id: string; chainId: ChainId; roundId: string },
+        amountInUsd: string,
+        tx?: KyselyTransaction,
+    ): Promise<void> {
+        try {
+            const queryBuilder = (tx || this.db).withSchema(this.schemaName);
+            await queryBuilder
+                .updateTable("applications")
+                .set((eb) => ({
+                    totalDonationsCount: eb("totalDonationsCount", "+", 1),
+                    totalAmountDonatedInUsd: eb("totalAmountDonatedInUsd", "+", amountInUsd),
+                }))
+                .where("id", "=", where.id)
+                .where("chainId", "=", where.chainId)
+                .where("roundId", "=", where.roundId)
+                .execute();
+        } catch (error) {
+            throw handlePostgresError(error, {
+                className: KyselyApplicationRepository.name,
+                methodName: "incrementApplicationDonationStats",
+                additionalData: {
+                    where,
+                    amountInUsd,
+                },
+            });
+        }
+    }
     /**
      * Formats the application to ensure that the statusSnapshots are stored as a JSON string.
      * Also, properly handles BigInt stringification.
diff --git a/packages/repository/src/kysely/repositories/round.repository.ts b/packages/repository/src/kysely/repositories/round.repository.ts
@@ -205,6 +205,35 @@ export class KyselyRoundRepository implements IRoundRepository<KyselyTransaction
         }
     }
 
+    /* @inheritdoc */
+    async incrementRoundDonationStats(
+        where: { chainId: ChainId; roundId: string },
+        amountInUsd: string,
+        tx?: KyselyTransaction,
+    ): Promise<void> {
+        try {
+            const queryBuilder = (tx || this.db).withSchema(this.schemaName);
+            await queryBuilder
+                .updateTable("rounds")
+                .set((eb) => ({
+                    totalDonationsCount: eb("totalDonationsCount", "+", 1),
+                    totalAmountDonatedInUsd: eb("totalAmountDonatedInUsd", "+", amountInUsd),
+                }))
+                .where("chainId", "=", where.chainId)
+                .where("id", "=", where.roundId)
+                .execute();
+        } catch (error) {
+            throw handlePostgresError(error, {
+                className: KyselyRoundRepository.name,
+                methodName: "incrementRoundDonationStats",
+                additionalData: {
+                    where,
+                    amountInUsd,
+                },
+            });
+        }
+    }
+
     /* @inheritdoc */
     async incrementRoundTotalDistributed(
         where: { chainId: ChainId; roundId: string },
diff --git a/packages/repository/src/types/application.types.ts b/packages/repository/src/types/application.types.ts
@@ -23,7 +23,7 @@ export type Application = {
     createdAtBlock: bigint;
     statusUpdatedAtBlock: bigint;
     totalDonationsCount: number;
-    totalAmountDonatedInUsd: number;
+    totalAmountDonatedInUsd: string;
     uniqueDonorsCount: number;
     timestamp: Date;
     tags: string[];
diff --git a/packages/repository/src/types/changeset.types.ts b/packages/repository/src/types/changeset.types.ts
