Merge pull request #1700 from Northeastern-Electric-Racing/#1527-Delete-Material-Endpoint

Issue #1527 initial push

Author: RChandler234

src/backend/src/controllers/projects.controllers.ts

@@ -269,6 +269,17 @@ export default class ProjectsController {
     }
   }
 
+  static async deleteMaterial(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { materialId } = req.params;
+      const user: User = await getCurrentUser(res);
+      const updatedMaterial = await ProjectsService.deleteMaterial(user, materialId);
+      res.status(200).json(updatedMaterial);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async editMaterial(req: Request, res: Response, next: NextFunction) {
     try {
       const user = await getCurrentUser(res);

src/backend/src/routes/projects.routes.ts

@@ -112,5 +112,6 @@ projectRouter.post(
 projectRouter.delete('/bom/material-type/:materialTypeId/delete', ProjectsController.deleteMaterialType);
 
 projectRouter.delete('/bom/assembly/:assemblyId/delete', ProjectsController.deleteAssemblyType);
+projectRouter.post('/bom/material/:materialId/delete', ProjectsController.deleteMaterial);
 
 export default projectRouter;

src/backend/src/services/projects.services.ts

@@ -1038,6 +1038,32 @@ export default class ProjectsService {
     return deletedMaterialType;
   }
 
+  /**
+   * Delete material in the database
+   * @param materialId the id number of the given material
+   * @param currentUser the current user currently accessing the material
+   * @returns the deleted material
+   * @throws if the user does not have permission, or materidal already deleted
+   */
+  static async deleteMaterial(currentUser: User, materialId: string): Promise<Material> {
+    if (!isLeadership(currentUser.role)) {
+      throw new AccessDeniedException('Only Leadership can delete materials');
+    }
+
+    const material = await prisma.material.findUnique({ where: { materialId } });
+
+    if (!material) throw new NotFoundException('Material', materialId);
+
+    if (material.dateDeleted) throw new DeletedException('Material', materialId);
+
+    const deletedMaterial = await prisma.material.update({
+      where: { materialId },
+      data: { dateDeleted: new Date(), userDeletedId: currentUser.userId }
+    });
+
+    return deletedMaterial;
+  }
+
   /**
    * Update a material
    * @param submitter the submitter of the request

src/backend/src/utils/errors.utils.ts

@@ -111,6 +111,7 @@ type ExceptionObjectNames =
   | 'Expense Type'
   | 'Reimbursement Request'
   | 'User Secure Settings'
+  | 'Material'
   | 'Image File'
   | 'Material'
   | 'Assembly'

src/backend/tests/projects.test.ts

@@ -683,6 +683,7 @@ describe('Projects', () => {
         new DeletedException('Manufacturer', prismaManufacturer2.name)
       );
     });
+
     test('Get all Manufacturer works', async () => {
       vi.spyOn(prisma.manufacturer, 'findMany').mockResolvedValue([]);
 
@@ -1014,5 +1015,42 @@ describe('Projects', () => {
       expect(updatedMaterial.name).toBe('name2');
       expect(prisma.material.update).toBeCalledTimes(1);
     });
+
+    test('deleteMaterial works', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(prismaMaterial);
+      const deletedMaterial = { ...prismaMaterial, dateDeleted: new Date() };
+      vi.spyOn(prisma.material, 'update').mockResolvedValue(deletedMaterial);
+
+      const material = await ProjectsService.deleteMaterial(batman, prismaMaterial.materialId);
+
+      expect(material).toStrictEqual(deletedMaterial);
+    });
+
+    test('deleteMaterial fails when user is not at least Lead', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(prismaMaterial);
+      vi.spyOn(prisma.material, 'update').mockResolvedValue(prismaMaterial);
+
+      await expect(async () => await ProjectsService.deleteMaterial(wonderwoman, prismaMaterial.materialId)).rejects.toThrow(
+        new AccessDeniedException('Only Leadership can delete materials')
+      );
+    });
+
+    test('deleteMaterial fails when material is not found', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(null);
+      vi.spyOn(prisma.material, 'update').mockResolvedValue(prismaMaterial);
+
+      await expect(async () => await ProjectsService.deleteMaterial(batman, prismaMaterial.materialId)).rejects.toThrow(
+        new NotFoundException('Material', prismaMaterial.materialId)
+      );
+    });
+
+    test('deleteMaterial fails when material has been deleted', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue({ ...prismaMaterial, dateDeleted: new Date() });
+      vi.spyOn(prisma.material, 'update').mockResolvedValue(prismaMaterial);
+
+      await expect(async () => await ProjectsService.deleteMaterial(batman, prismaMaterial.materialId)).rejects.toThrow(
+        new DeletedException('Material', prismaMaterial.materialId)
+      );
+    });
   });
 });