Merge pull request #1567 from Northeastern-Electric-Racing/#1330-wp-create-backend-redesign

#1330: redesigned the create wp endpoint

Author: RChandler234

src/backend/src/controllers/work-packages.controllers.ts

@@ -32,7 +32,7 @@ export default class WorkPackagesController {
   // Create a work package with the given details
   static async createWorkPackage(req: Request, res: Response, next: NextFunction) {
     try {
-      const { projectWbsNum, name, crId, startDate, duration, blockedBy, expectedActivities, deliverables } = req.body;
+      const { name, crId, startDate, duration, blockedBy, expectedActivities, deliverables } = req.body;
 
       let { stage } = req.body;
       if (stage === 'NONE') {
@@ -43,7 +43,6 @@ export default class WorkPackagesController {
 
       const wbsString: string = await WorkPackagesService.createWorkPackage(
         user,
-        projectWbsNum,
         name,
         crId,
         stage,

src/backend/src/prisma/seed-data/work-packages.seed.ts

@@ -18,7 +18,6 @@ import { descBulletConverter } from '../../utils/description-bullets.utils';
  */
 export const seedWorkPackage = async (
   creator: User,
-  projectWbsNumber: WbsNumber,
   name: string,
   changeRequestId: number,
   stage: WorkPackageStage | null,
@@ -37,7 +36,6 @@ export const seedWorkPackage = async (
 }> => {
   const workPackage1WbsString = await WorkPackagesService.createWorkPackage(
     creator,
-    projectWbsNumber,
     name,
     changeRequestId,
     stage,

src/backend/src/prisma/seed.ts

@@ -316,15 +316,74 @@ const performSeed: () => Promise<void> = async () => {
     joeBlow.userId
   );
 
+  /**
+   * Change Requests for Creating Work Packages
+   */
+
+  const changeRequestWP1Id: number = await ChangeRequestsService.createStandardChangeRequest(
+    cyborg,
+    project1WbsNumber.carNumber,
+    project1WbsNumber.projectNumber,
+    project1WbsNumber.workPackageNumber,
+    CR_Type.OTHER,
+    'Initial Change Request',
+    [
+      {
+        type: Scope_CR_Why_Type.INITIALIZATION,
+        explain: 'need this to initialize work packages'
+      }
+    ]
+  );
+
+  // make a proposed solution for it
+  const proposedSolution2Id: string = await ChangeRequestsService.addProposedSolution(
+    cyborg,
+    changeRequestWP1Id,
+    0,
+    'Initializing seed data',
+    0,
+    'no scope impact'
+  );
+
+  // approve the change request
+  await ChangeRequestsService.reviewChangeRequest(batman, changeRequestWP1Id, 'LGTM', true, proposedSolution2Id);
+
+  const changeRequestWP5Id: number = await ChangeRequestsService.createStandardChangeRequest(
+    cyborg,
+    project5WbsNumber.carNumber,
+    project5WbsNumber.projectNumber,
+    project5WbsNumber.workPackageNumber,
+    CR_Type.OTHER,
+    'Initial Change Request',
+    [
+      {
+        type: Scope_CR_Why_Type.INITIALIZATION,
+        explain: 'need this to initialize work packages'
+      }
+    ]
+  );
+
+  // make a proposed solution for it
+  const proposedSolution5Id: string = await ChangeRequestsService.addProposedSolution(
+    cyborg,
+    changeRequestWP5Id,
+    0,
+    'Initializing seed data',
+    0,
+    'no scope impact'
+  );
+
+  // approve the change request
+  await ChangeRequestsService.reviewChangeRequest(batman, changeRequestWP5Id, 'LGTM', true, proposedSolution5Id);
+
   /**
    * Work Packages
    */
   /** Work Package 1 */
   const { workPackageWbsNumber: workPackage1WbsNumber, workPackage: workPackage1 } = await seedWorkPackage(
     joeShmoe,
-    project1WbsNumber,
     'Bodywork Concept of Design',
-    changeRequest1Id,
+    changeRequestWP1Id,
     WorkPackageStage.Design,
     '01/01/2023',
     3,
@@ -363,9 +422,8 @@ const performSeed: () => Promise<void> = async () => {
   /** Work Package 2 */
   const { workPackageWbsNumber: workPackage2WbsNumber, workPackage: workPackage2 } = await seedWorkPackage(
     thomasEmrax,
-    project1WbsNumber,
     'Adhesive Shear Strength Test',
-    changeRequest1Id,
+    changeRequestWP1Id,
     WorkPackageStage.Research,
     '01/22/2023',
     5,
@@ -387,9 +445,8 @@ const performSeed: () => Promise<void> = async () => {
   /** Work Package 3 */
   const workPackage3WbsString = await WorkPackagesService.createWorkPackage(
     thomasEmrax,
-    project5WbsNumber,
     'Manufacture Wiring Harness',
-    changeRequest1Id,
+    changeRequestWP5Id,
     WorkPackageStage.Manufacturing,
     '02/01/2023',
     3,

src/backend/src/routes/work-packages.routes.ts

@@ -11,12 +11,10 @@ workPackagesRouter.post(
   '/create',
   intMinZero(body('crId')),
   nonEmptyString(body('name')),
-  intMinZero(body('projectWbsNum.carNumber')),
-  intMinZero(body('projectWbsNum.projectNumber')),
-  intMinZero(body('projectWbsNum.workPackageNumber')),
   isWorkPackageStageOrNone(body('stage')),
   isDate(body('startDate')),
   intMinZero(body('duration')),
+  body('blockedBy').isArray(),
   intMinZero(body('blockedBy.*.carNumber')),
   intMinZero(body('blockedBy.*.projectNumber')),
   intMinZero(body('blockedBy.*.workPackageNumber')),

src/backend/src/services/work-packages.services.ts

@@ -111,7 +111,6 @@ export default class WorkPackagesService {
   /**
    * Creates a Work_Package in the database
    * @param user the user creating the work package
-   * @param projectWbsNum the WBS number of the attached project
    * @param name the name of the new work package
    * @param crId the id of the change request creating this work package
    * @param stage the stage of the work package
@@ -125,7 +124,6 @@ export default class WorkPackagesService {
    */
   static async createWorkPackage(
     user: User,
-    projectWbsNum: WbsNumber,
     name: string,
     crId: number,
     stage: WorkPackageStage | null,
@@ -137,30 +135,11 @@ export default class WorkPackagesService {
   ): Promise<string> {
     if (isGuest(user.role)) throw new AccessDeniedGuestException('create work packages');
 
-    await validateChangeRequestAccepted(crId);
-
-    // get the corresponding project so we can find the next wbs number
-    // and what number work package this should be
-    const { carNumber, projectNumber, workPackageNumber } = projectWbsNum;
-
-    if (workPackageNumber !== 0) {
-      throw new HttpException(
-        400,
-        `Given WBS Number ${carNumber}.${projectNumber}.${workPackageNumber} is not for a project.`
-      );
-    }
-
-    if (blockedBy.find((dep: WbsNumber) => equalsWbsNumber(dep, projectWbsNum))) {
-      throw new HttpException(400, 'A Work Package cannot have its own project as a blocker');
-    }
+    const changeRequest = await validateChangeRequestAccepted(crId);
 
     const wbsElem = await prisma.wBS_Element.findUnique({
       where: {
-        wbsNumber: {
-          carNumber,
-          projectNumber,
-          workPackageNumber
-        }
+        wbsElementId: changeRequest.wbsElementId
       },
       include: {
         project: {
@@ -171,10 +150,32 @@ export default class WorkPackagesService {
       }
     });
 
-    if (!wbsElem) throw new NotFoundException('WBS Element', `${carNumber}.${projectNumber}.${workPackageNumber}`);
+    if (!wbsElem) throw new NotFoundException('WBS Element', changeRequest.wbsElementId);
+
+    // get the corresponding project so we can find the next wbs number
+    // and what number work package this should be
+    const { carNumber, projectNumber, workPackageNumber } = wbsElem;
+
+    const projectWbsNum: WbsNumber = {
+      carNumber,
+      projectNumber,
+      workPackageNumber
+    };
+
     if (wbsElem.dateDeleted)
       throw new DeletedException('WBS Element', wbsPipe({ carNumber, projectNumber, workPackageNumber }));
 
+    if (workPackageNumber !== 0) {
+      throw new HttpException(
+        400,
+        `Given WBS Number ${carNumber}.${projectNumber}.${workPackageNumber} is not for a project.`
+      );
+    }
+
+    if (blockedBy.find((dep: WbsNumber) => equalsWbsNumber(dep, projectWbsNum))) {
+      throw new HttpException(400, 'A Work Package cannot have its own project as a blocker');
+    }
+
     const { project } = wbsElem;
 
     if (!project) throw new NotFoundException('Project', `${carNumber}.${projectNumber}.${workPackageNumber}`);

src/backend/tests/test-data/wbs-element.test-data.ts

@@ -13,3 +13,17 @@ export const prismaWbsElement1: PrismaWbsElement = {
   projectLeadId: 4,
   projectManagerId: 5
 };
+
+export const prismaWbsElement2: PrismaWbsElement = {
+  wbsElementId: 1,
+  status: PrismaWBSElementStatus.ACTIVE,
+  carNumber: 1,
+  projectNumber: 2,
+  workPackageNumber: 2,
+  dateCreated: new Date(),
+  dateDeleted: null,
+  name: 'car',
+  deletedByUserId: null,
+  projectLeadId: 4,
+  projectManagerId: 5
+};

src/backend/tests/work-packages.test.ts

@@ -1,6 +1,6 @@
 import prisma from '../src/prisma/prisma';
 import { batman, wonderwoman } from './test-data/users.test-data';
-import { prismaWbsElement1 } from './test-data/wbs-element.test-data';
+import { prismaWbsElement1, prismaWbsElement2 } from './test-data/wbs-element.test-data';
 import { prismaChangeRequest1 } from './test-data/change-requests.test-data';
 import { calculateWorkPackageProgress } from '../src/utils/work-packages.utils';
 import {
@@ -41,18 +41,17 @@ describe('Work Packages', () => {
   const expectedActivities = ['ayo'];
   const deliverables = ['ajdhjakfjafja'];
   const stage = WorkPackageStage.Design;
-  const createWorkPackageArgs: [
-    User,
-    WbsNumber,
-    string,
-    number,
-    WorkPackageStage,
-    string,
-    number,
-    WbsNumber[],
-    string[],
-    string[]
-  ] = [batman, projectWbsNum, name, crId, stage, startDate, duration, blockedBy, expectedActivities, deliverables];
+  const createWorkPackageArgs: [User, string, number, WorkPackageStage, string, number, WbsNumber[], string[], string[]] = [
+    batman,
+    name,
+    crId,
+    stage,
+    startDate,
+    duration,
+    blockedBy,
+    expectedActivities,
+    deliverables
+  ];
   /*********************************************************/
 
   afterEach(() => {
@@ -73,16 +72,12 @@ describe('Work Packages', () => {
 
   describe('createWorkPackage', () => {
     test('createWorkPackage fails if WBS number does not represent a project', async () => {
+      vi.spyOn(prisma.wBS_Element, 'findUnique').mockResolvedValue(prismaWbsElement2);
       vi.spyOn(prisma.change_Request, 'findUnique').mockResolvedValue(prismaChangeRequest1);
 
       const callCreateWP = async () => {
         return await WorkPackageService.createWorkPackage(
           batman,
-          {
-            carNumber: 1,
-            projectNumber: 2,
-            workPackageNumber: 2
-          },
           name,
           crId,
           stage,
@@ -115,12 +110,12 @@ describe('Work Packages', () => {
     });
 
     test('createWorkPackage fails if user does not have access', async () => {
+      vi.spyOn(prisma.wBS_Element, 'findUnique').mockResolvedValue(prismaWbsElement2);
       vi.spyOn(prisma.change_Request, 'findUnique').mockResolvedValue(prismaChangeRequest1);
 
       const callCreateWP = async () => {
         return await WorkPackageService.createWorkPackage(
           wonderwoman,
-          projectWbsNum,
           name,
           crId,
           stage,
@@ -156,7 +151,9 @@ describe('Work Packages', () => {
         return await WorkPackageService.createWorkPackage.apply(null, createWorkPackageArgs);
       };
 
-      await expect(callCreateWP).rejects.toThrowError(new NotFoundException('WBS Element', '1.2.0'));
+      await expect(callCreateWP).rejects.toThrowError(
+        new NotFoundException('WBS Element', prismaChangeRequest1.wbsElementId.toString())
+      );
     });
 
     test('createWorkPackage fails if the associated wbsElem does not have a project object', async () => {
@@ -167,22 +164,24 @@ describe('Work Packages', () => {
         return await WorkPackageService.createWorkPackage.apply(null, createWorkPackageArgs);
       };
 
-      await expect(callCreateWP).rejects.toThrowError(new NotFoundException('WBS Element', '1.2.0'));
+      await expect(callCreateWP).rejects.toThrowError(
+        new NotFoundException('WBS Element', prismaChangeRequest1.wbsElementId.toString())
+      );
     });
 
     test("fails if the blocked by include the work package's own project", async () => {
-      const argsToTest: [
-        User,
-        WbsNumber,
-        string,
-        number,
-        WorkPackageStage,
-        string,
-        number,
-        WbsNumber[],
-        string[],
-        string[]
-      ] = [batman, projectWbsNum, name, crId, stage, startDate, duration, [projectWbsNum], expectedActivities, deliverables];
+      vi.spyOn(prisma.wBS_Element, 'findUnique').mockResolvedValueOnce(prismaWbsElement1);
+      const argsToTest: [User, string, number, WorkPackageStage, string, number, WbsNumber[], string[], string[]] = [
+        batman,
+        name,
+        crId,
+        stage,
+        startDate,
+        duration,
+        [projectWbsNum],
+        expectedActivities,
+        deliverables
+      ];
 
       const callCreateWP = async () => {
         return await WorkPackageService.createWorkPackage.apply(null, argsToTest);