Merge pull request #3464 from Northeastern-Electric-Racing/#3393-submission-guide

#3393 submission guide

Author: chpy04

src/backend/src/controllers/part-review.controllers.ts

@@ -234,12 +234,8 @@ export default class PartReviewController {
   static async deletePartTag(req: Request, res: Response, next: NextFunction) {
     try {
       const { partTagId } = req.params;
-      const deletedPartTag = await PartReviewService.deletePartTag(
-        partTagId,
-        req.currentUser,
-        req.organization.organizationId
-      );
-      res.status(200).send(deletedPartTag);
+      await PartReviewService.deletePartTag(partTagId, req.currentUser, req.organization.organizationId);
+      res.status(200).send({ message: 'Successfully deleted part tag' });
     } catch (error: unknown) {
       next(error);
     }
@@ -328,12 +324,8 @@ export default class PartReviewController {
   static async deleteCommonMistake(req: Request, res: Response, next: NextFunction) {
     try {
       const { commonMistakeId } = req.params;
-      const commonMistake = await PartReviewService.deleteCommonMistake(
-        commonMistakeId,
-        req.currentUser,
-        req.organization.organizationId
-      );
-      res.status(200).json(commonMistake);
+      await PartReviewService.deleteCommonMistake(commonMistakeId, req.currentUser, req.organization.organizationId);
+      res.status(200).json({ message: 'Successfully deleted common mistake' });
     } catch (error: unknown) {
       next(error);
     }
@@ -438,4 +430,29 @@ export default class PartReviewController {
       return next(error);
     }
   }
+
+  static async setPartReviewSampleImage(req: Request, res: Response, next: NextFunction) {
+    try {
+      if (!req.file) {
+        throw new HttpException(400, 'Invalid or undefined image data');
+      }
+
+      const updatedOrg = await PartReviewService.setPartReviewSampleImage(req.file, req.currentUser, req.organization);
+
+      res.status(200).json(updatedOrg);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
+  static async getPartReviewSampleImage(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { organization } = req;
+
+      const partReviewSampleImageId = await PartReviewService.getPartReviewSampleImage(organization.organizationId);
+      res.status(200).json(partReviewSampleImageId);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/routes/parts.routes.ts

@@ -65,22 +65,22 @@ partsRouter.get('/tags', PartReviewController.getAllPartTags);
 partsRouter.get('/faqs', PartReviewController.getAllPartReviewFAQS);
 
 partsRouter.post(
-  '/partTag/create',
+  '/tag/create',
   nonEmptyString(body('name')),
   nonEmptyString(body('colorHexCode')),
   validateInputs,
   PartReviewController.createPartTag
 );
 
 partsRouter.post(
-  '/partTag/:partTagId/update',
+  '/tag/:partTagId/update',
   nonEmptyString(body('name')),
   nonEmptyString(body('colorHexCode')),
   validateInputs,
   PartReviewController.updatePartTag
 );
 
-partsRouter.post('/partTag/:partTagId/delete', PartReviewController.deletePartTag);
+partsRouter.post('/tag/:partTagId/delete', PartReviewController.deletePartTag);
 
 partsRouter.post(
   '/faqs/create',
@@ -143,6 +143,13 @@ partsRouter.post(
   PartReviewController.updatePartReviewPopup
 );
 
+partsRouter.post(
+  '/partReviewSampleImage/update',
+  upload.single('partReviewSampleImage'),
+  PartReviewController.setPartReviewSampleImage
+);
+partsRouter.get('/partReviewSampleImage', PartReviewController.getPartReviewSampleImage);
+
 partsRouter.post('/common-mistake/:commonMistakeId/delete', PartReviewController.deleteCommonMistake);
 partsRouter.post('/popup/:popupId/delete', PartReviewController.deletePartReviewPopup);
 

src/backend/src/services/part-review.services.ts

@@ -603,7 +603,7 @@ export default class PartReviewService {
    * @returns the delted part tag
    * @throws if there are existing parts with this tag
    */
-  static async deletePartTag(partTagId: string, deleter: User, organizationId: string): Promise<PartTag> {
+  static async deletePartTag(partTagId: string, deleter: User, organizationId: string) {
     if (!(await userHasPermission(deleter.userId, organizationId, isAdmin))) {
       throw new AccessDeniedAdminOnlyException('delete part review tag');
     }
@@ -620,23 +620,21 @@ export default class PartReviewService {
     }
 
     if (
-      !partTagWithParts.parts.every((part) => {
-        return !part.dateDeleted;
+      partTagWithParts.parts.some((part) => {
+        return part.dateDeleted === null;
       })
     ) {
       throw new HttpException(409, `Cannot delete part tag ${partTagId} because it has associated parts`);
     }
 
-    const deletedPartTag = await prisma.partTag.update({
+    await prisma.partTag.update({
       where: {
         partTagId
       },
       data: {
         dateDeleted: new Date()
       }
     });
-
-    return deletedPartTag;
   }
 
   /**
@@ -800,7 +798,7 @@ export default class PartReviewService {
     creator: User,
     organizationId: string
   ): Promise<PartReviewCommonMistake> {
-    if (!(await userHasPermission(creator.userId, organizationId, isAdmin))) {
+    if (starred && !(await userHasPermission(creator.userId, organizationId, isAdmin))) {
       throw new AccessDeniedAdminOnlyException('create common mistake');
     }
 
@@ -882,11 +880,7 @@ export default class PartReviewService {
    * @param organizationId the orgainization
    * @returns the deleted common mistake
    */
-  static async deleteCommonMistake(
-    commonMistakeId: string,
-    deleter: User,
-    organizationId: string
-  ): Promise<PartReviewCommonMistake> {
+  static async deleteCommonMistake(commonMistakeId: string, deleter: User, organizationId: string) {
     const commonMistake = await prisma.partReviewCommonMistake.findUnique({
       where: {
         partReviewCommonMistakeId: commonMistakeId
@@ -901,7 +895,7 @@ export default class PartReviewService {
       throw new AccessDeniedAdminOnlyException('delete common mistake');
     }
 
-    const deletedCommonMistake = await prisma.partReviewCommonMistake.update({
+    await prisma.partReviewCommonMistake.update({
       where: {
         partReviewCommonMistakeId: commonMistakeId
       },
@@ -914,8 +908,6 @@ export default class PartReviewService {
         dateDeleted: new Date()
       }
     });
-
-    return partsReviewCommonMistakeTransformer(deletedCommonMistake);
   }
 
   /**
@@ -1157,4 +1149,54 @@ export default class PartReviewService {
     if (!fileData) throw new NotFoundException('File', fileId);
     return fileData;
   }
+
+  /**
+   * Sets the part review sample image for an organization, User must be admin
+   * @param image the image which will be uploaded and have its id stored in the org
+   * @param submitter the user submitting the sample image
+   * @param organization the organization who's sample image is being set
+   * @returns the updated organization
+   * @throws if the user is not an admin
+   */
+  static async setPartReviewSampleImage(
+    image: Express.Multer.File,
+    submitter: User,
+    organization: Organization
+  ): Promise<Organization> {
+    if (!(await userHasPermission(submitter.userId, organization.organizationId, isAdmin))) {
+      throw new AccessDeniedAdminOnlyException('update part review sample image');
+    }
+
+    const previewImageData = await uploadFile(image);
+
+    if (!previewImageData?.name) {
+      throw new HttpException(500, 'Image Name not found');
+    }
+
+    const updatedOrg = await prisma.organization.update({
+      where: { organizationId: organization.organizationId },
+      data: {
+        partReviewSampleImageId: previewImageData.id
+      }
+    });
+
+    return updatedOrg;
+  }
+
+  /**
+   * Gets the part review sample image of the organization
+   * @param organizationId the id of the organization
+   * @returns the id of the image
+   */
+  static async getPartReviewSampleImage(organizationId: string): Promise<string | null> {
+    const organization = await prisma.organization.findUnique({
+      where: { organizationId }
+    });
+
+    if (!organization) {
+      throw new NotFoundException('Organization', organizationId);
+    }
+
+    return organization.partReviewSampleImageId;
+  }
 }