Merge pull request #2201 from Northeastern-Electric-Racing/#2063-use-all-design-reviews-hook

#2063 use all design reviews hook

Author: walker-sean

src/frontend/src/apis/design-reviews.api.ts

@@ -0,0 +1,16 @@
+/*
+ * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
+ * See the LICENSE file in the repository root folder for details.
+ */
+import axios from '../utils/axios';
+import { apiUrls } from '../utils/urls';
+import { designReviewTransformer } from './transformers/design-reviews.tranformers';
+
+/**
+ * Gets all the design reviews
+ */
+export const getAllDesignReviews = () => {
+  return axios.get(apiUrls.designReviews(), {
+    transformResponse: (data) => JSON.parse(data).map(designReviewTransformer)
+  });
+};

src/frontend/src/apis/transformers/design-reviews.tranformers.ts

@@ -0,0 +1,9 @@
+import { DesignReview } from 'shared';
+
+export const designReviewTransformer = (designReview: DesignReview) => {
+  return {
+    ...designReview,
+    dateCreated: new Date(designReview.dateCreated),
+    dateDeleted: designReview.dateDeleted ? new Date(designReview.dateDeleted) : undefined
+  };
+};

src/frontend/src/hooks/design-reviews.hooks.ts

@@ -0,0 +1,19 @@
+/*
+ * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
+ * See the LICENSE file in the repository root folder for details.
+ */
+import { useQuery } from 'react-query';
+import { getAllDesignReviews } from '../apis/design-reviews.api';
+import { DesignReview } from 'shared';
+
+/**
+ * Custom react hook to get all design reviews
+ *
+ * @returns all the design reviews
+ */
+export const useAllDesignReviews = () => {
+  return useQuery<DesignReview[], Error>(['design-reviews'], async () => {
+    const { data } = await getAllDesignReviews();
+    return data;
+  });
+};

src/frontend/src/tests/hooks/DesignReviews.hooks.test.tsx

@@ -0,0 +1,26 @@
+/*
+ * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
+ * See the LICENSE file in the repository root folder for details.
+ */
+
+import { renderHook } from '@testing-library/react-hooks';
+import { AxiosResponse } from 'axios';
+import { DesignReview } from 'shared';
+import wrapper from '../../app/AppContextQuery';
+import { mockPromiseAxiosResponse } from '../test-support/test-data/test-utils.stub';
+import { exampleAllDesignReviews } from '../test-support/test-data/design-reviews.stub';
+import { getAllDesignReviews } from '../../apis/design-reviews.api';
+import { useAllDesignReviews } from '../../hooks/design-reviews.hooks';
+
+vi.mock('../../apis/design-reviews.api');
+
+describe('design review hooks', () => {
+  it('handles getting a list of design reviews', async () => {
+    const mockedGetAllDesignReviews = getAllDesignReviews as jest.Mock<Promise<AxiosResponse<DesignReview[]>>>;
+    mockedGetAllDesignReviews.mockReturnValue(mockPromiseAxiosResponse<DesignReview[]>(exampleAllDesignReviews));
+
+    const { result, waitFor } = renderHook(() => useAllDesignReviews(), { wrapper });
+    await waitFor(() => result.current.isSuccess);
+    expect(result.current.data).toEqual(exampleAllDesignReviews);
+  });
+});

src/frontend/src/tests/test-support/test-data/design-reviews.stub.ts

@@ -0,0 +1,54 @@
+/*
+ * This file is part of NER's FinishLine and licensed under GNU AGPLv3.
+ * See the LICENSE file in the repository root folder for details.
+ */
+
+import { DesignReview, DesignReviewStatus, TeamType } from 'shared';
+import { exampleAdminUser, exampleAppAdminUser } from './users.stub';
+import { exampleWbsProject1 } from './wbs-numbers.stub';
+
+export const teamType1: TeamType = {
+  teamTypeId: '1',
+  iconName: 'YouTubeIcon',
+  name: 'teamType1'
+};
+
+export const exampleDesignReview1: DesignReview = {
+  designReviewId: '1',
+  dateScheduled: new Date('2024-03-25'),
+  meetingTimes: [0, 1, 2, 3],
+  dateCreated: new Date('2024-03-10'),
+  userCreated: exampleAdminUser,
+  status: DesignReviewStatus.CONFIRMED,
+  teamType: teamType1,
+  requiredMembers: [exampleAdminUser],
+  optionalMembers: [],
+  confirmedMembers: [exampleAdminUser],
+  deniedMembers: [],
+  isOnline: true,
+  isInPerson: false,
+  attendees: [exampleAdminUser],
+  wbsName: '1',
+  wbsNum: exampleWbsProject1
+};
+
+export const exampleDesignReview2: DesignReview = {
+  designReviewId: '2',
+  dateScheduled: new Date('2024-03-25'),
+  meetingTimes: [0, 4],
+  dateCreated: new Date('2024-03-10'),
+  userCreated: exampleAppAdminUser,
+  status: DesignReviewStatus.CONFIRMED,
+  teamType: teamType1,
+  requiredMembers: [exampleAppAdminUser],
+  optionalMembers: [],
+  confirmedMembers: [exampleAppAdminUser],
+  deniedMembers: [],
+  isOnline: false,
+  isInPerson: true,
+  attendees: [exampleAppAdminUser],
+  wbsName: '1',
+  wbsNum: exampleWbsProject1
+};
+
+export const exampleAllDesignReviews: DesignReview[] = [exampleDesignReview1, exampleDesignReview2];

src/frontend/src/utils/urls.ts

@@ -129,6 +129,9 @@ const bomCreateManufacturer = () => `${bomEndpoints()}/manufacturer/create`;
 const bomCreateMaterialType = () => `${bomEndpoints()}/material-type/create`;
 const bomCreateUnit = () => `${bomEndpoints()}/units/create`;
 
+/**************** Design Reviews Endpoints ****************/
+const designReviews = () => `${API_URL}/design-reviews`;
+
 /**************** Other Endpoints ****************/
 const version = () => `https://api.github.com/repos/Northeastern-Electric-Racing/FinishLine/releases/latest`;
 
@@ -181,6 +184,8 @@ export const apiUrls = {
   changeRequestCreateProposeSolution,
   changeRequestRequestReviewer,
 
+  designReviews,
+
   teams,
   teamsById,
   teamsDelete,