Merge pull request #2195 from Northeastern-Electric-Racing/#2060-get-single-dr

#2060 Get single DR endpoint

Author: RChandler234

src/backend/src/controllers/design-review.controllers.ts

@@ -23,4 +23,15 @@ export default class DesignReviewController {
       next(error);
     }
   }
+
+  static async getSingleDesignReview(req: Request, res: Response, next: NextFunction) {
+    try {
+      const drId: string = req.params.designReviewId;
+      const user: User = await getCurrentUser(res);
+      const designReview = await DesignReviewService.getSingleDesignReview(user, drId);
+      return res.status(200).json(designReview);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/routes/design-review.routes.ts

@@ -6,5 +6,6 @@ const designReviewRouter = express.Router();
 designReviewRouter.get('/', DesignReviewController.getAllDesignReviews);
 
 designReviewRouter.delete('/:designReviewId/delete', DesignReviewController.deleteDesignReview);
+designReviewRouter.get('/:designReviewId', DesignReviewController.getSingleDesignReview);
 
 export default designReviewRouter;

src/backend/src/services/design-review.services.ts

@@ -44,4 +44,24 @@ export default class DesignReviewService {
 
     return designReviewTransformer(deletedDesignReview);
   }
+
+  /**
+   * Retrieves a single design review
+   *
+   * @param submitter the user who is trying to retrieve the design review
+   * @param designReviewId the id of the design review to retrieve
+   * @returns the design review
+   */
+  static async getSingleDesignReview(submitter: User, designReviewId: string): Promise<DesignReview> {
+    const designReview = await prisma.design_Review.findUnique({
+      where: { designReviewId },
+      ...designReviewQueryArgs
+    });
+
+    if (!designReview) throw new NotFoundException('Design Review', designReviewId);
+
+    if (designReview.dateDeleted) throw new DeletedException('Design Review', designReviewId);
+
+    return designReviewTransformer(designReview);
+  }
 }

src/backend/tests/design-reviews.test.ts

@@ -1,4 +1,4 @@
-import { designReview1, prismaDesignReview2 } from './test-data/design-reviews.test-data';
+import { prismaDesignReview1, prismaDesignReview2, sharedDesignReview1 } from './test-data/design-reviews.test-data';
 import { batman, wonderwoman } from './test-data/users.test-data';
 import DesignReviewService from '../src/services/design-review.services';
 import prisma from '../src/prisma/prisma';
@@ -25,20 +25,20 @@ describe('Design Reviews', () => {
   describe('Delete Design Review Tests', () => {
     test('Delete Reimbursment Request fails when ID does not exist', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(null);
-      await expect(() => DesignReviewService.deleteDesignReview(batman, designReview1.designReviewId)).rejects.toThrow(
-        new NotFoundException('Design Review', designReview1.designReviewId)
+      await expect(() => DesignReviewService.deleteDesignReview(batman, prismaDesignReview1.designReviewId)).rejects.toThrow(
+        new NotFoundException('Design Review', prismaDesignReview1.designReviewId)
       );
     });
     test('Delete Design Review fails when user is not an admin nor the user who created the design review', async () => {
-      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
-      await expect(() => DesignReviewService.deleteDesignReview(wonderwoman, designReview1.designReviewId)).rejects.toThrow(
-        new AccessDeniedAdminOnlyException('delete design reviews')
-      );
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(prismaDesignReview1);
+      await expect(() =>
+        DesignReviewService.deleteDesignReview(wonderwoman, prismaDesignReview1.designReviewId)
+      ).rejects.toThrow(new AccessDeniedAdminOnlyException('delete design reviews'));
     });
     test('Delete Design Review fails when design review is already deleted', async () => {
-      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue({ ...designReview1, dateDeleted: new Date() });
-      await expect(() => DesignReviewService.deleteDesignReview(batman, designReview1.designReviewId)).rejects.toThrow(
-        new DeletedException('Design Review', designReview1.designReviewId)
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue({ ...prismaDesignReview1, dateDeleted: new Date() });
+      await expect(() => DesignReviewService.deleteDesignReview(batman, prismaDesignReview1.designReviewId)).rejects.toThrow(
+        new DeletedException('Design Review', prismaDesignReview1.designReviewId)
       );
     });
     test('Delete Design Review succeeds when user is admin', async () => {
@@ -67,4 +67,28 @@ describe('Design Reviews', () => {
       expect(prismaDesignReview2.dateDeleted).toBeDefined();
     });
   });
+
+  describe('Get Single Design Review Tests', () => {
+    test('Get Single Design Review fails when ID does not exist', async () => {
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(null);
+      await expect(() =>
+        DesignReviewService.getSingleDesignReview(batman, prismaDesignReview1.designReviewId)
+      ).rejects.toThrow(new NotFoundException('Design Review', prismaDesignReview1.designReviewId));
+    });
+    test('Get Single Design Review fails when design review is already deleted', async () => {
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue({ ...prismaDesignReview1, dateDeleted: new Date() });
+      await expect(() =>
+        DesignReviewService.getSingleDesignReview(batman, prismaDesignReview1.designReviewId)
+      ).rejects.toThrow(new DeletedException('Design Review', prismaDesignReview1.designReviewId));
+    });
+
+    test('Get Single Design Review succeeds', async () => {
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(prismaDesignReview1);
+
+      const result = await DesignReviewService.getSingleDesignReview(wonderwoman, prismaDesignReview1.designReviewId);
+
+      expect(prisma.design_Review.findUnique).toHaveBeenCalledTimes(1);
+      expect(result).toEqual(sharedDesignReview1);
+    });
+  });
 });

src/backend/tests/test-data/design-reviews.test-data.ts

@@ -1,34 +1,39 @@
-import {
-  Design_Review as PrismaDesignReview,
-  Design_Review_Status as PrismaDesignReviewStatus,
-  Prisma,
-  TeamType
-} from '@prisma/client';
-import { batman, wonderwoman } from './users.test-data';
+import { Design_Review_Status as PrismaDesignReviewStatus, Prisma, TeamType } from '@prisma/client';
+import { batman, sharedBatman, wonderwoman } from './users.test-data';
 import designReviewQueryArgs from '../../src/prisma-query-args/design-review.query-args';
 import { prismaWbsElement1 } from './wbs-element.test-data';
+import { DesignReview as SharedDesignReview, DesignReviewStatus as sharedDesignReviewStatus } from 'shared';
 
 export const teamType1: TeamType = {
   teamTypeId: '1',
   name: 'teamType1'
 };
 
-export const designReview1: PrismaDesignReview = {
+export const prismaDesignReview1: Prisma.Design_ReviewGetPayload<typeof designReviewQueryArgs> = {
   designReviewId: '1',
   dateScheduled: new Date('2024-03-25'),
   meetingTimes: [0, 1, 2, 3],
   dateCreated: new Date('2024-03-10'),
   userCreatedId: batman.userId,
+  userCreated: batman,
   status: PrismaDesignReviewStatus.CONFIRMED,
   teamTypeId: '1',
+  teamType: teamType1,
   location: null,
   isOnline: true,
   isInPerson: false,
   zoomLink: null,
   dateDeleted: null,
   userDeletedId: null,
   docTemplateLink: null,
-  wbsElementId: 1
+  wbsElementId: 1,
+  requiredMembers: [batman],
+  optionalMembers: [],
+  confirmedMembers: [batman],
+  deniedMembers: [],
+  attendees: [batman],
+  userDeleted: null,
+  wbsElement: prismaWbsElement1
 };
 
 export const prismaDesignReview2: Prisma.Design_ReviewGetPayload<typeof designReviewQueryArgs> = {
@@ -57,3 +62,22 @@ export const prismaDesignReview2: Prisma.Design_ReviewGetPayload<typeof designRe
   wbsElement: prismaWbsElement1,
   teamType: teamType1
 };
+
+export const sharedDesignReview1: SharedDesignReview = {
+  designReviewId: '1',
+  dateScheduled: new Date('2024-03-25'),
+  meetingTimes: [0, 1, 2, 3],
+  dateCreated: new Date('2024-03-10'),
+  userCreated: sharedBatman,
+  status: sharedDesignReviewStatus.CONFIRMED,
+  isOnline: true,
+  isInPerson: false,
+  requiredMembers: [sharedBatman],
+  optionalMembers: [],
+  confirmedMembers: [sharedBatman],
+  deniedMembers: [],
+  attendees: [sharedBatman],
+  teamType: teamType1,
+  wbsName: 'car',
+  wbsNum: { carNumber: 1, projectNumber: 2, workPackageNumber: 0 }
+};