Merge pull request #1712 from Northeastern-Electric-Racing/#1520-get-all-material-types-endpoint

#1520: added get all material types endpoint with the tests

Author: RChandler234

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

@@ -1,6 +1,6 @@
-import { Project, validateWBS, WbsNumber, wbsPipe } from 'shared';
+import { Manufacturer, MaterialType, Project, validateWBS, WbsNumber, wbsPipe } from 'shared';
 import { NextFunction, Request, Response } from 'express';
-import { Manufacturer, User } from '@prisma/client';
+import { User } from '@prisma/client';
 import { getCurrentUser } from '../utils/auth.utils';
 import ProjectsService from '../services/projects.services';
 
@@ -197,7 +197,7 @@ export default class ProjectsController {
     try {
       const user: User = await getCurrentUser(res);
       const { manufacturerName } = req.params;
-      const deletedManufacturer: Manufacturer = await ProjectsService.deleteManufacturer(user, manufacturerName);
+      const deletedManufacturer = await ProjectsService.deleteManufacturer(user, manufacturerName);
       res.status(200).json(deletedManufacturer);
     } catch (error: unknown) {
       next(error);
@@ -214,6 +214,16 @@ export default class ProjectsController {
     }
   }
 
+  static async getAllMaterialTypes(req: Request, res: Response, next: NextFunction) {
+    try {
+      const user = await getCurrentUser(res);
+      const materialTypes: MaterialType[] = await ProjectsService.getAllMaterialTypes(user);
+      return res.status(200).json(materialTypes);
+    } 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/material-type.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 materialTypeQueryArgs = Prisma.validator<Prisma.Material_TypeArgs>()({
+  include: {
+    materials: true
+  }
+});
+
+export default materialTypeQueryArgs;

src/backend/src/prisma/seed.ts

@@ -29,6 +29,7 @@ import { seedProject } from './seed-data/projects.seed';
 import { seedWorkPackage } from './seed-data/work-packages.seed';
 import ReimbursementRequestService from '../services/reimbursement-requests.services';
 import { writeFileSync } from 'fs';
+import ProjectsService from '../services/projects.services';
 
 const prisma = new PrismaClient();
 
@@ -839,6 +840,10 @@ const performSeed: () => Promise<void> = async () => {
     [joeShmoe.userId]
   );
 
+  /**
+   * Reimbursements
+   */
+
   const vendor = await ReimbursementRequestService.createVendor(thomasEmrax, 'Tesla');
   const vendor2 = await ReimbursementRequestService.createVendor(thomasEmrax, 'Amazon');
   const vendor3 = await ReimbursementRequestService.createVendor(thomasEmrax, 'Google');
@@ -869,6 +874,12 @@ const performSeed: () => Promise<void> = async () => {
     expenseType.expenseTypeId,
     100
   );
+
+  /**
+   * Bill of Materials
+   */
+  await ProjectsService.createManufacturer(thomasEmrax, 'Digikey');
+  await ProjectsService.createMaterialType('Resistor', thomasEmrax);
 };
 
 performSeed()

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

@@ -58,6 +58,7 @@ projectRouter.post(
 );
 projectRouter.delete('/bom/manufacturer/:manufacturerName/delete', ProjectsController.deleteManufacturer);
 projectRouter.get('/bom/manufacturer', ProjectsController.getAllManufacturers);
+projectRouter.get('/bom/material-type', ProjectsController.getAllMaterialTypes);
 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,3 +1,4 @@
+import { Role, Material_Type, User, Assembly, Material_Status, Material } from '@prisma/client';
 import {
   isAdmin,
   isGuest,
@@ -6,11 +7,12 @@ import {
   isProject,
   LinkCreateArgs,
   LinkType,
+  Manufacturer,
+  MaterialType,
   Project,
   WbsNumber,
   wbsPipe
 } from 'shared';
-import { Manufacturer, Role, Material_Type, User, Assembly, Material_Status, Material } from '@prisma/client';
 import projectQueryArgs from '../prisma-query-args/projects.query-args';
 import prisma from '../prisma/prisma';
 import projectTransformer from '../transformers/projects.transformer';
@@ -40,10 +42,12 @@ import {
 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 materialTypeQueryArgs from '../prisma-query-args/material-type.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';
+import { materialTypeTransformer } from '../transformers/material-type.transformer';
 
 export default class ProjectsService {
   /**
@@ -773,7 +777,7 @@ export default class ProjectsService {
     return assembly;
   }
 
-  /*
+  /**
    * Creates a new Manufacturer
    * @param submitter the user who's creating the manufacturer
    * @param name the name of the manufacturer
@@ -836,6 +840,7 @@ export default class ProjectsService {
   }
   /**
    * Get all the manufacturers in the database.
+   * @param submitter the user who's getting all manufacturers
    * @returns all the manufacturers
    */
   static async getAllManufacturers(submitter: User): Promise<Manufacturer[]> {
@@ -850,6 +855,23 @@ export default class ProjectsService {
     ).map(manufacturerTransformer);
   }
 
+  /**
+   * Get all the material types in the database.
+   * @param submitter the user who's getting all material types
+   * @returns all the material types
+   */
+  static async getAllMaterialTypes(submitter: User): Promise<MaterialType[]> {
+    if (submitter.role === Role.GUEST) {
+      throw new AccessDeniedGuestException('Get Material Types');
+    }
+
+    return (
+      await prisma.material_Type.findMany({
+        ...materialTypeQueryArgs
+      })
+    ).map(materialTypeTransformer);
+  }
+
   /**
    * Create a new material type
    * @param name the name of the new material type

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

@@ -3,8 +3,9 @@
  * See the LICENSE file in the repository root folder for details.
  */
 
-import { Manufacturer, Prisma } from '@prisma/client';
+import { Prisma } from '@prisma/client';
 import manufacturerQueryArgs from '../prisma-query-args/manufacturers.query-args';
+import { Manufacturer } from 'shared';
 
 export const manufacturerTransformer = (
   manufacturer: Prisma.ManufacturerGetPayload<typeof manufacturerQueryArgs>
@@ -13,6 +14,6 @@ export const manufacturerTransformer = (
     name: manufacturer.name,
     dateCreated: manufacturer.dateCreated,
     creatorId: manufacturer.creatorId,
-    dateDeleted: manufacturer.dateDeleted
+    dateDeleted: manufacturer.dateDeleted ?? undefined
   };
 };

src/backend/src/transformers/material-type.transformer.ts

@@ -0,0 +1,19 @@
+/*
+ * 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';
+import materialTypeQueryArgs from '../prisma-query-args/material-type.query-args';
+import { MaterialType } from 'shared';
+
+export const materialTypeTransformer = (
+  materialType: Prisma.Material_TypeGetPayload<typeof materialTypeQueryArgs>
+): MaterialType => {
+  return {
+    name: materialType.name,
+    dateCreated: materialType.dateCreated,
+    creatorId: materialType.creatorId,
+    dateDeleted: materialType.dateDeleted ?? undefined
+  };
+};

src/backend/tests/projects.test.ts

@@ -724,6 +724,23 @@ describe('Projects', () => {
       expect(materialType.name).toBe('NERSoftwareTools');
       expect(prisma.material_Type.create).toBeCalledTimes(1);
     });
+
+    test('Get all Material Types fails from guest', async () => {
+      vi.spyOn(prisma.material_Type, 'findMany').mockResolvedValue([]);
+
+      await expect(ProjectsService.getAllMaterialTypes(theVisitor)).rejects.toThrow(
+        new AccessDeniedGuestException('Get Material Types')
+      );
+    });
+
+    test('Get all Material Types works', async () => {
+      vi.spyOn(prisma.material_Type, 'findMany').mockResolvedValue([]);
+
+      const res = await ProjectsService.getAllMaterialTypes(batman);
+
+      expect(prisma.material_Type.findMany).toHaveBeenCalledTimes(1);
+      expect(res).toStrictEqual([]);
+    });
   });
 
   describe('assigning material assemblies', () => {

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

@@ -118,7 +118,14 @@ export interface Manufacturer {
   name: string;
   dateCreated: Date;
   creatorId: number;
-  materials: Material[];
+  dateDeleted?: Date;
+}
+
+export interface MaterialType {
+  name: string;
+  dateCreated: Date;
+  creatorId: number;
+  dateDeleted?: Date;
 }
 
 export enum MaterialStatus {