Merge pull request #37 from topcoder-platform/copilot-payments

add support for copilot payment in ifx

Author: rootelement

config/default.js

@@ -225,5 +225,7 @@ module.exports = {
       WRITE: process.env.SCOPE_CHALLENGES_WRITE || 'write:challenges',
       ALL: process.env.SCOPE_CHALLENGES_ALL || 'all:challenges'
     }
-  }
+  },
+
+  COPILOT_PAYMENT_TYPE: process.env.COPILOT_PAYMENT_TYPE || 'copilot'
 }

src/scripts/migrations/008-fix-copilot-payments.js

@@ -0,0 +1,91 @@
+/**
+ * Fix the copilot payments on legacy:
+ */
+global.Promise = require('bluebird')
+
+const config = require('config')
+const _ = require('lodash')
+const logger = require('../../util/logger')
+const challengeIfxService = require('../../services/challengeInformixService')
+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) {
+          const copilotPayment = _.get(_.find(_.get(challenge, 'prizeSets', []), p => p.type === config.COPILOT_PAYMENT_TYPE), 'prizes[0].value', null)
+          const legacyId = _.get(challenge, 'legacyId')
+          const existing = await challengeIfxService.getCopilotPaymentFromIfx(legacyId)
+          if (existing) {
+            if (!copilotPayment) {
+              await challengeIfxService.deleteCopilotPaymentFromIfx(legacyId)
+            } else if (_.toString(existing.value) !== _.toString(copilotPayment)) {
+              await challengeIfxService.updateCopilotPaymentInIfx(legacyId, copilotPayment, challenge.updatedBy)
+            }
+          } else {
+            await challengeIfxService.createCopilotPaymentInIfx(legacyId, copilotPayment, challenge.createdBy)
+          }
+          challenge.legacy.migration = 8
+          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: {
+            exists: {
+              field: 'prizeSets'
+            }
+          },
+          must_not: {
+            match_phrase: {
+              'legacy.migration': 8
+            }
+          }
+        }
+      }
+    }
+  }
+  // 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/challengeInformixService.js

@@ -3,6 +3,59 @@ const logger = require('../util/logger')
 const helper = require('../util/helper')
 // const getErrorService = require('./errorService')
 const { executeQueryAsync } = require('../util/informixWrapper')
+
+/**
+ * Gets the copilot payment for a legacyId
+ * @param {Number} legacyId the legacy ID
+ */
+async function getCopilotPaymentFromIfx (legacyId) {
+  const sql = `SELECT limit 1 * FROM project_info WHERE project_info_type_id = 49 AND project_id = ${legacyId}`
+  return execQuery(sql)
+}
+
+/**
+ * Create the copilot payment record
+ * @param {Number} legacyId the legacy challenge id
+ * @param {Number} amount the $ amount of the copilot payment
+ * @param {String} createdBy the create user handle
+ */
+async function createCopilotPaymentInIfx (legacyId, amount, createdBy) {
+  const sql = `
+    INSERT INTO project_info
+      (
+        project_id,
+        project_info_type_id,
+        value,
+        create_user,
+        create_date,
+        modify_user,
+        modify_date
+      )
+    VALUES
+      (${legacyId}, 49, ${amount}, ${createdBy}, CURRENT, ${createdBy}, CURRENT)`
+  return execQuery(sql)
+}
+
+/**
+ * Update the existing copilot payment for a legacyId
+ * @param {Number} legacyId the legacy challenge id
+ * @param {Number} newValue the new value
+ * @param {String} updatedBy the update user handle
+ */
+async function updateCopilotPaymentInIfx (legacyId, newValue, updatedBy) {
+  const sql = `UPDATE project_info SET value = ${newValue}, modify_user = ${updatedBy}, modify_date = CURRENT WHERE project_info_type_id = 49 AND project_id = ${legacyId}`
+  return execQuery(sql)
+}
+
+/**
+ * Delete the existing copilot payment for a legacyId
+ * @param {Number} legacyId the legacy challenge id
+ */
+async function deleteCopilotPaymentFromIfx (legacyId) {
+  const sql = `DELETE FROM project_info WHERE project_info_type_id = 49 AND project_id = ${legacyId}`
+  return execQuery(sql)
+}
+
 /**
  * Get challenge scorecard information from informix
  * @param {Object} filter {id, ids}
@@ -623,5 +676,9 @@ module.exports = {
   getPhaseFromIfx,
   getTermsFromIfx,
   getChallengeSubmissions,
-  getChallengeRegistrants
+  getChallengeRegistrants,
+  getCopilotPaymentFromIfx,
+  createCopilotPaymentInIfx,
+  updateCopilotPaymentInIfx,
+  deleteCopilotPaymentFromIfx
 }

src/services/syncService.js

@@ -6,6 +6,7 @@ const resourceService = require('./resourceService')
 const challengeSyncStatusService = require('../services/challengeSyncStatusService')
 const challengeMigrationStatusService = require('../services/challengeMigrationStatusService')
 const migrationService = require('../services/migrationService')
+const challengeIfxService = require('../services/challengeInformixService')
 const { V4_TRACKS } = require('../util/conversionMappings')
 
 async function syncLegacyId (legacyId, force) {
@@ -89,12 +90,25 @@ async function processChallenge (legacyId, challengeListing, challengeDetails) {
   logger.debug(`v4 prizes: ${JSON.stringify(challengeV4Prizes)}`)
   const challengeV5APIPrizes = _.get(v5ChallengeFromAPI, 'prizeSets', [])
   logger.debug(`v5 prizes: ${JSON.stringify(challengeV5APIPrizes)}`)
-  const prizeSets = [
+  const prizeSets = _.filter([
     ..._.intersectionBy(challengeV4Prizes, challengeV5APIPrizes, 'type'),
     ..._.differenceBy(challengeV5APIPrizes, challengeV4Prizes, 'type')
-  ]
+  ], entry => entry.type !== config.COPILOT_PAYMENT_TYPE)
   logger.debug(`intersection: ${JSON.stringify(prizeSets)}`)
 
+  const copilotPayment = await challengeIfxService.getCopilotPaymentFromIfx(legacyId)
+  if (copilotPayment) {
+    prizeSets.push({
+      prizes: [
+        {
+          type: 'USD',
+          value: copilotPayment.value
+        }
+      ],
+      type: config.COPILOT_PAYMENT_TYPE
+    })
+  }
+
   const updatedV5Object = {
     ..._.omit(v5ChallengeFromAPI, ['prizeSets']),
     ..._.omit(v5ChallengeObjectFromV4, ommittedFields),