feat: challenge phase extension

rakibansary · rakibansary · commit 94f2cf63d574 · 2023-03-20T06:19:25.000+06:00
* move common phase functionality to a phase helper
* remove post-mortem phase if submission phase is opened
* determine isOpen status based on start and end dates
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,7 +1,7 @@
 version: 2
 defaults: &defaults
-    docker:
-      - image: cimg/python:3.11.0-browsers
+  docker:
+  - image: cimg/python:3.11.0-browsers
 install_dependency: &install_dependency
   name: Installation of build and deployment dependencies.
   command: |
@@ -23,44 +23,38 @@ restore_cache_settings_for_build: &restore_cache_settings_for_build
 save_cache_settings: &save_cache_settings
   key: docker-node-modules-{{ checksum "yarn.lock" }}
   paths:
-    - node_modules
+  - node_modules
 
 builddeploy_steps: &builddeploy_steps
-      - checkout
-      - setup_remote_docker
-      - run: *install_dependency
-      - run: *install_deploysuite
-      - restore_cache: *restore_cache_settings_for_build
-      - run:
-          name: "Authenticate with CodeArtifact and build docker image"
-          command: |
-            ./awsconfiguration.sh ${CODEARTIFACT_ENV}
-            source awsenvconf
-            aws codeartifact login --tool npm --repository topcoder-framework --domain topcoder --domain-owner $AWS_ACCOUNT_ID --region $AWS_REGION --namespace @topcoder-framework
-            cp ~/.npmrc .
-            rm -f awsenvconf            
-            ./build.sh ${APPNAME}
-      - save_cache: *save_cache_settings
-      - deploy:
-          name: Running MasterScript.
-          command: |
-            ./awsconfiguration.sh $DEPLOY_ENV
-            source awsenvconf
-            ./buildenv.sh -e $DEPLOY_ENV -b ${LOGICAL_ENV}-${APPNAME}-deployvar
-            source buildenvvar
-            ./master_deploy.sh -d ECS -e $DEPLOY_ENV -t latest -s ${LOGICAL_ENV}-global-appvar,${LOGICAL_ENV}-${APPNAME}-appvar -i ${APPNAME}
+- checkout
+- setup_remote_docker
+- run: *install_dependency
+- run: *install_deploysuite
+- restore_cache: *restore_cache_settings_for_build
+- run:
+    name: "Authenticate with CodeArtifact and build docker image"
+    command: "./awsconfiguration.sh ${CODEARTIFACT_ENV}\nsource awsenvconf\naws codeartifact login --tool npm --repository topcoder-framework --domain topcoder --domain-owner $AWS_ACCOUNT_ID --region $AWS_REGION --namespace @topcoder-framework\ncp ~/.npmrc .\nrm -f awsenvconf            \n./build.sh ${APPNAME}\n"
+- save_cache: *save_cache_settings
+- deploy:
+    name: Running MasterScript.
+    command: |
+      ./awsconfiguration.sh $DEPLOY_ENV
+      source awsenvconf
+      ./buildenv.sh -e $DEPLOY_ENV -b ${LOGICAL_ENV}-${APPNAME}-deployvar
+      source buildenvvar
+      ./master_deploy.sh -d ECS -e $DEPLOY_ENV -t latest -s ${LOGICAL_ENV}-global-appvar,${LOGICAL_ENV}-${APPNAME}-appvar -i ${APPNAME}
 jobs:
   # Build & Deploy against development backend
   "build-dev":
-    <<: *defaults
+    !!merge <<: *defaults
     environment:
       DEPLOY_ENV: "DEV"
       LOGICAL_ENV: "dev"
       APPNAME: "challenge-api"
     steps: *builddeploy_steps
 
   "build-qa":
-    <<: *defaults
+    !!merge <<: *defaults
     environment:
       DEPLOY_ENV: "QA"
       LOGICAL_ENV: "qa"
@@ -69,36 +63,36 @@ jobs:
     steps: *builddeploy_steps
 
   "build-prod":
-    <<: *defaults
+    !!merge <<: *defaults
     environment:
       DEPLOY_ENV: "PROD"
-      LOGICAL_ENV: "prod"    
-      APPNAME: "challenge-api"  
+      LOGICAL_ENV: "prod"
+      APPNAME: "challenge-api"
     steps: *builddeploy_steps
 
 workflows:
   version: 2
   build:
     jobs:
-      # Development builds are executed on "develop" branch only.
-      - "build-dev":
-          context : org-global
-          filters:
-            branches:
-              only:
-                - dev
+    # Development builds are executed on "develop" branch only.
+    - "build-dev":
+        context: org-global
+        filters:
+          branches:
+            only:
+            - dev
 
-      - "build-qa":
-          context : org-global
-          filters:
-            branches:
-              only:
-                - refactor/domain-challenge
+    - "build-qa":
+        context: org-global
+        filters:
+          branches:
+            only:
+            - refactor/domain-challenge
 
-      # Production builds are exectuted only on tagged commits to the
-      # master branch.
-      - "build-prod":
-          context : org-global
-          filters:
-            branches:
-              only: master
+    # Production builds are exectuted only on tagged commits to the
+    # master branch.
+    - "build-prod":
+        context: org-global
+        filters:
+          branches:
+            only: master
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,8 +1,6 @@
 {
-    "editor.defaultFormatter": "standard.vscode-standard",
-    "standard.autoFixOnSave": true,
-    "[javascript]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
-    },
-    "standard.autoFixOnSave": true
+  "standard.autoFixOnSave": true,
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
 }
diff --git a/src/common/phase-helper.js b/src/common/phase-helper.js
@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 const { GRPC_CHALLENGE_SERVER_HOST, GRPC_CHALLENGE_SERVER_PORT } = process.env;
 
 const {
@@ -22,6 +23,14 @@ const timelineTemplateService = require("../services/TimelineTemplateService");
 // );
 
 const phaseDomain = new PhaseDomain(GRPC_CHALLENGE_SERVER_HOST, GRPC_CHALLENGE_SERVER_PORT);
+=======
+const _ = require('lodash')
+const uuid = require('uuid/v4')
+const moment = require('moment')
+
+const errors = require('./errors')
+const helper = require('./helper')
+>>>>>>> 21bc5fc (feat: challenge phase extension)
 
 class ChallengePhaseHelper {
   /**
@@ -30,6 +39,7 @@ class ChallengePhaseHelper {
    * @param {Date} startDate the challenge start date
    * @param {String} timelineTemplateId the timeline template id
    */
+<<<<<<< HEAD
   async populatePhases(phases, startDate, timelineTemplateId) {
     if (_.isUndefined(timelineTemplateId)) {
       throw new errors.BadRequestError(`Invalid timeline template ID: ${timelineTemplateId}`);
@@ -44,10 +54,26 @@ class ChallengePhaseHelper {
       // auto populate phases
       for (const p of timelineTempate) {
         phases.push({ ...p });
+=======
+  async populatePhases (phases, startDate, timelineTemplateId) {
+    console.log('populatePhases', phases, startDate, timelineTemplateId)
+    if (_.isUndefined(timelineTemplateId)) {
+      throw new errors.BadRequestError(`Invalid timeline template ID: ${timelineTemplateId}`)
+    }
+
+    const { timelineTempate, timelineTemplateMap } = await this.getTemplateAndTemplateMap(timelineTemplateId)
+    const { phaseDefinitionMap } = await this.getPhaseDefinitionsAndMap()
+
+    if (!phases || phases.length === 0) {
+      // auto populate phases
+      for (const p of timelineTempate.phases) {
+        phases.push({ ...p })
+>>>>>>> 21bc5fc (feat: challenge phase extension)
       }
     }
 
     for (const p of phases) {
+<<<<<<< HEAD
       const phaseDefinition = phaseDefinitionMap.get(p.phaseId);
 
       // TODO: move to domain-challenge
@@ -73,18 +99,45 @@ class ChallengePhaseHelper {
           }
           p.predecessor = phaseTemplate.predecessor;
           console.log("Setting predecessor", p.predecessor, "for phase", p.phaseId);
+=======
+      const phaseDefinition = phaseDefinitionMap.get(p.phaseId)
+
+      p.id = uuid()
+      p.name = phaseDefinition.name
+      p.description = phaseDefinition.description
+
+      // set p.open based on current phase
+      const phaseTemplate = timelineTemplateMap.get(p.phaseId)
+      if (phaseTemplate) {
+        if (!p.duration) {
+          p.duration = phaseTemplate.defaultDuration
+        }
+
+        if (phaseTemplate.predecessor) {
+          const predecessor = _.find(phases, { phaseId: phaseTemplate.predecessor })
+          if (!predecessor) {
+            throw new errors.BadRequestError(`Predecessor ${phaseTemplate.predecessor} not found in given phases.`)
+          }
+          p.predecessor = phaseTemplate.predecessor
+          console.log('Setting predecessor', p.predecessor, 'for phase', p.phaseId)
+>>>>>>> 21bc5fc (feat: challenge phase extension)
         }
       }
     }
 
     // calculate dates
     if (!startDate) {
+<<<<<<< HEAD
       return;
+=======
+      return
+>>>>>>> 21bc5fc (feat: challenge phase extension)
     }
 
     // sort phases by predecessor
     phases.sort((a, b) => {
       if (a.predecessor === b.phaseId) {
+<<<<<<< HEAD
         return 1;
       }
       if (b.predecessor === a.phaseId) {
@@ -206,3 +259,97 @@ class ChallengePhaseHelper {
 }
 
 module.exports = new ChallengePhaseHelper();
+=======
+        return 1
+      }
+      if (b.predecessor === a.phaseId) {
+        return -1
+      }
+      return 0
+    })
+
+    let isSubmissionPhaseOpen = false
+    let postMortemPhaseIndex = -1
+
+    for (let p of phases) {
+      const predecessor = timelineTemplateMap.get(p.predecessor)
+
+      if (predecessor == null) {
+        p.scheduledStartDate = startDate
+        // p.actualStartDate = startDate
+
+        p.scheduledEndDate = moment(p.actualStartDate != null ? p.actaulStartDate : startDate).add(p.duration, 'seconds').toDate()
+      } else {
+        const precedecessorPhase = _.find(phases, { phaseId: predecessor.phaseId })
+        if (precedecessorPhase == null) {
+          throw new errors.BadRequestError(`Predecessor ${predecessor.phaseId} not found in given phases.`)
+        }
+        let phaseEndDate = moment(precedecessorPhase.scheduledEndDate)
+        if (precedecessorPhase.actualEndDate != null && moment(precedecessorPhase.actualEndDate).isAfter(phaseEndDate)) {
+          phaseEndDate = moment(precedecessorPhase.actualEndDate)
+        } else {
+          phaseEndDate = moment(precedecessorPhase.scheduledEndDate)
+        }
+
+        p.scheduledStartDate = phaseEndDate.toDate()
+        p.scheduledEndDate = moment(p.scheduledStartDate).add(p.duration, 'seconds').toDate()
+      }
+      p.isOpen = moment().isBetween(p.scheduledStartDate, p.scheduledEndDate)
+      if (p.name === 'Submission') {
+        isSubmissionPhaseOpen = p.isOpen
+      }
+      if (p.name === 'Post-Mortem') {
+        postMortemPhaseIndex = _.findIndex(phases, { phaseId: p.phaseId })
+      }
+    }
+
+    // if submission phase is open, remove post-mortem phase
+    if (isSubmissionPhaseOpen && postMortemPhaseIndex > -1) {
+      phases.splice(postMortemPhaseIndex, 1)
+    }
+
+    // phases.sort((a, b) => moment(a.scheduledStartDate).isAfter(b.scheduledStartDate))
+  }
+
+  async validatePhases (phases) {
+    if (!phases || phases.length === 0) {
+      return
+    }
+    const records = await helper.scan('Phase')
+    const map = new Map()
+    _.each(records, (r) => {
+      map.set(r.id, r)
+    })
+    const invalidPhases = _.filter(phases, (p) => !map.has(p.phaseId))
+    if (invalidPhases.length > 0) {
+      throw new errors.BadRequestError(
+        `The following phases are invalid: ${toString(invalidPhases)}`
+      )
+    }
+  }
+
+  async getPhaseDefinitionsAndMap () {
+    const records = await helper.scan('Phase')
+    const map = new Map()
+    _.each(records, (r) => {
+      map.set(r.id, r)
+    })
+    return { phaseDefinitions: records, phaseDefinitionMap: map }
+  }
+
+  async getTemplateAndTemplateMap (timelineTemplateId) {
+    const records = await helper.getById('TimelineTemplate', timelineTemplateId)
+    const map = new Map()
+    _.each(records.phases, (r) => {
+      map.set(r.phaseId, r)
+    })
+
+    return {
+      timelineTempate: records.phases,
+      timelineTemplateMap: map
+    }
+  }
+}
+
+module.exports = new ChallengePhaseHelper()
+>>>>>>> 21bc5fc (feat: challenge phase extension)
diff --git a/src/services/ChallengeService.js b/src/services/ChallengeService.js
@@ -3,6 +3,23 @@
  */
 
 const { GRPC_CHALLENGE_SERVER_HOST, GRPC_CHALLENGE_SERVER_PORT } = process.env;
+const _ = require("lodash");
+const Joi = require("joi");
+const uuid = require("uuid/v4");
+const config = require("config");
+const xss = require("xss");
+const helper = require("../common/helper");
+const logger = require("../common/logger");
+const errors = require("../common/errors");
+const phaseHelper = require("../common/phase-helper");
+const constants = require("../../app-constants");
+const models = require("../models");
+const HttpStatus = require("http-status-codes");
+const moment = require("moment");
+const PhaseService = require("./PhaseService");
+const ChallengeTypeService = require("./ChallengeTypeService");
+const ChallengeTrackService = require("./ChallengeTrackService");
+const ChallengeTimelineTemplateService = require("./ChallengeTimelineTemplateService");
 
 const {
   DomainHelper: { getLookupCriteria, getScanCriteria },
diff --git a/src/services/TimelineTemplateService.js b/src/services/TimelineTemplateService.js
@@ -60,6 +60,9 @@ searchTimelineTemplates.schema = {
  * @returns {Object} the created timeline template
  */
 async function createTimelineTemplate(timelineTemplate) {
+  // await helper.validateDuplicate('TimelineTemplate', 'name', timelineTemplate.name)
+  // await phaseHelper.validatePhases(timelineTemplate.phases)
+
   const scanCriteria = getScanCriteria({
     name: timelineTemplate.name,
   });

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`{`
`2`		`- "editor.defaultFormatter": "standard.vscode-standard",`
`3`		`- "standard.autoFixOnSave": true,`
`4`		`- "[javascript]": {`
`5`		`- "editor.defaultFormatter": "esbenp.prettier-vscode"`
`6`		`- },`
`7`		`- "standard.autoFixOnSave": true`
	`2`	`+ "standard.autoFixOnSave": true,`
	`3`	`+ "[javascript]": {`
	`4`	`+ "editor.defaultFormatter": "esbenp.prettier-vscode"`
	`5`	`+ }`
`8`	`6`	`}`