Performance improvement: reduce number of API calls to challenge API

Author: ThomasKranitsas

src/common/helper.js

@@ -363,30 +363,15 @@ function * getV5ChallengeId (challengeId) {
   return challengeId
 }
 
-/*
+/**
  * Get submission phase ID of a challenge from Challenge API
- * @param challengeId Challenge ID
+ * @param challenge Challenge
  * @returns {Integer} Submission phase ID of the given challengeId
  */
-function * getSubmissionPhaseId (challengeId) {
+function getSubmissionPhaseId (challenge) {
   let phaseId = null
-  let response
-  challengeId = yield getV5ChallengeId(challengeId)
-
-  try {
-    logger.info(`Calling to challenge API to find submission phase Id for ${challengeId}`)
-    const token = yield getM2Mtoken()
-    response = yield request.get(`${config.CHALLENGEAPI_V5_URL}/${challengeId}`)
-      .set('Authorization', `Bearer ${token}`)
-      .set('Content-Type', 'application/json')
-    logger.info(`returned from finding submission phase Id for ${challengeId}`)
-  } catch (ex) {
-    logger.error(`Error while accessing ${config.CHALLENGEAPI_V5_URL}/${challengeId}`)
-    logger.debug('Setting submissionPhaseId to Null')
-    response = null
-  }
-  if (response) {
-    const phases = _.get(response.body, 'phases', [])
+  if (challenge) {
+    const phases = _.get(challenge, 'phases', [])
     const checkPoint = _.filter(phases, { name: 'Checkpoint Submission', isOpen: true })
     const submissionPh = _.filter(phases, { name: 'Submission', isOpen: true })
     const finalFixPh = _.filter(phases, { name: 'Final Fix', isOpen: true })
@@ -404,14 +389,14 @@ function * getSubmissionPhaseId (challengeId) {
   return phaseId
 }
 
-/*
+/**
  * Function to check user access to create a submission
  * @param authUser Authenticated user
  * @param subEntity Submission Entity
+ * @param challengeDetails Challenge
  * @returns {Promise}
  */
-function * checkCreateAccess (authUser, subEntity) {
-  let challengeDetails
+function * checkCreateAccess (authUser, subEntity, challengeDetails) {
   let resources
 
   const challengeId = yield getV5ChallengeId(subEntity.challengeId)
@@ -423,18 +408,6 @@ function * checkCreateAccess (authUser, subEntity) {
 
   const token = yield getM2Mtoken()
 
-  try {
-    logger.info(`Calling to challenge API for fetch phases and winners for ${challengeId}`)
-    challengeDetails = yield request.get(`${config.CHALLENGEAPI_V5_URL}/${challengeId}`)
-      .set('Authorization', `Bearer ${token}`)
-      .set('Content-Type', 'application/json')
-    logger.info(`returned for ${challengeId} with ${JSON.stringify(challengeDetails)}`)
-  } catch (ex) {
-    logger.error(`Error while accessing ${config.CHALLENGEAPI_V5_URL}/${challengeId}`)
-    logger.error(ex)
-    throw new errors.HttpStatusError(503, `Could not fetch details of challenge with id ${challengeId}`)
-  }
-
   try {
     resources = yield request.get(`${config.RESOURCEAPI_V5_BASE_URL}/resources?challengeId=${challengeId}`)
       .set('Authorization', `Bearer ${token}`)
@@ -462,7 +435,7 @@ function * checkCreateAccess (authUser, subEntity) {
     })
 
     // Get phases and winner detail from challengeDetails
-    const phases = challengeDetails.body.phases
+    const { phases } = challengeDetails
 
     // Check if the User is assigned as the reviewer for the contest
     const reviewers = _.filter(currUserRoles, { role: 'Reviewer' })
@@ -482,7 +455,7 @@ function * checkCreateAccess (authUser, subEntity) {
       throw new errors.HttpStatusError(403, `Register for the contest before you can submit`)
     }
 
-    const submissionPhaseId = yield getSubmissionPhaseId(subEntity.challengeId)
+    const submissionPhaseId = yield getSubmissionPhaseId(challengeDetails)
 
     if (submissionPhaseId == null) {
       throw new errors.HttpStatusError(403, 'You cannot create a submission in the current phase')

src/services/SubmissionService.js

@@ -281,12 +281,13 @@ function * createSubmission (authUser, files, entity) {
 
   // Submission api only works with legacy challenge id
   // If it is a v5 challenge id, get the associated legacy challenge id
+  const challenge = yield helper.getChallenge(entity.challengeId)
   const {
     id: challengeId,
     status,
     phases,
     legacyId: legacyChallengeId
-  } = yield helper.getChallenge(entity.challengeId)
+  } = challenge
   const currDate = (new Date()).toISOString()
 
   if (status !== 'Active') {
@@ -321,7 +322,7 @@ function * createSubmission (authUser, files, entity) {
   if (entity.submissionPhaseId) {
     item.submissionPhaseId = entity.submissionPhaseId
   } else {
-    item.submissionPhaseId = yield helper.getSubmissionPhaseId(entity.challengeId)
+    item.submissionPhaseId = helper.getSubmissionPhaseId(challenge)
   }
 
   if (item.submissionPhaseId) {
@@ -341,7 +342,7 @@ function * createSubmission (authUser, files, entity) {
   logger.info('Check User access before creating the submission')
   if (_.intersection(authUser.roles, ['Administrator', 'administrator']).length === 0 && !authUser.scopes) {
     logger.info(`Calling checkCreateAccess for ${JSON.stringify(authUser)}`)
-    yield helper.checkCreateAccess(authUser, item)
+    yield helper.checkCreateAccess(authUser, item, challenge)
 
     if (entity.submittedDate) {
       throw new errors.HttpStatusError(403, 'You are not allowed to set the `submittedDate` attribute on a submission')