Merge pull request #1714 from Northeastern-Electric-Racing/#1427-BOM-Form-Modal

#1713 Bill of Materials Frontend

Author: RChandler234

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

@@ -348,4 +348,25 @@ export default class ProjectsController {
       next(error);
     }
   }
+
+  static async getAllUnits(_req: Request, res: Response, next: NextFunction) {
+    try {
+      const user = await getCurrentUser(res);
+      const units = await ProjectsService.getAllUnits(user);
+      res.status(200).json(units);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
+  static async createUnit(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { name } = req.body;
+      const user = await getCurrentUser(res);
+      const createdUnit = await ProjectsService.createUnit(name, user);
+      res.status(200).json(createdUnit);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

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

@@ -0,0 +1,21 @@
+export const assemblyQueryArgs = {
+  include: {
+    userCreated: true,
+    userDeleted: true,
+    materials: true
+  }
+};
+
+export const materialQueryArgs = {
+  include: {
+    assembly: {
+      ...assemblyQueryArgs
+    },
+    wbsElement: true,
+    userCreated: true,
+    userDeleted: true,
+    materialType: true,
+    quantityUnit: true,
+    manufacturer: true
+  }
+};

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

@@ -7,7 +7,8 @@ import { Prisma } from '@prisma/client';
 
 const manufacturerQueryArgs = Prisma.validator<Prisma.ManufacturerArgs>()({
   include: {
-    materials: true
+    materials: true,
+    userCreated: true
   }
 });
 

src/backend/src/prisma-query-args/material-type.query-args.ts

@@ -7,7 +7,8 @@ import { Prisma } from '@prisma/client';
 
 const materialTypeQueryArgs = Prisma.validator<Prisma.Material_TypeArgs>()({
   include: {
-    materials: true
+    materials: true,
+    userCreated: true
   }
 });
 

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

@@ -1,6 +1,7 @@
 import { Prisma } from '@prisma/client';
 import taskQueryArgs from './tasks.query-args';
 import linkQueryArgs from './links.query-args';
+import { assemblyQueryArgs, materialQueryArgs } from './bom.query-args';
 
 const projectQueryArgs = Prisma.validator<Prisma.ProjectArgs>()({
   include: {
@@ -10,7 +11,15 @@ const projectQueryArgs = Prisma.validator<Prisma.ProjectArgs>()({
         projectManager: true,
         tasks: { where: { dateDeleted: null }, ...taskQueryArgs },
         links: { ...linkQueryArgs },
-        changes: { where: { changeRequest: { dateDeleted: null } }, include: { implementer: true } }
+        changes: { where: { changeRequest: { dateDeleted: null } }, include: { implementer: true } },
+        materials: {
+          where: { dateDeleted: null },
+          ...materialQueryArgs
+        },
+        assemblies: {
+          where: { dateDeleted: null },
+          ...assemblyQueryArgs
+        }
       }
     },
     teams: { include: { members: true, head: true, leads: true } },
@@ -29,7 +38,13 @@ const projectQueryArgs = Prisma.validator<Prisma.ProjectArgs>()({
             projectLead: true,
             projectManager: true,
             links: { ...linkQueryArgs },
-            changes: { where: { changeRequest: { dateDeleted: null } }, include: { implementer: true } }
+            changes: { where: { changeRequest: { dateDeleted: null } }, include: { implementer: true } },
+            materials: {
+              ...materialQueryArgs
+            },
+            assemblies: {
+              ...assemblyQueryArgs
+            }
           }
         },
         blockedBy: { where: { dateDeleted: null } },

…ons/20231119081759_add_bom/migration.sql …ns/20231122182628_add_boms/migration.sqlsrc/backend/src/prisma/migrations/20231119081759_add_bom/migration.sql renamed to src/backend/src/prisma/migrations/20231122182628_add_boms/migration.sql src/backend/src/prisma/migrations/20231119081759_add_bom/migration.sql renamed to src/backend/src/prisma/migrations/20231122182628_add_boms/migration.sql

@@ -52,7 +52,7 @@ CREATE TABLE "Material_Type" (
     "name" TEXT NOT NULL,
     "dateCreated" TIMESTAMP(3) NOT NULL,
     "dateDeleted" TIMESTAMP(3),
-    "creatorId" INTEGER NOT NULL,
+    "userCreatedId" INTEGER NOT NULL,
 
     CONSTRAINT "Material_Type_pkey" PRIMARY KEY ("name")
 );
@@ -61,15 +61,12 @@ CREATE TABLE "Material_Type" (
 CREATE TABLE "Manufacturer" (
     "name" TEXT NOT NULL,
     "dateCreated" TIMESTAMP(3) NOT NULL,
-    "creatorId" INTEGER NOT NULL,
+    "userCreatedId" INTEGER NOT NULL,
     "dateDeleted" TIMESTAMP(3),
 
     CONSTRAINT "Manufacturer_pkey" PRIMARY KEY ("name")
 );
 
--- CreateIndex
-CREATE UNIQUE INDEX "Assembly_name_key" ON "Assembly"("name");
-
 -- AddForeignKey
 ALTER TABLE "Assembly" ADD CONSTRAINT "Assembly_userDeletedId_fkey" FOREIGN KEY ("userDeletedId") REFERENCES "User"("userId") ON DELETE SET NULL ON UPDATE CASCADE;
 
@@ -99,3 +96,9 @@ ALTER TABLE "Material" ADD CONSTRAINT "Material_manufacturerName_fkey" FOREIGN K
 
 -- AddForeignKey
 ALTER TABLE "Material" ADD CONSTRAINT "Material_unitName_fkey" FOREIGN KEY ("unitName") REFERENCES "Unit"("name") ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Material_Type" ADD CONSTRAINT "Material_Type_userCreatedId_fkey" FOREIGN KEY ("userCreatedId") REFERENCES "User"("userId") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Manufacturer" ADD CONSTRAINT "Manufacturer_userCreatedId_fkey" FOREIGN KEY ("userCreatedId") REFERENCES "User"("userId") ON DELETE RESTRICT ON UPDATE CASCADE;

src/backend/src/prisma/schema.prisma

@@ -114,6 +114,8 @@ model User {
   createdAssemblies         Assembly[]              @relation(name: "assemblyCreator")
   deletedMaterials          Material[]              @relation(name: "materialDeleter")
   createdMaterials          Material[]              @relation(name: "materialCreator")
+  createdMaterialTypes      Material_Type[]         @relation(name: "materialTypeCreator")
+  createdManufacturers      Manufacturer[]          @relation(name: "manufacturerCreator")
 }
 
 model Team {
@@ -490,7 +492,7 @@ model Unit {
 
 model Assembly {
   assemblyId    String      @id @default(uuid())
-  name          String      @unique
+  name          String      
   pdmFileName   String?
   dateDeleted   DateTime?
   userDeleted   User?       @relation(fields: [userDeletedId], references: [userId], name: "assemblyDeleter")
@@ -533,17 +535,19 @@ model Material {
 }
 
 model Material_Type {
-  name        String     @id
-  dateCreated DateTime
+  name          String     @id
+  dateCreated   DateTime
   dateDeleted DateTime?
-  creatorId   Int
-  materials   Material[]
+  userCreatedId Int
+  userCreated   User       @relation(name: "materialTypeCreator", fields: [userCreatedId], references: [userId])
+  materials     Material[]
 }
 
 model Manufacturer {
-  name        String     @id
-  dateCreated DateTime
-  creatorId   Int
+  name          String     @id
+  dateCreated   DateTime
+  userCreatedId Int
+  userCreated   User       @relation(name: "manufacturerCreator", fields: [userCreatedId], references: [userId])
   dateDeleted DateTime?
-  materials   Material[]
+  materials     Material[]
 }

src/backend/src/prisma/seed.ts

@@ -22,7 +22,7 @@ import ChangeRequestsService from '../services/change-requests.services';
 import projectQueryArgs from '../prisma-query-args/projects.query-args';
 import TeamsService from '../services/teams.services';
 import WorkPackagesService from '../services/work-packages.services';
-import { ClubAccount, StandardChangeRequest, validateWBS, WbsElementStatus, WorkPackageStage } from 'shared';
+import { ClubAccount, MaterialStatus, StandardChangeRequest, validateWBS, WbsElementStatus, WorkPackageStage } from 'shared';
 import TasksService from '../services/tasks.services';
 import DescriptionBulletsService from '../services/description-bullets.services';
 import { seedProject } from './seed-data/projects.seed';
@@ -881,6 +881,51 @@ const performSeed: () => Promise<void> = async () => {
    */
   await ProjectsService.createManufacturer(thomasEmrax, 'Digikey');
   await ProjectsService.createMaterialType('Resistor', thomasEmrax);
+
+  const assembly1 = await ProjectsService.createAssembly('1', thomasEmrax, {
+    carNumber: 1,
+    projectNumber: 1,
+    workPackageNumber: 0
+  });
+
+  await ProjectsService.createMaterial(
+    thomasEmrax,
+    '10k Resistor',
+    MaterialStatus.Ordered,
+    'Resistor',
+    'Digikey',
+    'abcdef',
+    20,
+    30,
+    600,
+    'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+    'Here are some notes',
+    {
+      carNumber: 1,
+      projectNumber: 1,
+      workPackageNumber: 0
+    }
+  );
+
+  await ProjectsService.createMaterial(
+    thomasEmrax,
+    '20k Resistor',
+    MaterialStatus.Ordered,
+    'Resistor',
+    'Digikey',
+    'bacfed',
+    10,
+    7,
+    70,
+    'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+    'Here are some more notes',
+    {
+      carNumber: 1,
+      projectNumber: 1,
+      workPackageNumber: 0
+    },
+    assembly1.assemblyId
+  );
 };
 
 performSeed()

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

@@ -78,7 +78,7 @@ projectRouter.post(
   ProjectsController.assignMaterialAssembly
 );
 projectRouter.post(
-  '/material/:wbsNum/create',
+  '/bom/material/:wbsNum/create',
   nonEmptyString(body('name')),
   nonEmptyString(body('assemblyId').optional()),
   isMaterialStatus(body('status')),
@@ -119,4 +119,7 @@ projectRouter.delete('/bom/material-type/:materialTypeId/delete', ProjectsContro
 projectRouter.delete('/bom/assembly/:assemblyId/delete', ProjectsController.deleteAssemblyType);
 projectRouter.post('/bom/material/:materialId/delete', ProjectsController.deleteMaterial);
 
+projectRouter.post('/bom/units/create', nonEmptyString(body('name')), ProjectsController.createUnit);
+projectRouter.get('/bom/units', ProjectsController.getAllUnits);
+
 export default projectRouter;

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

@@ -10,6 +10,7 @@ import {
   Manufacturer,
   MaterialType,
   Project,
+  Unit,
   WbsNumber,
   wbsPipe
 } from 'shared';
@@ -30,12 +31,13 @@ import { wbsNumOf } from '../utils/utils';
 import WorkPackagesService from './work-packages.services';
 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 { manufacturerTransformer } from '../transformers/manufacturer.transformer';
 import { isUserPartOfTeams } from '../utils/teams.utils';
 import { materialTypeTransformer } from '../transformers/material-type.transformer';
+import { materialPreviewTransformer } from '../transformers/material.transformer';
+import manufacturerQueryArgs from '../prisma-query-args/manufacturers.query-args';
+import manufacturerTransformer from '../transformers/manufacturer.transformer';
 
 export default class ProjectsService {
   /**
@@ -585,7 +587,7 @@ export default class ProjectsService {
    * Create an assembly
    * @param name The name of the assembly to be created
    * @param userCreated The user creating the assembly
-   * @param wbsElementId The
+   * @param wbsElementId The wbsElement that the created assembly is associated with
    * @param pdmFileName optional - The name of the file holding the assembly
    * @returns the project that the user has favorited/unfavorited
    * @throws if the project wbs doesn't exist or is not corresponding to a project
@@ -613,9 +615,9 @@ export default class ProjectsService {
     if (!project) throw new NotFoundException('Project', wbsPipe(wbsNumber));
     if (project.wbsElement.dateDeleted) throw new DeletedException('Project', project.projectId);
 
-    const checkAssembly = await prisma.assembly.findUnique({ where: { name } });
-
-    if (checkAssembly) throw new HttpException(400, `${name} already exists as an assembly!`);
+    console.log(project.wbsElement.assemblies);
+    if (project.wbsElement.assemblies.some((assembly) => assembly.name === name && !assembly.dateDeleted))
+      throw new HttpException(400, `${name} already exists as an assembly on this project!`);
 
     const { teams, wbsElementId } = project;
 
@@ -656,7 +658,7 @@ export default class ProjectsService {
     if (manufacturer) throw new HttpException(400, `${name} already exists as a manufacturer!`);
 
     const newManufacturer = await prisma.manufacturer.create({
-      data: { name, dateCreated: new Date(), creatorId: submitter.userId }
+      data: { name, dateCreated: new Date(), userCreatedId: submitter.userId }
     });
 
     return newManufacturer;
@@ -754,7 +756,7 @@ export default class ProjectsService {
       data: {
         name,
         dateCreated: new Date(),
-        creatorId: submitter.userId
+        userCreatedId: submitter.userId
       }
     });
 
@@ -1028,4 +1030,46 @@ export default class ProjectsService {
 
     return updatedMaterial;
   }
+
+  /**
+   * Gets all the units in the database with all their materials
+   * @returns all the units in the database
+   */
+  static async getAllUnits(user: User): Promise<Unit[]> {
+    if (isGuest(user.role)) throw new AccessDeniedGuestException('get units');
+
+    const units = await prisma.unit.findMany({
+      include: {
+        materials: true
+      }
+    });
+
+    return units.map((unit) => {
+      return { ...unit, materials: unit.materials.map(materialPreviewTransformer) };
+    });
+  }
+
+  /**
+   * Creates a new unit
+   * @param submitter the user who's creating the unit
+   * @param name the name of the unit
+   * @throws if the submitter is a guest or the given unit name already exists
+   */
+  static async createUnit(name: string, submitter: User): Promise<Unit> {
+    if (isGuest(submitter.role)) throw new AccessDeniedGuestException('create units');
+
+    const unit = await prisma.unit.findUnique({
+      where: {
+        name
+      }
+    });
+
+    if (unit) throw new HttpException(400, `${name} already exists as a unit!`);
+
+    const newUnit = await prisma.unit.create({
+      data: { name }
+    });
+
+    return { ...newUnit, materials: [] };
+  }
 }