Merge pull request #1656 from Northeastern-Electric-Racing/#1521-bom-create-manufacturer-endpoint

#1521 BOM create manufacturer endpoint

Author: RChandler234

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

@@ -127,4 +127,15 @@ export default class ProjectsController {
       next(error);
     }
   }
+
+  static async createManufacturer(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { name } = req.body;
+      const user = await getCurrentUser(res);
+      const createdManufacturer = await ProjectsService.createManufacturer(user, name);
+      res.status(200).json(createdManufacturer);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

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

@@ -48,4 +48,12 @@ projectRouter.post('/:wbsNum/set-team', nonEmptyString(body('teamId')), validate
 projectRouter.delete('/:wbsNum/delete', ProjectsController.deleteProject);
 projectRouter.post('/:wbsNum/favorite', ProjectsController.toggleFavorite);
 
+/**************** BOM Section ****************/
+projectRouter.post(
+  '/bom/manufacturer/create',
+  nonEmptyString(body('name')),
+  validateInputs,
+  ProjectsController.createManufacturer
+);
+
 export default projectRouter;

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

@@ -602,4 +602,29 @@ export default class ProjectsService {
       })
     ).map(linkTypeTransformer);
   }
+
+  /**
+   * Creates a new Manufacturer
+   * @param submitter the user who's creating the manufacturer
+   * @param name the name of the manufacturer
+   * @returns the newly created manufacturer
+   * @throws if the submitter is a guest or the given manufacturer name already exists
+   */
+  static async createManufacturer(submitter: User, name: string) {
+    if (isGuest(submitter.role)) throw new AccessDeniedGuestException('create manufacturers');
+
+    const manufacturer = await prisma.manufacturer.findUnique({
+      where: {
+        name
+      }
+    });
+
+    if (manufacturer) throw new HttpException(400, `${name} already exists as a manufacturer!`);
+
+    const newManufacturer = await prisma.manufacturer.create({
+      data: { name, dateCreated: new Date(), creatorId: submitter.userId }
+    });
+
+    return newManufacturer;
+  }
 }

src/backend/tests/projects.test.ts

@@ -2,13 +2,14 @@ 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, wonderwoman } from './test-data/users.test-data';
-import { prismaProject1, sharedProject1 } from './test-data/projects.test-data';
+import { prismaManufacturer1, prismaProject1, sharedProject1 } from './test-data/projects.test-data';
 import { prismaChangeRequest1 } from './test-data/change-requests.test-data';
 import { prismaTeam1 } from './test-data/teams.test-data';
 import * as projectTransformer from '../src/transformers/projects.transformer';
 import ProjectsService from '../src/services/projects.services';
 import {
   AccessDeniedAdminOnlyException,
+  AccessDeniedGuestException,
   DeletedException,
   HttpException,
   NotFoundException
@@ -254,4 +255,30 @@ describe('Projects', () => {
       expect(prisma.user.update).toBeCalledTimes(1);
     });
   });
+
+  describe('Manufacturer Tests', () => {
+    test('createManufacturer throws an error if user is a guest', async () => {
+      await expect(ProjectsService.createManufacturer(wonderwoman, 'NAME')).rejects.toThrow(
+        new AccessDeniedGuestException('create manufacturers')
+      );
+    });
+
+    test('createManufacturer throws an error if manufacturer already exists', async () => {
+      vi.spyOn(prisma.manufacturer, 'findUnique').mockResolvedValue(prismaManufacturer1);
+
+      await expect(ProjectsService.createManufacturer(batman, 'Manufacturer1')).rejects.toThrow(
+        new HttpException(400, 'Manufacturer1 already exists as a manufacturer!')
+      );
+    });
+
+    test('createManufacturer works as intended and successfully returns correct name and creator ID', async () => {
+      vi.spyOn(prisma.manufacturer, 'findUnique').mockResolvedValue(null);
+      vi.spyOn(prisma.manufacturer, 'create').mockResolvedValue(prismaManufacturer1);
+
+      const manufacturer = await ProjectsService.createManufacturer(batman, 'Manufacturer1');
+
+      expect(manufacturer.name).toBe(prismaManufacturer1.name);
+      expect(manufacturer.creatorId).toBe(prismaManufacturer1.creatorId);
+    });
+  });
 });

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

@@ -1,4 +1,4 @@
-import { Prisma, WBS_Element_Status as PrismaWBSElementStatus, Project } from '@prisma/client';
+import { Prisma, WBS_Element_Status as PrismaWBSElementStatus, Project, Manufacturer } from '@prisma/client';
 import { Project as SharedProject, WbsElementStatus } from 'shared';
 import projectQueryArgs from '../../src/prisma-query-args/projects.query-args';
 import { prismaTeam1 } from './teams.test-data';
@@ -97,3 +97,9 @@ export const sharedProject1: SharedProject = {
   tasks: [],
   teams: []
 };
+
+export const prismaManufacturer1: Manufacturer = {
+  name: 'Manufacturer1',
+  dateCreated: new Date('10-1-2023'),
+  creatorId: 1
+};