#1509 Made pdmFileName optional, and updated tests

Author: jackturner106

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

@@ -129,11 +129,11 @@ export default class ProjectsController {
   }
 
   static async createAssembly(req: Request, res: Response, next: NextFunction) {
-    const user: User = await getCurrentUser(res);
-    const wbsNum: WbsNumber = validateWBS(req.params.wbsNum);
-    const { name, pdmFileName } = req.body;
     try {
-      const createAssembly = await ProjectsService.createAssembly(name, pdmFileName, user, wbsNum);
+      const user: User = await getCurrentUser(res);
+      const wbsNum: WbsNumber = validateWBS(req.params.wbsNum);
+      const { name, pdmFileName } = req.body;
+      const createAssembly = await ProjectsService.createAssembly(name, user, wbsNum, pdmFileName);
       res.status(200).json(createAssembly);
     } catch (error: unknown) {
       next(error);

src/backend/src/prisma/migrations/20231023224608_make_pdm_filename_optional_for_assembly/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Assembly" ALTER COLUMN "pdmFileName" DROP NOT NULL;

src/backend/src/prisma/schema.prisma

@@ -474,7 +474,7 @@ model Unit {
 model Assembly {
   assemblyId    String      @id @default(uuid())
   name          String      @unique
-  pdmFileName   String
+  pdmFileName   String?
   dateDeleted   DateTime?
   userDeleted   User?       @relation(fields: [userDeletedId], references: [userId], name: "assemblyDeleter")
   userDeletedId Int?

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

@@ -616,9 +616,9 @@ export default class ProjectsService {
    */
   static async createAssembly(
     name: string,
-    pdmFileName: string | '',
     userCreated: User,
-    wbsNumber: WbsNumber
+    wbsNumber: WbsNumber,
+    pdmFileName?: string
   ): Promise<Assembly> {
     if (!isProject(wbsNumber)) throw new HttpException(400, `${wbsPipe(wbsNumber)} is not a valid project WBS #!`);
     const { carNumber, projectNumber, workPackageNumber } = wbsNumber;
@@ -647,10 +647,10 @@ export default class ProjectsService {
     const assembly = await prisma.assembly.create({
       data: {
         name,
-        pdmFileName,
         dateCreated: new Date(),
         userCreatedId,
-        wbsElementId
+        wbsElementId,
+        pdmFileName
       }
     });
 

src/backend/src/utils/teams.utils.ts

@@ -40,6 +40,13 @@ export const areUsersPartOfTeams = (teams: Prisma.TeamGetPayload<typeof teamQuer
   return users.every((user) => teams.some((team) => isUserOnTeam(team, user)));
 };
 
+/**
+ * Validates that the given user is part of at least one of the given teams
+ *
+ * @param teams the teams to check the users are on
+ * @param user the user to check
+ * @returns if all of the users are part of at least one of ther teams
+ */
 export const isUserPartOfTeams = (teams: Prisma.TeamGetPayload<typeof teamQueryArgsMembersOnly>[], user: User) => {
   return teams.some((team) => isUserOnTeam(team, user));
 };

src/backend/tests/projects.test.ts

@@ -267,23 +267,33 @@ describe('Projects', () => {
     test('createAssembly fails given invalid project wbs number', async () => {
       await expect(
         async () =>
-          await ProjectsService.createAssembly('new assembly', 'file.txt', batman, {
-            carNumber: 1,
-            projectNumber: 1,
-            workPackageNumber: 1
-          })
+          await ProjectsService.createAssembly(
+            'new assembly',
+            batman,
+            {
+              carNumber: 1,
+              projectNumber: 1,
+              workPackageNumber: 1
+            },
+            'file.txt'
+          )
       ).rejects.toThrow(new HttpException(400, `1.1.1 is not a valid project WBS #!`));
     });
 
     test('createAssembly fails when associated wbsElement doesnt exist', async () => {
       vi.spyOn(prisma.project, 'findFirst').mockResolvedValue(null);
       await expect(
         async () =>
-          await ProjectsService.createAssembly('new assembly', 'file.txt', batman, {
-            carNumber: 1,
-            projectNumber: 1,
-            workPackageNumber: 0
-          })
+          await ProjectsService.createAssembly(
+            'new assembly',
+            batman,
+            {
+              carNumber: 1,
+              projectNumber: 1,
+              workPackageNumber: 0
+            },
+            'file.txt'
+          )
       ).rejects.toThrow(new NotFoundException('Project', '1.1.0'));
     });
 
@@ -295,11 +305,16 @@ describe('Projects', () => {
       } as any);
       await expect(
         async () =>
-          await ProjectsService.createAssembly('new assembly', 'file.txt', batman, {
-            carNumber: 1,
-            projectNumber: 1,
-            workPackageNumber: 0
-          })
+          await ProjectsService.createAssembly(
+            'new assembly',
+            batman,
+            {
+              carNumber: 1,
+              projectNumber: 1,
+              workPackageNumber: 0
+            },
+            'file.txt'
+          )
       ).rejects.toThrow(new DeletedException('Project', prismaProject1.projectId));
     });
 
@@ -311,11 +326,16 @@ describe('Projects', () => {
       } as any);
       await expect(
         async () =>
-          await ProjectsService.createAssembly('new assembly', 'file.txt', wonderwoman, {
-            carNumber: 1,
-            projectNumber: 1,
-            workPackageNumber: 0
-          })
+          await ProjectsService.createAssembly(
+            'new assembly',
+            wonderwoman,
+            {
+              carNumber: 1,
+              projectNumber: 1,
+              workPackageNumber: 0
+            },
+            'file.txt'
+          )
       ).rejects.toThrow(new AccessDeniedException(`Users must be admin, or assigned to the team to create assemblies`));
     });
 
@@ -327,11 +347,16 @@ describe('Projects', () => {
       } as any);
       await expect(
         async () =>
-          await ProjectsService.createAssembly('new assembly', 'file.txt', aquaman, {
-            carNumber: 1,
-            projectNumber: 1,
-            workPackageNumber: 0
-          })
+          await ProjectsService.createAssembly(
+            'new assembly',
+            aquaman,
+            {
+              carNumber: 1,
+              projectNumber: 1,
+              workPackageNumber: 0
+            },
+            'file.txt'
+          )
       ).rejects.toThrow(new AccessDeniedException(`Users must be admin, or assigned to the team to create assemblies`));
     });
 
@@ -344,11 +369,16 @@ describe('Projects', () => {
       vi.spyOn(prisma.assembly, 'create').mockResolvedValue(prismaAssembly1);
 
       // no error, no return value
-      await ProjectsService.createAssembly('new assembly', 'file.txt', batman, {
-        carNumber: 1,
-        projectNumber: 1,
-        workPackageNumber: 0
-      });
+      await ProjectsService.createAssembly(
+        'new assembly',
+        batman,
+        {
+          carNumber: 1,
+          projectNumber: 1,
+          workPackageNumber: 0
+        },
+        'file.txt'
+      );
     });
 
     test('createAssembly works if the submitter is on the team', async () => {
@@ -357,11 +387,16 @@ describe('Projects', () => {
       vi.spyOn(prisma.project, 'findFirst').mockResolvedValue(prismaProject1);
 
       // no error, no return value
-      await ProjectsService.createAssembly('new assembly', 'file.txt', superman, {
-        carNumber: 1,
-        projectNumber: 1,
-        workPackageNumber: 0
-      });
+      await ProjectsService.createAssembly(
+        'new assembly',
+        superman,
+        {
+          carNumber: 1,
+          projectNumber: 1,
+          workPackageNumber: 0
+        },
+        'file.txt'
+      );
     });
   });