Merge pull request #1697 from Northeastern-Electric-Racing/1523-bom-delete-manufacturer-endpoint

#1523 : Delete manufacturer endpoint

Author: RChandler234

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

@@ -193,6 +193,17 @@ export default class ProjectsController {
     }
   }
 
+  static async deleteManufacturer(req: Request, res: Response, next: NextFunction) {
+    try {
+      const user: User = await getCurrentUser(res);
+      const { manufacturerName } = req.params;
+      const deletedManufacturer: Manufacturer = await ProjectsService.deleteManufacturer(user, manufacturerName);
+      res.status(200).json(deletedManufacturer);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async getAllManufacturers(req: Request, res: Response, next: NextFunction) {
     try {
       const user = await getCurrentUser(res);

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

@@ -62,6 +62,7 @@ CREATE TABLE "Manufacturer" (
     "name" TEXT NOT NULL,
     "dateCreated" TIMESTAMP(3) NOT NULL,
     "creatorId" INTEGER NOT NULL,
+    "dateDeleted" TIMESTAMP(3),
 
     CONSTRAINT "Manufacturer_pkey" PRIMARY KEY ("name")
 );

src/backend/src/prisma/schema.prisma

@@ -528,5 +528,6 @@ model Manufacturer {
   name        String     @id
   dateCreated DateTime
   creatorId   Int
+  dateDeleted DateTime?
   materials   Material[]
 }

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

@@ -56,6 +56,7 @@ projectRouter.post(
   validateInputs,
   ProjectsController.createManufacturer
 );
+projectRouter.delete('/bom/manufacturer/:manufacturerName/delete', ProjectsController.deleteManufacturer);
 projectRouter.get('/bom/manufacturer', ProjectsController.getAllManufacturers);
 projectRouter.post('/bom/material-type/create', nonEmptyString(body('name')), ProjectsController.createMaterialType);
 projectRouter.post(

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

@@ -798,6 +798,42 @@ export default class ProjectsService {
     return newManufacturer;
   }
 
+  /**
+   * Deletes a manufacturer
+   * @param user the user who's deleting the manufacturer
+   * @param name the name of the manufacturer
+   * @throws if the user is not at least a head, or if the provided name isn't a manufacturer, or if the manufacturer has already been soft-deleted
+   * @returns the deleted manufacturer
+   */
+  static async deleteManufacturer(user: User, name: string) {
+    if (!isHead(user.role)) {
+      throw new AccessDeniedException('Only heads and above can delete a manufacturer');
+    }
+
+    const manufacturer = await prisma.manufacturer.findFirst({
+      where: {
+        name
+      }
+    });
+
+    if (!manufacturer) {
+      throw new NotFoundException('Manufacturer', name);
+    }
+
+    if (manufacturer.dateDeleted) throw new DeletedException('Manufacturer', manufacturer.name);
+
+    const dateDeleted: Date = new Date();
+    const deletedManufacturer = await prisma.manufacturer.update({
+      where: {
+        name: manufacturer.name
+      },
+      data: {
+        dateDeleted
+      }
+    });
+
+    return deletedManufacturer;
+  }
   /**
    * Get all the manufacturers in the database.
    * @returns all the manufacturers

src/backend/src/transformers/manufacturer.transformer.ts

@@ -12,6 +12,7 @@ export const manufacturerTransformer = (
   return {
     name: manufacturer.name,
     dateCreated: manufacturer.dateCreated,
-    creatorId: manufacturer.creatorId
+    creatorId: manufacturer.creatorId,
+    dateDeleted: manufacturer.dateDeleted
   };
 };

src/backend/tests/projects.test.ts

@@ -642,6 +642,46 @@ describe('Projects', () => {
       expect(manufacturer.creatorId).toBe(prismaManufacturer1.creatorId);
     });
 
+    test('deleteManufacturer works', async () => {
+      vi.spyOn(prisma.manufacturer, 'findFirst').mockResolvedValue(prismaManufacturer1);
+      vi.spyOn(prisma.manufacturer, 'update').mockResolvedValue(prismaManufacturer1);
+
+      const manufacturer = await ProjectsService.deleteManufacturer(batman, prismaManufacturer1.name);
+
+      expect(manufacturer).toStrictEqual(prismaManufacturer1);
+      expect(prisma.manufacturer.findFirst).toHaveBeenCalledTimes(1);
+      expect(prisma.manufacturer.update).toHaveBeenCalledTimes(1);
+    });
+
+    test('deleteManufacturer fails when user is not at least Head', async () => {
+      vi.spyOn(prisma.manufacturer, 'findFirst').mockResolvedValue(prismaManufacturer1);
+      vi.spyOn(prisma.manufacturer, 'update').mockResolvedValue(prismaManufacturer1);
+
+      await expect(
+        async () => await ProjectsService.deleteManufacturer(wonderwoman, prismaManufacturer1.name)
+      ).rejects.toThrow(new AccessDeniedException('Only heads and above can delete a manufacturer'));
+
+      expect(prisma.project.findFirst).toHaveBeenCalledTimes(0);
+      expect(prisma.project.update).toHaveBeenCalledTimes(0);
+    });
+
+    test('deleteManufacturer fails when manufacturer is not found', async () => {
+      vi.spyOn(prisma.manufacturer, 'findFirst').mockResolvedValue(null);
+
+      await expect(async () => await ProjectsService.deleteManufacturer(batman, prismaManufacturer1.name)).rejects.toThrow(
+        new NotFoundException('Manufacturer', prismaManufacturer1.name)
+      );
+
+      expect(prisma.project.findFirst).toHaveBeenCalledTimes(0);
+      expect(prisma.project.update).toHaveBeenCalledTimes(0);
+    });
+
+    test('deleteManufacturer fails when manufacturer has been deleted', async () => {
+      vi.spyOn(prisma.manufacturer, 'findFirst').mockResolvedValue(prismaManufacturer2);
+      await expect(async () => await ProjectsService.deleteManufacturer(batman, prismaManufacturer2.name)).rejects.toThrow(
+        new DeletedException('Manufacturer', prismaManufacturer2.name)
+      );
+    });
     test('Get all Manufacturer works', async () => {
       vi.spyOn(prisma.manufacturer, 'findMany').mockResolvedValue([]);
 

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

@@ -153,13 +153,15 @@ export const prismaMaterial: Material = {
 export const prismaManufacturer1: Manufacturer = {
   name: 'Manufacturer1',
   dateCreated: new Date('10-1-2023'),
-  creatorId: 1
+  creatorId: 1,
+  dateDeleted: null
 };
 
 export const prismaManufacturer2: Manufacturer = {
   name: 'name',
   dateCreated: new Date('10-18-2023'),
-  creatorId: 1
+  creatorId: 1,
+  dateDeleted: new Date('10-18-2023')
 };
 
 export const toolMaterial: PrismaMaterialType = {