Merge pull request #2114 from Northeastern-Electric-Racing/#2011-delete-design-review-endpoint

#2011 delete design review endpoint

Author: walker-sean

src/backend/index.ts

@@ -11,6 +11,7 @@ import changeRequestsRouter from './src/routes/change-requests.routes';
 import descriptionBulletsRouter from './src/routes/description-bullets.routes';
 import tasksRouter from './src/routes/tasks.routes';
 import reimbursementRequestsRouter from './src/routes/reimbursement-requests.routes';
+import designReviewRouter from './src/routes/design-review.routes';
 
 const app = express();
 const port = process.env.PORT || 3001;
@@ -52,6 +53,7 @@ app.use('/change-requests', changeRequestsRouter);
 app.use('/description-bullets', descriptionBulletsRouter);
 app.use('/tasks', tasksRouter);
 app.use('/reimbursement-requests', reimbursementRequestsRouter);
+app.use('/design-reviews', designReviewRouter);
 app.use('/', (_req, res) => {
   res.json('Welcome to FinishLine');
 });

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

@@ -1 +1,17 @@
-export default class DesignReviewController {}
+import { User } from '@prisma/client';
+import { Request, Response, NextFunction } from 'express';
+import { getCurrentUser } from '../utils/auth.utils';
+import DesignReviewService from '../services/design-review.services';
+
+export default class DesignReviewController {
+  static async deleteDesignReview(req: Request, res: Response, next: NextFunction) {
+    try {
+      const drId: string = req.params.designReviewId;
+      const user: User = await getCurrentUser(res);
+      const deletedDesignReview = await DesignReviewService.deleteDesignReview(user, drId);
+      return res.status(200).json(deletedDesignReview);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+}

src/backend/src/prisma-query-args/design-review.query-args.ts

@@ -0,0 +1,17 @@
+import { Prisma } from '@prisma/client';
+
+const designReviewQueryArgs = Prisma.validator<Prisma.Design_ReviewArgs>()({
+  include: {
+    userCreated: true,
+    teamType: true,
+    requiredMembers: true,
+    optionalMembers: true,
+    confirmedMembers: true,
+    deniedMembers: true,
+    attendees: true,
+    userDeleted: true,
+    wbsElement: true
+  }
+});
+
+export default designReviewQueryArgs;

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

@@ -1,5 +1,8 @@
 import express from 'express';
+import DesignReviewController from '../controllers/design-review.controllers';
 
 const designReviewRouter = express.Router();
 
+designReviewRouter.delete('/:designReviewId/delete', DesignReviewController.deleteDesignReview);
+
 export default designReviewRouter;

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

@@ -1 +1,35 @@
-export default class DesignReviewService {}
+import { DesignReview, isAdmin } from 'shared';
+import prisma from '../prisma/prisma';
+import { AccessDeniedAdminOnlyException, DeletedException, NotFoundException } from '../utils/errors.utils';
+import { User } from '@prisma/client';
+import designReviewQueryArgs from '../prisma-query-args/design-review.query-args';
+import { designReviewTransformer } from '../transformers/design-review.transformer';
+
+export default class DesignReviewService {
+  /**
+   * Deletes a design review
+   * @param submitter the user who deleted the design review
+   * @param designReviewId the id of the design review to be deleted
+   */
+
+  static async deleteDesignReview(submitter: User, designReviewId: string): Promise<DesignReview> {
+    const designReview = await prisma.design_Review.findUnique({
+      where: { designReviewId }
+    });
+
+    if (!designReview) throw new NotFoundException('Design Review', designReviewId);
+
+    if (!(isAdmin(submitter.role) || submitter.userId === designReview.userCreatedId))
+      throw new AccessDeniedAdminOnlyException('delete design reviews');
+
+    if (designReview.dateDeleted) throw new DeletedException('Design Review', designReviewId);
+
+    const deletedDesignReview = await prisma.design_Review.update({
+      where: { designReviewId },
+      data: { dateDeleted: new Date(), userDeleted: { connect: { userId: submitter.userId } } },
+      ...designReviewQueryArgs
+    });
+
+    return designReviewTransformer(deletedDesignReview);
+  }
+}

src/backend/src/transformers/design-review.transformer.ts

@@ -0,0 +1,33 @@
+import { Prisma } from '@prisma/client';
+import { DesignReview, DesignReviewStatus } from 'shared';
+import userTransformer from './user.transformer';
+import designReviewQueryArgs from '../prisma-query-args/design-review.query-args';
+import { wbsNumOf } from '../utils/utils';
+
+export const designReviewTransformer = (
+  designReview: Prisma.Design_ReviewGetPayload<typeof designReviewQueryArgs>
+): DesignReview => {
+  return {
+    designReviewId: designReview.designReviewId,
+    dateScheduled: designReview.dateScheduled,
+    meetingTimes: designReview.meetingTimes,
+    dateCreated: designReview.dateCreated,
+    userCreated: userTransformer(designReview.userCreated),
+    requiredMembers: designReview.requiredMembers.map(userTransformer),
+    optionalMembers: designReview.optionalMembers.map(userTransformer),
+    confirmedMembers: designReview.confirmedMembers.map(userTransformer),
+    deniedMembers: designReview.deniedMembers.map(userTransformer),
+    location: designReview.location ?? undefined,
+    isOnline: designReview.isOnline,
+    isInPerson: designReview.isInPerson,
+    zoomLink: designReview.zoomLink ?? undefined,
+    attendees: designReview.attendees.map(userTransformer),
+    dateDeleted: designReview.dateDeleted ?? undefined,
+    userDeleted: designReview.userDeleted ? userTransformer(designReview.userDeleted) : undefined,
+    docTemplateLink: designReview.docTemplateLink ?? undefined,
+    status: designReview.status as DesignReviewStatus,
+    teamType: designReview.teamType,
+    wbsName: designReview.wbsElement.name,
+    wbsNum: wbsNumOf(designReview.wbsElement)
+  };
+};

src/backend/src/utils/errors.utils.ts

@@ -120,4 +120,5 @@ type ExceptionObjectNames =
   | 'Manufacturer'
   | 'Unit'
   | 'Material'
-  | 'Link Type';
+  | 'Link Type'
+  | 'Design Review';

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

@@ -0,0 +1,59 @@
+import { designReview1, prismaDesignReview2 } 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';
+import { AccessDeniedAdminOnlyException, DeletedException, NotFoundException } from '../src/utils/errors.utils';
+
+describe('Design Reviews', () => {
+  beforeEach(() => {});
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  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)
+      );
+    });
+    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')
+      );
+    });
+    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)
+      );
+    });
+    test('Delete Design Review succeeds when user is admin', async () => {
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(prismaDesignReview2);
+      vi.spyOn(prisma.design_Review, 'update').mockResolvedValue(prismaDesignReview2);
+
+      expect(prismaDesignReview2.dateDeleted).toBeNull();
+
+      await DesignReviewService.deleteDesignReview(batman, prismaDesignReview2.designReviewId);
+
+      expect(prisma.design_Review.findUnique).toHaveBeenCalledTimes(1);
+      expect(prisma.design_Review.update).toHaveBeenCalledTimes(1);
+      expect(prismaDesignReview2.dateDeleted).toBeDefined();
+    });
+
+    test('Delete Design Review succeeds when user is the creator of the design review', async () => {
+      vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(prismaDesignReview2);
+      vi.spyOn(prisma.design_Review, 'update').mockResolvedValue(prismaDesignReview2);
+
+      expect(prismaDesignReview2.dateDeleted).toBeNull();
+
+      await DesignReviewService.deleteDesignReview(wonderwoman, prismaDesignReview2.designReviewId);
+
+      expect(prisma.design_Review.findUnique).toHaveBeenCalledTimes(1);
+      expect(prisma.design_Review.update).toHaveBeenCalledTimes(1);
+      expect(prismaDesignReview2.dateDeleted).toBeDefined();
+    });
+  });
+});

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

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

src/shared/index.ts

@@ -10,6 +10,7 @@ export * from './src/types/work-package-types';
 export * from './src/types/team-types';
 export * from './src/types/task-types';
 export * from './src/types/reimbursement-requests-types';
+export * from './src/types/design-review-types';
 
 export * from './src/validate-wbs';
 export * from './src/date-utils';