Merge branch 'develop'

Author: rootelement

ReadMe.md

@@ -45,10 +45,13 @@ The following parameters can be set in config files or in env variables:
 - AUTH0_CLIENT_SECRET: Auth0 client secret, used to get TC M2M token
 - AUTH0_PROXY_SERVER_URL: Proxy Auth0 URL, used to get TC M2M token
 - V5_CHALLENGE_API_URL: v5 challenge api url, default value is 'http://localhost:4000/v5/challenges'
-- V5_CHALLENGE_TYPE_API_URL: v5 challenge type api url, default value is 'http://localhost:4000/v5/challengeTypes'
+- V5_CHALLENGE_TYPE_API_URL: v5 challenge type api url, default value is 'http://localhost:4000/v5/challenge-types'
 - V4_CHALLENGE_API_URL: v4 challenge api url, default value is 'http://localhost:4000/v4/challenges'
 - V4_TECHNOLOGIES_API_URL: v4 technologies api url, default value is 'http://localhost:4000/v4/technologies'
 - V4_PLATFORMS_API_URL: v4 platforms api url, default value is 'http://localhost:4000/v4/platforms'
+- TASK_TYPE_ID: The v5 Type ID for tasks
+- CHALLENGE_TYPE_ID: The v5 Type ID for regular challenges
+- FIRST_2_FINISH_TYPE_ID: The v5 Type ID for F2F challenges
 
 There is a `/health` endpoint that checks for the health of the app. This sets up an expressjs server and listens on the environment variable `PORT`. It's not part of the configuration file and needs to be passed as an environment variable
 
@@ -142,7 +145,7 @@ Please see that 192.168.1.3 is the IP of host machine for docker where we run al
 ```
 KAFKA_URL=192.168.1.3:9092
 V5_CHALLENGE_API_URL=http://192.168.1.3:4000/v5/challenges
-V5_CHALLENGE_TYPE_API_URL=http://192.168.1.3:4000/v5/challengeTypes
+V5_CHALLENGE_TYPE_API_URL=http://192.168.1.3:4000/v5/challenge-types
 V4_CHALLENGE_API_URL=http://192.168.1.3:4000/v4/challenges
 V4_TECHNOLOGIES_API_URL=http://192.168.1.3:4000/v4/technologies
 V4_PLATFORMS_API_URL=http://192.168.1.3:4000/v4/platforms

Verification.md

@@ -69,7 +69,7 @@ debug: Successfully processed message
 4. Check the mock-api logs:
 
 ```sql
-debug: GET /v5/challengeTypes/0b2ac310-eaf0-40e3-b66b-37e5e9e09365
+debug: GET /v5/challenge-types/0b2ac310-eaf0-40e3-b66b-37e5e9e09365
 debug: GET /v4/technologies
 debug: GET /v4/platforms
 debug: POST /v4/challenges
@@ -152,7 +152,7 @@ debug: Successfully processed message
 8. Watch the logs of mock-api :
 
 ```bash
-debug: GET /v5/challengeTypes/d0f8ad73-d9c6-4dbc-b213-e643f43d28e7
+debug: GET /v5/challenge-types/d0f8ad73-d9c6-4dbc-b213-e643f43d28e7
 debug: GET /v4/technologies
 debug: GET /v4/platforms
 debug: GET /v4/challenges/30055016

config/default.js

@@ -43,6 +43,8 @@ module.exports = {
   SUBMISSION_PHASE_ID: process.env.SUBMISSION_PHASE_ID || '6950164f-3c5e-4bdc-abc8-22aaf5a1bd49',
   CHECKPOINT_SUBMISSION_PHASE_ID: process.env.CHECKPOINT_SUBMISSION_PHASE_ID || 'd8a2cdbe-84d1-4687-ab75-78a6a7efdcc8',
 
-  // Challenge Type IDs
-  TASK_TYPE_ID: process.env.TASK_TYPE_ID || 'e885273d-aeda-42c0-917d-bfbf979afbba'
+  // challenge types
+  TASK_TYPE_ID: process.env.TASK_TYPE_ID || 'e885273d-aeda-42c0-917d-bfbf979afbba',
+  CHALLENGE_TYPE_ID: process.env.CHALLENGE_TYPE_ID || '94eee466-9255-4b60-88d8-4f59c1810dd0',
+  FIRST_2_FINISH_TYPE_ID: process.env.FIRST_2_FINISH_TYPE_ID || '6950164f-3c5e-4bdc-abc8-22aaf5a1bd49'
 }

docker/api.env

@@ -1,6 +1,6 @@
 KAFKA_URL=192.168.1.3:9092
 V5_CHALLENGE_API_URL=http://192.168.1.3:4000/v5/challenges
-V5_CHALLENGE_TYPE_API_URL=http://192.168.1.3:4000/v5/challengeTypes
+V5_CHALLENGE_TYPE_API_URL=http://192.168.1.3:4000/v5/challenge-types
 V4_CHALLENGE_API_URL=http://192.168.1.3:4000/v4/challenges
 V4_TECHNOLOGIES_API_URL=http://192.168.1.3:4000/v4/technologies
 V4_PLATFORMS_API_URL=http://192.168.1.3:4000/v4/platforms

src/constants.js

@@ -1,3 +1,6 @@
+const _ = require('lodash')
+const config = require('config')
+
 /**
  * constants
  */
@@ -45,10 +48,32 @@ const challengeStatuses = {
   CancelledZeroRegistrations: 'Cancelled - Zero Registrations'
 }
 
+const challengeTracks = {
+  DEVELOP: 'DEVELOP',
+  DESIGN: 'DESIGN',
+  DATA_SCIENCE: 'DATA_SCIENCE',
+  QA: 'QA'
+}
+
 const challengeAbbreviations = {
   TASK: 'TASK',
   FIRST_2_FINISH: 'FIRST_2_FINISH',
-  DESIGN_FIRST_2_FINISH: 'DESIGN_FIRST_2_FINISH'
+  DESIGN_FIRST_2_FINISH: 'DESIGN_FIRST_2_FINISH',
+  CODE: 'CODE',
+  APPLICATION_FRONT_END_DESIGN: 'APPLICATION_FRONT_END_DESIGN'
+}
+
+const legacySubTrackMapping = {
+  [_.toLower(challengeTracks.DEVELOP)]: {
+    [config.TASK_TYPE_ID]: challengeAbbreviations.FIRST_2_FINISH,
+    [config.CHALLENGE_TYPE_ID]: challengeAbbreviations.CODE,
+    [config.FIRST_2_FINISH_TYPE_ID]: challengeAbbreviations.FIRST_2_FINISH
+  },
+  [_.toLower(challengeTracks.DESIGN)]: {
+    [config.TASK_TYPE_ID]: challengeAbbreviations.DESIGN_FIRST_2_FINISH,
+    [config.CHALLENGE_TYPE_ID]: challengeAbbreviations.APPLICATION_FRONT_END_DESIGN,
+    [config.FIRST_2_FINISH_TYPE_ID]: challengeAbbreviations.DESIGN_FIRST_2_FINISH
+  }
 }
 
 module.exports = {
@@ -57,5 +82,7 @@ module.exports = {
   EVENT_MIME_TYPE,
   createChallengeStatusesMap,
   challengeStatuses,
-  challengeAbbreviations
+  challengeAbbreviations,
+  challengeTracks,
+  legacySubTrackMapping
 }

src/services/ProcessorService.js

@@ -55,6 +55,49 @@ async function getDirectProjectId (m2mToken, projectId) {
   return response.body
 }
 
+/**
+ * Get legacy challenge track and subTrack values based on the v5 legacy.track and typeId
+ * @param {String} legacyTrack the legacy.track value from the v5 challenge object
+ * @param {String} typeId the v5 type ID
+ * @param {String} m2mToken the M2M token
+ */
+async function getLegacyTrackInformation (legacyTrack, typeId, m2mToken) {
+  const data = {
+    track: _.toUpper(legacyTrack)
+  }
+  if (_.isUndefined(data.track)) {
+    throw new Error(`Cannot create a challenge without a track. Please use one of [${_.values(constants.challengeTracks).join(', ')}]`)
+  }
+  if (_.isUndefined(typeId)) {
+    throw new Error('Cannot create a challenge without a typeId.')
+  }
+
+  // Use the configured subTrack if set for the given track/typeId
+  if (constants.legacySubTrackMapping[_.toLower(legacyTrack)] && constants.legacySubTrackMapping[_.toLower(legacyTrack)][typeId]) {
+    data.subTrack = constants.legacySubTrackMapping[_.toLower(legacyTrack)][typeId]
+  } else {
+    // otherwise fetch v4 challenge type based on the v5 type.legacyId
+    const v5Type = await helper.getRequest(`${config.V5_CHALLENGE_TYPE_API_URL}/${typeId}`, m2mToken)
+    const v4TypeList = await helper.getRequest(`${config.V4_CHALLENGE_TYPE_API_URL}`, m2mToken)
+    const v4Type = _.find(_.get(v4TypeList, 'body.result.content', []), type => type.id === v5Type.body.legacyId)
+    if (!v4Type) {
+      throw new Error(`There is no mapping between v5 Type ${v5Type.body.name} and V4`)
+    }
+    data.subTrack = v4Type.subTrack
+    data.legacyTypeId = v5Type.body.legacyId
+  }
+
+  // If it's a private task, set the `task` property to `true`
+  if (typeId === config.TASK_TYPE_ID) {
+    // Tasks can only be created for the develop and design tracks
+    if (data.track !== constants.challengeTracks.DEVELOP && data.track !== constants.challengeTracks.DESIGN) {
+      throw new Error(`Cannot create a task for track ${data.track}`)
+    }
+    data.task = true
+  }
+  return data
+}
+
 /**
  * Construct DTO from Kafka message payload.
  * @param {Object} payload the Kafka message payload
@@ -71,8 +114,11 @@ async function parsePayload (payload, m2mToken, isCreated = true) {
       projectId = _.get((await getDirectProjectId(m2mToken, payload.projectId)), 'directProjectId')
       if (!projectId) throw new Error(`Could not find Direct Project ID for Project ${payload.projectId}`)
     }
+
+    const legacyTrackInfo = await getLegacyTrackInformation(_.get(payload, 'legacy.track'), payload.typeId, m2mToken)
+
     const data = {
-      track: _.get(payload, 'legacy.track'), // FIXME: thomas
+      ...legacyTrackInfo,
       name: payload.name,
       reviewType: _.get(payload, 'legacy.reviewType'),
       projectId,
@@ -94,30 +140,6 @@ async function parsePayload (payload, m2mToken, isCreated = true) {
       data.submissionVisibility = true
       data.milestoneId = 1
     }
-    if (payload.typeId) {
-      const v5Type = await helper.getRequest(`${config.V5_CHALLENGE_TYPE_API_URL}/${payload.typeId}`, m2mToken)
-      const v4TypeList = await helper.getRequest(`${config.V4_CHALLENGE_TYPE_API_URL}`, m2mToken)
-      const v4Type = _.find(_.get(v4TypeList, 'body.result.content', []), type => type.id === v5Type.body.legacyId)
-      if (!v4Type) {
-        throw new Error(`There is no mapping between v5 Type ${v5Type.body.name} and V4`)
-      }
-      data.subTrack = v4Type.subTrack
-      // TASK is named as FIRST_2_FINISH on legacy
-      if (v5Type.body.abbreviation === constants.challengeAbbreviations.TASK) {
-        data.task = true
-        switch (_.toLower(_.toString(data.track))) {
-          case 'develop':
-            data.subTrack = constants.challengeAbbreviations.FIRST_2_FINISH
-            break
-          case 'design':
-            data.subTrack = constants.challengeAbbreviations.DESIGN_FIRST_2_FINISH
-            break
-          default:
-            throw new Error(`Cannot create a task for track ${data.track}`)
-        }
-      }
-      data.legacyTypeId = v5Type.body.legacyId
-    }
     if (payload.description) {
       try {
         data.detailedRequirements = converter.makeHtml(payload.description)

test/e2e/test.js

@@ -215,7 +215,7 @@ describe('Topcoder - Legacy Challenge Processor E2E Test', () => {
     await sendMessage(testTopics.create)
     await waitJob()
 
-    should.equal(debugLogs[3], 'GET /v5/challengeTypes/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
+    should.equal(debugLogs[3], 'GET /v5/challenge-types/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
     should.equal(debugLogs[4], 'GET /v4/technologies')
     should.equal(debugLogs[5], 'GET /v4/platforms')
     should.equal(debugLogs[8], 'POST /v4/challenges')
@@ -258,7 +258,7 @@ describe('Topcoder - Legacy Challenge Processor E2E Test', () => {
     await sendMessage(testTopics.update)
     await waitJob()
 
-    should.equal(debugLogs[3], 'GET /v5/challengeTypes/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
+    should.equal(debugLogs[3], 'GET /v5/challenge-types/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
     should.equal(debugLogs[4], 'GET /v4/technologies')
     should.equal(debugLogs[5], 'GET /v4/platforms')
     should.equal(debugLogs[8], 'PUT /v4/challenges/30055016')
@@ -279,7 +279,7 @@ describe('Topcoder - Legacy Challenge Processor E2E Test', () => {
     await sendMessage(message)
     await waitJob()
 
-    should.equal(debugLogs[3], 'GET /v5/challengeTypes/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
+    should.equal(debugLogs[3], 'GET /v5/challenge-types/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
     should.equal(debugLogs[4], 'GET /v4/technologies')
     should.equal(debugLogs[5], 'GET /v4/platforms')
     should.equal(debugLogs[8], 'PUT /v4/challenges/30055016')

test/unit/test.js

@@ -95,7 +95,7 @@ describe('Topcoder - Legacy Challenge Processor Unit Test', () => {
 
   it('process create challenge success', async () => {
     await service.processCreate(testTopics.create)
-    should.equal(debugLogs[3], 'GET /v5/challengeTypes/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
+    should.equal(debugLogs[3], 'GET /v5/challenge-types/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
     should.equal(debugLogs[4], 'GET /v4/technologies')
     should.equal(debugLogs[5], 'GET /v4/platforms')
     should.equal(debugLogs[8], 'POST /v4/challenges')
@@ -140,7 +140,7 @@ describe('Topcoder - Legacy Challenge Processor Unit Test', () => {
 
   it('process update challenge success', async () => {
     await service.processUpdate(testTopics.update)
-    should.equal(debugLogs[3], 'GET /v5/challengeTypes/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
+    should.equal(debugLogs[3], 'GET /v5/challenge-types/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
     should.equal(debugLogs[7], 'GET /v4/challenges/30055016')
     should.equal(debugLogs[8], 'PUT /v4/challenges/30055016')
     const body = JSON.parse(debugLogs[9])
@@ -158,7 +158,7 @@ describe('Topcoder - Legacy Challenge Processor Unit Test', () => {
     const message = _.cloneDeep(testTopics.update)
     message.payload.prizeSets = [{ type: 'Check Point', prizes: [{ type: 'first-place', value: 1 }] }]
     await service.processUpdate(message)
-    should.equal(debugLogs[3], 'GET /v5/challengeTypes/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
+    should.equal(debugLogs[3], 'GET /v5/challenge-types/2f4ef3a8-ed35-40d1-b8a6-7371a700d098')
     should.equal(debugLogs[7], 'GET /v4/challenges/30055016')
     should.equal(debugLogs[8], 'PUT /v4/challenges/30055016')
     const body = JSON.parse(debugLogs[9])