Merge pull request #90 from GeneralMagicio/feat/improve-queries

improve record create/update queries
GeneralMagicio · Oct 9, 2024 · 55abe59 · 55abe59
2 parents c85bc33 + 24b26e1
commit 55abe59
Show file tree

Hide file tree

Showing 4 changed files with 117 additions and 53 deletions.
diff --git a/src/repositories/projectRoundRecordRepository.test.ts b/src/repositories/projectRoundRecordRepository.test.ts
@@ -210,6 +210,28 @@ describe('ProjectRoundRecord test cases', () => {
       expect(roundRecord2?.totalDonationAmount).to.equal(donationAmount2);
       expect(roundRecord2?.totalDonationUsdAmount).to.equal(donationUsdAmount2);
     });
+
+    it('should not cause issue in case of multiple call of updateOrCreateProjectRoundRecord', async () => {
+      const donationAmount1 = 100;
+      const donationUsdAmount1 = 150;
+
+      await insertDonation({
+        amount: donationAmount1,
+        valueUsd: donationUsdAmount1,
+        qfRoundId: qfRound1.id,
+      });
+
+      const record1 = await updateOrCreateProjectRoundRecord(
+        projectId,
+        qfRound1.id,
+      );
+      const record2 = await updateOrCreateProjectRoundRecord(
+        projectId,
+        qfRound1.id,
+      );
+
+      expect(record1).to.deep.equal(record2);
+    });
   });
 
   describe('getProjectRoundRecord test cases', () => {

diff --git a/src/repositories/projectRoundRecordRepository.ts b/src/repositories/projectRoundRecordRepository.ts
@@ -42,33 +42,40 @@ export async function updateOrCreateProjectRoundRecord(
     const { totalDonationAmount, totalDonationUsdAmount } =
       await query.getRawOne();
 
-    let record = await ProjectRoundRecord.findOneBy({
-      projectId,
-      qfRoundId: qfRoundId ?? undefined,
-      earlyAccessRoundId: earlyAccessRoundId ?? undefined,
-    });
+    // If a new record was created, result will have one entry; if not, result will be empty
 
-    if (!record) {
-      record = ProjectRoundRecord.create({
-        projectId,
-        qfRoundId,
-        earlyAccessRoundId,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-      });
-    }
-
-    record.totalDonationAmount = totalDonationAmount || 0;
-    record.totalDonationUsdAmount = totalDonationUsdAmount || 0;
-    record.updatedAt = new Date();
-    record.cumulativePastRoundsDonationAmounts =
+    const cumulativePastRoundsDonationAmounts =
       await getCumulativePastRoundsDonationAmounts({
         projectId,
         qfRoundId: qfRoundId || undefined,
         earlyAccessRoundId: earlyAccessRoundId || undefined,
       });
 
-    const prr = await ProjectRoundRecord.save(record);
+    const result = await ProjectRoundRecord.createQueryBuilder(
+      'projectRoundRecord',
+    )
+      .insert()
+      .values({
+        projectId,
+        qfRoundId,
+        earlyAccessRoundId,
+        totalDonationAmount: totalDonationAmount || 0,
+        totalDonationUsdAmount: totalDonationUsdAmount || 0,
+        cumulativePastRoundsDonationAmounts,
+        createdAt: new Date(),
+        updatedAt: new Date(),
+      })
+      .orUpdate(
+        [
+          'totalDonationAmount',
+          'totalDonationUsdAmount',
+          'cumulativePastRoundsDonationAmounts',
+          'updatedAt',
+        ],
+        ['projectId', qfRoundId ? 'qfRoundId' : 'earlyAccessRoundId'],
+      )
+      .execute();
+    const prr = result.raw[0];
 
     logger.info(`ProjectRoundRecord updated for project ${projectId}`);
 

diff --git a/src/repositories/projectUserRecordRepository.test.ts b/src/repositories/projectUserRecordRepository.test.ts
@@ -204,4 +204,48 @@ describe('projectUserRecordRepository', () => {
       ea1DonationAmount + ea2DonationAmount + qfDonationAmount,
     );
   });
+
+  it('should update record if it already exists', async () => {
+    const donationAmount1 = 100;
+    const donationAmount2 = 200;
+
+    await saveDonationDirectlyToDb(
+      {
+        ...createDonationData(),
+        amount: donationAmount1,
+        status: DONATION_STATUS.VERIFIED,
+      },
+      user.id,
+      project.id,
+    );
+
+    let projectUserRecord = await updateOrCreateProjectUserRecord({
+      projectId: project.id,
+      userId: user.id,
+    });
+
+    assert.isOk(projectUserRecord);
+    assert.equal(projectUserRecord.totalDonationAmount, donationAmount1);
+
+    await saveDonationDirectlyToDb(
+      {
+        ...createDonationData(),
+        amount: donationAmount2,
+        status: DONATION_STATUS.VERIFIED,
+      },
+      user.id,
+      project.id,
+    );
+
+    projectUserRecord = await updateOrCreateProjectUserRecord({
+      projectId: project.id,
+      userId: user.id,
+    });
+
+    assert.isOk(projectUserRecord);
+    assert.equal(
+      projectUserRecord.totalDonationAmount,
+      donationAmount1 + donationAmount2,
+    );
+  });
 });
diff --git a/src/repositories/projectUserRecordRepository.ts b/src/repositories/projectUserRecordRepository.ts
@@ -1,4 +1,4 @@
-import { Donation, DONATION_STATUS } from '../entities/donation';
+import { DONATION_STATUS } from '../entities/donation';
 import { ProjectUserRecord } from '../entities/projectUserRecord';
 
 export async function updateOrCreateProjectUserRecord({
@@ -8,42 +8,33 @@ export async function updateOrCreateProjectUserRecord({
   projectId: number;
   userId: number;
 }): Promise<ProjectUserRecord> {
-  const { eaTotalDonationAmount, qfTotalDonationAmount, totalDonationAmount } =
-    await Donation.createQueryBuilder('donation')
-      .select('SUM(donation.amount)', 'totalDonationAmount')
-      // sum eaTotalDonationAmount if earlyAccessRoundId is not null
-      .addSelect(
-        'SUM(CASE WHEN donation.earlyAccessRoundId IS NOT NULL THEN donation.amount ELSE 0 END)',
-        'eaTotalDonationAmount',
-      )
-      .addSelect(
-        'SUM(CASE WHEN donation.qfRoundId IS NOT NULL THEN donation.amount ELSE 0 END)',
-        'qfTotalDonationAmount',
-      )
-      .where('donation.projectId = :projectId', { projectId })
-      .andWhere('donation.status = :status', {
-        status: DONATION_STATUS.VERIFIED,
-      })
-      .andWhere('donation.userId = :userId', { userId })
-      .getRawOne();
+  const query = `
+  INSERT INTO project_user_record ("projectId", "userId", "eaTotalDonationAmount", "qfTotalDonationAmount", "totalDonationAmount")
+  SELECT 
+    $1 AS projectId, 
+    $2 AS userId, 
+    COALESCE(SUM(CASE WHEN donation."earlyAccessRoundId" IS NOT NULL THEN donation.amount ELSE 0 END), 0) AS eaTotalDonationAmount,
+    COALESCE(SUM(CASE WHEN donation."qfRoundId" IS NOT NULL THEN donation.amount ELSE 0 END), 0) AS qfTotalDonationAmount,
+    COALESCE(SUM(donation.amount), 0) AS totalDonationAmount
+  FROM donation
+  WHERE donation."projectId" = $1 
+    AND donation."userId" = $2
+    AND donation.status = $3 
+  ON CONFLICT ("projectId", "userId") DO UPDATE 
+  SET 
+    "eaTotalDonationAmount" = EXCLUDED."eaTotalDonationAmount",
+    "qfTotalDonationAmount" = EXCLUDED."qfTotalDonationAmount",
+    "totalDonationAmount" = EXCLUDED."totalDonationAmount"
+  RETURNING *;
+`;
 
-  let projectUserRecord = await ProjectUserRecord.findOneBy({
+  const result = await ProjectUserRecord.query(query, [
     projectId,
     userId,
-  });
+    DONATION_STATUS.VERIFIED,
+  ]);
 
-  if (!projectUserRecord) {
-    projectUserRecord = ProjectUserRecord.create({
-      projectId,
-      userId,
-    });
-  }
-
-  projectUserRecord.eaTotalDonationAmount = eaTotalDonationAmount || 0;
-  projectUserRecord.qfTotalDonationAmount = qfTotalDonationAmount || 0;
-  projectUserRecord.totalDonationAmount = totalDonationAmount || 0;
-
-  return projectUserRecord.save();
+  return result[0];
 }
 
 export type ProjectUserRecordAmounts = Pick<