Better handling of draft challenges and locking

Author: jmgasper

src/services/ChallengeService.js

@@ -105,12 +105,50 @@ function isChallengeBillingLockStatus(status) {
 }
 
 /**
- * Reads the currently persisted challenge prize total.
+ * Calculates the billable USD prize-set total for a challenge.
  *
  * @param {object} challenge Challenge model or response object.
- * @returns {number|undefined} Total member-payment amount before markup.
+ * @returns {number|undefined} USD prize-set member-payment amount before markup,
+ * or `undefined` when prize sets are not loaded.
+ */
+function getChallengePrizeSetMemberPaymentAmount(challenge) {
+  const prizeSets = _.get(challenge, "prizeSets");
+
+  if (!Array.isArray(prizeSets)) {
+    return undefined;
+  }
+
+  return prizeSets.reduce((total, prizeSet) => {
+    const prizes = Array.isArray(prizeSet && prizeSet.prizes) ? prizeSet.prizes : [];
+
+    return (
+      total +
+      prizes.reduce((prizeTotal, prize) => {
+        if (_.toString(_.get(prize, "type")).toUpperCase() !== constants.prizeTypes.USD) {
+          return prizeTotal;
+        }
+
+        const prizeValue = _.toNumber(_.get(prize, "value"));
+
+        return Number.isFinite(prizeValue) ? prizeTotal + prizeValue : prizeTotal;
+      }, 0)
+    );
+  }, 0);
+}
+
+/**
+ * Reads the currently persisted challenge member-payment total.
+ *
+ * @param {object} challenge Challenge model or response object.
+ * @returns {number|undefined} Total USD member-payment amount before markup.
  */
 function getChallengeMemberPaymentAmount(challenge) {
+  const prizeSetMemberPaymentAmount = getChallengePrizeSetMemberPaymentAmount(challenge);
+
+  if (!_.isNil(prizeSetMemberPaymentAmount)) {
+    return prizeSetMemberPaymentAmount;
+  }
+
   const totalPrizes = _.get(
     challenge,
     "overview.totalPrizes",
@@ -2916,14 +2954,17 @@ async function updateChallenge(currentUser, challengeId, data, options = {}) {
       })`,
     );
 
-    if (billingAccountId && _.isUndefined(_.get(challenge, "billing.billingAccountId"))) {
-      // Ensure billingAccountId is a string or null to match Prisma schema
-      if (billingAccountId !== null && billingAccountId !== undefined) {
-        _.set(data, "billing.billingAccountId", String(billingAccountId));
-      } else {
-        _.set(data, "billing.billingAccountId", null);
-      }
-      _.set(data, "billing.markup", _.isNil(markup) ? 0 : markup);
+    const existingBillingAccountId = normalizeOptionalString(
+      _.get(challenge, "billing.billingAccountId"),
+    );
+    const projectBillingAccountId = normalizeOptionalString(billingAccountId);
+    if (projectBillingAccountId && !existingBillingAccountId) {
+      data.billing = {
+        ..._.get(challenge, "billing", {}),
+        ..._.get(data, "billing", {}),
+        billingAccountId: projectBillingAccountId,
+        markup: _.isNil(markup) ? 0 : markup,
+      };
     }
 
     // Make sure the user cannot change the direct project ID
@@ -4300,7 +4341,11 @@ function sanitizeChallenge(challenge) {
     ]);
   }
   if (challenge.billing) {
-    sanitized.billing = _.pick(challenge.billing, ["billingAccountId", "markup"]);
+    sanitized.billing = _.pick(challenge.billing, [
+      "billingAccountId",
+      "markup",
+      "clientBillingRate",
+    ]);
   }
   if (challenge.metadata) {
     sanitized.metadata = _.map(challenge.metadata, (meta) => _.pick(meta, ["name", "value"]));

test/unit/ChallengeService.test.js

@@ -608,7 +608,10 @@ describe("challenge service unit tests", () => {
           createdChallengeData.id,
         );
 
-        should.equal(result.billing.billingAccountId, createdChallengeData.billing.billingAccountId);
+        should.equal(
+          result.billing.billingAccountId,
+          createdChallengeData.billing.billingAccountId,
+        );
         should.equal(_.isUndefined(result.billing.markup), true);
       } finally {
         helper.userHasProjectWriteAccess = originalUserHasProjectWriteAccess;
@@ -1656,6 +1659,118 @@ describe("challenge service unit tests", () => {
       should.equal(testHelper.getDatesDiff(result.startDate, testChallengeData.startDate), 0);
     });
 
+    it("backfills missing billing and locks draft budget including copilot prizes", async () => {
+      const challengeData = _.cloneDeep(testChallengeData);
+      challengeData.name = `${challengeData.name} Billing Lock ${Date.now()}`;
+      challengeData.legacyId = Math.floor(Math.random() * 1000000);
+      challengeData.status = ChallengeStatusEnum.NEW;
+      challengeData.prizeSets = [
+        {
+          type: PrizeSetTypeEnum.PLACEMENT,
+          description: "placement prizes",
+          prizes: [
+            {
+              description: "placement 1",
+              type: constants.prizeTypes.USD,
+              value: 1000,
+            },
+          ],
+        },
+        {
+          type: PrizeSetTypeEnum.COPILOT,
+          description: "copilot payment",
+          prizes: [
+            {
+              description: "copilot",
+              type: constants.prizeTypes.USD,
+              value: 150,
+            },
+          ],
+        },
+      ];
+
+      const originalGetProject = projectHelper.getProject;
+      const originalGetProjectBillingInformation = projectHelper.getProjectBillingInformation;
+      let billingLookupCount = 0;
+      let createdChallengeId;
+
+      projectHelper.getProject = async () => ({ directProjectId: "33541" });
+      projectHelper.getProjectBillingInformation = async () => {
+        billingLookupCount += 1;
+
+        if (billingLookupCount === 1) {
+          return {
+            billingAccountId: null,
+            markup: null,
+          };
+        }
+
+        return {
+          billingAccountId: "80001012",
+          markup: 0.1,
+        };
+      };
+
+      try {
+        const created = await service.createChallenge(
+          { isMachine: true, sub: "sub-billing-lock-create", userId: "testuser" },
+          challengeData,
+          config.M2M_FULL_ACCESS_TOKEN,
+        );
+        createdChallengeId = created.id;
+        should.equal(billingLockRequests.length, 0);
+
+        const draft = await service.updateChallenge(
+          { isMachine: true, sub: "sub-billing-lock-update", userId: 22838965 },
+          created.id,
+          {
+            status: ChallengeStatusEnum.DRAFT,
+          },
+        );
+
+        should.equal(draft.billing.billingAccountId, "80001012");
+        should.equal(billingLockRequests.length, 1);
+        billingLockRequests[0].should.deep.equal({
+          billingAccountId: "80001012",
+          challengeId: created.id,
+          markup: 0.1,
+          memberPaymentAmount: 1150,
+        });
+
+        const updatedPrizeSets = _.cloneDeep(draft.prizeSets);
+        const copilotPrizeSet = _.find(
+          updatedPrizeSets,
+          (prizeSet) => _.toString(prizeSet.type).toUpperCase() === PrizeSetTypeEnum.COPILOT,
+        );
+        should.exist(copilotPrizeSet);
+        copilotPrizeSet.prizes[0].value = 225;
+        billingLockRequests = [];
+
+        await service.updateChallenge(
+          { isMachine: true, sub: "sub-billing-lock-prize-update", userId: 22838965 },
+          created.id,
+          {
+            prizeSets: updatedPrizeSets,
+          },
+        );
+
+        should.equal(billingLockRequests.length, 1);
+        billingLockRequests[0].should.deep.equal({
+          billingAccountId: "80001012",
+          challengeId: created.id,
+          markup: 0.1,
+          memberPaymentAmount: 1225,
+        });
+      } finally {
+        projectHelper.getProject = originalGetProject;
+        projectHelper.getProjectBillingInformation = originalGetProjectBillingInformation;
+
+        if (createdChallengeId) {
+          await prisma.challenge.deleteMany({ where: { id: createdChallengeId } });
+        }
+      }
+    }).timeout(10000);
+
     it("preserves existing terms when update payload omits the terms field", async () => {
       const challengeData = _.cloneDeep(testChallengeData);
       challengeData.name = `${challengeData.name} Terms ${Date.now()}`;