Merge pull request #2840 from Northeastern-Electric-Racing/getorganiz…

…ation-endpoint

Created get organization endpoint and hook

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

@@ -2,6 +2,15 @@ import { NextFunction, Request, Response } from 'express';
 import OrganizationsService from '../services/organizations.services';
 
 export default class OrganizationsController {
+  static async getCurrentOrganization(req: Request, res: Response, next: NextFunction) {
+    try {
+      const organization = await OrganizationsService.getCurrentOrganization(req.organization.organizationId);
+      return res.status(200).json(organization);
+    } catch (error: unknown) {
+      return next(error);
+    }
+  }
+
   static async setUsefulLinks(req: Request, res: Response, next: NextFunction) {
     try {
       const { links } = req.body;

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

@@ -6,6 +6,7 @@ import multer, { memoryStorage } from 'multer';
 const organizationRouter = express.Router();
 const upload = multer({ limits: { fileSize: 30000000 }, storage: memoryStorage() });
 
+organizationRouter.get('/current', OrganizationsController.getCurrentOrganization);
 organizationRouter.post('/useful-links/set', ...linkValidators, validateInputs, OrganizationsController.setUsefulLinks);
 organizationRouter.get('/useful-links', OrganizationsController.getAllUsefulLinks);
 organizationRouter.post(

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

@@ -1,14 +1,34 @@
 import { Organization, User } from '@prisma/client';
 import { LinkCreateArgs, isAdmin } from 'shared';
 import prisma from '../prisma/prisma';
-import { AccessDeniedAdminOnlyException, NotFoundException } from '../utils/errors.utils';
+import { AccessDeniedAdminOnlyException, DeletedException, NotFoundException } from '../utils/errors.utils';
 import { userHasPermission } from '../utils/users.utils';
 import { createUsefulLinks } from '../utils/organizations.utils';
 import { linkTransformer } from '../transformers/links.transformer';
 import { getLinkQueryArgs } from '../prisma-query-args/links.query-args';
 import { uploadFile } from '../utils/google-integration.utils';
 
 export default class OrganizationsService {
+  /**
+   * Gets the current organization
+   * @param organizationId the organizationId to be fetched
+   */
+  static async getCurrentOrganization(organizationId: string) {
+    const organization = await prisma.organization.findUnique({
+      where: { organizationId }
+    });
+
+    if (!organization) {
+      throw new NotFoundException('Organization', organizationId);
+    }
+
+    if (organization.dateDeleted) {
+      throw new DeletedException('Organization', organizationId);
+    }
+
+    return organization;
+  }
+
   /**
    * sets an organizations useful links
    * @param submitter the user who is setting the links

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

@@ -13,7 +13,7 @@ vi.mock('../../src/utils/google-integration.utils', () => ({
   uploadFile: vi.fn()
 }));
 
-describe('Team Type Tests', () => {
+describe('Organization Tests', () => {
   let orgId: string;
   let organization: Organization;
 
@@ -26,6 +26,22 @@ describe('Team Type Tests', () => {
     await resetUsers();
   });
 
+  describe('Get Current Organization', () => {
+    it('Fails if organization does not exist', async () => {
+      await expect(async () => await OrganizationsService.getCurrentOrganization('1')).rejects.toThrow(
+        new NotFoundException('Organization', '1')
+      );
+    });
+
+    it('Succeeds and gets the organization', async () => {
+      const org = await OrganizationsService.getCurrentOrganization(orgId);
+
+      expect(org).not.toBeNull();
+      expect(org.organizationId).toBe(orgId);
+      expect(org.name).toBe(organization.name);
+    });
+  });
+
   describe('Set Images', () => {
     const file1 = { originalname: 'image1.png' } as Express.Multer.File;
     const file2 = { originalname: 'image2.png' } as Express.Multer.File;

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

@@ -0,0 +1,13 @@
+import axios from '../utils/axios';
+import { Organization } from 'shared';
+import { apiUrls } from '../utils/urls';
+
+/**
+ * Create a design review
+ * @param payload all info needed to create a design review
+ */
+export const getCurrentOrganization = async () => {
+  return axios.get<Organization>(apiUrls.currentOrganization(), {
+    transformResponse: (data) => JSON.parse(data)
+  });
+};

src/frontend/src/app/AppOrganizationContext.tsx

@@ -1,5 +1,5 @@
 import { createContext } from 'react';
-import { useProvideOrganization } from '../hooks/organization.hooks';
+import { useProvideOrganization } from '../hooks/organizations.hooks';
 
 export interface Organization {
   organizationId: string;

src/frontend/src/app/AppPublic.tsx

@@ -10,7 +10,7 @@ import Login from '../pages/LoginPage/Login';
 import AppAuthenticated from './AppAuthenticated';
 import { useProvideThemeToggle } from '../hooks/theme.hooks';
 import LoadingIndicator from '../components/LoadingIndicator';
-import { useOrganization } from '../hooks/organization.hooks';
+import { useOrganization } from '../hooks/organizations.hooks';
 import Organizations from '../pages/OrganizationPage/Organizations';
 
 const AppPublic: React.FC = () => {

src/frontend/src/hooks/organization.hooks.ts → src/frontend/src/hooks/organizations.hooks.ts

@@ -1,5 +1,8 @@
 import { useContext, useState } from 'react';
 import { OrganizationContext } from '../app/AppOrganizationContext';
+import { useQuery } from 'react-query';
+import { Organization } from 'shared';
+import { getCurrentOrganization } from '../apis/organizations.api';
 
 interface OrganizationProvider {
   organizationId: string;
@@ -20,6 +23,13 @@ export const useProvideOrganization = (): OrganizationProvider => {
   };
 };
 
+export const useCurrentOrganization = () => {
+  return useQuery<Organization, Error>(['organizations'], async () => {
+    const { data } = await getCurrentOrganization();
+    return data;
+  });
+};
+
 // Hook for child components to get the auth object
 export const useOrganization = () => {
   const context = useContext(OrganizationContext);

src/frontend/src/pages/LoginPage/Login.tsx

@@ -12,7 +12,7 @@ import LoginPage from './LoginPage';
 import LoadingIndicator from '../../components/LoadingIndicator';
 import { useQuery } from '../../hooks/utils.hooks';
 import { GoogleLoginResponse, GoogleLoginResponseOffline } from 'react-google-login';
-import { useOrganization } from '../../hooks/organization.hooks';
+import { useOrganization } from '../../hooks/organizations.hooks';
 
 /**
  * Page for unauthenticated users to do login.

src/frontend/src/utils/urls.ts

@@ -170,6 +170,7 @@ const workPackageTemplateDelete = (workPackageTemplateId: string) =>
 
 /******************* Organizations Endpoints ********************/
 const organizations = () => `${API_URL}/organizations`;
+const currentOrganization = () => `${organizations()}/current`;
 const organizationsUsefulLinks = () => `${organizations()}/useful-links`;
 const organizationsSetUsefulLinks = () => `${organizationsUsefulLinks()}/set`;
 
@@ -324,6 +325,7 @@ export const apiUrls = {
   workPackageTemplatesCreate,
   workPackageTemplateDelete,
 
+  currentOrganization,
   organizationsUsefulLinks,
   organizationsSetUsefulLinks,