Enrich skills data for PUT / PATCH response and add blocks on review type phases to ensure they can't be manually opened without at least 1 resource assigned to the review type role associated with the phase type.

Author: jmgasper

src/services/ChallengePhaseService.js

@@ -24,6 +24,13 @@ const REVIEW_PHASE_NAMES = Object.freeze([
   "approval",
 ]);
 const REVIEW_PHASE_NAME_SET = new Set(REVIEW_PHASE_NAMES.map((name) => name.toLowerCase()));
+const PHASE_RESOURCE_ROLE_REQUIREMENTS = Object.freeze({
+  "iterative review": "Iterative Reviewer",
+  "checkpoint screening": "Checkpoint Screener",
+  screening: "Screener",
+  review: "Reviewer",
+  "checkpoint review": "Checkpoint Reviewer",
+});
 
 async function hasPendingScorecardsForPhase(challengePhaseId) {
   if (!config.REVIEW_DB_URL) {
@@ -201,6 +208,48 @@ async function postChallengeUpdatedNotification(challengeId) {
   }
 }
 
+async function ensureRequiredResourcesBeforeOpeningPhase(challengeId, phaseName) {
+  const normalizedPhaseName = _.toLower(_.trim(phaseName || ""));
+  const requiredRoleName = PHASE_RESOURCE_ROLE_REQUIREMENTS[normalizedPhaseName];
+  if (!requiredRoleName) {
+    return;
+  }
+
+  const challengeResources = await helper.getChallengeResources(challengeId);
+  const requiredRoleNameLower = _.toLower(requiredRoleName);
+  const hasRequiredRoleByName = (challengeResources || []).some((resource) => {
+    const roleName =
+      resource.roleName ||
+      resource.role ||
+      _.get(resource, "role.name") ||
+      _.get(resource, "resourceRoleName") ||
+      _.get(resource, "resourceRole.name");
+    return roleName && _.toLower(roleName) === requiredRoleNameLower;
+  });
+
+  let hasRequiredRole = hasRequiredRoleByName;
+
+  if (!hasRequiredRole) {
+    const resourceRoles = await helper.getResourceRoles();
+    const requiredRoleIds = (resourceRoles || [])
+      .filter((role) => role.name && _.toLower(role.name) === requiredRoleNameLower)
+      .map((role) => _.toString(role.id));
+    if (requiredRoleIds.length > 0) {
+      const requiredRoleIdSet = new Set(requiredRoleIds);
+      hasRequiredRole = (challengeResources || []).some(
+        (resource) => resource.roleId && requiredRoleIdSet.has(_.toString(resource.roleId))
+      );
+    }
+  }
+
+  if (!hasRequiredRole) {
+    const displayPhaseName = phaseName || "phase";
+    throw new errors.BadRequestError(
+      `Cannot open ${displayPhaseName} phase because the challenge does not have any resource with the ${requiredRoleName} role`
+    );
+  }
+}
+
 /**
  * Get all phase information for that challenge
  * @param {String} challengeId the challenge id
@@ -330,6 +379,11 @@ async function partiallyUpdateChallengePhase(currentUser, challengeId, id, data)
     }
   }
 
+  if (isOpeningPhase) {
+    const phaseName = data.name || challengePhase.name;
+    await ensureRequiredResourcesBeforeOpeningPhase(challengeId, phaseName);
+  }
+
   if (data["scheduledStartDate"] || data["scheduledEndDate"]) {
     const startDate = data["scheduledStartDate"] || challengePhase.scheduledStartDate;
     const endDate = data["scheduledEndDate"] || challengePhase.scheduledEndDate;

src/services/ChallengeService.js

@@ -1515,6 +1515,7 @@ async function createChallenge(currentUser, challenge, userToken) {
   // No conversion needed - values are already in dollars in the database
 
   prismaHelper.convertModelToResponse(ret);
+  await enrichSkillsData(ret);
   enrichChallengeForResponse(ret, track, type);
 
   // If the challenge is self-service, add the creating user as the "client manager", *not* the manager
@@ -2683,6 +2684,7 @@ async function updateChallenge(currentUser, challengeId, data, options = {}) {
 
   // Convert to response shape before any business-logic checks that expect it
   prismaHelper.convertModelToResponse(updatedChallenge);
+  await enrichSkillsData(updatedChallenge);
   enrichChallengeForResponse(updatedChallenge);
 
   if (_.get(updatedChallenge, "legacy.selfService")) {

test/unit/ChallengePhaseService.test.js

@@ -13,6 +13,7 @@ const uuid = require('uuid/v4')
 const { getReviewClient } = require('../../src/common/review-prisma')
 const prisma = require('../../src/common/prisma').getClient()
 const service = require('../../src/services/ChallengePhaseService')
+const helper = require('../../src/common/helper')
 const testHelper = require('../testHelper')
 
 const should = chai.should()
@@ -802,6 +803,107 @@ describe('challenge phase service unit tests', () => {
       const challengePhase = await service.partiallyUpdateChallengePhase(authUser, data.challenge.id, data.challengePhase1Id, { isOpen: true })
       should.equal(challengePhase.isOpen, true)
     })
+
+    it('partially update challenge phase - cannot open review phase without reviewer resource', async () => {
+      const reviewPhase = await prisma.phase.create({
+        data: {
+          id: uuid(),
+          name: 'Review',
+          description: 'desc',
+          isOpen: false,
+          duration: 86400,
+          createdBy: 'admin',
+          updatedBy: 'admin'
+        }
+      })
+      const reviewChallengePhaseId = uuid()
+      await prisma.challengePhase.create({
+        data: {
+          id: reviewChallengePhaseId,
+          challengeId: data.challenge.id,
+          phaseId: reviewPhase.id,
+          name: 'Review',
+          isOpen: false,
+          createdBy: 'admin',
+          updatedBy: 'admin'
+        }
+      })
+
+      const originalGetChallengeResources = helper.getChallengeResources
+      const originalGetResourceRoles = helper.getResourceRoles
+      helper.getChallengeResources = async () => ([
+        { roleId: 'some-other-role-id' }
+      ])
+      helper.getResourceRoles = async () => ([
+        { id: 'reviewer-role-id', name: 'Reviewer' }
+      ])
+
+      try {
+        await service.partiallyUpdateChallengePhase(authUser, data.challenge.id, reviewChallengePhaseId, { isOpen: true })
+      } catch (e) {
+        should.equal(e.httpStatus || e.statusCode, 400)
+        should.equal(
+          e.message,
+          'Cannot open Review phase because the challenge does not have any resource with the Reviewer role'
+        )
+        return
+      } finally {
+        helper.getChallengeResources = originalGetChallengeResources
+        helper.getResourceRoles = originalGetResourceRoles
+        await prisma.challengePhase.delete({ where: { id: reviewChallengePhaseId } })
+        await prisma.phase.delete({ where: { id: reviewPhase.id } })
+      }
+
+      throw new Error('should not reach here')
+    })
+
+    it('partially update challenge phase - opens review phase when reviewer resource exists', async () => {
+      const reviewPhase = await prisma.phase.create({
+        data: {
+          id: uuid(),
+          name: 'Review',
+          description: 'desc',
+          isOpen: false,
+          duration: 86400,
+          createdBy: 'admin',
+          updatedBy: 'admin'
+        }
+      })
+      const reviewChallengePhaseId = uuid()
+      await prisma.challengePhase.create({
+        data: {
+          id: reviewChallengePhaseId,
+          challengeId: data.challenge.id,
+          phaseId: reviewPhase.id,
+          name: 'Review',
+          isOpen: false,
+          createdBy: 'admin',
+          updatedBy: 'admin'
+        }
+      })
+
+      const originalGetChallengeResources = helper.getChallengeResources
+      const originalGetResourceRoles = helper.getResourceRoles
+      helper.getChallengeResources = async () => ([
+        {
+          roleId: 'reviewer-role-id',
+          resourceRole: { name: 'Reviewer' }
+        }
+      ])
+      helper.getResourceRoles = async () => ([
+        { id: 'reviewer-role-id', name: 'Reviewer' }
+      ])
+
+      try {
+        const challengePhase = await service.partiallyUpdateChallengePhase(authUser, data.challenge.id, reviewChallengePhaseId, { isOpen: true })
+        should.equal(challengePhase.isOpen, true)
+      } finally {
+        helper.getChallengeResources = originalGetChallengeResources
+        helper.getResourceRoles = originalGetResourceRoles
+        await prisma.challengePhase.delete({ where: { id: reviewChallengePhaseId } })
+        await prisma.phase.delete({ where: { id: reviewPhase.id } })
+      }
+    })
   })
 
   describe('delete challenge phase tests', () => {