Merge pull request #1701 from Northeastern-Electric-Racing/#1526-Edit-Material-Endpoint

RChandler234 · web-flow · commit 155fb7a12945 · 2023-11-19T00:31:43.000-05:00
#1526 edit material endpoint
diff --git a/src/backend/src/controllers/projects.controllers.ts b/src/backend/src/controllers/projects.controllers.ts
@@ -167,14 +167,14 @@ export default class ProjectsController {
         manufacturerName,
         manufacturerPartNumber,
         quantity,
-        unitName,
         price,
         subtotal,
         linkUrl,
         notes,
         wbsNum,
         assemblyId,
-        pdmFileName
+        pdmFileName,
+        unitName
       );
       return res.status(200).json(material);
     } catch (error: unknown) {
@@ -213,4 +213,46 @@ export default class ProjectsController {
       next(error);
     }
   }
+
+  static async editMaterial(req: Request, res: Response, next: NextFunction) {
+    try {
+      const user = await getCurrentUser(res);
+      const { materialId } = req.params;
+      const {
+        name,
+        assemblyId,
+        status,
+        materialTypeName,
+        manufacturerName,
+        manufacturerPartNumber,
+        pdmFileName,
+        quantity,
+        unitName,
+        price,
+        subtotal,
+        linkUrl,
+        notes
+      } = req.body;
+      const updatedMaterial = await ProjectsService.editMaterial(
+        user,
+        materialId,
+        name,
+        status,
+        materialTypeName,
+        manufacturerName,
+        manufacturerPartNumber,
+        quantity,
+        price,
+        subtotal,
+        linkUrl,
+        notes,
+        unitName,
+        assemblyId,
+        pdmFileName
+      );
+      res.status(200).json(updatedMaterial);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }
diff --git a/src/backend/src/prisma/migrations/20231119042617_add_bom/migration.sql b/src/backend/src/prisma/migrations/20231119042617_add_bom/migration.sql
@@ -68,9 +68,6 @@ CREATE TABLE "Manufacturer" (
 -- CreateIndex
 CREATE UNIQUE INDEX "Assembly_name_key" ON "Assembly"("name");
 
--- CreateIndex
-CREATE UNIQUE INDEX "Material_name_key" ON "Material"("name");
-
 -- AddForeignKey
 ALTER TABLE "Assembly" ADD CONSTRAINT "Assembly_userDeletedId_fkey" FOREIGN KEY ("userDeletedId") REFERENCES "User"("userId") ON DELETE SET NULL ON UPDATE CASCADE;
 
diff --git a/src/backend/src/prisma/schema.prisma b/src/backend/src/prisma/schema.prisma
@@ -491,7 +491,7 @@ model Material {
   materialId             String          @id @default(uuid())
   assembly               Assembly?       @relation(fields: [assemblyId], references: [assemblyId])
   assemblyId             String?
-  name                   String          @unique
+  name                   String
   wbsElement             WBS_Element     @relation(fields: [wbsElementId], references: [wbsElementId])
   wbsElementId           Int
   dateDeleted            DateTime?
diff --git a/src/backend/src/routes/projects.routes.ts b/src/backend/src/routes/projects.routes.ts
@@ -74,13 +74,31 @@ projectRouter.post(
   nonEmptyString(body('manufacturerPartNumber')),
   nonEmptyString(body('pdmFileName').optional()),
   intMinZero(body('quantity')),
-  nonEmptyString(body('unitName')),
+  nonEmptyString(body('unitName')).optional(),
   intMinZero(body('price')), // in cents
   intMinZero(body('subtotal')), // in cents
   nonEmptyString(body('linkUrl').isURL()),
   body('notes').isString(),
   validateInputs,
   ProjectsController.createMaterial
 );
+projectRouter.post(
+  '/bom/material/:materialId/edit',
+  nonEmptyString(body('name')),
+  nonEmptyString(body('assemblyId').optional()),
+  isMaterialStatus(body('status')),
+  nonEmptyString(body('materialTypeName')),
+  nonEmptyString(body('manufacturerName')),
+  nonEmptyString(body('manufacturerPartNumber')),
+  nonEmptyString(body('pdmFileName').optional()),
+  intMinZero(body('quantity')),
+  body('unitName').optional(),
+  intMinZero(body('price')), // in cents
+  intMinZero(body('subtotal')), // in cents
+  nonEmptyString(body('linkUrl').isURL()),
+  body('notes').isString(),
+  validateInputs,
+  ProjectsController.editMaterial
+);
 
 export default projectRouter;
diff --git a/src/backend/src/services/projects.services.ts b/src/backend/src/services/projects.services.ts
@@ -616,14 +616,14 @@ export default class ProjectsService {
    * @param manufacturerName the name of the material's manufacturer
    * @param manufacturerPartNumber the manufacturer part number for the material
    * @param quantity the quantity of material as a number
-   * @param unitName the name of the Quantity Unit the quantity is measured in
    * @param price the price of the material in whole cents
    * @param subtotal the subtotal of the price for the material in whole cents
    * @param linkUrl the url for the material's link as a string
    * @param notes any notes about the material as a string
    * @param wbsNumber the WBS number of the project associated with this material
    * @param assemblyId the id of the Assembly for the material
    * @param pdmFileName the name of the pdm file for the material
+   * @param unitName the name of the Quantity Unit the quantity is measured in
    * @returns the created material
    */
   static async createMaterial(
@@ -634,14 +634,14 @@ export default class ProjectsService {
     manufacturerName: string,
     manufacturerPartNumber: string,
     quantity: number,
-    unitName: string,
     price: number,
     subtotal: number,
     linkUrl: string,
     notes: string,
     wbsNumber: WbsNumber,
     assemblyId?: string,
-    pdmFileName?: string
+    pdmFileName?: string,
+    unitName?: string
   ): Promise<Material> {
     const project = await prisma.project.findFirst({
       where: {
@@ -671,10 +671,12 @@ export default class ProjectsService {
     });
     if (!manufacturer) throw new NotFoundException('Manufacturer', manufacturerName);
 
-    const unit = await prisma.unit.findFirst({
-      where: { name: unitName }
-    });
-    if (!unit) throw new NotFoundException('Unit', unitName);
+    if (unitName) {
+      const unit = await prisma.unit.findFirst({
+        where: { name: unitName }
+      });
+      if (!unit) throw new NotFoundException('Unit', unitName);
+    }
 
     const perms = isLeadership(creator.role) || isUserPartOfTeams(project.teams, creator);
 
@@ -829,4 +831,109 @@ export default class ProjectsService {
 
     return newMaterialType;
   }
+
+  /**
+   * Update a material
+   * @param submitter the submitter of the request
+   * @param materialId the material id of the material being edited
+   * @param name the name of the edited material
+   * @param status the status of the edited material
+   * @param materialTypeName the material type of the edited material
+   * @param manufacturerName the manufacturerName of the edited material
+   * @param manufacturerPartNumber the manufacturerPartNumber of the edited material
+   * @param quantity the quantity of the edited material
+   * @param price the price of the edited material
+   * @param subtotal the subtotal of the edited material
+   * @param linkUrl the linkUrl of the edited material
+   * @param notes the notes of the edited material
+   * @param unitName the unit name of the edited material
+   * @param assemblyId the assembly id of the edited material
+   * @param pdmFileName the pdm file name of the edited material
+   * @throws if permission denied or material's wbsElement is undefined/deleted
+   * @returns the updated material
+   */
+  static async editMaterial(
+    submitter: User,
+    materialId: string,
+    name: string,
+    status: Material_Status,
+    materialTypeName: string,
+    manufacturerName: string,
+    manufacturerPartNumber: string,
+    quantity: number,
+    price: number,
+    subtotal: number,
+    linkUrl: string,
+    notes: string,
+    unitName?: string,
+    assemblyId?: string,
+    pdmFileName?: string
+  ): Promise<Material> {
+    const material = await prisma.material.findUnique({
+      where: {
+        materialId
+      }
+    });
+
+    if (!material) throw new NotFoundException('Material', materialId);
+    if (material.dateDeleted) throw new DeletedException('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);
+
+    if (assemblyId) {
+      const assembly = await prisma.assembly.findFirst({ where: { assemblyId } });
+      if (!assembly) throw new NotFoundException('Assembly', assemblyId);
+    }
+
+    const materialType = await prisma.material_Type.findFirst({
+      where: { name: materialTypeName }
+    });
+    if (!materialType) throw new NotFoundException('Material Type', materialTypeName);
+
+    const manufacturer = await prisma.manufacturer.findFirst({
+      where: { name: manufacturerName }
+    });
+    if (!manufacturer) throw new NotFoundException('Manufacturer', manufacturerName);
+
+    if (unitName) {
+      const unit = await prisma.unit.findFirst({
+        where: { name: unitName }
+      });
+      if (!unit) throw new NotFoundException('Unit', unitName);
+    }
+
+    const perms = isLeadership(submitter.role) || isUserPartOfTeams(project.teams, submitter);
+
+    if (!perms) throw new AccessDeniedException('update material');
+
+    const updatedMaterial = await prisma.material.update({
+      where: { materialId },
+      data: {
+        name,
+        status,
+        materialTypeName,
+        manufacturerName,
+        manufacturerPartNumber,
+        quantity,
+        unitName,
+        price,
+        subtotal,
+        linkUrl,
+        notes,
+        wbsElementId: project.wbsElementId,
+        assemblyId,
+        pdmFileName
+      }
+    });
+
+    return updatedMaterial;
+  }
 }
diff --git a/src/backend/src/utils/errors.utils.ts b/src/backend/src/utils/errors.utils.ts
@@ -115,4 +115,5 @@ type ExceptionObjectNames =
   | 'Assembly'
   | 'Material Type'
   | 'Manufacturer'
-  | 'Unit';
+  | 'Unit'
+  | 'Material';
diff --git a/src/backend/src/utils/projects.utils.ts b/src/backend/src/utils/projects.utils.ts
@@ -60,3 +60,40 @@ export const getUserFullName = async (userId: number | null): Promise<string | n
   if (!user) throw new NotFoundException('User', userId);
   return `${user.firstName} ${user.lastName}`;
 };
+
+/**
+ * Check if given assembly, material type, manufacturer, and unit exist in the app database
+ * @param manufacturerName the manufacure of the material to check if it exists
+ * @param materialTypeName the material type of the material to check if it exists
+ * @param unitName the unit of the material to check if it exists
+ * @param assemblyId the assembly of the material to check if it exists
+ * @throws if any of these properties of the material does not exist in the db
+ */
+export const checkMaterialInputs = async (
+  manufacturerName: string,
+  materialTypeName: string,
+  unitName?: string,
+  assemblyId?: string
+) => {
+  if (assemblyId) {
+    const assembly = await prisma.assembly.findFirst({ where: { assemblyId } });
+    if (!assembly) throw new NotFoundException('Assembly', assemblyId);
+  }
+
+  const materialType = await prisma.material_Type.findFirst({
+    where: { name: materialTypeName }
+  });
+  if (!materialType) throw new NotFoundException('Material Type', materialTypeName);
+
+  const manufacturer = await prisma.manufacturer.findFirst({
+    where: { name: manufacturerName }
+  });
+  if (!manufacturer) throw new NotFoundException('Manufacturer', manufacturerName);
+
+  if (unitName) {
+    const unit = await prisma.unit.findFirst({
+      where: { name: unitName }
+    });
+    if (!unit) throw new NotFoundException('Unit', unitName);
+  }
+};
diff --git a/src/backend/tests/projects.test.ts b/src/backend/tests/projects.test.ts
diff --git a/src/backend/tests/test-data/projects.test-data.ts b/src/backend/tests/test-data/projects.test-data.ts
