Built out shift signup endpoints

backend/graphql/index.ts

@@ -12,6 +12,8 @@ import userResolvers from "./resolvers/userResolvers";
 import userType from "./types/userType";
 import shiftResolvers from "./resolvers/shiftResolvers";
 import shiftType from "./types/shiftType";
+import shiftSignupResolvers from "./resolvers/shiftSignupResolvers";
+import shiftSignupType from "./types/shiftSignupType";
 import postingResolvers from "./resolvers/postingResolvers";
 import postingType from "./types/postingType";
 import skillResolvers from "./resolvers/skillResolvers";
@@ -105,6 +107,7 @@ const executableSchema = makeExecutableSchema({
     entityType,
     userType,
     shiftType,
+    shiftSignupType,
     skillType,
     skillType,
     postingType,
@@ -117,6 +120,7 @@ const executableSchema = makeExecutableSchema({
     entityResolvers,
     userResolvers,
     shiftResolvers,
+    shiftSignupResolvers,
     postingResolvers,
     skillResolvers,
     branchResolvers,
@@ -128,6 +132,7 @@ const authorizedByAllRoles = () =>
 const authorizedByAdmin = () => isAuthorizedByRole(new Set(["ADMIN"]));
 const authorizedByAdminAndVolunteer = () =>
   isAuthorizedByRole(new Set(["ADMIN", "VOLUNTEER"]));
+const authorizedByVolunteer = () => isAuthorizedByRole(new Set(["VOLUNTEER"]));
 
 const graphQLMiddlewares = {
   Query: {
@@ -147,6 +152,7 @@ const graphQLMiddlewares = {
     skills: authorizedByAdmin(),
     branch: authorizedByAdmin(),
     branches: authorizedByAdmin(),
+    getShiftSignupsForUser: authorizedByAdmin(),
   },
   Mutation: {
     createEntity: authorizedByAllRoles(),
@@ -175,6 +181,8 @@ const graphQLMiddlewares = {
     createBranch: authorizedByAdmin(),
     updateBranch: authorizedByAdmin(),
     deleteBranch: authorizedByAdmin(),
+    createShiftSignups: authorizedByVolunteer(),
+    updateShiftSignup: authorizedByAdmin(),
   },
 };
 

backend/graphql/resolvers/shiftSignupResolvers.ts

@@ -0,0 +1,45 @@
+import ShiftSignupService from "../../services/implementations/shiftSignupService";
+import IShiftSignupService from "../../services/interfaces/shiftSignupService";
+import {
+  CreateShiftSignupDTO,
+  ShiftSignupResponseDTO,
+  UpdateShiftSignupRequestDTO,
+} from "../../types";
+
+const shiftSignupService: IShiftSignupService = new ShiftSignupService();
+
+const shiftSignupResolvers = {
+  Query: {
+    getShiftSignupsForUser: async (
+      _parent: undefined,
+      { userId }: { userId: string },
+    ): Promise<ShiftSignupResponseDTO[]> => {
+      return shiftSignupService.getShiftSignupsForUser(userId);
+    },
+  },
+  Mutation: {
+    createShiftSignups: async (
+      _parent: undefined,
+      { shifts }: { shifts: CreateShiftSignupDTO[] },
+    ): Promise<ShiftSignupResponseDTO[]> => {
+      return shiftSignupService.createShiftSignups(shifts);
+    },
+
+    updateShiftSignup: async (
+      _parent: undefined,
+      {
+        shiftId,
+        userId,
+        update,
+      }: {
+        shiftId: string;
+        userId: string;
+        update: UpdateShiftSignupRequestDTO;
+      },
+    ): Promise<ShiftSignupResponseDTO> => {
+      return shiftSignupService.updateShiftSignup(shiftId, userId, update);
+    },
+  },
+};
+
+export default shiftSignupResolvers;

backend/graphql/types/shiftSignupType.ts

@@ -0,0 +1,47 @@
+import { gql } from "apollo-server-express";
+
+const shiftSignupType = gql`
+  enum SignupStatus {
+    PENDING
+    CONFIRMED
+    CANCELED
+  }
+
+  input CreateShiftSignupRequestDTO {
+    shiftId: ID!
+    userId: ID!
+    numVolunteers: Int!
+    note: String!
+  }
+
+  input UpdateShiftSignupRequestDTO {
+    numVolunteers: Int!
+    note: String!
+    status: SignupStatus!
+  }
+
+  type ShiftSignupResponseDTO {
+    shiftId: ID!
+    userId: ID!
+    numVolunteers: Int!
+    note: String!
+    status: SignupStatus!
+  }
+
+  extend type Query {
+    getShiftSignupsForUser(userId: ID!): [ShiftSignupResponseDTO!]!
+  }
+
+  extend type Mutation {
+    createShiftSignups(
+      shifts: [CreateShiftSignupRequestDTO!]!
+    ): [ShiftSignupResponseDTO!]!
+    updateShiftSignup(
+      shiftId: ID!
+      userId: ID!
+      update: UpdateShiftSignupRequestDTO!
+    ): ShiftSignupResponseDTO!
+  }
+`;
+
+export default shiftSignupType;

backend/prisma/migrations/20220203230753_add_pk_and_note_field_to_signups/migration.sql

@@ -0,0 +1,13 @@
+/*
+  Warnings:
+
+  - The primary key for the `signups` table will be changed. If it partially fails, the table could be left without primary key constraint.
+  - You are about to drop the column `id` on the `signups` table. All the data in the column will be lost.
+  - Added the required column `note` to the `signups` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "signups" DROP CONSTRAINT "signups_pkey",
+DROP COLUMN "id",
+ADD COLUMN     "note" TEXT NOT NULL,
+ADD CONSTRAINT "signups_pkey" PRIMARY KEY ("shifts_id", "userId");

backend/prisma/schema.prisma

@@ -114,15 +114,16 @@ model Shift {
 }
 
 model Signup {
-  id            Int          @id @default(autoincrement())
   shift         Shift        @relation(fields: [shiftId], references: [id])
   shiftId       Int          @map("shifts_id")
   user          User         @relation(fields: [userId], references: [id])
   userId        Int
   status        SignupStatus
   numVolunteers Int          @default(1) @map("num_volunteers")
+  note          String
 
   @@map("signups")
+  @@id([shiftId, userId])
 }
 
 model Volunteer {

backend/services/implementations/shiftSignupService.ts

@@ -0,0 +1,94 @@
+import { PrismaClient, Signup, SignupStatus } from "@prisma/client";
+
+import IShiftSignupService from "../interfaces/shiftSignupService";
+import {
+  CreateShiftSignupDTO,
+  ShiftSignupDTO,
+  ShiftSignupResponseDTO,
+  UpdateShiftSignupRequestDTO,
+} from "../../types";
+import logger from "../../utilities/logger";
+import { getErrorMessage } from "../../utilities/errorUtils";
+
+const prisma = new PrismaClient();
+
+const Logger = logger(__filename);
+
+class ShiftSignupService implements IShiftSignupService {
+  convertSignupToDTO = (signup: Signup): ShiftSignupDTO => {
+    return {
+      ...signup,
+      shiftId: String(signup.shiftId),
+      userId: String(signup.userId),
+    };
+  };
+
+  async getShiftSignupsForUser(
+    userId: string,
+  ): Promise<ShiftSignupResponseDTO[]> {
+    try {
+      const shiftSignups = await prisma.signup.findMany({
+        where: { userId: Number(userId) },
+      });
+      return shiftSignups.map((signup) => this.convertSignupToDTO(signup));
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to shift signups. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+
+  async createShiftSignups(
+    shiftSignups: CreateShiftSignupDTO[],
+  ): Promise<ShiftSignupResponseDTO[]> {
+    try {
+      const newShiftSignups = await prisma.$transaction(
+        shiftSignups.map((shiftSignup) =>
+          prisma.signup.create({
+            data: {
+              ...shiftSignup,
+              shiftId: Number(shiftSignup.shiftId),
+              userId: Number(shiftSignup.userId),
+              status: SignupStatus.PENDING,
+            },
+          }),
+        ),
+      );
+      return newShiftSignups.map((newShiftSignup) =>
+        this.convertSignupToDTO(newShiftSignup),
+      );
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to create shift signup. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+
+  async updateShiftSignup(
+    shiftId: string,
+    userId: string,
+    shiftSignup: UpdateShiftSignupRequestDTO,
+  ): Promise<ShiftSignupResponseDTO> {
+    try {
+      const updateResult = await prisma.signup.update({
+        where: {
+          shiftId_userId: {
+            shiftId: Number(shiftId),
+            userId: Number(userId),
+          },
+        },
+        data: shiftSignup,
+      });
+      return this.convertSignupToDTO(updateResult);
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to update shift signup. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+}
+
+export default ShiftSignupService;

backend/services/interfaces/shiftSignupService.ts

@@ -0,0 +1,41 @@
+import {
+  CreateShiftSignupDTO,
+  ShiftSignupResponseDTO,
+  UpdateShiftSignupRequestDTO,
+} from "../../types";
+
+interface IShiftSignupService {
+  /**
+   * Bulk creates sign ups for shifts
+   * @param shiftSignups array of CreateShiftSignupDTOs
+   * @returns an array of ShiftSignupResponseDTO
+   * @throws Error if any of the shifts signups cannot be created
+   */
+  createShiftSignups(
+    shiftSignups: CreateShiftSignupDTO[],
+  ): Promise<ShiftSignupResponseDTO[]>;
+
+  /**
+   * Update a shift signup entry
+   * @param shiftId the shift to update
+   * @param userId the user to update
+   * @param shiftSignup the information to be updated
+   * @returns a ShiftSignupResponseDTO containing the updated information
+   * @throws Error if the shift signup
+   */
+  updateShiftSignup(
+    shiftId: string,
+    userId: string,
+    shiftSignup: UpdateShiftSignupRequestDTO,
+  ): Promise<ShiftSignupResponseDTO>;
+
+  /**
+   * Gets all shifts the user has signed up for
+   * @param userId the target user's id
+   * @returns an array of ShiftSignupResponseDTOs for each shift the user signed up for
+   * @throws Error if the shift signup retrieval fails
+   */
+  getShiftSignupsForUser(userId: string): Promise<ShiftSignupResponseDTO[]>;
+}
+
+export default IShiftSignupService;

backend/types.ts

@@ -116,6 +116,25 @@ export type ShiftBulkRequestDTO = {
 
 export type ShiftResponseDTO = ShiftDTO;
 
+export type ShiftSignupStatus = "PENDING" | "CONFIRMED" | "CANCELED";
+
+export type ShiftSignupDTO = {
+  shiftId: string;
+  userId: string;
+  numVolunteers: number;
+  note: string;
+  status: ShiftSignupStatus;
+};
+
+export type CreateShiftSignupDTO = Omit<ShiftSignupDTO, "status">;
+
+export type UpdateShiftSignupRequestDTO = Omit<
+  ShiftSignupDTO,
+  "shiftId" | "userId"
+>;
+
+export type ShiftSignupResponseDTO = ShiftSignupDTO;
+
 export type SkillDTO = {
   id: string;
   name: string;