Update Challenge API to store challenge winners

Author: ThomasKranitsas

docs/swagger.yaml

@@ -1764,6 +1764,20 @@ definitions:
         type: array
         items:
           type: string
+      winners:
+        type: array
+        items:
+          properties:
+            userId:
+              type: integer
+              description: The user id
+            handle:
+              type: string
+              description: the user handle
+            placement:
+              type: integer
+              description: the winner placement
+              example: 1
       created:
         type: string
         format: date-time
@@ -1973,6 +1987,20 @@ definitions:
         type: array
         items:
           type: string
+      winners:
+        type: array
+        items:
+          properties:
+            userId:
+              type: integer
+              description: The user id
+            handle:
+              type: string
+              description: the user handle
+            placement:
+              type: integer
+              description: the winner placement
+              example: 1
     required:
       - typeId
       - track
@@ -2073,6 +2101,20 @@ definitions:
         type: array
         items:
           type: string
+      winners:
+        type: array
+        items:
+          properties:
+            userId:
+              type: integer
+              description: The user id
+            handle:
+              type: string
+              description: the user handle
+            placement:
+              type: integer
+              description: the winner placement
+              example: 1
       created:
         type: string
         format: date-time

docs/topcoder-challenge-api.postman_collection.json

@@ -501,7 +501,6 @@ function getESClient () {
 }
 
 /**
-<<<<<<< HEAD
  * Ensure project exist
  * @param {String} projectId the project id
  * @param {String} userToken the user token

package-lock.json

@@ -86,6 +86,11 @@ const schema = new Schema({
     type: Array,
     required: false
   },
+  // winners
+  winners: {
+    type: [Object],
+    required: false
+  },
   created: {
     type: Date,
     required: true

src/common/helper.js

@@ -436,6 +436,31 @@ function isDifferentPrizeSets (prizeSets, otherPrizeSets) {
   return false
 }
 
+/**
+ * Validate the winners array.
+ * @param {Array} winners the Winner Array
+ */
+function validateWinners (winners) {
+  for (const winner of winners) {
+    const diffWinners = _.differenceWith(winners, [winner], _.isEqual)
+    if (diffWinners.length + 1 !== winners.length) {
+      throw new errors.BadRequestError(`Duplicate member with placement: ${helper.toString(winner)}`)
+    }
+
+    // find another member with the placement
+    const placementExists = _.find(diffWinners, function (w) { return w.placement === winner.placement })
+    if (placementExists && (placementExists.userId !== winner.userId || placementExists.handle !== winner.handle)) {
+      throw new errors.BadRequestError(`Only one member can have a placement: ${winner.placement}`)
+    }
+
+    // find another placement for a member
+    const memberExists = _.find(diffWinners, function (w) { return w.userId === winner.userId })
+    if (memberExists && memberExists.placement !== winner.placement) {
+      throw new errors.BadRequestError(`The same member ${winner.userId} cannot have multiple placements`)
+    }
+  }
+}
+
 /**
  * Update challenge.
  * @param {Object} currentUser the user who perform operation
@@ -480,10 +505,22 @@ async function update (currentUser, challengeId, data, userToken, isFull) {
   }
 
   await validateChallengeData(data)
+  if ((challenge.status === constants.challengeStatuses.Completed || challenge.status === constants.challengeStatuses.Canceled) && data.status && data.status !== challenge.status) {
+    throw new errors.BadRequestError(`Cannot change ${challenge.status} challenge status to ${data.status} status`)
+  }
+
+  if (data.winners && (challenge.status !== constants.challengeStatuses.Completed && data.status !== constants.challengeStatuses.Completed)) {
+    throw new errors.BadRequestError(`Cannot set winners for challenge with non-completed ${challenge.status} status`)
+  }
+
   if (data.phases) {
     await helper.validatePhases(data.phases)
   }
 
+  if (data.winners && data.winners.length) {
+    await validateWinners(data.winners)
+  }
+
   data.updated = new Date()
   data.updatedBy = currentUser.handle || currentUser.sub
   const updateDetails = {}
@@ -526,6 +563,11 @@ async function update (currentUser, challengeId, data, userToken, isFull) {
         _.intersection(challenge[key], value).length !== value.length) {
         op = '$PUT'
       }
+    } else if (key === 'winners') {
+      if (_.isUndefined(challenge[key]) || challenge[key].length !== value.length ||
+      _.intersectionWith(challenge[key], value, _.isEqual).length !== value.length) {
+        op = '$PUT'
+      }
     } else if (_.isUndefined(challenge[key]) || challenge[key] !== value) {
       op = '$PUT'
     }
@@ -649,6 +691,24 @@ async function update (currentUser, challengeId, data, userToken, isFull) {
     // send null to Elasticsearch to clear the field
     data.legacyId = null
   }
+  if (isFull && _.isUndefined(data.winners) && challenge.winners) {
+    if (!updateDetails['$DELETE']) {
+      updateDetails['$DELETE'] = {}
+    }
+    updateDetails['$DELETE'].winners = null
+    auditLogs.push({
+      id: uuid(),
+      challengeId,
+      fieldName: 'winners',
+      oldValue: JSON.stringify(challenge.winners),
+      newValue: 'NULL',
+      created: new Date(),
+      createdBy: currentUser.handle || currentUser.sub
+    })
+    delete challenge.winners
+    // send null to Elasticsearch to clear the field
+    data.winners = null
+  }
 
   await models.Challenge.update({ id: challengeId }, updateDetails)
   if (auditLogs.length > 0) {
@@ -727,7 +787,12 @@ fullyUpdateChallenge.schema = {
     status: Joi.string().valid(_.values(constants.challengeStatuses)).required(),
     attachmentIds: Joi.array().items(Joi.optionalId()),
     groups: Joi.array().items(Joi.string()), // group names
-    gitRepoURLs: Joi.array().items(Joi.string().uri())
+    gitRepoURLs: Joi.array().items(Joi.string().uri()),
+    winners: Joi.array().items(Joi.object().keys({
+      userId: Joi.number().integer().positive().required(),
+      handle: Joi.string().required(),
+      placement: Joi.number().integer().positive().required()
+    })).min(1)
   }).required(),
   userToken: Joi.any()
 }
@@ -783,7 +848,12 @@ partiallyUpdateChallenge.schema = {
     status: Joi.string().valid(_.values(constants.challengeStatuses)),
     attachmentIds: Joi.array().items(Joi.optionalId()),
     groups: Joi.array().items(Joi.string()), // group names
-    gitRepoURLs: Joi.array().items(Joi.string().uri())
+    gitRepoURLs: Joi.array().items(Joi.string().uri()),
+    winners: Joi.array().items(Joi.object().keys({
+      userId: Joi.number().integer().positive().required(),
+      handle: Joi.string().required(),
+      placement: Joi.number().integer().positive().required()
+    })).min(1)
   }).required(),
   userToken: Joi.any()
 }