Merge pull request #805 from topcoder-platform/pm-1168

feat(PM-1168): Added API to assign an opportunity with an applicant

Author: kkartunov

.circleci/config.yml

@@ -149,7 +149,7 @@ workflows:
           context : org-global
           filters:
             branches:
-              only: ['develop', 'migration-setup']
+              only: ['develop', 'migration-setup', 'pm-1168']
       - deployProd:
           context : org-global
           filters:

docs/swagger.yaml

@@ -560,6 +560,37 @@ paths:
           description: "Internal Server Error"
           schema:
             $ref: "#/definitions/ErrorModel"
+  "/projects/copilots/opportunity/{copilotOpportunityId}/assign":
+    post:
+      tags:
+        - assign project copilot opportunity
+      operationId: assignCopilotOpportunity
+      security:
+        - Bearer: []
+      description: "Assign a copilot opportunity with copilot."
+      parameters:
+        - $ref: "#/parameters/copilotOpportunityIdParam"
+        - in: body
+          name: body
+          schema:
+            $ref: "#/definitions/AssignCopilotOpportunity"
+      responses:
+        "200":
+          description: "The response after assigning an copilot opportunity"
+          schema:
+            $ref: "#/definitions/CopilotOpportunityAssignResponse"
+        "401":
+          description: "Unauthorized"
+          schema:
+            $ref: "#/definitions/ErrorModel"
+        "403":
+          description: "Forbidden - User does not have permission"
+          schema:
+            $ref: "#/definitions/ErrorModel"
+        "500":
+          description: "Internal Server Error"
+          schema:
+            $ref: "#/definitions/ErrorModel"
   "/projects/{projectId}/attachments":
     get:
       tags:
@@ -6081,6 +6112,13 @@ definitions:
       notes:
         description: notes regarding the application
         type: string
+      status:
+        description: status of the application
+        type: string
+        enum:
+          - pending
+          - accepted
+        example: pending
       opportunityId:
         description: copilot request id
         type: integer
@@ -6111,6 +6149,13 @@ definitions:
         format: int64
         description: READ-ONLY. User that deleted this task
         readOnly: true
+  CopilotOpportunityAssignResponse:
+    type: object
+    properties:
+      id:
+        description: unique identifier
+        type: integer
+        format: int64
   Project:
     type: object
     properties:
@@ -6321,12 +6366,19 @@ definitions:
           - manager
           - copilot
   ApplyCopilotOpportunity:
-    title: Apply copilot CopilotOpportunity
+    title: Apply Copilot Opportunity
     type: object
     properties:
       notes:
         type: string
         description: notes about applying copilot opportunity
+  AssignCopilotOpportunity:
+    title: Assign Copilot Opportunity
+    type: object
+    properties:
+      applicationId:
+        type: string
+        description: The ID of the application to be accepted for the copilot opportunity.
   NewProjectAttachment:
     title: Project attachment request
     type: object

migrations/umzug/migrations/20250411182312-copilot_opportunity_apply.js

@@ -1,4 +1,4 @@
-'use strict';
+
 
 module.exports = {
   up: async (queryInterface, Sequelize) => {
@@ -56,5 +56,5 @@ module.exports = {
 
   down: async (queryInterface) => {
     await queryInterface.dropTable('copilot_applications');
-  }
+  },
 };

migrations/umzug/migrations/20250511123109-copilot_application_status.js

@@ -0,0 +1,21 @@
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    await queryInterface.addColumn('copilot_applications', 'status', {
+      type: Sequelize.STRING(16),
+      allowNull: true,
+    });
+
+    await queryInterface.sequelize.query(
+      'UPDATE copilot_applications SET status = \'pending\' WHERE status IS NULL',
+    );
+
+    await queryInterface.changeColumn('copilot_applications', 'status', {
+      type: Sequelize.STRING(16),
+      allowNull: false,
+    });
+  },
+
+  down: async (queryInterface) => {
+    await queryInterface.removeColumn('copilot_applications', 'status');
+  },
+};

src/constants.js

@@ -18,6 +18,11 @@ export const COPILOT_REQUEST_STATUS = {
   FULFILLED: 'fulfiled',
 };
 
+export const COPILOT_APPLICATION_STATUS = {
+  PENDING: 'pending',
+  ACCEPTED: 'accepted',
+};
+
 export const COPILOT_OPPORTUNITY_STATUS = {
   ACTIVE: 'active',
   COMPLETED: 'completed',

src/models/copilotApplication.js

@@ -1,4 +1,5 @@
 import _ from 'lodash';
+import { COPILOT_APPLICATION_STATUS } from '../constants';
 
 module.exports = function defineCopilotOpportunity(sequelize, DataTypes) {
   const CopilotApplication = sequelize.define('CopilotApplication', {
@@ -8,14 +9,22 @@ module.exports = function defineCopilotOpportunity(sequelize, DataTypes) {
       allowNull: false,
       references: {
         model: 'copilot_opportunities',
-        key: 'id'
+        key: 'id',
       },
       onUpdate: 'CASCADE',
-      onDelete: 'CASCADE'
+      onDelete: 'CASCADE',
     },
     notes: {
       type: DataTypes.TEXT,
-      allowNull: true
+      allowNull: true,
+    },
+    status: {
+      type: DataTypes.STRING(16),
+      defaultValue: 'pending',
+      validate: {
+        isIn: [_.values(COPILOT_APPLICATION_STATUS)],
+      },
+      allowNull: false,
     },
     userId: { type: DataTypes.BIGINT, allowNull: false },
     deletedAt: { type: DataTypes.DATE, allowNull: true },

src/permissions/constants.js

@@ -276,6 +276,18 @@ export const PERMISSION = { // eslint-disable-line import/prefer-default-export
     ],
     scopes: SCOPES_PROJECTS_WRITE,
   },
+  ASSIGN_COPILOT_OPPORTUNITY: {
+    meta: {
+      title: 'Assign copilot to opportunity',
+      group: 'Assign Copilot',
+      description: 'Who can assign for copilot opportunity.',
+    },
+    topcoderRoles: [
+      USER_ROLE.PROJECT_MANAGER,
+      USER_ROLE.TOPCODER_ADMIN,
+    ],
+    scopes: SCOPES_PROJECTS_WRITE,
+  },
 
   LIST_COPILOT_OPPORTUNITY: {
     meta: {

src/routes/copilotOpportunity/assign.js

@@ -0,0 +1,94 @@
+import _ from 'lodash';
+import validate from 'express-validation';
+import Joi from 'joi';
+
+import models from '../../models';
+import util from '../../util';
+import { PERMISSION } from '../../permissions/constants';
+import { COPILOT_APPLICATION_STATUS, COPILOT_OPPORTUNITY_STATUS, COPILOT_REQUEST_STATUS } from '../../constants';
+
+const assignCopilotOpportunityValidations = {
+  body: Joi.object().keys({
+    applicationId: Joi.string(),
+  }),
+};
+
+module.exports = [
+  validate(assignCopilotOpportunityValidations),
+  async (req, res, next) => {
+    const { applicationId } = req.body;
+    const copilotOpportunityId = _.parseInt(req.params.id);
+    if (!util.hasPermissionByReq(PERMISSION.ASSIGN_COPILOT_OPPORTUNITY, req)) {
+      const err = new Error('Unable to assign copilot opportunity');
+      _.assign(err, {
+        details: JSON.stringify({ message: 'You do not have permission to assign a copilot opportunity' }),
+        status: 403,
+      });
+      return next(err);
+    }
+
+    return models.sequelize.transaction(async (t) => {
+      const opportunity = await models.CopilotOpportunity.findOne({
+        where: { id: copilotOpportunityId },
+        transaction: t,
+      });
+
+      if (!opportunity) {
+        const err = new Error('No opportunity found');
+        err.status = 404;
+        throw err;
+      }
+
+      if (opportunity.status !== COPILOT_OPPORTUNITY_STATUS.ACTIVE) {
+        const err = new Error('Opportunity is not active');
+        err.status = 400;
+        throw err;
+      }
+
+      const application = await models.CopilotApplication.findOne({
+        where: { id: applicationId },
+        transaction: t,
+      });
+
+      if (!application) {
+        const err = new Error('No such application available');
+        err.status = 400;
+        throw err;
+      }
+
+      if (application.status === COPILOT_APPLICATION_STATUS.ACCEPTED) {
+        const err = new Error('Application already accepted');
+        err.status = 400;
+        throw err;
+      }
+
+      const projectId = opportunity.projectId;
+      const userId = application.userId;
+      const activeMembers = await models.ProjectMember.getActiveProjectMembers(projectId);
+
+      const existingUser = activeMembers.find(item => item.userId === userId);
+      if (existingUser && existingUser.role === 'copilot') {
+        const err = new Error(`User is already a copilot of this project`);
+        err.status = 400;
+        throw err;
+      }
+
+      await models.CopilotRequest.update(
+        { status: COPILOT_REQUEST_STATUS.FULFILLED },
+        { where: { id: opportunity.copilotRequestId }, transaction: t },
+      );
+
+      await opportunity.update(
+        { status: COPILOT_OPPORTUNITY_STATUS.COMPLETED },
+        { transaction: t },
+      );
+
+      await models.CopilotApplication.update(
+        { status: COPILOT_APPLICATION_STATUS.ACCEPTED },
+        { where: { id: applicationId }, transaction: t },
+      );
+
+      res.status(200).send({ id: applicationId });
+    }).catch(err => next(err));
+  },
+];

src/routes/copilotOpportunityApply/create.js

@@ -63,16 +63,16 @@ module.exports = [
         res.status(200).json(existingApplication);
         return Promise.resolve();
       }
-  
+
       return models.CopilotApplication.create(data)
         .then((result) => {
           res.status(201).json(result);
           return Promise.resolve();
         })
         .catch((err) => {
-        util.handleError('Error creating copilot application', err, req, next);
-        return next(err);
-      });
+          util.handleError('Error creating copilot application', err, req, next);
+          return next(err);
+        });
     }).catch((e) => {
       util.handleError('Error applying for copilot opportunity', e, req, next);
     });

src/routes/copilotOpportunityApply/list.js

@@ -10,7 +10,6 @@ const permissions = tcMiddleware.permissions;
 module.exports = [
   permissions('copilotApplications.view'),
   (req, res, next) => {
-
     const canAccessAllApplications = util.hasRoles(req, ADMIN_ROLES) || util.hasProjectManagerRole(req);
     const userId = req.authUser.userId;
     const opportunityId = _.parseInt(req.params.id);
@@ -29,7 +28,7 @@ module.exports = [
     const whereCondition = _.assign({
       opportunityId,
     },
-      canAccessAllApplications ? {} : { createdBy: userId },
+    canAccessAllApplications ? {} : { createdBy: userId },
     );
 
     return models.CopilotApplication.findAll({