Merge pull request #1684 from Northeastern-Electric-Racing/#1524-Delete-Material-Type-Endpoint

1524 Created the delete materials type endpoint and tested it

Author: RChandler234

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

@@ -213,6 +213,16 @@ export default class ProjectsController {
       next(error);
     }
   }
+  static async deleteMaterialType(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { materialTypeId } = req.params;
+      const user = await getCurrentUser(res);
+      const deletedMaterial = await ProjectsService.deleteMaterialType(materialTypeId, user);
+      res.status(200).json(deletedMaterial);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 
   static async editMaterial(req: Request, res: Response, next: NextFunction) {
     try {

…ons/20231119042617_add_bom/migration.sql …ons/20231119054311_add_bom/migration.sqlsrc/backend/src/prisma/migrations/20231119042617_add_bom/migration.sql renamed to src/backend/src/prisma/migrations/20231119054311_add_bom/migration.sql src/backend/src/prisma/migrations/20231119042617_add_bom/migration.sql renamed to src/backend/src/prisma/migrations/20231119054311_add_bom/migration.sql

@@ -51,6 +51,7 @@ CREATE TABLE "Material" (
 CREATE TABLE "Material_Type" (
     "name" TEXT NOT NULL,
     "dateCreated" TIMESTAMP(3) NOT NULL,
+    "dateDeleted" TIMESTAMP(3),
     "creatorId" INTEGER NOT NULL,
 
     CONSTRAINT "Material_Type_pkey" PRIMARY KEY ("name")

src/backend/src/prisma/schema.prisma

@@ -519,6 +519,7 @@ model Material {
 model Material_Type {
   name        String     @id
   dateCreated DateTime
+  dateDeleted DateTime?
   creatorId   Int
   materials   Material[]
 }

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

@@ -101,4 +101,6 @@ projectRouter.post(
   ProjectsController.editMaterial
 );
 
+projectRouter.delete('/bom/material-type/:materialTypeId/delete', ProjectsController.deleteMaterialType);
+
 export default projectRouter;

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

@@ -1,5 +1,16 @@
+import {
+  isAdmin,
+  isGuest,
+  isHead,
+  isLeadership,
+  isProject,
+  LinkCreateArgs,
+  LinkType,
+  Project,
+  WbsNumber,
+  wbsPipe
+} from 'shared';
 import { Manufacturer, Role, Material_Type, User, Assembly, Material_Status, Material } from '@prisma/client';
-import { isAdmin, isGuest, isLeadership, isProject, LinkCreateArgs, LinkType, Project, WbsNumber, wbsPipe } from 'shared';
 import projectQueryArgs from '../prisma-query-args/projects.query-args';
 import prisma from '../prisma/prisma';
 import projectTransformer from '../transformers/projects.transformer';
@@ -832,6 +843,38 @@ export default class ProjectsService {
     return newMaterialType;
   }
 
+  /**
+   * Deletes a material type based on the given Id
+   * @param submitter the user who is deleting the material type
+   * @param materialTypeId the Id of the material type being deleted
+   * @throws if the submitter is not an admin/head or if the material type is not found
+   * @returns the deleted material type
+   */
+  static async deleteMaterialType(materialTypeId: string, submitter: User): Promise<Material_Type> {
+    if (!isHead(submitter.role) && !isAdmin(submitter.role)) {
+      throw new AccessDeniedException('Only an admin or head can delete a material type');
+    }
+    const materialType = await prisma.material_Type.findUnique({
+      where: {
+        name: materialTypeId
+      }
+    });
+
+    if (!materialType) throw new NotFoundException('Material Type', materialTypeId);
+    if (materialType.dateDeleted) throw new DeletedException('Material Type', materialTypeId);
+
+    const deletedMaterialType = await prisma.material_Type.update({
+      where: {
+        name: materialTypeId
+      },
+      data: {
+        dateDeleted: new Date()
+      }
+    });
+
+    return deletedMaterialType;
+  }
+
   /**
    * Update a material
    * @param submitter the submitter of the request

src/backend/tests/projects.test.ts

@@ -1,7 +1,7 @@
 import prisma from '../src/prisma/prisma';
 import { getHighestProjectNumber } from '../src/utils/projects.utils';
 import * as changeRequestUtils from '../src/utils/change-requests.utils';
-import { aquaman, batman, superman, theVisitor, wonderwoman } from './test-data/users.test-data';
+import { aquaman, batman, wonderwoman, superman, theVisitor } from './test-data/users.test-data';
 import {
   prismaProject1,
   sharedProject1,
@@ -685,6 +685,35 @@ describe('Projects', () => {
     });
   });
 
+  describe('Deleting material type', () => {
+    test('Delete Material Type does not work if user is not an admin or head', async () => {
+      await expect(ProjectsService.deleteMaterialType('NERSoftwareTools', theVisitor)).rejects.toThrow(
+        new AccessDeniedException('Only an admin or head can delete a material type')
+      );
+    });
+
+    test('Delete Material Type does not work if material type does not exist', async () => {
+      await expect(ProjectsService.deleteMaterialType('NERSoftwareTools', batman)).rejects.toThrow(
+        new NotFoundException('Material Type', 'NERSoftwareTools')
+      );
+    });
+
+    test('Deleted Material Tye does not work if the material type is already deleted', async () => {
+      vi.spyOn(prisma.material_Type, 'findUnique').mockResolvedValue({ ...toolMaterial, dateDeleted: new Date() });
+      await expect(ProjectsService.deleteMaterialType('NERSoftwareTools', batman)).rejects.toThrow(
+        new DeletedException('Material Type', 'NERSoftwareTools')
+      );
+    });
+
+    test('Delete Material Type works', async () => {
+      vi.spyOn(prisma.material_Type, 'findUnique').mockResolvedValue(toolMaterial);
+      vi.spyOn(prisma.material_Type, 'update').mockResolvedValue({ ...toolMaterial, dateDeleted: new Date() });
+      const deletedMaterialType = await ProjectsService.deleteMaterialType('NERSoftwareTools', superman);
+      expect(deletedMaterialType.name).toBe('NERSoftwareTools');
+      expect(prisma.material_Type.update).toBeCalledTimes(1);
+    });
+  });
+
   describe('updateMaterial', () => {
     test('Update material fails if the given material does not exists', async () => {
       vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(null);

src/backend/tests/test-data/projects.test-data.ts

@@ -121,7 +121,8 @@ export const prismaAssembly1: Assembly = {
 export const prismaMaterialType: PrismaMaterialType = {
   name: 'name',
   dateCreated: new Date('10-18-2023'),
-  creatorId: 1
+  creatorId: 1,
+  dateDeleted: null
 };
 
 export const prismaUnit: Unit = {
@@ -164,7 +165,8 @@ export const prismaManufacturer2: Manufacturer = {
 export const toolMaterial: PrismaMaterialType = {
   name: 'NERSoftwareTools',
   dateCreated: new Date(),
-  creatorId: batman.userId
+  creatorId: batman.userId,
+  dateDeleted: null
 };
 
 export const prismaMaterial2: Material = {