Add optional "checkpointWinners" to challenge object

Author: jmgasper

docs/swagger.yaml

@@ -2585,6 +2585,25 @@ definitions:
               minimum: 1
               description: the winner placement
               example: 1
+        required:
+          - userId
+          - handle
+          - placement
+      checkpointWinners:
+        type: array
+        items:
+          properties:
+            userId:
+              type: integer
+              description: The user id
+            handle:
+              type: string
+              description: the user handle
+            placement:
+              type: integer
+              minimum: 1
+              description: the checkpoint winner placement
+              example: 1
           required:
             - userId
             - handle
@@ -3032,6 +3051,25 @@ definitions:
             - userId
             - handle
             - placement
+      checkpointWinners:
+        type: array
+        items:
+          properties:
+            userId:
+              type: integer
+              description: The user id
+            handle:
+              type: string
+              description: the user handle
+            placement:
+              type: integer
+              minimum: 1
+              description: the checkpoint winner placement
+              example: 1
+          required:
+            - userId
+            - handle
+            - placement
       terms:
         type: array
         description: The ids and roleId of the terms of use to add for the challenge
@@ -3229,6 +3267,25 @@ definitions:
             - userId
             - handle
             - placement
+      checkpointWinners:
+        type: array
+        items:
+          properties:
+            userId:
+              type: integer
+              description: The user id
+            handle:
+              type: string
+              description: the user handle
+            placement:
+              type: integer
+              minimum: 1
+              description: the checkpoint winner placement
+              example: 1
+          required:
+            - userId
+            - handle
+            - placement
       terms:
         type: array
         description: The ids and roleId of the terms of use to add for the challenge

src/common/challenge-helper.js

@@ -297,9 +297,11 @@ class ChallengeHelper {
       );
     }
 
+    const hasWinnerUpdates =
+      (Array.isArray(data.winners) && data.winners.length > 0) ||
+      (Array.isArray(data.checkpointWinners) && data.checkpointWinners.length > 0);
     if (
-      data.winners &&
-      data.winners.length > 0 &&
+      hasWinnerUpdates &&
       challenge.status !== ChallengeStatusEnum.COMPLETED &&
       data.status !== ChallengeStatusEnum.COMPLETED
     ) {

src/common/prisma-helper.js

@@ -244,21 +244,36 @@ function convertChallengeSchemaToPrisma(currentUser, challenge) {
       }),
     };
   }
-  // winners
+  const allWinnerEntries = [];
   if (!_.isNil(challenge.winners)) {
+    _.forEach(challenge.winners, (winner) => {
+      const entry = {
+        ...auditFields,
+        ..._.pick(winner, ["userId", "handle", "placement", "type"]),
+      };
+      if (_.isNil(entry.type)) {
+        entry.type = PrizeSetTypeEnum.PLACEMENT;
+      } else {
+        entry.type = entry.type.toUpperCase();
+      }
+      allWinnerEntries.push(entry);
+    });
+  }
+  if (!_.isNil(challenge.checkpointWinners)) {
+    _.forEach(challenge.checkpointWinners, (winner) => {
+      const entry = {
+        ...auditFields,
+        ..._.pick(winner, ["userId", "handle", "placement", "type"]),
+      };
+      entry.type = _.isNil(entry.type)
+        ? PrizeSetTypeEnum.CHECKPOINT
+        : entry.type.toUpperCase();
+      allWinnerEntries.push(entry);
+    });
+  }
+  if (allWinnerEntries.length > 0) {
     result.winners = {
-      create: _.map(challenge.winners, (w) => {
-        const t = {
-          ...auditFields,
-          ..._.pick(w, ["userId", "handle", "placement", "type"]),
-        };
-        if (_.isNil(t.type)) {
-          t.type = PrizeSetTypeEnum.PLACEMENT;
-        } else {
-          t.type = t.type.toUpperCase();
-        }
-        return t;
-      }),
+      create: allWinnerEntries,
     };
   }
   // relations
@@ -357,11 +372,17 @@ function convertModelToResponse(ret) {
   // convert attachments
   ret.attachments = _.map(ret.attachments, (r) => _.omit(r, constants.auditFields, "challengeId"));
   // convert winners
-  ret.winners = _.map(ret.winners, (w) => {
-    const winner = _.pick(w, ["userId", "handle", "placement"]);
-
-    return winner;
-  });
+  const winnersForResponse = ret.winners || [];
+  const winnerGroups = _.groupBy(winnersForResponse, (w) => w.type);
+  const placementWinners = winnerGroups[PrizeSetTypeEnum.PLACEMENT] || [];
+  const checkpointWinners = winnerGroups[PrizeSetTypeEnum.CHECKPOINT] || [];
+  ret.winners = _.map(placementWinners, (w) => _.pick(w, ["userId", "handle", "placement"]));
+  delete ret.checkpointWinners;
+  if (checkpointWinners.length > 0) {
+    ret.checkpointWinners = _.map(checkpointWinners, (w) =>
+      _.pick(w, ["userId", "handle", "placement"])
+    );
+  }
   // convert reviewers
   if (ret.reviewers) {
     ret.reviewers = _.map(ret.reviewers, (rv) =>

src/services/ChallengeService.js

@@ -1098,6 +1098,7 @@ async function searchChallenges(currentUser, criteria) {
   result.forEach((challenge) => {
     if (challenge.status !== ChallengeStatusEnum.COMPLETED) {
       _.unset(challenge, "winners");
+      _.unset(challenge, "checkpointWinners");
     }
     if (!_hasAdminRole && !_.get(currentUser, "isMachine", false)) {
       _.unset(challenge, "payments");
@@ -1769,6 +1770,7 @@ async function getChallenge(currentUser, id, checkIfExists) {
 
   if (challenge.status !== ChallengeStatusEnum.COMPLETED) {
     _.unset(challenge, "winners");
+    _.unset(challenge, "checkpointWinners");
   }
 
   // TODO: in the long run we wanna do a finer grained filtering of the payments
@@ -1855,6 +1857,27 @@ function isDifferentPrizeSets(prizeSets = [], otherPrizeSets = []) {
  * @param {Array} winners the Winner Array
  * @param {Array} challengeResources the challenge resources
  */
+function buildCombinedWinnerPayload(data = {}) {
+  const combined = [];
+  if (Array.isArray(data.winners)) {
+    combined.push(
+      ...data.winners.map((winner) => ({
+        ...winner,
+        type: _.toUpper(winner.type || PrizeSetTypeEnum.PLACEMENT),
+      }))
+    );
+  }
+  if (Array.isArray(data.checkpointWinners)) {
+    combined.push(
+      ...data.checkpointWinners.map((winner) => ({
+        ...winner,
+        type: _.toUpper(winner.type || PrizeSetTypeEnum.CHECKPOINT),
+      }))
+    );
+  }
+  return combined;
+}
+
 async function validateWinners(winners, challengeResources) {
   const registrants = _.filter(challengeResources, (r) => r.roleId === config.SUBMITTER_ROLE_ID);
   for (const prizeType of _.values(PrizeSetTypeEnum)) {
@@ -2381,13 +2404,15 @@ async function updateChallenge(currentUser, challengeId, data, options = {}) {
     }
   }
 
-  if (data.winners && data.winners.length && data.winners.length > 0) {
-    await validateWinners(data.winners, challengeResources);
-    if (_.get(challenge, "legacy.pureV5Task", false)) {
-      _.each(data.winners, (w) => {
-        w.type = PrizeSetTypeEnum.PLACEMENT;
-      });
-    }
+  const combinedWinnerPayload = buildCombinedWinnerPayload(data);
+  if (combinedWinnerPayload.length > 0) {
+    await validateWinners(combinedWinnerPayload, challengeResources);
+  }
+
+  if (_.get(challenge, "legacy.pureV5Task", false) && !_.isUndefined(data.winners)) {
+    _.each(data.winners, (w) => {
+      w.type = PrizeSetTypeEnum.PLACEMENT;
+    });
   }
 
   // Only m2m tokens are allowed to modify the `task.*` information on a challenge
@@ -2876,6 +2901,18 @@ updateChallenge.schema = {
             .unknown(true)
         )
         .optional(),
+      checkpointWinners: Joi.array()
+        .items(
+          Joi.object()
+            .keys({
+              userId: Joi.number().integer().positive().required(),
+              handle: Joi.string().required(),
+              placement: Joi.number().integer().positive().required(),
+              type: Joi.string().valid(_.values(PrizeSetTypeEnum)),
+            })
+            .unknown(true)
+        )
+        .optional(),
       terms: Joi.array().items(
         Joi.object().keys({
           id: Joi.id(),
@@ -3192,6 +3229,11 @@ function sanitizeChallenge(challenge) {
       _.pick(winner, ["userId", "handle", "placement", "type"])
     );
   }
+  if (challenge.checkpointWinners) {
+    sanitized.checkpointWinners = _.map(challenge.checkpointWinners, (winner) =>
+      _.pick(winner, ["userId", "handle", "placement", "type"])
+    );
+  }
   if (challenge.discussions) {
     sanitized.discussions = _.map(challenge.discussions, (discussion) => ({
       ..._.pick(discussion, ["id", "provider", "name", "type", "url", "options"]),