Merge pull request #2687 from Northeastern-Electric-Racing/Leadership-Approval-Reimbursement-Status

Add Leadership Approval Mechanism

Author: walker-sean

src/backend/src/controllers/reimbursement-requests.controllers.ts

@@ -295,6 +295,23 @@ export default class ReimbursementRequestsController {
     }
   }
 
+  static async leadershipApproveReimbursementRequest(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { requestId } = req.params;
+      const user = await getCurrentUser(res);
+      const organizationId = getOrganizationId(req.headers);
+
+      const reimbursementStatus = await ReimbursementRequestService.leadershipApproveReimbursementRequest(
+        requestId,
+        user,
+        organizationId
+      );
+      res.status(200).json(reimbursementStatus);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async approveReimbursementRequest(req: Request, res: Response, next: NextFunction) {
     try {
       const { requestId } = req.params;

src/backend/src/prisma/migrations/20240627230310_leadership_approval_reimbursement_request_status/migration.sql

@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "Reimbursement_Status_Type" ADD VALUE 'PENDING_LEADERSHIP_APPROVAL';

src/backend/src/prisma/schema.prisma

@@ -77,6 +77,7 @@ enum Club_Accounts {
 }
 
 enum Reimbursement_Status_Type {
+  PENDING_LEADERSHIP_APPROVAL
   PENDING_FINANCE
   SABO_SUBMITTED
   ADVISOR_APPROVED
@@ -424,12 +425,12 @@ model Link {
   linkType    Link_Type @relation(name: "linkTypes", fields: [linkTypeId], references: [id])
 
   // Either its on a wbsElement, a wbsProposedChanges, or an organization
-  wbsElementId               String?
-  wbsElment                  WBS_Element?          @relation(name: "links", fields: [wbsElementId], references: [wbsElementId])
-  wbsProposedChangesId       String?
-  wbsProposedChanges         Wbs_Proposed_Changes? @relation(name: "proposedChangeLinks", fields: [wbsProposedChangesId], references: [wbsProposedChangesId])
-  organization               Organization?         @relation(fields: [organizationId], references: [organizationId])
-  organizationId String?
+  wbsElementId         String?
+  wbsElment            WBS_Element?          @relation(name: "links", fields: [wbsElementId], references: [wbsElementId])
+  wbsProposedChangesId String?
+  wbsProposedChanges   Wbs_Proposed_Changes? @relation(name: "proposedChangeLinks", fields: [wbsProposedChangesId], references: [wbsProposedChangesId])
+  organization         Organization?         @relation(fields: [organizationId], references: [organizationId])
+  organizationId       String?
 }
 
 model Description_Bullet_Type {

src/backend/src/routes/reimbursement-requests.routes.ts

@@ -137,6 +137,10 @@ reimbursementRequestsRouter.post(
 );
 
 reimbursementRequestsRouter.post('/:requestId/approve', ReimbursementRequestController.approveReimbursementRequest);
+reimbursementRequestsRouter.post(
+  '/:requestId/leadership-approve',
+  ReimbursementRequestController.leadershipApproveReimbursementRequest
+);
 reimbursementRequestsRouter.delete('/:requestId/delete', ReimbursementRequestController.deleteReimbursementRequest);
 reimbursementRequestsRouter.post('/:requestId/deny', ReimbursementRequestController.denyReimbursementRequest);
 

src/backend/src/services/reimbursement-requests.services.ts

@@ -171,7 +171,7 @@ export default class ReimbursementRequestService {
         totalCost,
         reimbursementStatuses: {
           create: {
-            type: ReimbursementStatusType.PENDING_FINANCE,
+            type: ReimbursementStatusType.PENDING_LEADERSHIP_APPROVAL,
             userId: recipient.userId
           }
         },
@@ -847,6 +847,53 @@ export default class ReimbursementRequestService {
     return reimbursementRequestTransformer(reimbursementRequest);
   }
 
+  /**
+   * Adds a reimbursement status with type pending finance to the given reimbursement request
+   *
+   * @param reimbursementRequestId The id of the reimbursement request to approve
+   * @param submitter The person approving the reimbursement request
+   * @param organizationId The organization the user is currently in
+   * @returns The Pending Finance reimbursement status
+   */
+  static async leadershipApproveReimbursementRequest(
+    reimbursementRequestId: string,
+    submitter: User,
+    organizationId: string
+  ) {
+    if (!(await userHasPermission(submitter.userId, organizationId, isHead)))
+      throw new AccessDeniedException('Only a head or admin can approve reimbursement requests');
+
+    const reimbursementRequest = await prisma.reimbursement_Request.findUnique({
+      where: { reimbursementRequestId },
+      include: {
+        reimbursementStatuses: true
+      }
+    });
+
+    if (!reimbursementRequest) throw new NotFoundException('Reimbursement Request', reimbursementRequestId);
+    if (reimbursementRequest.dateDeleted) throw new DeletedException('Reimbursement Request', reimbursementRequestId);
+    if (reimbursementRequest.organizationId !== organizationId)
+      throw new InvalidOrganizationException('Reimbursement Request');
+
+    if (
+      reimbursementRequest.reimbursementStatuses.some(
+        (reimbursementStatus) => reimbursementStatus.type === Reimbursement_Status_Type.PENDING_FINANCE
+      )
+    )
+      throw new HttpException(400, 'This reimbursement request has already been approved by leadership');
+
+    const reimbursementStatus = await prisma.reimbursement_Status.create({
+      data: {
+        type: ReimbursementStatusType.PENDING_FINANCE,
+        userId: submitter.userId,
+        reimbursementRequestId: reimbursementRequest.reimbursementRequestId
+      },
+      ...getReimbursementStatusQueryArgs(organizationId)
+    });
+
+    return reimbursementStatusTransformer(reimbursementStatus);
+  }
+
   /**
    * Adds a reimbursement status with type sabo submitted to the given reimbursement request
    *
@@ -872,6 +919,11 @@ export default class ReimbursementRequestService {
     if (reimbursementRequest.organizationId !== organizationId)
       throw new InvalidOrganizationException('Reimbursement Request');
 
+    if (
+      !reimbursementRequest.reimbursementStatuses.some((status) => status.type === ReimbursementStatusType.PENDING_FINANCE)
+    ) {
+      throw new HttpException(400, 'This reimbursement request has not been approved by leadership');
+    }
     if (
       reimbursementRequest.reimbursementStatuses.some((status) => status.type === ReimbursementStatusType.SABO_SUBMITTED)
     ) {

src/frontend/src/apis/finance.api.ts

@@ -169,6 +169,16 @@ export const approveReimbursementRequest = (id: string) => {
   return axios.post(apiUrls.financeApproveReimbursementRequest(id));
 };
 
+/**
+ * Leadership approve Reimbursement Request (set it to Pending Finance)
+ *
+ * @param id of the reimbursement request being approved by finance
+ * @returns the pending finance reimbursement status
+ */
+export const leadershipApproveReimbursementRequest = (id: string) => {
+  return axios.post(apiUrls.financeLeadershipApprove(id));
+};
+
 /**
  * Deny Reimbursement Request
  *

src/frontend/src/hooks/finance.hooks.ts

@@ -28,7 +28,8 @@ import {
   createAccountCode,
   createVendor,
   editVendor,
-  getAllAccountCodes
+  getAllAccountCodes,
+  leadershipApproveReimbursementRequest
 } from '../apis/finance.api';
 import {
   ClubAccount,
@@ -315,6 +316,28 @@ export const useApproveReimbursementRequest = (id: string) => {
   );
 };
 
+/**
+ * Custom react hook to approve a reimbursement request for the leadership team
+ *
+ * @param id id of the reimbursement request to approve
+ * @returns the created pending finance reimbursement status
+ */
+export const useLeadershipApproveReimbursementRequest = (id: string) => {
+  const queryClient = useQueryClient();
+  return useMutation<ReimbursementStatus, Error>(
+    ['reimbursement-requests', 'edit'],
+    async () => {
+      const { data } = await leadershipApproveReimbursementRequest(id);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['reimbursement-requests', id]);
+      }
+    }
+  );
+};
+
 /**
  * Custom react hook to deny a reimbursement request for the finance team
  *

src/frontend/src/pages/FinancePage/ReimbursementRequestDetailPage/ReimbursementRequestDetailsView.tsx

@@ -15,14 +15,15 @@ import { Grid, Typography, useTheme, Link, IconButton } from '@mui/material';
 import { Box } from '@mui/system';
 import { useState } from 'react';
 import { useHistory } from 'react-router-dom';
-import { ReimbursementRequest } from 'shared';
+import { ReimbursementRequest, isHead } from 'shared';
 import ActionsMenu, { ButtonInfo } from '../../../components/ActionsMenu';
 import NERModal from '../../../components/NERModal';
 import PageLayout from '../../../components/PageLayout';
 import VerticalDetailDisplay from '../../../components/VerticalDetailDisplay';
 import {
   useDeleteReimbursementRequest,
   useDenyReimbursementRequest,
+  useLeadershipApproveReimbursementRequest,
   useMarkReimbursementRequestAsDelivered,
   useMarkReimbursementRequestAsReimbursed
 } from '../../../hooks/finance.hooks';
@@ -64,6 +65,7 @@ const ReimbursementRequestDetailsView: React.FC<ReimbursementRequestDetailsViewP
   const toast = useToast();
   const [showDeleteModal, setShowDeleteModal] = useState(false);
   const [showDenyModal, setShowDenyModal] = useState(false);
+  const [showLeadershipApproveModal, setShowLeadershipApproveModal] = useState(false);
   const [showMarkDelivered, setShowMarkDelivered] = useState(false);
   const [showMarkReimbursed, setShowMarkReimbursed] = useState(false);
   const [showSubmitToSaboModal, setShowSubmitToSaboModal] = useState(false);
@@ -75,7 +77,12 @@ const ReimbursementRequestDetailsView: React.FC<ReimbursementRequestDetailsViewP
   const { mutateAsync: markReimbursed } = useMarkReimbursementRequestAsReimbursed(
     reimbursementRequest.reimbursementRequestId
   );
+  const { mutateAsync: leadershipApproveReimbursementRequest } = useLeadershipApproveReimbursementRequest(
+    reimbursementRequest.reimbursementRequestId
+  );
+
   const isSaboSubmitted = isReimbursementRequestSaboSubmitted(reimbursementRequest);
+  const isLeadershipApproved = isReimbursementRequestAdvisorApproved(reimbursementRequest);
 
   const handleDelete = async () => {
     try {
@@ -121,6 +128,17 @@ const ReimbursementRequestDetailsView: React.FC<ReimbursementRequestDetailsViewP
     }
   };
 
+  const handleLeadershipApprove = async () => {
+    try {
+      await leadershipApproveReimbursementRequest();
+      setShowLeadershipApproveModal(false);
+    } catch (e: unknown) {
+      if (e instanceof Error) {
+        toast.error(e.message, 3000);
+      }
+    }
+  };
+
   const DeleteModal = () => {
     return (
       <NERModal
@@ -151,6 +169,21 @@ const ReimbursementRequestDetailsView: React.FC<ReimbursementRequestDetailsViewP
     );
   };
 
+  const LeadershipApproveModal = () => {
+    return (
+      <NERModal
+        open={showLeadershipApproveModal}
+        onHide={() => setShowLeadershipApproveModal(false)}
+        title="Warning!"
+        cancelText="No"
+        submitText="Yes"
+        onSubmit={handleLeadershipApprove}
+      >
+        <Typography>Are you sure you want to approve this reimbursement request?</Typography>
+      </NERModal>
+    );
+  };
+
   const MarkDeliveredModal = () => (
     <NERModal
       open={showMarkDelivered}
@@ -303,6 +336,16 @@ const ReimbursementRequestDetailsView: React.FC<ReimbursementRequestDetailsViewP
       icon: isSaboSubmitted ? <Assignment /> : <CheckIcon />,
       disabled: !user.isFinance
     },
+    {
+      title: 'Leadership Approve',
+      onClick: () => setShowLeadershipApproveModal(true),
+      icon: <CheckIcon />,
+      disabled:
+        !isHead(user.role) ||
+        isReimbursementRequestDenied(reimbursementRequest) ||
+        isReimbursementRequestReimbursed(reimbursementRequest) ||
+        isLeadershipApproved
+    },
     {
       title: 'Deny',
       onClick: () => setShowDenyModal(true),
@@ -337,6 +380,7 @@ const ReimbursementRequestDetailsView: React.FC<ReimbursementRequestDetailsViewP
       <DenyModal />
       <MarkDeliveredModal />
       <MarkReimbursedModal />
+      <LeadershipApproveModal />
       <SubmitToSaboModal
         open={showSubmitToSaboModal}
         setOpen={setShowSubmitToSaboModal}

src/frontend/src/utils/reimbursement-request.utils.ts

@@ -45,6 +45,7 @@ export const descendingComparator = <T>(a: T, b: T, orderBy: keyof T) => {
 
 export const statusDescendingComparator = (a: ReimbursementStatusType, b: ReimbursementStatusType) => {
   const statusOrder = new Map<ReimbursementStatusType, number>([
+    [ReimbursementStatusType.PENDING_LEADERSHIP_APPROVAL, 0],
     [ReimbursementStatusType.PENDING_FINANCE, 1],
     [ReimbursementStatusType.SABO_SUBMITTED, 2],
     [ReimbursementStatusType.ADVISOR_APPROVED, 3],
@@ -123,6 +124,8 @@ export const cleanReimbursementRequestStatus = (status: ReimbursementStatusType)
     case ReimbursementStatusType.DENIED: {
       return 'Denied';
     }
+    default:
+      return 'Pending Leadership Approval';
   }
 };
 
@@ -142,6 +145,12 @@ export const isReimbursementRequestSaboSubmitted = (reimbursementRequest: Reimbu
     .includes(ReimbursementStatusType.SABO_SUBMITTED);
 };
 
+export const isReimbursementRequestLeadershipApproved = (reimbursementRequest: ReimbursementRequest) => {
+  return !reimbursementRequest.reimbursementStatuses
+    .map((status) => status.type)
+    .includes(ReimbursementStatusType.PENDING_FINANCE);
+};
+
 export const isReimbursementRequestDenied = (reimbursementRequest: ReimbursementRequest) => {
   return reimbursementRequest.reimbursementStatuses.map((status) => status.type).includes(ReimbursementStatusType.DENIED);
 };

src/frontend/src/utils/urls.ts

@@ -122,6 +122,7 @@ const financeEditAccountCode = (accountCodeId: string) => `${getAllAccountCodes(
 const financeCreateAccountCode = () => `${getAllAccountCodes()}/create`;
 const financeCreateVendor = () => `${financeEndpoints()}/vendors/create`;
 const financeEditVendor = (vendorId: string) => `${financeEndpoints()}/${vendorId}/vendors/edit`;
+const financeLeadershipApprove = (id: string) => `${financeEndpoints()}/${id}/leadership-approve`;
 
 /**************** Bill of Material Endpoints **************************/
 const bomEndpoints = () => `${API_URL}/projects/bom`;
@@ -270,6 +271,7 @@ export const apiUrls = {
   financeCreateAccountCode,
   financeCreateVendor,
   financeEditVendor,
+  financeLeadershipApprove,
 
   bomEndpoints,
   bomGetMaterialsByWbsNum,