Merge pull request #1646 from Northeastern-Electric-Racing/#1522-create-material-type-endpoint

#1522: added create material type endpoint with tests

Author: RChandler234

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

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

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

@@ -55,5 +55,6 @@ projectRouter.post(
   validateInputs,
   ProjectsController.createManufacturer
 );
+projectRouter.post('/bom/material-type/create', nonEmptyString(body('name')), ProjectsController.createMaterialType);
 
 export default projectRouter;

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

@@ -1,5 +1,5 @@
-import { User } from '@prisma/client';
-import { isAdmin, isGuest, isProject, LinkCreateArgs, LinkType, Project, WbsNumber, wbsPipe } from 'shared';
+import { Material_Type, User } 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';
@@ -9,7 +9,8 @@ import {
   AccessDeniedGuestException,
   HttpException,
   NotFoundException,
-  DeletedException
+  DeletedException,
+  AccessDeniedException
 } from '../utils/errors.utils';
 import {
   addDescriptionBullets,
@@ -627,4 +628,33 @@ export default class ProjectsService {
 
     return newManufacturer;
   }
+
+  /**
+   * Create a new material type
+   * @param name the name of the new material type
+   * @param submitter the user who is creating the material type
+   * @throws if the submitter is not a leader or the material type with the given name already exists
+   */
+  static async createMaterialType(name: string, submitter: User): Promise<Material_Type> {
+    if (!isLeadership(submitter.role))
+      throw new AccessDeniedException('Only leadership or above can create a material type');
+
+    const materialType = await prisma.material_Type.findUnique({
+      where: {
+        name
+      }
+    });
+
+    if (!!materialType) throw new HttpException(400, `The following material type already exists: ${name}`);
+
+    const newMaterialType = await prisma.material_Type.create({
+      data: {
+        name,
+        dateCreated: new Date(),
+        creatorId: submitter.userId
+      }
+    });
+
+    return newMaterialType;
+  }
 }

src/backend/tests/projects.test.ts

@@ -2,14 +2,15 @@ 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 { prismaManufacturer1, prismaProject1, sharedProject1 } from './test-data/projects.test-data';
+import { prismaManufacturer1, prismaProject1, sharedProject1, toolMaterial } 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,
+  AccessDeniedException,
   DeletedException,
   HttpException,
   NotFoundException
@@ -281,4 +282,29 @@ describe('Projects', () => {
       expect(manufacturer.creatorId).toBe(prismaManufacturer1.creatorId);
     });
   });
+
+  describe('materialType', () => {
+    test('Create material type fails if user is not leader', async () => {
+      await expect(ProjectsService.createMaterialType('Tools', wonderwoman)).rejects.toThrow(
+        new AccessDeniedException('Only leadership or above can create a material type')
+      );
+    });
+
+    test('Create material type fails if the material type with the given name already exists', async () => {
+      vi.spyOn(prisma.material_Type, 'findUnique').mockResolvedValue(toolMaterial);
+
+      await expect(ProjectsService.createMaterialType('NERSoftwareTools', batman)).rejects.toThrow(
+        new HttpException(400, 'The following material type already exists: NERSoftwareTools')
+      );
+    });
+
+    test('Create material type works', async () => {
+      vi.spyOn(prisma.material_Type, 'findUnique').mockResolvedValue(null);
+      vi.spyOn(prisma.material_Type, 'create').mockResolvedValue(toolMaterial);
+
+      const materialType = await ProjectsService.createMaterialType('NERSoftwareTools', batman);
+      expect(materialType.name).toBe('NERSoftwareTools');
+      expect(prisma.material_Type.create).toBeCalledTimes(1);
+    });
+  });
 });

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

@@ -1,4 +1,10 @@
-import { Prisma, WBS_Element_Status as PrismaWBSElementStatus, Project, Manufacturer } from '@prisma/client';
+import {
+  Material_Type as PrismaMaterialType,
+  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';
@@ -103,3 +109,9 @@ export const prismaManufacturer1: Manufacturer = {
   dateCreated: new Date('10-1-2023'),
   creatorId: 1
 };
+
+export const toolMaterial: PrismaMaterialType = {
+  name: 'NERSoftwareTools',
+  dateCreated: new Date(),
+  creatorId: batman.userId
+};