Merge pull request #2682 from Northeastern-Electric-Racing/Weekly-Availability-Times

Weekly availability times

Author: walker-sean

src/backend/src/prisma-query-args/user.query-args.ts

@@ -4,6 +4,8 @@ export type UserQueryArgs = ReturnType<typeof getUserQueryArgs>;
 
 export type UserWithSettingsQueryArgs = ReturnType<typeof getUserWithSettingsQueryArgs>;
 
+export type UserScheduleSettingsQueryArgs = ReturnType<typeof getUserScheduleSettingsQueryArgs>;
+
 // DO NOT CALL ANY OTHER QUERY ARGS FROM HERE TO AVOID CIRCULAR DEPENDENCIES
 export const getUserQueryArgs = (organizationId: string) =>
   Prisma.validator<Prisma.UserDefaultArgs>()({
@@ -25,8 +27,16 @@ export const getUserWithSettingsQueryArgs = (organizationId: string) =>
           organizationId
         }
       },
-      drScheduleSettings: true,
+      drScheduleSettings: getUserScheduleSettingsQueryArgs(),
       userSettings: true,
       organizations: true
     }
   });
+
+export const getUserScheduleSettingsQueryArgs = () => {
+  return Prisma.validator<Prisma.Schedule_SettingsDefaultArgs>()({
+    include: {
+      availabilities: true
+    }
+  });
+};

src/backend/src/prisma/migrations/20240625233416_multiple_availabilities/migration.sql

@@ -0,0 +1,27 @@
+/*
+  Warnings:
+
+  - You are about to drop the column `availability` on the `Schedule_Settings` table. All the data in the column will be lost.
+
+*/
+
+-- CreateTable
+CREATE TABLE "Availability" (
+    "availabilityId" TEXT NOT NULL,
+    "scheduleSettingsId" TEXT NOT NULL,
+    "availability" INTEGER[],
+    "dateSet" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "Availability_pkey" PRIMARY KEY ("availabilityId")
+);
+
+-- AddForeignKey
+ALTER TABLE "Availability" ADD CONSTRAINT "Availability_scheduleSettingsId_fkey" FOREIGN KEY ("scheduleSettingsId") REFERENCES "Schedule_Settings"("drScheduleSettingsId") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+/* Migrate all existing availabilities to new availability table */
+INSERT INTO "Availability" ("availabilityId", "scheduleSettingsId", "availability", "dateSet") SELECT gen_random_uuid(), "drScheduleSettingsId", "availability", CURRENT_TIMESTAMP FROM "Schedule_Settings";
+
+-- AlterTable
+ALTER TABLE "Schedule_Settings" DROP COLUMN "availability";
+
+

src/backend/src/prisma/schema.prisma

@@ -736,14 +736,23 @@ model Design_Review {
   notificationSlackThreads Message_Info[]
 }
 
+model Availability {
+  availabilityId     String            @id @default(uuid())
+  scheduleSettingsId String
+  scheduleSettings   Schedule_Settings @relation(fields: [scheduleSettingsId], references: [drScheduleSettingsId])
+
+  // Availibilies are integers between 0 and 83 from 10am - 10pm (Monday - Sunday) see meetingTime field in Design_Review
+  availability Int[]
+  dateSet      DateTime @default(now())
+}
+
 model Schedule_Settings {
-  drScheduleSettingsId String @id @default(uuid())
+  drScheduleSettingsId String         @id @default(uuid())
   personalGmail        String
   personalZoomLink     String
-  // Availibilies are integers between 0 and 83 from 10am - 10pm (Monday - Sunday) see meetingTime field in Design_Review
-  availability         Int[]
-  User                 User   @relation(fields: [userId], references: [userId])
-  userId               String @unique
+  User                 User           @relation(fields: [userId], references: [userId])
+  userId               String         @unique
+  availabilities       Availability[]
 }
 
 model Meeting {

src/backend/src/routes/users.routes.ts

@@ -34,8 +34,8 @@ userRouter.post(
 
 userRouter.post(
   '/schedule-settings/set',
-  nonEmptyString(body('personalGmail')).isEmail(),
-  nonEmptyString(body('personalZoomLink')).isURL(),
+  body('personalGmail').isString(),
+  body('personalZoomLink').isString(),
   body('availability').isArray(),
   intMinZero(body('availibility.*')),
   validateInputs,

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

@@ -10,7 +10,13 @@ import {
   AccessDeniedException,
   InvalidOrganizationException
 } from '../utils/errors.utils';
-import { getUsers, getPrismaQueryUserIds, userHasPermission, areUsersinList } from '../utils/users.utils';
+import {
+  getUsers,
+  getPrismaQueryUserIds,
+  userHasPermission,
+  areUsersinList,
+  updateUserAvailability
+} from '../utils/users.utils';
 import { isUserOnDesignReview, validateMeetingTimes } from '../utils/design-reviews.utils';
 import { designReviewTransformer } from '../transformers/design-reviews.transformer';
 import {
@@ -23,6 +29,7 @@ import {
 import { getDesignReviewQueryArgs } from '../prisma-query-args/design-reviews.query-args';
 import { getWorkPackageQueryArgs } from '../prisma-query-args/work-packages.query-args';
 import { UserWithSettings } from '../utils/auth.utils';
+import { getUserScheduleSettingsQueryArgs } from '../prisma-query-args/user.query-args';
 
 export default class DesignReviewsService {
   /**
@@ -363,25 +370,29 @@ export default class DesignReviewsService {
     if (!isUserOnDesignReview(submitter, designReviewTransformer(designReview)))
       throw new HttpException(400, 'Current user is not in the list of this design reviews members');
 
-    availability.forEach((time) => {
-      if (time < 0 || time > 83) {
-        throw new HttpException(400, 'Availability times have to be in range 0-83');
-      }
-    });
-
-    await prisma.schedule_Settings.upsert({
+    let userSettings = await prisma.schedule_Settings.findUnique({
       where: { userId: submitter.userId },
-      update: {
-        availability
-      },
-      create: {
-        userId: submitter.userId,
-        personalGmail: '',
-        personalZoomLink: '',
-        availability
-      }
+      ...getUserScheduleSettingsQueryArgs()
     });
 
+    if (!userSettings) {
+      userSettings = await prisma.schedule_Settings.create({
+        data: {
+          userId: submitter.userId,
+          availabilities: {
+            create: {
+              availability
+            }
+          },
+          personalGmail: '',
+          personalZoomLink: ''
+        },
+        ...getUserScheduleSettingsQueryArgs()
+      });
+    }
+
+    await updateUserAvailability(availability, userSettings, submitter, designReview.dateScheduled);
+
     // set submitter as confirmed if they're not already
     if (!designReview.confirmedMembers.map((user) => user.userId).includes(submitter.userId)) {
       const updatedDesignReview = await prisma.design_Review.update({

src/backend/src/services/users.services.ts

@@ -27,8 +27,12 @@ import userSecureSettingsTransformer from '../transformers/user-secure-settings.
 import { validateUserIsPartOfFinanceTeam } from '../utils/reimbursement-requests.utils';
 import userScheduleSettingsTransformer from '../transformers/user-schedule-settings.transformer';
 import { userTransformer, userWithScheduleSettingsTransformer } from '../transformers/user.transformer';
-import { getUserRole } from '../utils/users.utils';
-import { getUserQueryArgs, getUserWithSettingsQueryArgs } from '../prisma-query-args/user.query-args';
+import { getUserRole, updateUserAvailability } from '../utils/users.utils';
+import {
+  getUserQueryArgs,
+  getUserScheduleSettingsQueryArgs,
+  getUserWithSettingsQueryArgs
+} from '../prisma-query-args/user.query-args';
 import { getAuthUserQueryArgs } from '../prisma-query-args/auth-user.query-args';
 import authenticatedUserTransformer from '../transformers/auth-user.transformer';
 
@@ -44,7 +48,7 @@ export default class UsersService {
         include: {
           roles: true,
           userSettings: true,
-          drScheduleSettings: true,
+          drScheduleSettings: getUserScheduleSettingsQueryArgs(),
           organizations: true
         }
       });
@@ -480,7 +484,8 @@ export default class UsersService {
   static async getUserScheduleSettings(userId: string, submitter: PrismaUser): Promise<UserScheduleSettings> {
     if (submitter.userId !== userId) throw new AccessDeniedException('You can only access your own schedule settings');
     const scheduleSettings = await prisma.schedule_Settings.findUnique({
-      where: { userId }
+      where: { userId },
+      ...getUserScheduleSettingsQueryArgs()
     });
     if (!scheduleSettings) throw new HttpException(404, 'User Schedule Settings Not Found');
 
@@ -501,28 +506,32 @@ export default class UsersService {
     personalZoomLink: string,
     availability: number[]
   ): Promise<UserScheduleSettings> {
-    const existingUser = await prisma.schedule_Settings.findFirst({
-      where: { personalGmail, userId: { not: user.userId } } // excludes the current user from check
-    });
+    if (personalGmail !== '') {
+      const existingUser = await prisma.schedule_Settings.findFirst({
+        where: { personalGmail, userId: { not: user.userId } } // excludes the current user from check
+      });
 
-    if (existingUser) {
-      throw new HttpException(400, 'Email already in use');
+      if (existingUser) {
+        throw new HttpException(400, 'Email already in use');
+      }
     }
 
     const newUserScheduleSettings = await prisma.schedule_Settings.upsert({
       where: { userId: user.userId },
       update: {
         personalGmail,
-        personalZoomLink,
-        availability
+        personalZoomLink
       },
       create: {
         userId: user.userId,
         personalGmail,
-        personalZoomLink,
-        availability
-      }
+        personalZoomLink
+      },
+      ...getUserScheduleSettingsQueryArgs()
     });
+
+    await updateUserAvailability(availability, newUserScheduleSettings, user, new Date());
+
     return userScheduleSettingsTransformer(newUserScheduleSettings);
   }
 }

src/backend/src/transformers/user-schedule-settings.transformer.ts

@@ -1,12 +1,15 @@
 import { Prisma } from '@prisma/client';
 import { UserScheduleSettings } from 'shared';
+import { UserScheduleSettingsQueryArgs } from '../prisma-query-args/user.query-args';
 
-const userScheduleSettingsTransformer = (settings: Prisma.Schedule_SettingsGetPayload<null>): UserScheduleSettings => {
+const userScheduleSettingsTransformer = (
+  settings: Prisma.Schedule_SettingsGetPayload<UserScheduleSettingsQueryArgs>
+): UserScheduleSettings => {
   return {
     drScheduleSettingsId: settings.drScheduleSettingsId,
     personalGmail: settings.personalGmail,
     personalZoomLink: settings.personalZoomLink,
-    availability: settings.availability
+    availabilities: settings.availabilities
   };
 };
 

src/backend/src/utils/users.utils.ts

@@ -1,8 +1,9 @@
-import { User, User_Settings } from '@prisma/client';
+import { Prisma, User, User_Settings } from '@prisma/client';
 import prisma from '../prisma/prisma';
 import { HttpException, NotFoundException } from './errors.utils';
-import { PermissionCheck, Role, RoleEnum } from 'shared';
+import { isWithinSameWeek, PermissionCheck, Role, RoleEnum } from 'shared';
 import { UserWithId } from './teams.utils';
+import { UserScheduleSettingsQueryArgs } from '../prisma-query-args/user.query-args';
 
 type UserWithSettings = {
   userSettings: User_Settings | null;
@@ -107,3 +108,41 @@ export const userHasPermission = async (
 export const areUsersinList = (users: User[], userList: User[]): boolean => {
   return users.every((user) => userList.some((u) => u.userId === user.userId));
 };
+
+export const updateUserAvailability = async (
+  availability: number[],
+  userSettings: Prisma.Schedule_SettingsGetPayload<UserScheduleSettingsQueryArgs>,
+  submitter: User,
+  dateToCheckFor: Date
+) => {
+  availability.forEach((time) => {
+    if (time < 0 || time > 83) {
+      throw new HttpException(400, 'Availability times have to be in range 0-83');
+    }
+  });
+  const availabilityInSameWeek = userSettings.availabilities.filter((availability) =>
+    isWithinSameWeek(availability.dateSet, dateToCheckFor)
+  );
+
+  if (availabilityInSameWeek.length > 0) {
+    await prisma.availability.update({
+      where: { availabilityId: availabilityInSameWeek[0].availabilityId },
+      data: {
+        availability,
+        dateSet: dateToCheckFor
+      }
+    });
+  } else {
+    await prisma.availability.create({
+      data: {
+        availability,
+        dateSet: dateToCheckFor,
+        scheduleSettings: {
+          connect: {
+            userId: submitter.userId
+          }
+        }
+      }
+    });
+  }
+};

src/backend/tests/test-data/users.test-data.ts

@@ -155,7 +155,6 @@ export const batmanScheduleSettings: Schedule_Settings = {
   drScheduleSettingsId: 'bmschedule',
   personalGmail: 'brucewayne@gmail.com',
   personalZoomLink: 'https://zoom.us/j/gotham',
-  availability: [],
   userId: '69'
 };
 
@@ -170,22 +169,20 @@ export const batmanUserScheduleSettings: UserScheduleSettings = {
   drScheduleSettingsId: 'bmschedule',
   personalGmail: 'brucewayne@gmail.com',
   personalZoomLink: 'https://zoom.us/j/gotham',
-  availability: []
+  availabilities: []
 };
 
 export const wonderwomanScheduleSettings: Schedule_Settings = {
   drScheduleSettingsId: 'wwschedule',
   personalGmail: 'diana@gmail.com',
   personalZoomLink: 'https://zoom.us/jk/athens',
-  availability: [3],
   userId: '72'
 };
 
 export const wonderwomanMarkedScheduleSettings: Schedule_Settings = {
   drScheduleSettingsId: 'wwschedule',
   personalGmail: 'diana@gmail.com',
   personalZoomLink: 'https://zoom.us/jk/athens',
-  availability: [1, 2],
   userId: '72'
 };
 

src/frontend/src/apis/users.api.ts

@@ -4,7 +4,14 @@
  */
 
 import axios from '../utils/axios';
-import { Project, User, UserScheduleSettings, UserSecureSettings, UserWithScheduleSettings } from 'shared';
+import {
+  Project,
+  SetUserScheduleSettingsPayload,
+  User,
+  UserScheduleSettings,
+  UserSecureSettings,
+  UserWithScheduleSettings
+} from 'shared';
 import { apiUrls } from '../utils/urls';
 import { authUserTransformer, userTransformer } from './transformers/users.transformers';
 import { AuthenticatedUser, UserSettings } from 'shared';
@@ -120,7 +127,7 @@ export const updateUserSecureSettings = (settings: UserSecureSettings) => {
 /**
  * Update the given user's schedule settings by UserId
  */
-export const updateUserScheduleSettings = (settings: UserScheduleSettings) => {
+export const updateUserScheduleSettings = (settings: SetUserScheduleSettingsPayload) => {
   return axios.post<UserScheduleSettings>(apiUrls.userScheduleSettingsSet(), settings);
 };