Merge pull request #38 from topcoder-platform/feature/misc-fixes

Add support for overview.totalPrizes

Author: rootelement

README.md

@@ -64,6 +64,16 @@ npm i
 - Inside the docker container, start the express server: `npm start`
 
 ## Migrations
+### For local migrations
+There are two parts need to be updated for local migrations,
+- `./src/models/challenge.js`
+`throughput: 'ON_DEMAND',` should be updated to `throughput:{ read: 4, write: 2 },`
+- `./config/default.js`
+Two aws config should be uncommented
+
+and env variable `IS_LOCAL_DB` should be set to true before you continue to the next steps.
+
+### Run a migration
 - To run a migration, the command should be:
 `MIGRATION=<name-of-migration-file> nf run npm run migrate`
 Example: 
@@ -76,4 +86,4 @@ Example:
 - TBD
 
 ## Running tests in CI
-- TBD
+- TBD

config/default.js

@@ -56,8 +56,8 @@ module.exports = {
 
   AMAZON: {
     // Uncomment for local deployment
-    // AWS_ACCESS_KEY_ID: process.env.AWS_FAKE_ID,
-    // AWS_SECRET_ACCESS_KEY: process.env.AWS_FAKE_KEY,
+    // AWS_ACCESS_KEY_ID: process.env.AWS_FAKE_ID || 'FAKE_ACCESS_KEY',
+    // AWS_SECRET_ACCESS_KEY: process.env.AWS_FAKE_KEY || 'FAKE_SECRET_ACCESS_KEY',
     AWS_REGION: process.env.AWS_REGION || 'ap-northeast-1', // aws region
     IS_LOCAL_DB: process.env.IS_LOCAL_DB ? process.env.IS_LOCAL_DB === 'true' : false, // true or uninitialize if we use local instance
     DYNAMODB_URL: process.env.DYNAMODB_URL || 'http://localhost:8000', // just for local development

src/constants.js

@@ -0,0 +1,14 @@
+/**
+ * App constants
+ */
+
+const prizeSetTypes = {
+  ChallengePrizes: 'placement',
+  CopilotPayment: 'copilot',
+  ReviewerPayment: 'reviewer',
+  CheckpointPrizes: 'checkpoint'
+}
+
+module.exports = {
+  prizeSetTypes
+}

src/models/challenge.js

@@ -108,6 +108,10 @@ const schema = new Schema({
     type: Array,
     required: false
   },
+  overview: {
+    type: Object,
+    required: false
+  },
   created: {
     type: Date,
     required: true

src/scripts/migrations/009-add-overview-totalPrizes.js

@@ -0,0 +1,82 @@
+/**
+ * Populate the following properties on the challenges:
+ * - overview.totalPrizes
+ */
+global.Promise = require('bluebird')
+
+const config = require('config')
+const _ = require('lodash')
+const logger = require('../../util/logger')
+const helper = require('../../util/helper')
+const constants = require('../../constants')
+const challengeService = require('../../services/challengeService')
+const { getESClient } = require('../../util/helper')
+
+const migrationFunction = {
+  run: async () => {
+    const perPage = config.get('MIGRATION_SCRIPT_BATCH_SIZE')
+    let finish = false
+    let page = 0
+    let batch = 1
+
+    while (!finish) {
+      logger.info(`Batch-${batch} - Loading challenges`)
+      const challenges = await getChallengesMissingData(page, perPage)
+      logger.info(`Found ${challenges.length} challenges`)
+      if (challenges.length > 0) {
+        for (const challenge of challenges) {
+          if (challenge.prizeSets) {
+            const prizeSetsGroup = _.groupBy(challenge.prizeSets, 'type')
+            if (prizeSetsGroup[constants.prizeSetTypes.ChallengePrizes]) {
+              const totalPrizes = helper.sumOfPrizes(prizeSetsGroup[constants.prizeSetTypes.ChallengePrizes][0].prizes)
+              _.set(challenge, 'overview.totalPrizes', totalPrizes)
+              await challengeService.save(challenge)
+            }
+          }
+        }
+      } else {
+        finish = true
+      }
+      page++
+      batch++
+    }
+  }
+}
+
+async function getChallengesMissingData (page = 0, perPage = 10) {
+  const esQuery = {
+    index: config.get('ES.CHALLENGE_ES_INDEX'),
+    type: config.get('ES.CHALLENGE_ES_TYPE'),
+    size: perPage,
+    from: page * perPage,
+    body: {
+      query: {
+        bool: {
+          must_not: {
+            exists: {
+              field: 'overview.totalPrizes'
+            }
+          }
+        }
+      }
+    }
+  }
+  // logger.debug(`ES Query ${JSON.stringify(esQuery)}`)
+  // Search with constructed query
+  let docs
+  try {
+    docs = await getESClient().search(esQuery)
+  } catch (e) {
+    // Catch error when the ES is fresh and has no data
+    docs = {
+      hits: {
+        total: 0,
+        hits: []
+      }
+    }
+  }
+  // Extract data from hits
+  return _.map(docs.hits.hits, item => (item._source))
+}
+
+module.exports = migrationFunction

src/services/challengeService.js

@@ -16,6 +16,7 @@ const resourceInformixService = require('./resourceInformixService')
 const translationService = require('./translationService')
 const { V4_TRACKS } = require('../util/conversionMappings')
 const { getCopilotPaymentFromIfx } = require('./challengeInformixService')
+const constants = require('../constants')
 
 let allV5Terms
 
@@ -760,7 +761,11 @@ async function buildV5Challenge (legacyId, challengeListing, challengeDetails) {
   }
 
   // console.log(JSON.stringify(metadata))
-
+  const prizeSetsGroup = _.groupBy(prizeSets, 'type')
+  if (prizeSetsGroup[constants.prizeSetTypes.ChallengePrizes]) {
+    const totalPrizes = helper.sumOfPrizes(prizeSetsGroup[constants.prizeSetTypes.ChallengePrizes][0].prizes)
+    _.set(newChallenge, 'overview.totalPrizes', totalPrizes)
+  }
   return _.assign(newChallenge, { prizeSets, tags, groups, winners, phases, metadata, terms, events })
 }
 

src/util/helper.js

@@ -239,6 +239,23 @@ function setResHeaders (req, res, result) {
   }
 }
 
+/**
+ * Calculate the sum of prizes.
+ *
+ * @param {Array} prizes the list of prize
+ * @returns {Object} the result prize
+ */
+function sumOfPrizes (prizes) {
+  let sum = 0
+  if (!prizes.length) {
+    return sum
+  }
+  for (const prize of prizes) {
+    sum += prize.value
+  }
+  return sum
+}
+
 module.exports = {
   forceV4ESFeeder,
   wrapExpress,
@@ -249,5 +266,6 @@ module.exports = {
   scanDynamoModelByProperty,
   generateInformxDate,
   getM2MToken,
-  setResHeaders
+  setResHeaders,
+  sumOfPrizes
 }