Merge pull request #3528 from Northeastern-Electric-Racing/createSponsorTier

implemented everything to do with sponsor tiers

Author: walker-sean

src/backend/src/controllers/finance.controllers.ts

@@ -100,9 +100,15 @@ export default class FinanceController {
 
   static async createSponsorTier(req: Request, res: Response, next: NextFunction) {
     try {
-      const { name, colorHexCode } = req.body;
+      const { name, colorHexCode, minSupportValue } = req.body;
 
-      const sponsor = await FinanceServices.createSponsorTier(req.currentUser, name, req.organization, colorHexCode);
+      const sponsor = await FinanceServices.createSponsorTier(
+        req.currentUser,
+        name,
+        req.organization,
+        colorHexCode,
+        minSupportValue
+      );
       res.status(200).json(sponsor);
     } catch (error: unknown) {
       next(error);
@@ -324,4 +330,33 @@ export default class FinanceController {
       next(error);
     }
   }
+
+  static async deleteSponsorTier(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { sponsorTierId } = req.params;
+      const deletedSponsorTier = await FinanceServices.deleteSponsorTier(sponsorTierId, req.currentUser, req.organization);
+      res.status(200).json(deletedSponsorTier);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
+  static async editSponsorTier(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { sponsorTierId } = req.params;
+      const { name, colorHexCode, minSupportValue } = req.body;
+
+      const updatedSponsorTier = await FinanceServices.editSponsorTier(
+        req.currentUser,
+        req.organization,
+        sponsorTierId,
+        name,
+        colorHexCode,
+        minSupportValue
+      );
+      res.status(200).json(updatedSponsorTier);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/prisma/migrations/20250812021255_sponsor_tier_additions/migration.sql

@@ -0,0 +1,11 @@
+-- AlterTable
+ALTER TABLE "public"."Sponsor_Tier" 
+ADD COLUMN     "dateDeleted" TIMESTAMP(3),
+ADD COLUMN     "deleterId" TEXT,
+ADD COLUMN     "minSupportValue" INTEGER NOT NULL DEFAULT 0;
+
+-- AlterTable
+ALTER TABLE "public"."Vendor" ALTER COLUMN "addedByUserId" DROP DEFAULT;
+
+-- AddForeignKey
+ALTER TABLE "public"."Sponsor_Tier" ADD CONSTRAINT "Sponsor_Tier_deleterId_fkey" FOREIGN KEY ("deleterId") REFERENCES "public"."User"("userId") ON DELETE SET NULL ON UPDATE CASCADE;

src/backend/src/prisma/schema.prisma

@@ -256,6 +256,7 @@ model User {
   deletedOtherReimbursementProductReasons Reimbursement_Product_Other_Reason[] @relation(name: "deletedOtherReimbursementProductReasons")
   reimbursementRequestComments            Reimbursement_Request_Comment[]      @relation(name: "createdReimbursementRequestComments")
   deletedReimbursementRequestComments     Reimbursement_Request_Comment[]      @relation(name: "deletedReimbursementRequestComments")
+  deletedSponsorTiers                     Sponsor_Tier[]
 }
 
 model Role {
@@ -1345,12 +1346,16 @@ model Part_Review_Common_Mistake {
 }
 
 model Sponsor_Tier {
-  sponsorTierId  String       @id @default(uuid())
-  organization   Organization @relation(fields: [organizationId], references: [organizationId])
-  organizationId String
-  name           String
-  colorHexCode   String
-  sponsors       Sponsor[]
+  sponsorTierId   String       @id @default(uuid())
+  organization    Organization @relation(fields: [organizationId], references: [organizationId])
+  organizationId  String
+  name            String
+  colorHexCode    String
+  sponsors        Sponsor[]
+  dateDeleted     DateTime?
+  deleter         User?        @relation(fields: [deleterId], references: [userId])
+  deleterId       String?
+  minSupportValue Int          @default(0)
 }
 
 model Index_Code {

src/backend/src/prisma/seed.ts

@@ -3031,9 +3031,9 @@ const performSeed: () => Promise<void> = async () => {
     }
   });
 
-  const goldSponsorTier = await FinanceServices.createSponsorTier(thomasEmrax, 'Gold', ner, '#9F9156');
-  await FinanceServices.createSponsorTier(thomasEmrax, 'Silver', ner, '#C0C0C0');
-  await FinanceServices.createSponsorTier(thomasEmrax, 'Bronze', ner, '#CD7F32');
+  const goldSponsorTier = await FinanceServices.createSponsorTier(thomasEmrax, 'Gold', ner, '#9F9156', 3000);
+  await FinanceServices.createSponsorTier(thomasEmrax, 'Silver', ner, '#C0C0C0', 200);
+  await FinanceServices.createSponsorTier(thomasEmrax, 'Bronze', ner, '#CD7F32', 10);
 
   const sponsor = await FinanceServices.createSponsor(
     thomasEmrax,
@@ -3050,8 +3050,6 @@ const performSeed: () => Promise<void> = async () => {
     'googlecode'
   );
 
-  await FinanceServices.createSponsorTier(thomasEmrax, 'Silver', ner, 'C0C0C0');
-
   await FinanceServices.createSponsorTask(
     thomasEmrax,
     ner,

src/backend/src/routes/finance.routes.ts

@@ -145,4 +145,15 @@ financeRouter.post(
   FinanceController.editSponsor
 );
 
+financeRouter.delete('/sponsorTier/:sponsorTierId', FinanceController.deleteSponsorTier);
+
+financeRouter.post(
+  '/sponsorTier/:sponsorTierId/edit',
+  nonEmptyString(body('name')),
+  nonEmptyString(body('colorHexCode')),
+  intMinZero(body('minSupportValue')),
+  validateInputs,
+  FinanceController.editSponsorTier
+);
+
 export default financeRouter;

src/backend/src/services/finance.services.ts

@@ -1,5 +1,6 @@
 import {
   CreateSponsorTask,
+  isAdmin,
   isHead,
   ReimbursementRequestData,
   SpendingBarData,
@@ -15,6 +16,7 @@ import {
   getSponsorTierQueryArgs
 } from '../prisma-query-args/sponsor.query.args';
 import {
+  AccessDeniedAdminOnlyException,
   AccessDeniedException,
   DeletedException,
   HttpException,
@@ -176,17 +178,25 @@ export default class FinanceServices {
    * @param name tier name
    * @param organization current organization of the current user
    * @param colorHexCode tier color
+   * @param minSupportValue minimum support value for the tier
    * @returns newly created sponsor tier
    */
-  static async createSponsorTier(submitter: User, name: string, organization: Organization, colorHexCode: string) {
+  static async createSponsorTier(
+    submitter: User,
+    name: string,
+    organization: Organization,
+    colorHexCode: string,
+    minSupportValue: number
+  ): Promise<SponsorTier> {
     if (!(await userHasPermission(submitter.userId, organization.organizationId, isHead)))
       throw new AccessDeniedException('Only heads can create a sponsor tier');
 
     const sponsorTier = await prisma.sponsor_Tier.create({
       data: {
         name,
         organizationId: organization.organizationId,
-        colorHexCode
+        colorHexCode,
+        minSupportValue
       },
       include: {
         organization: true
@@ -587,10 +597,97 @@ export default class FinanceServices {
    */
   static async getAllSponsorTiers(organization: Organization): Promise<SponsorTier[]> {
     const allSponsorTiers = await prisma.sponsor_Tier.findMany({
-      where: { organizationId: organization.organizationId },
+      where: { organizationId: organization.organizationId, dateDeleted: null },
+      orderBy: { minSupportValue: 'asc' },
       ...getSponsorTierQueryArgs(organization.organizationId)
     });
 
     return allSponsorTiers;
   }
+
+  /**
+   * Soft deletes a given sponsor tier
+   * @param sponsorTierId the id of the sponsor tier that is getting deleted
+   * @param deleter the person deleting the sponsor tier
+   * @param organization the organization the person deleting belongs to
+   * @returns the deleted sponsor tier
+   */
+  static async deleteSponsorTier(sponsorTierId: string, deleter: User, organization: Organization): Promise<SponsorTier> {
+    const sponsorTier = await prisma.sponsor_Tier.findUnique({
+      where: { sponsorTierId }
+    });
+
+    if (!(await userHasPermission(deleter.userId, organization.organizationId, isAdmin))) {
+      throw new AccessDeniedAdminOnlyException('delete a sponsor tier');
+    }
+
+    if (!sponsorTier) throw new NotFoundException('Sponsor Tier', sponsorTierId);
+    if (sponsorTier.organizationId !== organization.organizationId) throw new InvalidOrganizationException('Sponsor Tier');
+    if (sponsorTier.dateDeleted) throw new DeletedException('Sponsor Tier', sponsorTierId);
+
+    const associatedSponsors = await prisma.sponsor.count({
+      where: { sponsorTierId: sponsorTier.sponsorTierId, dateDeleted: null }
+    });
+
+    if (associatedSponsors > 0) {
+      throw new HttpException(
+        400,
+        `Cannot delete Sponsor Tier "${sponsorTier.name}" because it is associated with existing sponsors.`
+      );
+    }
+
+    const deletedSponsorTier = await prisma.sponsor_Tier.update({
+      where: { sponsorTierId },
+      data: { dateDeleted: new Date(), deleter: { connect: { userId: deleter.userId } } },
+      ...getSponsorTierQueryArgs(organization.organizationId)
+    });
+
+    return deletedSponsorTier;
+  }
+
+  /**
+   * Edits a sponsor tier.
+   * @param submitter current user editing the sponsor tier
+   * @param organization current organization of the current user
+   * @param sponsorTierId id of the sponsor tier to be edited
+   * @param name updated tier name
+   * @param colorHexCode updated tier color
+   * @param minSupportValue updated minimum support value for the tier
+   * @returns the updated sponsor tier
+   * @throws AccessDeniedAdminOnlyException if the user lacks permissions.
+   * @throws NotFoundException if the sponsor tier is not found.
+   */
+  static async editSponsorTier(
+    submitter: User,
+    organization: Organization,
+    sponsorTierId: string,
+    name: string,
+    colorHexCode: string,
+    minSupportValue: number
+  ): Promise<SponsorTier> {
+    if (!(await userHasPermission(submitter.userId, organization.organizationId, isAdmin)))
+      throw new AccessDeniedAdminOnlyException('edit a sponsor tier');
+
+    const oldSponsorTier = await prisma.sponsor_Tier.findUnique({
+      where: {
+        sponsorTierId,
+        organizationId: organization.organizationId
+      }
+    });
+
+    if (!oldSponsorTier) throw new NotFoundException('Sponsor Tier', sponsorTierId);
+    if (oldSponsorTier.dateDeleted) throw new DeletedException('Sponsor Tier', sponsorTierId);
+
+    const updatedSponsorTier = await prisma.sponsor_Tier.update({
+      where: { sponsorTierId: oldSponsorTier.sponsorTierId },
+      data: {
+        name,
+        colorHexCode,
+        minSupportValue
+      },
+      ...getSponsorTierQueryArgs(organization.organizationId)
+    });
+
+    return updatedSponsorTier;
+  }
 }

src/backend/tests/unit/finance.test.ts

@@ -320,7 +320,8 @@ describe('Finance Tests', () => {
             await createTestUser(wonderwomanGuest, orgId),
             'Silver',
             organization,
-            'C0C0C0'
+            '#C0C0C0',
+            0
           )
       ).rejects.toThrow(new AccessDeniedException('Only heads can create a sponsor tier'));
     });
@@ -330,12 +331,12 @@ describe('Finance Tests', () => {
         await createTestUser(batmanAppAdmin, orgId),
         'Silver',
         organization,
-        'C0C0C0'
+        '#C0C0C0',
+        0
       );
 
       expect(result.name).toEqual('Silver');
-      expect(result.colorHexCode).toEqual('C0C0C0');
-      expect(result.organizationId).toEqual(orgId);
+      expect(result.colorHexCode).toEqual('#C0C0C0');
     });
   });
 
@@ -474,14 +475,20 @@ describe('Finance Tests', () => {
       const result1 = await FinanceServices.getAllSponsorTiers(organization);
       expect(result1.length).toEqual(1);
 
-      await FinanceServices.createSponsorTier(await createTestUser(batmanAppAdmin, orgId), 'Silver', organization, 'C0C0C0');
+      await FinanceServices.createSponsorTier(
+        await createTestUser(batmanAppAdmin, orgId),
+        'Silver',
+        organization,
+        '#C0C0C0',
+        0
+      );
 
       const result2 = await FinanceServices.getAllSponsorTiers(organization);
       expect(result2.length).toEqual(2);
       expect(result2[0].name).toEqual('Gold Tier');
       expect(result2[0].colorHexCode).toEqual('#FFFFFF');
       expect(result2[1].name).toEqual('Silver');
-      expect(result2[1].colorHexCode).toEqual('C0C0C0');
+      expect(result2[1].colorHexCode).toEqual('#C0C0C0');
     });
   });
 

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

@@ -677,3 +677,25 @@ export const editSponsor = (id: string, formData: SponsorPayload) => {
 export const deleteSponsorTask = (sponsorTaskId: string) => {
   return axios.post(apiUrls.deleteSponsorTask(sponsorTaskId));
 };
+
+/**
+ * API call to delete a given sponsor tier
+ *
+ * @param sponsorTierId the id of the sponsor tier to delete
+ *
+ * @returns the deleted sponsor tier
+ */
+export const deleteSponsorTier = (sponsorTierId: string) => {
+  return axios.delete(apiUrls.deleteSponsorTier(sponsorTierId));
+};
+
+/**
+ * Edits a sponsor tier in the database
+ * @param sponsorTierId the id of the sponsor tier
+ * @param formData the data expected from the form
+ * @return the updated sponsor tier
+ */
+
+export const editSponsorTier = (sponsorTierId: string, formData: SponsorTierPayload) => {
+  return axios.post(apiUrls.editSponsorTier(sponsorTierId), formData);
+};

src/frontend/src/components/WarningBanner.tsx

@@ -6,7 +6,7 @@ interface WarningBannerProps {
 }
 
 const WarningBanner: React.FC<WarningBannerProps> = ({ amount }) => {
-  const formattedMessage = `Spending is $${amount} over budget!`;
+  const formattedMessage = `Spending is $${Math.round(amount * 100) / 100} over budget!`;
 
   return (
     <Box