feat: add phase criteria for submission, reivew and registration phase

Signed-off-by: Rakib Ansary <[email protected]>

Author: rakibansary

.circleci/config.yml

@@ -72,7 +72,7 @@ workflows:
             branches:
               only:
                 - develop
-                - PLAT-2035
+                - PLAT-2032
 
       # Production builds are exectuted only on tagged commits to the
       # master branch.

src/services/ProcessorService.js

@@ -20,6 +20,7 @@ const { createOrSetNumberOfReviewers } = require('./selfServiceReviewerService')
 const { disableTimelineNotifications } = require('./selfServiceNotificationService')
 const legacyChallengeService = require('./legacyChallengeService')
 const legacyChallengeReviewService = require('./legacyChallengeReviewService')
+const phaseCriteriaService = require('./phaseCriteriaService');
 
 /**
  * Drop and recreate phases in ifx
@@ -92,6 +93,79 @@ async function recreatePhases (legacyId, v5Phases, createdBy) {
   logger.info('recreatePhases :: end')
 }
 
+async function addPhaseConstraints(legacyId, v5Phases, createdBy) {
+  logger.info(`addPhaseConstraints :: start: ${legacyId}, ${JSON.stringify(v5Phases)}`)
+  const allPhaseCriteria = await phaseCriteriaService.getPhaseCriteria();
+  logger.info(`addPhaseConstraints :: allPhaseCriteria: ${JSON.stringify(allPhaseCriteria)}`)
+
+  const phaseTypes = await timelineService.getPhaseTypes()
+  logger.info(`addPhaseConstraints :: phaseTypes: ${JSON.stringify(phaseTypes)}`)
+  
+  const phasesFromIFx = await timelineService.getChallengePhases(legacyId)
+
+  for (const phase of v5Phases) {
+    logger.info(`addPhaseConstraints :: phase: ${legacyId} -> ${JSON.stringify(phase)}`)
+    if (phase.constraints == null || phase.constraints.length === 0) continue;
+
+    const phaseLegacyId = _.get(_.find(phaseTypes, pt => pt.name === phase.name), 'phase_type_id')
+    const existingLegacyPhase = _.find(phasesFromIFx, p => p.phase_type_id === phaseLegacyId)
+
+    const projectPhaseId = _.get(existingLegacyPhase, 'project_phase_id')
+    if (!projectPhaseId) {
+      logger.warn(`Could not find phase ${phase.name} on legacy!`)
+      continue 
+    }
+
+    let constraintName = null;
+    let constraintValue = null
+
+    if (phase.name === 'Submission') {
+      const numSubmissionsConstraint = phase.constraints.find(c => c.name === 'Number of Submissions')
+      if (numSubmissionsConstraint) {
+        constraintName = 'Submission Number'
+        constraintValue = numSubmissionsConstraint.value
+      }
+    }
+
+    if (phase.name === 'Registration') { 
+      const numRegistrantsConstraint = phase.constraints.find(c => c.name === 'Number of Registrants')
+      if (numRegistrantsConstraint) {
+        constraintName = 'Registration Number'
+        constraintValue = numRegistrantsConstraint.value
+      }
+    }
+
+    if (phase.name === 'Review') {
+      const numReviewersConstraint = phase.constraints.find(c => c.name === 'Number of Reviewers')
+      if (numReviewersConstraint) {
+        constraintName = 'Reviewer Number'
+        constraintValue = numReviewersConstraint.value
+      }
+    }
+
+    // We have an interesting situation if a submission phase constraint was added but
+    // no registgration phase constraint was added. This ends up opening Post-Mortem
+    // phase if registration closes with 0 submissions.
+    // For now I'll leave it as is and handle this better in the new Autopilot implementation
+    // A quick solution would have been adding a registration constraint with value 1 if none is provided when there is a submission phase constraint
+
+    if (constraintName && constraintValue) {
+      const phaseCriteriaTypeId = _.get(_.find(allPhaseCriteria, pc => pc.name === constraintName), 'phase_criteria_type_id')
+      if (phaseCriteriaTypeId) {
+        logger.debug(`Will create phase constraint ${constraintName} with value ${constraintValue}`)
+        // Ideally we should update the existing phase criteria, but this processor will go away in weeks
+        // and it's a backend processor, so we can just drop and recreate without slowing down anything
+        await phaseCriteriaService.dropPhaseCriteria(projectPhaseId, phaseCriteriaTypeId)
+        await phaseCriteriaService.createPhaseCriteria(projectPhaseId, phaseCriteriaTypeId, constraintValue, createdBy)
+      } else {
+        logger.warn(`Could not find phase criteria type for ${constraintName}`)
+      }
+    }
+
+  }
+  logger.info('addPhaseConstraints :: end')
+}
+
 /**
  * Sync the information from the v5 phases into legacy
  * @param {Number} legacyId the legacy challenge ID
@@ -806,6 +880,7 @@ async function processMessage (message) {
     if (!_.get(message.payload, 'task.isTask')) {
       const numOfReviewers = 2
       await syncChallengePhases(legacyId, message.payload.phases, createdByUserId, _.get(message, 'payload.legacy.selfService'), numOfReviewers, isBeingActivated)
+      await addPhaseConstraints(legacyId, message.payload.phases, createdByUserId);
       needSyncV4ES = true
     } else {
       logger.info('Will skip syncing phases as the challenge is a task...')

src/services/phaseCriteriaService.js

@@ -0,0 +1,81 @@
+/**
+ * Number of reviewers Service
+ * Interacts with InformixDB
+ */
+const util = require('util')
+const logger = require('../common/logger')
+const helper = require('../common/helper')
+
+const QUERY_GET_PHASE_CRITERIA = 'SELECT phase_criteria_type_id, name FROM phase_criteria_type_lu;'
+const QUERY_CREATE = 'INSERT INTO phase_criteria (project_phase_id, phase_criteria_type_id, parameter, create_user, create_date, modify_user, modify_date) VALUES (?, ?, ?, ?, CURRENT, ?, CURRENT)'
+const QUERY_DELETE = 'DELETE FROM phase_criteria WHERE project_phase_id = ? AND phase_criteria_type_id = ?'
+
+/**
+ * Prepare Informix statement
+ * @param {Object} connection the Informix connection
+ * @param {String} sql the sql
+ * @return {Object} Informix statement
+ */
+async function prepare (connection, sql) {
+  // logger.debug(`Preparing SQL ${sql}`)
+  const stmt = await connection.prepareAsync(sql)
+  return Promise.promisifyAll(stmt)
+}
+
+async function getPhaseCriteria () {
+ const connection = await helper.getInformixConnection()
+ let result = null
+ try {
+   result = await connection.queryAsync(QUERY_GET_PHASE_CRITERIA)
+ } catch (e) {
+   logger.error(`Error in 'getPhaseCriteria' ${e}`)
+   throw e
+ } finally {
+   await connection.closeAsync()
+ }
+ return result
+}
+
+async function dropPhaseCriteria(phaseId, phaseCriteriaTypeId) {
+  const connection = await helper.getInformixConnection()
+  let result = null
+  try {
+    await connection.beginTransactionAsync()
+    const query = await prepare(connection, QUERY_DELETE)
+    result = await query.executeAsync([phaseId, phaseCriteriaTypeId])
+    await connection.commitTransactionAsync()
+  } catch (e) {
+    logger.error(`Error in 'dropPhaseCriteria' ${e}`)
+    await connection.rollbackTransactionAsync()
+    throw e
+  } finally {
+    await connection.closeAsync()
+  }
+  return result
+}
+
+async function createPhaseCriteria(phaseId, phaseCriteriaTypeId, value, createdBy) {
+    const connection = await helper.getInformixConnection()
+    let result = null
+    try {
+        await connection.beginTransactionAsync()
+        const query = await prepare(connection, QUERY_CREATE)
+        result = await query.executeAsync([phaseId, phaseCriteriaTypeId, value, createdBy, createdBy])
+        await connection.commitTransactionAsync()
+    } catch (e) {
+        logger.error(`Error in 'createPhaseCriteria' ${e}`)
+        await connection.rollbackTransactionAsync()
+        throw e
+    } finally {
+        await connection.closeAsync()
+    }
+    return result
+}
+
+
+
+module.exports = {
+  getPhaseCriteria,
+  createPhaseCriteria,
+  dropPhaseCriteria
+}