#3873 renamed platform logo and implemented get/set platform endpoints + hooks + frontend impl

Author: staysgt

src/backend/src/controllers/organizations.controllers.ts

@@ -111,6 +111,29 @@ export default class OrganizationsController {
     }
   }
 
+  static async setPlatformLogoImage(req: Request, res: Response, next: NextFunction) {
+    try {
+      if (!req.file) {
+        throw new HttpException(400, 'Invalid or undefined image data');
+      }
+
+      const updatedOrg = await OrganizationsService.setPlatformLogoImage(req.file, req.currentUser, req.organization);
+
+      res.status(200).json(updatedOrg);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
+  static async getPlatformLogoImage(req: Request, res: Response, next: NextFunction) {
+    try {
+      const platformLogoImageId = await OrganizationsService.getPlatformLogoImage(req.organization.organizationId);
+      res.status(200).json(platformLogoImageId);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async setNewMemberImage(req: Request, res: Response, next: NextFunction) {
     try {
       if (!req.file) {

…0215155228_guest_home_page/migration.sql …0221213604_guest_home_page/migration.sqlsrc/backend/src/prisma/migrations/20260215155228_guest_home_page/migration.sql renamed to src/backend/src/prisma/migrations/20260221213604_guest_home_page/migration.sql src/backend/src/prisma/migrations/20260215155228_guest_home_page/migration.sql renamed to src/backend/src/prisma/migrations/20260221213604_guest_home_page/migration.sql

@@ -8,5 +8,5 @@
 -- AlterTable
 ALTER TABLE "Organization" DROP COLUMN "applyInterestImageId",
 DROP COLUMN "exploreAsGuestImageId",
-ADD COLUMN     "finishlineDescription" TEXT NOT NULL DEFAULT '',
-ADD COLUMN     "finishlineLogo" TEXT;
+ADD COLUMN     "platformDescription" TEXT NOT NULL DEFAULT '',
+ADD COLUMN     "platformLogoImageId" TEXT;

src/backend/src/prisma/schema.prisma

@@ -1320,8 +1320,8 @@ model Organization {
   partReviewSampleImageId                String?
   partReviewGuideLink                    String?
   sponsorshipNotificationsSlackChannelId String?
-  finishlineDescription                  String    @default("")
-  finishlineLogo                         String?
+  platformDescription                    String    @default("")
+  platformLogoImageId                    String?
 
   // Relation references
   wbsElements              WBS_Element[]

src/backend/src/prisma/seed.ts

@@ -127,9 +127,9 @@ const performSeed: () => Promise<void> = async () => {
         'Northeastern Electric Racing is a student-run organization at Northeastern University building all-electric formula-style race cars from scratch to compete in Forumla Hybrid + Electric Formula SAE (FSAE).',
       applicationLink:
         'https://docs.google.com/forms/d/e/1FAIpQLSeCvG7GqmZm_gmSZiahbVTW9ZFpEWG0YfGQbkSB_whhHzxXpA/closedform',
-      finishlineDescription:
+      platformDescription:
         'Finishline is a Project Management Dashboard developed by the Software Team at Northeastern Electric Racing.',
-      finishlineLogo: '1auQO3GYydZOo1-vCn0D2iyCfaxaVFssx'
+      platformLogoImageId: '1auQO3GYydZOo1-vCn0D2iyCfaxaVFssx'
     }
   });
 

src/backend/src/routes/organizations.routes.ts

@@ -43,6 +43,14 @@ organizationRouter.post(
 );
 organizationRouter.post('/logo/update', upload.single('logo'), OrganizationsController.setLogoImage);
 organizationRouter.get('/logo', OrganizationsController.getOrganizationLogoImage);
+
+organizationRouter.post(
+  '/platform-logo/update',
+  upload.single('platformLogo'),
+  OrganizationsController.setPlatformLogoImage
+);
+organizationRouter.get('/platform-logo', OrganizationsController.getPlatformLogoImage);
+
 organizationRouter.post(
   '/new-member-image/update',
   upload.single('newMemberImage'),

src/backend/src/services/organizations.services.ts

@@ -545,4 +545,50 @@ export default class OrganizationsService {
 
     return updatedOrg.financeDelegates.map(userTransformer);
   }
+
+  /**
+   * sets an organizations platform image
+   * @param submitter the user who is setting the images
+   * @param organizationId the organization which the images will be set up
+   * @param images the images which are being set
+   */
+  static async setPlatformLogoImage(
+    platformLogoImageId: Express.Multer.File | null,
+    submitter: User,
+    organization: Organization
+  ) {
+    if (!(await userHasPermission(submitter.userId, organization.organizationId, isAdmin))) {
+      throw new AccessDeniedAdminOnlyException('update platform logo');
+    }
+
+    const platformLogoImageData = platformLogoImageId ? await uploadFile(platformLogoImageId) : null;
+
+    const updateData = {
+      ...(platformLogoImageData && { platformLogoImageId: platformLogoImageData.id })
+    };
+
+    const newImages = await prisma.organization.update({
+      where: { organizationId: organization.organizationId },
+      data: updateData
+    });
+
+    return newImages;
+  }
+
+  /**
+   * Gets platform logo image for the given organization
+   * @param organizationId organization Id of the milestone
+   * @returns all the milestones from the given organization
+   */
+  static async getPlatformLogoImage(organizationId: string) {
+    const organization = await prisma.organization.findUnique({
+      where: { organizationId }
+    });
+
+    if (!organization) {
+      throw new NotFoundException('Organization', organizationId);
+    }
+
+    return organization.platformLogoImageId;
+  }
 }

src/backend/src/transformers/organizationTransformer.ts

@@ -5,6 +5,7 @@ export const organizationTransformer = (organization: Organization): Organizatio
   return {
     ...organization,
     applicationLink: organization.applicationLink ?? undefined,
-    newMemberImageId: organization.newMemberImageId ?? undefined
+    newMemberImageId: organization.newMemberImageId ?? undefined,
+    platformLogoImageId: organization.platformLogoImageId ?? undefined
   };
 };

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

@@ -295,4 +295,64 @@ describe('Organization Tests', () => {
       expect(updatedOrganization.partReviewGuideLink).toBe('newlink');
     });
   });
+
+  describe('Set Organization Platform Logo', () => {
+    const file1 = { originalname: 'image1.png' } as Express.Multer.File;
+    const file2 = { originalname: 'image2.png' } as Express.Multer.File;
+    const file3 = { originalname: 'image3.png' } as Express.Multer.File;
+    it('Fails if user is not an admin', async () => {
+      await expect(
+        OrganizationsService.setPlatformLogoImage(file1, await createTestUser(wonderwomanGuest, orgId), organization)
+      ).rejects.toThrow(new AccessDeniedAdminOnlyException('update platform logo'));
+    });
+
+    it('Succeeds and updates all the images', async () => {
+      const testBatman = await createTestUser(batmanAppAdmin, orgId);
+      (uploadFile as Mock).mockImplementation((file) => {
+        return Promise.resolve({ name: `${file.originalname}`, id: `uploaded-${file.originalname}` });
+      });
+
+      await OrganizationsService.setPlatformLogoImage(file2, testBatman, organization);
+
+      const oldOrganization = await prisma.organization.findUnique({
+        where: {
+          organizationId: orgId
+        }
+      });
+
+      expect(oldOrganization).not.toBeNull();
+      expect(oldOrganization?.platformLogoImageId).toBe('uploaded-image2.png');
+
+      await OrganizationsService.setPlatformLogoImage(file3, testBatman, organization);
+
+      const updatedOrganization = await prisma.organization.findUnique({
+        where: {
+          organizationId: orgId
+        }
+      });
+
+      expect(updatedOrganization?.platformLogoImageId).toBe('uploaded-image3.png');
+    });
+  });
+
+  describe('Get Organization Platform Logo', () => {
+    it('Fails if an organization does not exist', async () => {
+      await expect(async () => await OrganizationsService.getPlatformLogoImage('1')).rejects.toThrow(
+        new NotFoundException('Organization', '1')
+      );
+    });
+
+    it('Succeeds and gets the image', async () => {
+      const testBatman = await createTestUser(batmanAppAdmin, orgId);
+      await OrganizationsService.setPlatformLogoImage(
+        { originalname: 'image1.png' } as Express.Multer.File,
+        testBatman,
+        organization
+      );
+      const image = await OrganizationsService.getPlatformLogoImage(orgId);
+
+      expect(image).not.toBeNull();
+      expect(image).toBe('uploaded-image1.png');
+    });
+  });
 });

src/frontend/src/apis/organizations.api.ts

@@ -66,6 +66,18 @@ export const getOrganizationNewMemberImage = async () => {
   });
 };
 
+export const setOrganizationPlatformLogoImage = async (file: File) => {
+  const formData = new FormData();
+  formData.append('platformLogo', file);
+  return axios.post<Organization>(apiUrls.organizationsSetPlatformLogoImage(), formData);
+};
+
+export const getOrganizationPlatformLogoImage = async () => {
+  return axios.get<string>(apiUrls.organizationsPlatformLogoImage(), {
+    transformResponse: (data) => JSON.parse(data)
+  });
+};
+
 export const setOrganizationFeaturedProjects = async (featuredProjectIds: string[]) => {
   return axios.post<Organization>(apiUrls.organizationsSetFeaturedProjects(), {
     projectIds: featuredProjectIds

src/frontend/src/hooks/organizations.hooks.ts

@@ -19,7 +19,9 @@ import {
   getFinanceDelegates,
   setFinanceDelegates,
   setOrganizationNewMemberImage,
-  getOrganizationNewMemberImage
+  getOrganizationNewMemberImage,
+  setOrganizationPlatformLogoImage,
+  getOrganizationPlatformLogoImage
 } from '../apis/organizations.api';
 import { downloadGoogleImage } from '../apis/organizations.api';
 
@@ -218,6 +220,25 @@ export const useSetOrganizationNewMemberImage = () => {
   });
 };
 
+export const useSetOrganizationPlatformLogoImage = () => {
+  const queryClient = useQueryClient();
+  return useMutation<Organization, Error, File>(['organizations', 'platform-logo'], async (file: File) => {
+    const { data } = await setOrganizationPlatformLogoImage(file);
+    queryClient.invalidateQueries(['organizations']);
+    return data;
+  });
+};
+
+export const useOrganizationPlatformLogoImage = () => {
+  return useQuery<Blob | undefined, Error>(['organizations', 'platform-logo'], async () => {
+    const { data: fileId } = await getOrganizationPlatformLogoImage();
+    if (!fileId) {
+      return;
+    }
+    return await downloadGoogleImage(fileId);
+  });
+};
+
 /*
  * Custom React Hook to fetch confluence guide for current
  * organization in backend