Merge pull request #1548 from Northeastern-Electric-Racing/#1417-Get-Many-Work-Packages

#1417 - get many work packages endpoint

Author: RChandler234

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

@@ -29,6 +29,16 @@ export default class WorkPackagesController {
     }
   }
 
+  static async getManyWorkPackages(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { wbsNums } = req.body;
+      const workPackages: WorkPackage[] = await WorkPackagesService.getManyWorkPackages(wbsNums);
+      res.status(200).json(workPackages);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   // Create a work package with the given details
   static async createWorkPackage(req: Request, res: Response, next: NextFunction) {
     try {

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

@@ -6,6 +6,15 @@ import { intMinZero, isDate, isWorkPackageStageOrNone, nonEmptyString } from '..
 const workPackagesRouter = express.Router();
 
 workPackagesRouter.get('/', WorkPackagesController.getAllWorkPackages);
+workPackagesRouter.get(
+  '/get-many',
+  body('wbsNums').isArray(),
+  intMinZero(body('wbsNums.*.carNumber')),
+  intMinZero(body('wbsNums.*.projectNumber')),
+  intMinZero(body('wbsNums.*.workPackageNumber')),
+  validateInputs,
+  WorkPackagesController.getManyWorkPackages
+);
 workPackagesRouter.get('/:wbsNum', WorkPackagesController.getSingleWorkPackage);
 workPackagesRouter.post(
   '/create',

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

@@ -108,6 +108,53 @@ export default class WorkPackagesService {
     return workPackageTransformer(wp);
   }
 
+  /**
+   * Retrieve a subset of work packages.
+   * @param wbsNums the WBS numbers of the work packages to retrieve
+   * @returns the work packages with the given WBS numbers
+   * @throws if any of the work packages are not found
+   */
+  static async getManyWorkPackages(wbsNums: WbsNumber[]): Promise<WorkPackage[]> {
+    wbsNums.forEach((wbsNum) => {
+      if (isProject(wbsNum)) {
+        throw new HttpException(
+          404,
+          `WBS Number ${wbsNum.carNumber}.${wbsNum.projectNumber}.${wbsNum.workPackageNumber} is a project WBS#, not a Work Package WBS#`
+        );
+      }
+    });
+
+    const workPackagePromises = wbsNums.map(async (wbsNum) => {
+      const workPackage = await prisma.work_Package.findFirst({
+        where: {
+          AND: [
+            {
+              wbsElement: {
+                dateDeleted: null
+              }
+            },
+            {
+              wbsElement: {
+                carNumber: wbsNum.carNumber,
+                projectNumber: wbsNum.projectNumber,
+                workPackageNumber: wbsNum.workPackageNumber
+              }
+            }
+          ]
+        },
+        ...workPackageQueryArgs
+      });
+
+      if (!workPackage) {
+        throw new NotFoundException('Work Package', wbsPipe(wbsNum));
+      }
+      return workPackageTransformer(workPackage);
+    });
+
+    const resolvedWorkPackages = await Promise.all(workPackagePromises);
+    return resolvedWorkPackages;
+  }
+
   /**
    * Creates a Work_Package in the database
    * @param user the user creating the work package

src/backend/src/transformers/work-packages.transformer.ts

@@ -6,7 +6,7 @@ import { convertStatus, wbsNumOf } from '../utils/utils';
 import { calculateWorkPackageProgress } from '../utils/work-packages.utils';
 import userTransformer from './user.transformer';
 
-const workPackageTransformer = (wpInput: Prisma.Work_PackageGetPayload<typeof workPackageQueryArgs>) => {
+const workPackageTransformer = (wpInput: Prisma.Work_PackageGetPayload<typeof workPackageQueryArgs>): WorkPackage => {
   const expectedProgress = calculatePercentExpectedProgress(wpInput.startDate, wpInput.duration, wpInput.wbsElement.status);
   const wbsNum = wbsNumOf(wpInput.wbsElement);
   const progress = calculateWorkPackageProgress(wpInput.deliverables, wpInput.expectedActivities);

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

@@ -292,6 +292,18 @@ describe('Work Packages', () => {
     });
   });
 
+  describe('getManyWorkPackages', () => {
+    test('should retrieve an empty array for an empty WBS numbers array', async () => {
+      const wbsNums: WbsNumber[] = [];
+
+      vi.spyOn(prisma.work_Package, 'findMany').mockResolvedValue([]);
+
+      const result = await WorkPackageService.getManyWorkPackages(wbsNums);
+
+      expect(result).toStrictEqual([]);
+    });
+  });
+
   describe('slackMessageUpcomingDeadlines', () => {
     beforeEach(() => {
       vi.spyOn(slackUtils, 'sendSlackUpcomingDeadlineNotification').mockImplementation(async () => {});