#1986 - service method returns shared type

Author: RChandler234

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

@@ -95,7 +95,7 @@ export default class DesignReviewsController {
       // get the user from the submitter
       const user = await getCurrentUser(res);
 
-      await DesignReviewsService.editDesignReviews(
+      await DesignReviewsService.editDesignReview(
         user,
         designReviewId,
         dateScheduled,

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

@@ -1,4 +1,4 @@
-import { Design_Review, Design_Review_Status, User } from '@prisma/client';
+import { Design_Review_Status, User } from '@prisma/client';
 import { DesignReview, WbsNumber, isAdmin, isLeadership, isNotLeadership } from 'shared';
 import prisma from '../prisma/prisma';
 import {
@@ -228,7 +228,7 @@ export default class DesignReviewsService {
    * @param meetingTimes meeting time must be between 0-83 (Monday 12am - Sunday 12am, 1hr minute increments)
    */
 
-  static async editDesignReviews(
+  static async editDesignReview(
     user: User,
     designReviewId: string,
     dateScheduled: Date,
@@ -243,7 +243,7 @@ export default class DesignReviewsService {
     status: Design_Review_Status,
     attendees: number[],
     meetingTimes: number[]
-  ): Promise<Design_Review> {
+  ): Promise<DesignReview> {
     // verify user is allowed to edit work package
     if (isNotLeadership(user.role)) throw new AccessDeniedMemberException('edit design reviews');
 
@@ -289,8 +289,9 @@ export default class DesignReviewsService {
     const updatedAttendees = getPrismaQueryUserIds(await getUsers(attendees));
 
     // actually try to update the design review
-    const updateDesignReviews = await prisma.design_Review.update({
+    const updateDesignReview = await prisma.design_Review.update({
       where: { designReviewId },
+      ...designReviewQueryArgs,
       data: {
         designReviewId,
         dateScheduled,
@@ -313,6 +314,6 @@ export default class DesignReviewsService {
         }
       }
     });
-    return updateDesignReviews;
+    return designReviewTransformer(updateDesignReview);
   }
 }

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

@@ -1,5 +1,6 @@
 import {
   designReview1,
+  designReview3,
   prismaDesignReview1,
   prismaDesignReview2,
   prismaDesignReview3,
@@ -29,7 +30,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when user is not lead or above', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           wonderwoman,
           designReview1.designReviewId,
           designReview1.dateScheduled,
@@ -51,7 +52,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when ID does not exist', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(null);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           designReview1.designReviewId,
           designReview1.dateScheduled,
@@ -73,7 +74,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when design review is already deleted', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue({ ...designReview1, dateDeleted: new Date() });
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           designReview1.designReviewId,
           designReview1.dateScheduled,
@@ -96,7 +97,7 @@ describe('Design Reviews', () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       vi.spyOn(prisma.teamType, 'findUnique').mockResolvedValue(null);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           designReview1.designReviewId,
           designReview1.dateScheduled,
@@ -118,7 +119,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when any requiredMembers are in optionalMembers', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -142,7 +143,7 @@ describe('Design Reviews', () => {
       vi.spyOn(prisma.teamType, 'findUnique').mockResolvedValue(teamType1);
 
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -166,7 +167,7 @@ describe('Design Reviews', () => {
       vi.spyOn(prisma.teamType, 'findUnique').mockResolvedValue(teamType1);
 
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           designReview1.designReviewId,
           designReview1.dateScheduled,
@@ -188,7 +189,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when the meeting is online and there is no zoomLink / no text', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -210,7 +211,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when the meeting in person and there is no location', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -232,7 +233,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when meeting times are not consecutive', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -254,7 +255,7 @@ describe('Design Reviews', () => {
     test('Edit Design Review fails when meeting times are consecutive and *above* 83', async () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -277,7 +278,7 @@ describe('Design Reviews', () => {
       vi.spyOn(prisma.design_Review, 'findUnique').mockResolvedValue(designReview1);
       vi.spyOn(prisma.teamType, 'findUnique').mockResolvedValue(teamType1);
       await expect(() =>
-        DesignReviewsService.editDesignReviews(
+        DesignReviewsService.editDesignReview(
           batman,
           prismaDesignReview2.designReviewId,
           prismaDesignReview2.dateScheduled,
@@ -300,7 +301,7 @@ describe('Design Reviews', () => {
       vi.spyOn(prisma.design_Review, 'update').mockResolvedValue(prismaDesignReview3);
       vi.spyOn(prisma.teamType, 'findUnique').mockResolvedValue(teamType1);
 
-      const res = await DesignReviewsService.editDesignReviews(
+      const res = await DesignReviewsService.editDesignReview(
         aquaman,
         prismaDesignReview3.designReviewId,
         prismaDesignReview3.dateScheduled,
@@ -319,7 +320,7 @@ describe('Design Reviews', () => {
 
       expect(prisma.design_Review.findUnique).toHaveBeenCalledTimes(1);
       // THIS TEST IS KINDA BS, but everything else I try fails.
-      expect(res).toStrictEqual(prismaDesignReview3);
+      expect(res).toStrictEqual(designReview3);
     });
   });
   describe('getAllDesignReviews', () => {

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

@@ -6,7 +6,12 @@ import {
 } from '@prisma/client';
 import { batman, sharedBatman, wonderwoman } from './users.test-data';
 import { prismaWbsElement1 } from './wbs-element.test-data';
-import { DesignReview as SharedDesignReview, DesignReviewStatus as sharedDesignReviewStatus } from 'shared';
+import {
+  DesignReview,
+  DesignReviewStatus,
+  DesignReview as SharedDesignReview,
+  DesignReviewStatus as sharedDesignReviewStatus
+} from 'shared';
 import designReviewQueryArgs from '../../src/prisma-query-args/design-reviews.query-args';
 
 export const designReview1: PrismaDesignReview = {
@@ -103,16 +108,41 @@ export const prismaDesignReview3: Prisma.Design_ReviewGetPayload<typeof designRe
   userDeletedId: null,
   docTemplateLink: null,
   wbsElementId: 1,
-  userCreated: wonderwoman,
-  requiredMembers: [wonderwoman],
+  userCreated: batman,
+  requiredMembers: [batman],
   optionalMembers: [],
-  confirmedMembers: [wonderwoman],
+  confirmedMembers: [batman],
   deniedMembers: [],
-  attendees: [wonderwoman],
+  attendees: [batman],
   userDeleted: null,
   wbsElement: prismaWbsElement1,
   teamType: teamType1
 };
+
+export const designReview3: DesignReview = {
+  designReviewId: '2',
+  dateScheduled: new Date('2024-03-25'),
+  meetingTimes: [80, 81, 82, 83],
+  dateCreated: new Date('2024-03-10'),
+  userCreated: sharedBatman,
+  status: DesignReviewStatus.CONFIRMED,
+  teamType: teamType1,
+  location: 'location',
+  isOnline: true,
+  isInPerson: false,
+  zoomLink: 'https://www.zoom.com',
+  docTemplateLink: undefined,
+  wbsName: 'car',
+  wbsNum: { carNumber: 1, projectNumber: 2, workPackageNumber: 0 },
+  requiredMembers: [sharedBatman],
+  optionalMembers: [],
+  confirmedMembers: [sharedBatman],
+  deniedMembers: [],
+  attendees: [sharedBatman],
+  userDeleted: undefined,
+  dateDeleted: undefined
+};
+
 export const sharedDesignReview1: SharedDesignReview = {
   designReviewId: '1',
   dateScheduled: new Date('2024-03-25'),