WIP: applicant record service

Author: carolynzhang18

backend/typescript/graphql/resolvers/applicantRecordResolvers.ts

@@ -0,0 +1,24 @@
+import ApplicantRecord from "../../models/applicantRecord.model";
+import ApplicantRecordService from "../../services/implementations/applicantRecordService";
+import { PositionTitle } from "../../types";
+
+const applicantRecordService = new ApplicantRecordService();
+
+const applicantRecordResolvers = {
+  Query: {
+    getApplicantRecords: async (
+      _parent: undefined,
+      { positions }: { positions: PositionTitle[] },
+    ): Promise<ApplicantRecord[]> => {
+      return applicantRecordService.getApplicantRecords(positions);
+    },
+    getApplicantRecordById: (
+      _parent: undefined,
+      { id }: { id: string },
+    ): Promise<ApplicantRecord> => {
+      return applicantRecordService.getApplicantRecordById(id);
+    },
+  },
+};
+
+export default applicantRecordResolvers;

backend/typescript/graphql/types/applicantRecordType.ts

@@ -0,0 +1,72 @@
+import { gql } from "apollo-server-express";
+
+const applicantRecordType = gql`
+  enum ApplicationStatus {
+    Applied
+    InReview
+    Reviewed
+    Interview
+    InterviewComplete
+    Offer
+    NotConsidered
+  }
+
+  enum SkillCategory {
+    Junior
+    Intermediate
+    Senior
+  }
+
+  type ApplicantDTO {
+    id: ID!
+    firstName: String!
+    lastName: String!
+    email: String!
+    academicOrCoop: String!
+    academicYear: String!
+    heardFrom: String!
+    locationPreference: String!
+    program: String!
+    pronouns: String!
+    resumeUrl: String!
+    timesApplied: Int!
+    shortAnswerQuestions: [String!]!
+    term: String!
+    submittedAt: String!
+  }
+
+  type UserDTO {
+    id: ID!
+    firstName: String!
+    lastName: String!
+    email: String!
+    position: String
+    role: Role!
+  }
+
+  type ReviewedApplicantRecordDTO {
+    applicantRecordId: ID!
+    reviewer: UserDTO!
+    review: JSON
+    status: ReviewStatus!
+  }
+
+  type ApplicantRecordDTO {
+    id: ID!
+    applicant: ApplicantDTO!
+    position: String!
+    roleSpecificQuestions: [String!]!
+    choice: Int!
+    status: ApplicationStatus!
+    skillCategory: SkillCategory
+    extraInfo: JSON
+    reviews: [ReviewedApplicantRecordDTO!]!
+  }
+
+  extend type Query {
+    getApplicantRecords(positions: [String!]!): [ApplicantRecordDTO!]!
+    getApplicantRecordById(id: ID!): ApplicantRecordDTO!
+  }
+`;
+
+export default applicantRecordType;

backend/typescript/models/applicantRecord.model.ts

@@ -1,9 +1,11 @@
 /* eslint import/no-cycle: 0 */
 
 import {
+  BelongsTo,
   Column,
   DataType,
   ForeignKey,
+  HasMany,
   Model,
   Table,
 } from "sequelize-typescript";
@@ -14,14 +16,14 @@ import {
 } from "../types";
 import Applicant from "./applicant.model";
 import Position from "./position.model";
+import ReviewedApplicantRecord from "./reviewedApplicantRecord.model";
 
 @Table({ tableName: "applicant_records" })
 export default class ApplicantRecord extends Model {
   @Column({
-    type: DataType.INTEGER,
+    type: DataType.STRING,
     primaryKey: true,
     unique: true,
-    autoIncrement: true,
   })
   id!: string;
 
@@ -47,4 +49,10 @@ export default class ApplicantRecord extends Model {
 
   @Column({ type: DataType.JSONB, allowNull: true })
   extraInfo!: ApplicantRecordExtraInfo;
+
+  @HasMany(() => ReviewedApplicantRecord, "applicantRecordId")
+  reviews!: ReviewedApplicantRecord[];
+
+  @BelongsTo(() => Applicant, "applicantId")
+  applicant!: Applicant;
 }

backend/typescript/models/reviewedApplicantRecord.model.ts

@@ -1,6 +1,7 @@
 /* eslint import/no-cycle: 0 */
 
 import {
+  BelongsTo,
   Column,
   DataType,
   ForeignKey,
@@ -29,4 +30,10 @@ export default class ReviewedApplicantRecord extends Model {
     defaultValue: ReviewStatusEnum.TODO,
   })
   status!: ReviewStatus;
+
+  @BelongsTo(() => ApplicantRecord, "applicantRecordId")
+  applicantRecord!: ApplicantRecord;
+
+  @BelongsTo(() => User, "reviewerId")
+  reviewer!: User;
 }

backend/typescript/services/implementations/applicantRecordService.ts

@@ -0,0 +1,72 @@
+import { Op } from "sequelize";
+import { PositionTitle } from "../../types";
+import IApplicantRecordService from "../interfaces/applicantRecordService";
+import logger from "../../utilities/logger";
+import ApplicantRecord from "../../models/applicantRecord.model";
+import { getErrorMessage } from "../../utilities/errorUtils";
+import Applicant from "../../models/applicant.model";
+import ReviewedApplicantRecord from "../../models/reviewedApplicantRecord.model";
+import User from "../../models/user.model";
+
+const Logger = logger(__filename);
+
+class ApplicantRecordService implements IApplicantRecordService {
+  /* eslint-disable class-methods-use-this */
+
+  async getApplicantRecords(
+    positions: PositionTitle[],
+  ): Promise<ApplicantRecord[]> {
+    try {
+      return await ApplicantRecord.findAll({
+        where: {
+          position: { [Op.in]: positions },
+        },
+        include: [
+          {
+            model: Applicant,
+            as: "applicant",
+          },
+          {
+            model: ReviewedApplicantRecord,
+            as: "reviews",
+            include: [
+              {
+                model: User,
+                as: "reviewer",
+              },
+            ],
+          },
+        ],
+      });
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to get applicant records. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+
+  async getApplicantRecordById(id: string): Promise<ApplicantRecord> {
+    try {
+      const applicantRecord = await ApplicantRecord.findByPk(id, {
+        include: [
+          {
+            model: Applicant,
+            as: "applicant",
+          },
+        ],
+      });
+      if (!applicantRecord) {
+        throw new Error(`Applicant record with id ${id} not found.`);
+      }
+      return applicantRecord;
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to get applicant record. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+}
+
+export default ApplicantRecordService;

backend/typescript/services/interfaces/applicantRecordService.ts

@@ -0,0 +1,16 @@
+import ApplicantRecord from "../../models/applicantRecord.model";
+import { PositionTitle } from "../../types";
+
+interface IApplicantRecordService {
+  /**
+   * Retrieve full applicant records by positions.
+   */
+  getApplicantRecords(positions: PositionTitle[]): Promise<ApplicantRecord[]>;
+
+  /**
+   * Retrieve a full applicant record by id.
+   */
+  getApplicantRecordById(id: string): Promise<ApplicantRecord>;
+}
+
+export default IApplicantRecordService;

backend/typescript/types.ts

@@ -97,9 +97,9 @@ export type ApplicantDTO = {
 };
 
 export type ApplicantRecordDTO = {
-  id: number;
+  id: string;
   applicantId: string;
-  position: PositionTitle; // EDIT LATER
+  position: PositionTitle;
   roleSpecificQuestions: string[];
   choice: number;
   status: ApplicationStatus;