Merge pull request #1688 from Northeastern-Electric-Racing/#1448-BenjaminZhu-AddAbilityToEditVendors

#1448 benjamin zhu add ability to edit vendors

Author: RChandler234

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

@@ -319,4 +319,16 @@ export default class ReimbursementRequestsController {
       next(error);
     }
   }
+
+  static async editVendor(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { vendorId } = req.params;
+      const { name } = req.body;
+      const submitter = await getCurrentUser(res);
+      const editVendors = await ReimbursementRequestService.editVendors(name, vendorId, submitter);
+      res.status(200).json(editVendors);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

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

@@ -24,6 +24,13 @@ reimbursementRequestsRouter.get('/reimbursements/current-user', ReimbursementReq
 
 reimbursementRequestsRouter.get('/reimbursements', ReimbursementRequestController.getAllReimbursements);
 
+reimbursementRequestsRouter.post(
+  '/:vendorId/vendors/edit',
+  nonEmptyString(body('name')),
+  validateInputs,
+  ReimbursementRequestController.editVendor
+);
+
 reimbursementRequestsRouter.post(
   '/create',
   isDate(body('dateOfExpense')),

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

@@ -22,6 +22,7 @@ import {
 } from 'shared';
 import prisma from '../prisma/prisma';
 import {
+  isUserAdminOrOnFinance,
   createReimbursementProducts,
   isUserLeadOrHeadOfFinanceTeam,
   removeDeletedReceiptPictures,
@@ -767,4 +768,29 @@ export default class ReimbursementRequestService {
     if (!fileData) throw new NotFoundException('Image File', fileId);
     return fileData;
   }
+
+  /**
+   * Edits the vendor name
+   *
+   * @param name the new vendor name
+   * @param vendorId the requested vendor to be edited
+   * @param submitter the user editing the vendor name
+   * @returns the updated vendor
+   */
+  static async editVendors(name: string, vendorId: string, submitter: User) {
+    await isUserAdminOrOnFinance(submitter);
+
+    const vendorUniqueName = await prisma.vendor.findUnique({
+      where: { name }
+    });
+
+    if (!!vendorUniqueName) throw new HttpException(400, 'vendor name already exists');
+
+    const vendor = await prisma.vendor.update({
+      where: { vendorId },
+      data: { name }
+    });
+
+    return vendorTransformer(vendor);
+  }
 }

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

@@ -9,6 +9,7 @@ import {
   ReimbursementProductCreateArgs,
   ReimbursementReceiptCreateArgs,
   ValidatedWbsReimbursementProductCreateArgs,
+  isAdmin,
   wbsPipe,
   WbsReimbursementProductCreateArgs
 } from 'shared';
@@ -366,6 +367,16 @@ export const isAuthUserHeadOfFinance = (user: Prisma.UserGetPayload<typeof authU
   return user.teamAsHead?.teamId === process.env.FINANCE_TEAM_ID;
 };
 
+export const isUserAdminOrOnFinance = async (submitter: User) => {
+  try {
+    await validateUserIsPartOfFinanceTeam(submitter);
+  } catch (error) {
+    if (!isAdmin(submitter.role)) {
+      throw new AccessDeniedException('Only Admins, Finance Team Leads, or Heads can edit vendors');
+    }
+  }
+};
+
 const isTeamIdInList = (teamId: string, teamsList: Team[]) => {
   return teamsList.map((team) => team.teamId).includes(teamId);
 };

src/backend/tests/reimbursement-requests.test.ts

@@ -22,7 +22,8 @@ import {
   prismaGiveMeMyMoney4,
   prismaGiveMeMyMoney5,
   prismaReimbursementStatus,
-  sharedGiveMeMyMoney
+  sharedGiveMeMyMoney,
+  KFC
 } from './test-data/reimbursement-requests.test-data';
 import {
   alfred,
@@ -758,4 +759,29 @@ describe('Reimbursement Requests', () => {
       expect(newReimbursement).toStrictEqual(reimbursementTransformer(reimbursementMock));
     });
   });
+
+  describe('Edit Vendor Tests', () => {
+    test('Throws error if user isnt an admin or lead/head of the finance', async () => {
+      await expect(
+        ReimbursementRequestService.editVendors('I Love Benny', GiveMeMyMoney.vendorId, wonderwoman)
+      ).rejects.toThrow(new AccessDeniedException('Only Admins, Finance Team Leads, or Heads can edit vendors'));
+    });
+
+    test('Throws error if the vendor name already exists', async () => {
+      vi.spyOn(prisma.vendor, 'findUnique').mockResolvedValue(PopEyes);
+      await expect(ReimbursementRequestService.editVendors('CHICKEN', GiveMeMyMoney.vendorId, batman)).rejects.toThrow(
+        new HttpException(400, 'vendor name already exists')
+      );
+    });
+
+    test('Successfuly changes Vendors name', async () => {
+      vi.spyOn(prisma.vendor, 'update').mockResolvedValue(KFC);
+      vi.spyOn(prisma.vendor, 'findUnique').mockResolvedValue(null);
+
+      const vendor = await ReimbursementRequestService.editVendors('kfc', PopEyes.vendorId, batman);
+
+      expect(vendor.name).toBe('kfc');
+      expect(prisma.vendor.update).toBeCalledTimes(1);
+    });
+  });
 });

src/backend/tests/test-data/reimbursement-requests.test-data.ts

@@ -23,6 +23,12 @@ export const PopEyes: PrismaVendor = {
   name: 'Pop Eyes'
 };
 
+export const KFC: PrismaVendor = {
+  vendorId: 'CHICKEN',
+  dateCreated: new Date('12/22/203'),
+  name: 'kfc'
+};
+
 export const Parts: PrismaExpenseType = {
   expenseTypeId: 'PARTS',
   name: 'hammer',