Merge pull request #1675 from Northeastern-Electric-Racing/#1519-get-all-manufacturers-endpoint

#1519 get all manufacturers endpoint

Author: RChandler234

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

@@ -1,6 +1,6 @@
 import { Project, validateWBS, WbsNumber, wbsPipe } from 'shared';
 import { NextFunction, Request, Response } from 'express';
-import { User } from '@prisma/client';
+import { Manufacturer, User } from '@prisma/client';
 import { getCurrentUser } from '../utils/auth.utils';
 import ProjectsService from '../services/projects.services';
 
@@ -193,6 +193,16 @@ export default class ProjectsController {
     }
   }
 
+  static async getAllManufacturers(req: Request, res: Response, next: NextFunction) {
+    try {
+      const user = await getCurrentUser(res);
+      const manufacturers: Manufacturer[] = await ProjectsService.getAllManufacturers(user);
+      return res.status(200).json(manufacturers);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async createMaterialType(req: Request, res: Response, next: NextFunction) {
     try {
       const { name } = req.body;

src/backend/src/prisma-query-args/manufacturers.query-args.ts

@@ -0,0 +1,14 @@
+/*
+ * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
+ * See the LICENSE file in the repository root folder for details.
+ */
+
+import { Prisma } from '@prisma/client';
+
+const manufacturerQueryArgs = Prisma.validator<Prisma.ManufacturerArgs>()({
+  include: {
+    materials: true
+  }
+});
+
+export default manufacturerQueryArgs;

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

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

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

@@ -1,4 +1,4 @@
-import { Material_Type, User, Assembly, Material_Status, Material } from '@prisma/client';
+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';
@@ -28,8 +28,10 @@ import {
 } from '../utils/description-bullets.utils';
 import linkQueryArgs from '../prisma-query-args/links.query-args';
 import linkTypeQueryArgs from '../prisma-query-args/link-types.query-args';
+import manufacturerQueryArgs from '../prisma-query-args/manufacturers.query-args';
 import { linkTypeTransformer } from '../transformers/links.transformer';
 import { updateLinks, linkToChangeListValue } from '../utils/links.utils';
+import { manufacturerTransformer } from '../transformers/manufacturer.transformer';
 import { isUserPartOfTeams } from '../utils/teams.utils';
 
 export default class ProjectsService {
@@ -783,6 +785,22 @@ export default class ProjectsService {
     return newManufacturer;
   }
 
+  /**
+   * Get all the manufacturers in the database.
+   * @returns all the manufacturers
+   */
+  static async getAllManufacturers(submitter: User): Promise<Manufacturer[]> {
+    if (submitter.role === Role.GUEST) {
+      throw new AccessDeniedGuestException('Get Manufacturers');
+    }
+
+    return (
+      await prisma.manufacturer.findMany({
+        ...manufacturerQueryArgs
+      })
+    ).map(manufacturerTransformer);
+  }
+
   /**
    * Create a new material type
    * @param name the name of the new material type

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

@@ -0,0 +1,17 @@
+/*
+ * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
+ * See the LICENSE file in the repository root folder for details.
+ */
+
+import { Manufacturer, Prisma } from '@prisma/client';
+import manufacturerQueryArgs from '../prisma-query-args/manufacturers.query-args';
+
+export const manufacturerTransformer = (
+  manufacturer: Prisma.ManufacturerGetPayload<typeof manufacturerQueryArgs>
+): Manufacturer => {
+  return {
+    name: manufacturer.name,
+    dateCreated: manufacturer.dateCreated,
+    creatorId: manufacturer.creatorId
+  };
+};

src/backend/tests/projects.test.ts

@@ -640,6 +640,23 @@ describe('Projects', () => {
       expect(manufacturer.name).toBe(prismaManufacturer1.name);
       expect(manufacturer.creatorId).toBe(prismaManufacturer1.creatorId);
     });
+
+    test('Get all Manufacturer works', async () => {
+      vi.spyOn(prisma.manufacturer, 'findMany').mockResolvedValue([]);
+
+      const res = await ProjectsService.getAllManufacturers(batman);
+
+      expect(prisma.manufacturer.findMany).toHaveBeenCalledTimes(1);
+      expect(res).toStrictEqual([]);
+    });
+
+    test('Get all Manufacturer fails from guest', async () => {
+      vi.spyOn(prisma.manufacturer, 'findMany').mockResolvedValue([]);
+
+      await expect(ProjectsService.getAllManufacturers(theVisitor)).rejects.toThrow(
+        new AccessDeniedGuestException('Get Manufacturers')
+      );
+    });
   });
 
   describe('materialType', () => {

src/shared/src/types/project-types.ts

@@ -96,6 +96,31 @@ export interface LinkCreateArgs {
   url: string;
 }
 
+export interface Material {
+  materialId: String;
+  name: String;
+  wbsElement: WbsElement;
+  wbsElementId: number;
+  dateCreated: Date;
+  userCreated: User;
+  userCreatedId: number;
+  materialTypeName: String;
+  manufacturerName: String;
+  manufacturerPartNumber: String;
+  quantity: number;
+  price: number;
+  subtotal: number;
+  linkUrl: String;
+  notes: String;
+}
+
+export interface Manufacturer {
+  name: string;
+  dateCreated: Date;
+  creatorId: number;
+  materials: Material[];
+}
+
 export enum MaterialStatus {
   Ordered = 'ORDERED',
   Received = 'RECEIVED',