Merge pull request #1677 from Northeastern-Electric-Racing/#1528-material-to-assembly

#1528 Create assign material assembly route and controller

Author: RChandler234

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

@@ -225,6 +225,18 @@ export default class ProjectsController {
     }
   }
 
+  static async assignMaterialAssembly(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { materialId } = req.params;
+      const { assemblyId } = req.body;
+      const user = await getCurrentUser(res);
+      const updatedMaterial = await ProjectsService.assignMaterialAssembly(user, materialId, assemblyId);
+      res.status(200).json(updatedMaterial);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async deleteAssemblyType(req: Request, res: Response, next: NextFunction) {
     try {
       const { assemblyId } = req.params;

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

@@ -62,9 +62,15 @@ projectRouter.post('/bom/material-type/create', nonEmptyString(body('name')), Pr
 projectRouter.post(
   '/bom/assembly/:wbsNum/create',
   nonEmptyString(body('name')),
-  nonEmptyString(body('pdmFileName')).optional(),
+  nonEmptyString(body('pdmFileName').optional()),
   ProjectsController.createAssembly
 );
+projectRouter.post(
+  '/bom/material/:materialId/assign-assembly',
+  nonEmptyString(body('assemblyId').optional()),
+  validateInputs,
+  ProjectsController.assignMaterialAssembly
+);
 projectRouter.post(
   '/material/:wbsNum/create',
   nonEmptyString(body('name')),

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

@@ -879,6 +879,79 @@ export default class ProjectsService {
     return newMaterialType;
   }
 
+  /**
+   * Assign a material on a project to a different assembly
+   * @param submitter the submitter
+   * @param materialId the material that will be moved
+   * @param assemblyId the assembly to change the material to, or undefined to unassign the material
+   * @throws if the submitter does not have the relevant positions
+   * @returns the updated material
+   */
+  static async assignMaterialAssembly(submitter: User, materialId: string, assemblyId?: string) {
+    const material = await prisma.material.findUnique({
+      where: { materialId },
+      include: { wbsElement: true, assembly: true }
+    });
+
+    if (!material) throw new NotFoundException('Material', materialId);
+
+    const project = await prisma.project.findFirst({
+      where: {
+        wbsElementId: material.wbsElementId
+      },
+      ...projectQueryArgs
+    });
+
+    if (!project) throw new NotFoundException('Project', material.wbsElementId);
+    if (project.wbsElement.dateDeleted) throw new DeletedException('Project', project.projectId);
+
+    // Permission: leadership and up, anyone on project team
+    if (!(isLeadership(submitter.role) || isUserPartOfTeams(project.teams, submitter)))
+      throw new AccessDeniedException(
+        `Only leadership or above, or someone on the project's team can assign materials to assemblies`
+      );
+
+    //assigning the material to a new assembly
+    if (assemblyId) {
+      const assembly = await prisma.assembly.findUnique({
+        where: { assemblyId },
+        include: { wbsElement: true }
+      });
+      if (!assembly) throw new NotFoundException('Assembly', assemblyId);
+
+      // Confirm that the assembly's wbsElement is the same as the material's wbsElement
+      if (material.wbsElementId !== assembly.wbsElementId)
+        throw new HttpException(
+          400,
+          `The WBS element of the material (${wbsPipe(material.wbsElement)}) and assembly (${wbsPipe(
+            assembly.wbsElement
+          )}) do not match`
+        );
+      const updatedMaterial = await prisma.material.update({
+        where: { materialId },
+        data: { assemblyId }
+      });
+
+      return updatedMaterial;
+    }
+    //unassigning material from an existing assembly
+    if (material.assemblyId) {
+      await prisma.assembly.update({
+        where: { assemblyId: material.assemblyId },
+        data: { materials: { disconnect: { materialId } } },
+        include: { materials: true }
+      });
+
+      const updatedMaterial = await prisma.material.findUnique({
+        where: { materialId },
+        include: { wbsElement: true, assembly: true }
+      });
+
+      return updatedMaterial;
+    }
+    return material;
+  }
+
   /**
    * Deletes an assembly type
    * @param assemblyId the name of the assembly

src/backend/src/utils/errors.utils.ts

@@ -112,6 +112,7 @@ type ExceptionObjectNames =
   | 'Reimbursement Request'
   | 'User Secure Settings'
   | 'Image File'
+  | 'Material'
   | 'Assembly'
   | 'Material Type'
   | 'Manufacturer'

src/backend/tests/projects.test.ts

@@ -8,6 +8,7 @@ import {
   prismaAssembly1,
   toolMaterial,
   prismaManufacturer1,
+  prismaMaterial1,
   prismaManufacturer2,
   prismaMaterial,
   prismaMaterialType,
@@ -29,7 +30,7 @@ import {
 import { prismaWbsElement1 } from './test-data/wbs-element.test-data';
 import WorkPackagesService from '../src/services/work-packages.services';
 import { validateWBS, WbsNumber } from 'shared';
-import { Material_Status, User } from '@prisma/client';
+import { Material, Material_Status, User } from '@prisma/client';
 
 vi.mock('../src/utils/projects.utils');
 const mockGetHighestProjectNumber = getHighestProjectNumber as jest.Mock<Promise<number>>;
@@ -725,6 +726,64 @@ describe('Projects', () => {
     });
   });
 
+  describe('assigning material assemblies', () => {
+    test('assignment fails because of permissions', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(prismaMaterial1);
+      vi.spyOn(prisma.assembly, 'findUnique').mockResolvedValue(prismaAssembly1);
+      const project = { ...prismaProject1, teams: [{ members: [aquaman], leads: [superman] }] };
+      vi.spyOn(prisma.project, 'findFirst').mockResolvedValue(project);
+
+      await expect(ProjectsService.assignMaterialAssembly(theVisitor, 'mid', 'aid')).rejects.toThrow(
+        new AccessDeniedException(
+          `Only leadership or above, or someone on the project's team can assign materials to assemblies`
+        )
+      );
+    });
+
+    test('assignment fails because of invalid material id', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(null);
+      await expect(ProjectsService.assignMaterialAssembly(superman, 'invalid-mid', 'aid')).rejects.toThrow(
+        new NotFoundException('Material', 'invalid-mid')
+      );
+    });
+
+    test('assignment fails because of invalid assembly id', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(prismaMaterial1);
+      vi.spyOn(prisma.assembly, 'findUnique').mockResolvedValue(null);
+      await expect(ProjectsService.assignMaterialAssembly(superman, 'mid', 'invalid-aid')).rejects.toThrow(
+        new NotFoundException('Assembly', 'invalid-aid')
+      );
+    });
+
+    test('assignment fails because the wbsElements do not match', async () => {
+      const material = { ...prismaMaterial1, wbsElementId: 1, wbsElement: prismaWbsElement1 };
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(material);
+      const assembly = {
+        ...prismaAssembly1,
+        wbsElementId: 2,
+        wbsElement: { ...prismaWbsElement1, wbsElementId: 2, projectNumber: 1 }
+      };
+      vi.spyOn(prisma.assembly, 'findUnique').mockResolvedValue(assembly);
+      await expect(ProjectsService.assignMaterialAssembly(superman, 'mid', 'aid')).rejects.toThrow(
+        new HttpException(400, `The WBS element of the material (1.2.0) and assembly (1.1.0) do not match`)
+      );
+    });
+
+    test('assignment successful', async () => {
+      vi.spyOn(prisma.material, 'findUnique').mockResolvedValue(prismaMaterial1);
+      vi.spyOn(prisma.assembly, 'findUnique').mockResolvedValue(prismaAssembly1);
+      vi.spyOn(prisma.project, 'findFirst').mockResolvedValue(prismaProject1);
+
+      const expectedUpdatedToolMaterial: Material = {
+        ...prismaMaterial1,
+        assemblyId: 'updated-aid'
+      };
+      vi.spyOn(prisma.material, 'update').mockResolvedValue(expectedUpdatedToolMaterial);
+
+      const updatedMaterial = await ProjectsService.assignMaterialAssembly(aquaman, 'mid', 'updated-aid');
+      expect(updatedMaterial).toBe(expectedUpdatedToolMaterial);
+    });
+  });
   describe('Delete Assembly', () => {
     test('Deleteing assembly fails because user is not an admin or head', async () => {
       await expect(ProjectsService.deleteAssembly('New Assembly', theVisitor)).rejects.toThrow(
@@ -733,6 +792,8 @@ describe('Projects', () => {
     });
 
     test('Deleting assembly fails if assembly does not exist', async () => {
+      vi.spyOn(prisma.assembly, 'findUnique').mockResolvedValue(null);
+
       await expect(ProjectsService.deleteAssembly('New Assembly', batman)).rejects.toThrow(
         new NotFoundException('Assembly', 'New Assembly')
       );

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

@@ -5,8 +5,8 @@ import {
   Prisma,
   WBS_Element_Status as PrismaWBSElementStatus,
   Project,
-  Unit,
-  Manufacturer
+  Manufacturer,
+  Unit
 } from '@prisma/client';
 import { Project as SharedProject, WbsElementStatus } from 'shared';
 import projectQueryArgs from '../../src/prisma-query-args/projects.query-args';
@@ -112,7 +112,7 @@ export const prismaAssembly1: Assembly = {
   pdmFileName: 'file.txt',
   dateCreated: new Date('10-19-2023'),
   userCreatedId: batman.userId,
-  wbsElementId: 66,
+  wbsElementId: sharedProject1.id,
   dateDeleted: null,
   userDeletedId: null,
   assemblyId: '1'
@@ -192,3 +192,25 @@ export const prismaMaterial2: Material = {
   unitName: 'FT',
   linkUrl: 'https://www.google.com'
 };
+
+export const prismaMaterial1: Material = {
+  materialId: '1',
+  assemblyId: '1',
+  dateCreated: new Date('2023-11-07'),
+  linkUrl: 'https://example.com',
+  manufacturerName: 'Manufacturer1',
+  manufacturerPartNumber: '1',
+  materialTypeName: 'NERSoftwareTools',
+  name: prismaManufacturer1.name,
+  notes: 'Sample notes',
+  pdmFileName: 'pdmname',
+  price: 10,
+  quantity: 89,
+  status: 'ORDERED',
+  subtotal: 1,
+  unitName: 'Unit',
+  userCreatedId: batman.userId,
+  wbsElementId: sharedProject1.id,
+  dateDeleted: null,
+  userDeletedId: null
+};