add GraphQL mutators to support CUDing, for new admin comments feature of applicant records

Author: ericahan22

backend/typescript/graphql/index.ts

@@ -18,6 +18,8 @@ import userType from "./types/userType";
 import dashboardType from "./types/dashboardType";
 import dashboardResolvers from "./resolvers/dashboardResolvers";
 import reviewType from "./types/reviewType";
+import adminCommentResolvers from "./resolvers/adminCommentsResolvers";
+import adminCommentsType from "./types/adminCommentsType";
 
 const query = gql`
   type Query {
@@ -41,13 +43,15 @@ const executableSchema = makeExecutableSchema({
     simpleEntityType,
     userType,
     dashboardType,
+    adminCommentsType,
   ],
   resolvers: merge(
     authResolvers,
     entityResolvers,
     simpleEntityResolvers,
     userResolvers,
     dashboardResolvers,
+    adminCommentResolvers,
   ),
 });
 
@@ -90,6 +94,9 @@ const graphQLMiddlewares = {
     logout: isAuthorizedByUserId("userId"),
     resetPassword: isAuthorizedByEmail("email"),
     sendSignInLink: authorizedByAllRoles(),
+    createAdminComment: authorizedByAdmin(),
+    updateAdminComment: authorizedByAdmin(),
+    deleteAdminCommentById: authorizedByAdmin(),
   },
 };
 

backend/typescript/graphql/resolvers/adminCommentsResolvers.ts

@@ -0,0 +1,38 @@
+import AdminCommentService from "../../services/implementations/adminCommentService";
+import IAdminCommentService from "../../services/interfaces/adminCommentService";
+import { CreateAdminCommentDTO, AdminCommentDTO } from "../../types";
+
+const adminCommentService: IAdminCommentService = new AdminCommentService();
+
+const adminCommentResolvers = {
+  Mutation: {
+    createAdminComment: async (
+      _parent: undefined,
+      { adminComment }: { adminComment: CreateAdminCommentDTO },
+    ): Promise<AdminCommentDTO> => {
+      const newAdminComment = await adminCommentService.createAdminComment(
+        adminComment,
+      );
+      return newAdminComment;
+    },
+    updateAdminComment: async (
+      _parent: undefined,
+      { id, content }: { id: string; content: CreateAdminCommentDTO },
+    ): Promise<AdminCommentDTO> => {
+      const adminComment = await adminCommentService.updateAdminComment(
+        id,
+        content,
+      );
+      return adminComment;
+    },
+    deleteAdminCommentById: async (
+      _parent: undefined,
+      { id }: { id: string },
+    ): Promise<AdminCommentDTO> => {
+      const adminComment = await adminCommentService.deleteAdminCommentById(id);
+      return adminComment;
+    },
+  },
+};
+
+export default adminCommentResolvers;

backend/typescript/graphql/types/adminCommentsType.ts

@@ -0,0 +1,29 @@
+import { gql } from "apollo-server-express";
+
+const adminCommentsType = gql`
+  type AdminCommentDTO {
+    id: String!
+    userId: Int!
+    applicantRecordId: String!
+    comment: String!
+    createdAt: String!
+    updatedAt: String!
+  }
+
+  input CreateAdminCommentDTO {
+    userId: Int!
+    applicantRecordId: String!
+    comment: String!
+  }
+
+  extend type Mutation {
+    createAdminComment(adminComment: CreateAdminCommentDTO!): AdminCommentDTO!
+    updateAdminComment(
+      id: String!
+      content: CreateAdminCommentDTO!
+    ): AdminCommentDTO!
+    deleteAdminCommentById(id: String!): AdminCommentDTO!
+  }
+`;
+
+export default adminCommentsType;

backend/typescript/services/implementations/adminCommentService.ts

@@ -0,0 +1,100 @@
+import { AdminCommentDTO, CreateAdminCommentDTO } from "../../types";
+import { getErrorMessage } from "../../utilities/errorUtils";
+import logger from "../../utilities/logger";
+import AdminComment from "../../models/adminComment.model";
+import IAdminCommentService from "../interfaces/adminCommentService";
+
+const Logger = logger(__filename);
+
+const grabAdminComment = async (commentId: string): Promise<AdminComment> => {
+  try {
+    const adminComment = await AdminComment.findByPk(commentId);
+    if (!adminComment) {
+      throw new Error(`adminCommentId ${commentId} not found.`);
+    }
+    return adminComment;
+  } catch (error: unknown) {
+    Logger.error(
+      `Failed to get admin comment. Reason = ${getErrorMessage(error)}`,
+    );
+    throw error;
+  }
+};
+
+class AdminCommentService implements IAdminCommentService {
+  /* eslint-disable class-methods-use-this */
+
+  async createAdminComment(
+    content: CreateAdminCommentDTO,
+  ): Promise<AdminCommentDTO> {
+    try {
+      const adminComment = await AdminComment.create({
+        userId: content.userId,
+        applicantRecordId: content.applicantRecordId,
+        comment: content.comment,
+        createdAt: new Date(),
+        updatedAt: new Date(),
+      });
+      return {
+        id: String(adminComment.id),
+        userId: adminComment.userId,
+        applicantRecordId: String(adminComment.applicantRecordId),
+        comment: adminComment.comment,
+        createdAt: adminComment.createdAt.toISOString(),
+        updatedAt: adminComment.updatedAt.toISOString(),
+      };
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to create admin comment. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+
+  async updateAdminComment(
+    commentId: string,
+    content: CreateAdminCommentDTO,
+  ): Promise<AdminCommentDTO> {
+    const adminComment = await grabAdminComment(commentId);
+    try {
+      adminComment.comment = content.comment;
+      adminComment.updatedAt = new Date();
+      await adminComment.save();
+      return {
+        id: String(adminComment.id),
+        userId: adminComment.userId,
+        applicantRecordId: String(adminComment.applicantRecordId),
+        comment: adminComment.comment,
+        createdAt: adminComment.createdAt.toISOString(),
+        updatedAt: adminComment.updatedAt.toISOString(),
+      };
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to update admin comment. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+
+  async deleteAdminCommentById(id: string): Promise<AdminCommentDTO> {
+    const adminComment = await grabAdminComment(id);
+    try {
+      await adminComment.destroy();
+      return {
+        id: String(adminComment.id),
+        userId: adminComment.userId,
+        applicantRecordId: String(adminComment.applicantRecordId),
+        comment: adminComment.comment,
+        createdAt: adminComment.createdAt.toISOString(),
+        updatedAt: adminComment.updatedAt.toISOString(),
+      };
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to delete admin comment. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+}
+
+export default AdminCommentService;

backend/typescript/services/interfaces/adminCommentService.ts

@@ -0,0 +1,12 @@
+import { AdminCommentDTO, CreateAdminCommentDTO } from "../../types";
+
+interface IAdminCommentService {
+  createAdminComment(content: CreateAdminCommentDTO): Promise<AdminCommentDTO>;
+  updateAdminComment(
+    commentId: string,
+    content: CreateAdminCommentDTO,
+  ): Promise<AdminCommentDTO>;
+  deleteAdminCommentById(id: string): Promise<AdminCommentDTO>;
+}
+
+export default IAdminCommentService;

backend/typescript/types.ts

@@ -239,3 +239,17 @@ export type ReviewedApplicantRecordDTO = {
   score?: number | null;
   reviewerHasConflict: boolean;
 };
+
+export type AdminCommentDTO = {
+  id: string;
+  userId: number;
+  applicantRecordId: string;
+  comment: string;
+  createdAt: string;
+  updatedAt: string;
+};
+
+export type CreateAdminCommentDTO = Pick<
+  AdminCommentDTO,
+  "userId" | "applicantRecordId" | "comment"
+>;