Merge branch 'develop' into master

Author: rakibansary

README.md

@@ -83,7 +83,9 @@ Example:
 - TBD
 
 ## Running tests
+
 - TBD
 
 ## Running tests in CI
+
 - TBD

src/controllers/syncController.js

@@ -69,6 +69,7 @@ async function autoQueueChallenges () {
  * @param {Object} filter {startDate, endDate, legacyId, status}
  */
 async function queueChallenges (filter) {
+  logger.debug(`Inside queueChallenges with filter: ${JSON.stringify(filter)}`)
   // find challenges in es status
   let page = 1
   const perPage = 50

src/models/audit-log.js

@@ -0,0 +1,48 @@
+/**
+ * This defines AuditLog model.
+ */
+
+ const dynamoose = require('dynamoose')
+
+ const Schema = dynamoose.Schema
+ 
+ const schema = new Schema({
+   id: {
+     type: String,
+     hashKey: true,
+     required: true
+   },
+   challengeId: {
+     type: String,
+     required: true
+   },
+   fieldName: {
+     type: String,
+     required: true
+   },
+   oldValue: {
+     type: String,
+     required: true
+   },
+   newValue: {
+     type: String,
+     required: true
+   },
+   created: {
+     type: Date,
+     required: true
+   },
+   createdBy: {
+     type: String,
+     required: true
+   },
+   memberId: {
+     type: String
+   }
+ },
+ {
+   throughput: { read: 4, write: 2 }
+ })
+ 
+ module.exports = schema
+ 

src/models/index.js

@@ -34,5 +34,6 @@ module.exports = {
   Challenge: dynamoose.model('Challenge', require('./challenge')),
   ChallengeType: dynamoose.model('ChallengeType', require('./challenge-type')),
   ChallengeTrack: dynamoose.model('ChallengeTrack', require('./challenge-track')),
-  ChallengeTimelineTemplate: dynamoose.model('ChallengeTimelineTemplate', require('./challenge-timeline-template'))
+  ChallengeTimelineTemplate: dynamoose.model('ChallengeTimelineTemplate', require('./challenge-timeline-template')),
+  AuditLog: dynamoose.model('AuditLog', require('./audit-log'))
 }

src/services/challengeService.js

@@ -8,7 +8,7 @@ const _ = require('lodash')
 const HashMap = require('hashmap')
 const logger = require('../util/logger')
 const helper = require('../util/helper')
-const { Challenge, ChallengeType, ChallengeTimelineTemplate } = require('../models')
+const { Challenge, ChallengeType, ChallengeTimelineTemplate, AuditLog } = require('../models')
 const { getESClient, getV4ESClient, getM2MToken, forceV4ESFeeder } = require('../util/helper')
 const challengeInformixService = require('./challengeInformixService')
 const resourceService = require('./resourceService')
@@ -34,17 +34,25 @@ const challengePropertiesToOmitFromDynamo = [
   'track'
 ]
 
+/**
+ * Check whether given two PrizeSet Array are different.
+ * @param {Array} prizeSets the first PrizeSet Array
+ * @param {Array} otherPrizeSets the second PrizeSet Array
+ * @returns {Boolean} true if different, false otherwise
+ */
+ function isDifferentPrizeSets (prizeSets = [], otherPrizeSets = []) {
+  return !_.isEqual(_.sortBy(prizeSets, 'type'), _.sortBy(otherPrizeSets, 'type'))
+}
+
 async function save (challenge) {
   // Check if challenge is already created
+  let challengesInES
   if (!challenge.id) {
     try {
-      const challengesInES = await getChallengeFromES(challenge.legacyId)
-      if (challengesInES.length === 1) {
-        logger.info(`PREVENT DUPLICATE CHALLENGE - ${challenge.legacyId} - V5 already exists ${challengesInES[0].challengeId}`)
-        challenge.id = challengesInES[0].challengeId
-      } else if (challengesInES.length > 1) {
-        // There are more than 1 duplicate challenges
-        logger.warn(`Duplicate challenge found for legacy ID ${challenge.legacyId} has ${challengesInES.length} duplicates - ${challengesInES.toString()}`)
+      challengesInES = await getChallengeFromES(challenge.legacyId, true)
+      if (challengesInES.length > 0) {
+        logger.debug(`PREVENT DUPLICATE CHALLENGE - ${challenge.legacyId} - V5 already exists ${challengesInES[0].id}`)
+        challenge.id = challengesInES[0].id
       }
     } catch (e) {
       logger.error(`Error fetching V5 challenge ${JSON.stringify(e)}`)
@@ -54,7 +62,7 @@ async function save (challenge) {
   if (challenge.id) {
     // logger.debug(`Update Challenge ${challenge.id}`)
     // return
-    return updateChallenge(challenge)
+    return updateChallenge(challenge, challengesInES && challengesInES.length ? challengesInES[0] : null)
   }
   // logger.debug(`Create Challenge ${challenge.id}`)
   // return
@@ -91,14 +99,119 @@ async function createChallenge (challenge) {
  * Update challenge data to new system
  * @param {Object} challenge challenge data
  */
-async function updateChallenge (challenge) {
+async function updateChallenge (challenge, previousState) {
+  if (!previousState) {
+    challengesInES = await getChallengeFromES(challenge.legacyId, true)
+    previousState = challengesInES[0]
+  }
+  const auditLogs = []
+
   try {
     if (challenge.task && _.isUndefined(challenge.task.memberId) && (challenge.status === constants.challengeStatuses.Completed || _.get(challenge, 'winners.length') > 0)) {
       _.unset(challenge, 'task')
     }
     const updateChallenge = new Challenge(_.omit(challenge, ['created', 'createdBy', 'name']))
     // numOfSubmissions and numOfRegistrants are not stored in dynamo, they're calclated by the ES processor
     await Challenge.update({ id: challenge.id }, _.omit(updateChallenge, challengePropertiesToOmitFromDynamo))
+
+    const updateDetails = {}
+    let phasesHaveBeenModified = false
+    _.each(updateChallenge, (value, key) => {
+      let op
+      if (key === 'metadata') {
+        if (_.isUndefined(previousState[key]) || previousState[key].length !== value.length ||
+          _.differenceWith(previousState[key], value, _.isEqual).length !== 0) {
+          op = '$PUT'
+        }
+      } else if (key === 'phases') {
+        // always consider a modification if the property exists
+        phasesHaveBeenModified = true
+        op = '$PUT'
+      } else if (key === 'prizeSets') {
+        if (isDifferentPrizeSets(previousState[key], value)) {
+          op = '$PUT'
+        }
+      } else if (key === 'tags') {
+        if (_.isUndefined(previousState[key]) || previousState[key].length !== value.length ||
+          _.intersection(previousState[key], value).length !== value.length) {
+          op = '$PUT'
+        }
+      } else if (key === 'attachments') {
+        const oldIds = _.map(previousState.attachments || [], (a) => a.id)
+        if (oldIds.length !== value.length ||
+          _.intersection(oldIds, _.map(value, a => a.id)).length !== value.length) {
+          op = '$PUT'
+        }
+      } else if (key === 'groups') {
+        if (_.isUndefined(previousState[key]) || previousState[key].length !== value.length ||
+          _.intersection(previousState[key], value).length !== value.length) {
+          op = '$PUT'
+        }
+      } else if (key === 'winners') {
+        if (_.isUndefined(previousState[key]) || previousState[key].length !== value.length ||
+        _.intersectionWith(previousState[key], value, _.isEqual).length !== value.length) {
+          op = '$PUT'
+        }
+      } else if (key === 'terms') {
+        const oldIds = _.map(previousState.terms || [], (t) => t.id)
+        const newIds = _.map(value || [], (t) => t.id)
+        if (oldIds.length !== newIds.length ||
+          _.intersection(oldIds, newIds).length !== value.length) {
+          op = '$PUT'
+        }
+      } else if (key === 'billing' || key === 'legacy') {
+        // make sure that's always being udpated
+        op = '$PUT'
+      } else if (_.isUndefined(previousState[key]) || previousState[key] !== value) {
+        op = '$PUT'
+      } else if (_.get(previousState, 'legacy.pureV5Task') && key === 'task') {
+        // always update task for pureV5 challenges
+        op = '$PUT'
+      }
+  
+      if (op) {
+        if (_.isUndefined(updateDetails[op])) {
+          updateDetails[op] = {}
+        }
+        if (key === 'attachments') {
+          updateDetails[op].attachments = updateChallenge.attachments
+        } else if (key === 'terms') {
+          updateDetails[op].terms = updateChallenge.terms
+        } else {
+          updateDetails[op][key] = value
+        }
+        if (key !== 'updated' && key !== 'updatedBy') {
+          let oldValue
+          let newValue
+          if (key === 'attachments') {
+            oldValue = previousState.attachments ? JSON.stringify(previousState.attachments) : 'NULL'
+            newValue = JSON.stringify(updateChallenge.attachments)
+          } else if (key === 'terms') {
+            oldValue = previousState.terms ? JSON.stringify(previousState.terms) : 'NULL'
+            newValue = JSON.stringify(updateChallenge.terms)
+          } else {
+            oldValue = previousState[key] ? JSON.stringify(previousState[key]) : 'NULL'
+            newValue = JSON.stringify(value)
+          }
+          // logger.debug(`Audit Log: Key ${key} OldValue: ${oldValue} NewValue: ${newValue}`)
+          auditLogs.push({
+            id: uuid(),
+            challengeId: challenge.id,
+            fieldName: key,
+            oldValue,
+            newValue,
+            created: moment().utc(),
+            createdBy: 'v5migration',
+            memberId: null
+          })
+        }
+      }
+    })
+
+    if (auditLogs.length > 0) {
+      // insert audit logs
+      await AuditLog.batchPut(auditLogs)
+    }
     await getESClient().update({
       index: config.get('ES.CHALLENGE_ES_INDEX'),
       type: config.get('ES.CHALLENGE_ES_TYPE'),
@@ -195,7 +308,7 @@ async function getChallengesFromES (legacyIds) {
 /**
  * Get existing challenges from ES using legacyId
  */
-async function getChallengeFromES (legacyId) {
+async function getChallengeFromES (legacyId, full) {
   const esQuery = {
     index: config.get('ES.CHALLENGE_ES_INDEX'),
     type: config.get('ES.CHALLENGE_ES_TYPE'),
@@ -228,7 +341,7 @@ async function getChallengeFromES (legacyId) {
     }
   }
   // Extract data from hits
-  return _.map(docs.hits.hits, item => ({
+  return full ? _.map(docs.hits.hits, item => item._source) : _.map(docs.hits.hits, item => ({
     legacyId: item._source.legacyId,
     legacy: {
       screeningScorecardId: _.get(item._source, 'legacy.screeningScorecardId'),