Merge pull request #3459 from Northeastern-Electric-Racing/#3458-part-page-notifications

#3458 notifications

Author: chpy04

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

@@ -372,6 +372,26 @@ export default class PartReviewController {
     }
   }
 
+  static async notifyReviewer(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { reviewerId, partId } = req.body;
+      await PartReviewService.notifyReviewer(reviewerId, partId, req.organization.organizationId);
+      res.status(200).json({ message: 'Successfully notified reviewer' });
+    } catch (error) {
+      next(error);
+    }
+  }
+
+  static async notifyAssignee(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { assigneeId, partId } = req.body;
+      await PartReviewService.notifyAssignee(assigneeId, partId, req.organization.organizationId);
+      res.status(200).json({ message: 'Successfully notified assignee' });
+    } catch (error) {
+      next(error);
+    }
+  }
+
   static async createPartReviewPopup(req: Request, res: Response, next: NextFunction) {
     try {
       const user = req.currentUser;

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

@@ -166,50 +166,28 @@ partsRouter.post('/popup/:popupId/delete', PartReviewController.deletePartReview
 partsRouter.post('/reviewRequest/:reviewRequestId/delete', PartReviewController.deletePartReviewRequest);
 
 partsRouter.post(
-  '/:partId/reviewRequest/create',
+  '/notifyReviewer',
   nonEmptyString(body('reviewerId')),
+  nonEmptyString(body('partId')),
   validateInputs,
-  PartReviewController.createPartReviewRequest
+  PartReviewController.notifyReviewer
 );
-partsRouter.post('/reviewRequest/:reviewRequestId/delete', PartReviewController.deletePartReviewRequest);
-
-partsRouter.post('/:partId/upload-preview', upload.single('image'), PartReviewController.uploadPreview);
 
 partsRouter.post(
-  '/:partId/update',
-  intMinZero(body('index')),
-  nonEmptyString(body('commonName')),
-  body('description').optional().isString(),
-  body('reviewStatus').custom((value) => Object.values(Review_Status).includes(value)),
-  body('tagIds').isArray(),
-  body('assigneeIds').isArray(),
-  body('reviewerIds').isArray(),
+  '/notifyAssignee',
+  nonEmptyString(body('assigneeId')),
+  nonEmptyString(body('partId')),
   validateInputs,
-  PartReviewController.updatePart
+  PartReviewController.notifyAssignee
 );
 
-partsRouter.post('/:partId/delete', PartReviewController.deletePart);
-
-partsRouter.get('/:wbsNum', PartReviewController.getAllPartsForProject);
-
-partsRouter.post('/:partId/upload-preview', upload.single('image'), PartReviewController.uploadPreview);
-
 partsRouter.post(
-  '/:partId/update',
-  intMinZero(body('index')),
-  nonEmptyString(body('commonName')),
-  body('description').optional().isString(),
-  body('reviewStatus').custom((value) => Object.values(Review_Status).includes(value)),
-  body('tagIds').isArray(),
-  body('assigneeIds').isArray(),
+  '/:partId/reviewRequest/create',
+  nonEmptyString(body('reviewerId')),
   validateInputs,
-  PartReviewController.updatePart
+  PartReviewController.createPartReviewRequest
 );
 
-partsRouter.post('/:partId/delete', PartReviewController.deletePart);
-
-partsRouter.get('/:wbsNum', PartReviewController.getAllPartsForProject);
-
 partsRouter.post('/:partId/upload-preview', upload.single('image'), PartReviewController.uploadPreview);
 
 partsRouter.post(

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

@@ -42,6 +42,7 @@ import {
 import { isUserPartOfTeams } from '../utils/teams.utils';
 import { uploadFile, downloadFile } from '../utils/google-integration.utils';
 import ProjectsService from './projects.services';
+import { sendPartAssignmentPopUp, sendPartReviewRequestPopUp } from '../utils/pop-up.utils';
 
 export default class PartReviewService {
   /**
@@ -1091,6 +1092,82 @@ export default class PartReviewService {
     return partReviewRequestTransformer(softDeletedRequest);
   }
 
+  /**
+   * Sends a notification to the reviewer of a part review request
+   * @param reviewerId id of the reviewer
+   * @param partId id of the part
+   * @param creator id of the creator
+   * @param organizationId id of the organization
+   */
+  static async notifyReviewer(reviewerId: string, partId: string, organizationId: string) {
+    const part = await prisma.part.findUnique({
+      where: { partId },
+      include: {
+        project: {
+          include: {
+            wbsElement: true
+          }
+        },
+        reviewRequests: true
+      }
+    });
+
+    if (!part) {
+      throw new NotFoundException('Part', partId);
+    }
+
+    if (part.dateDeleted) {
+      throw new DeletedException('Part', partId);
+    }
+
+    if (!part.reviewRequests.some((request) => request.reviewerId === reviewerId)) {
+      throw new HttpException(400, 'User is not a reviewer for this part');
+    }
+
+    const wbsNum = `${part.project.wbsElement.carNumber}.${part.project.wbsElement.projectNumber}.0`;
+    const partLink = `/projects/${wbsNum}/part/${part.index}`;
+
+    await sendPartReviewRequestPopUp(partLink, part.commonName, reviewerId, organizationId);
+  }
+
+  /**
+   * Sends a notification to the assignee of a part
+   * @param assigneeId id of the assignee
+   * @param partId id of the part
+   * @param creator id of the creator
+   * @param organizationId id of the organization
+   */
+  static async notifyAssignee(assigneeId: string, partId: string, organizationId: string) {
+    const part = await prisma.part.findUnique({
+      where: { partId },
+      include: {
+        project: {
+          include: {
+            wbsElement: true
+          }
+        },
+        assignees: true
+      }
+    });
+
+    if (!part) {
+      throw new NotFoundException('Part', partId);
+    }
+
+    if (part.dateDeleted) {
+      throw new DeletedException('Part', partId);
+    }
+
+    if (!part.assignees.some((assignee) => assignee.userId === assigneeId)) {
+      throw new HttpException(400, 'User is not an assignee for this part');
+    }
+
+    const wbsNum = `${part.project.wbsElement.carNumber}.${part.project.wbsElement.projectNumber}.0`;
+    const partLink = `/projects/${wbsNum}/part/${part.index}`;
+
+    await sendPartAssignmentPopUp(partLink, part.commonName, assigneeId, organizationId);
+  }
+
   /**
    * Creates a part review popup
    *

src/backend/src/utils/pop-up.utils.ts

@@ -67,3 +67,47 @@ export const sendCrRequestReviewPopUp = async (changeRequest: Change_Request, re
     changeRequestLink
   );
 };
+
+/**
+ * Sends a finishline pop up to a user whose review was requested on a part
+ * @param partLink link to the part
+ * @param partName name of the part
+ * @param reviewer user whose review was requested
+ * @param organizationId id of the organization of the part
+ */
+export const sendPartReviewRequestPopUp = async (
+  partLink: string,
+  partName: string,
+  reviewerId: string,
+  organizationId: string
+) => {
+  await PopUpService.sendPopUpToUsers(
+    `Your review has been requested on ${partName}`,
+    'edit_note',
+    [reviewerId],
+    organizationId,
+    partLink
+  );
+};
+
+/**
+ * Sends a finishline pop up to a user who is assigned to a part
+ * @param partLink link to the part
+ * @param partName name of the part
+ * @param assignee user who is assigned to the part
+ * @param organizationId id of the organization of the part
+ */
+export const sendPartAssignmentPopUp = async (
+  partLink: string,
+  partName: string,
+  assigneeId: string,
+  organizationId: string
+) => {
+  await PopUpService.sendPopUpToUsers(
+    `You have been assigned to ${partName}`,
+    'edit_note',
+    [assigneeId],
+    organizationId,
+    partLink
+  );
+};

src/frontend/src/apis/part-review.api.ts

@@ -342,3 +342,25 @@ export const setPartReviewSampleImage = async (file: File) => {
   formData.append('partReviewSampleImage', file);
   return axios.post(apiUrls.setPartReviewSampleImage(), formData, {});
 };
+
+/**
+ * Sends a notification to the assignee of a part
+ * @param partId id of the part
+ * @param assigneeId id of the assignee
+ */
+export const sendPartAssignmentNotification = (payload: { partId: string; assigneeId: string }) => {
+  return axios.post<{ message: string }>(apiUrls.notifyPartAssignee(), {
+    ...payload
+  });
+};
+
+/**
+ * Sends a notification to the reviewer of a part
+ * @param partId id of the part
+ * @param reviewerId id of the reviewer
+ */
+export const sendPartReviewRequestNotification = (payload: { partId: string; reviewerId: string }) => {
+  return axios.post<{ message: string }>(apiUrls.notifyPartReviewer(), {
+    ...payload
+  });
+};

src/frontend/src/hooks/part-review.hooks.ts

@@ -34,6 +34,8 @@ import {
   updateReviewPopup,
   deleteReviewPopup,
   uploadFile,
+  sendPartAssignmentNotification,
+  sendPartReviewRequestNotification,
   setPartReviewSampleImage,
   getPartReviewSampleImage,
   createCommonMistake,
@@ -649,3 +651,45 @@ export const usePartReviewSampleImageId = () => {
     return fileId;
   });
 };
+
+/**
+ * Custom React Hook to notify the assignee of a part
+ *
+ * @returns a success message
+ */
+export const useNotifyPartAssignee = () => {
+  const queryClient = useQueryClient();
+  return useMutation<{ message: string }, Error, { partId: string; assigneeId: string }>(
+    ['parts', 'notifyAssignee'],
+    async (notification) => {
+      const { data } = await sendPartAssignmentNotification(notification);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['pop-ups', 'current-user']);
+      }
+    }
+  );
+};
+
+/**
+ * Custom React Hook to notify the reviewer of a part
+ *
+ * @returns a success message
+ */
+export const useNotifyPartReviewer = () => {
+  const queryClient = useQueryClient();
+  return useMutation<{ message: string }, Error, { partId: string; reviewerId: string }>(
+    ['parts', 'notifyReviewer'],
+    async (notification) => {
+      const { data } = await sendPartReviewRequestNotification(notification);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['pop-ups', 'current-user']);
+      }
+    }
+  );
+};