Merge pull request #77 from uwblueprint/INTF25-fetch-application-review-page-query

[INTF25] Build fetch application review page query

Author: ruiichen

backend/typescript/graphql/index.ts

@@ -19,6 +19,8 @@ import reviewDashboardResolvers from "./resolvers/reviewDashboardResolvers";
 import reviewDashboardType from "./types/reviewDashboardType";
 import adminCommentResolvers from "./resolvers/adminCommentsResolvers";
 import adminCommentType from "./types/adminCommentsType";
+import reviewPageType from "./types/reviewPageType";
+import reviewPageResolvers from "./resolvers/reviewPageResolvers";
 
 const query = gql`
   type Query {
@@ -42,6 +44,7 @@ const executableSchema = makeExecutableSchema({
     userType,
     reviewDashboardType,
     adminCommentType,
+    reviewPageType,
   ],
   resolvers: merge(
     authResolvers,
@@ -50,6 +53,7 @@ const executableSchema = makeExecutableSchema({
     userResolvers,
     reviewDashboardResolvers,
     adminCommentResolvers,
+    reviewPageResolvers,
   ),
 });
 

backend/typescript/graphql/resolvers/reviewPageResolvers.ts

@@ -0,0 +1,22 @@
+import { ApplicationDTO } from "../../types";
+import ReviewPageService from "../../services/implementations/reviewPageService";
+import { getErrorMessage } from "../../utilities/errorUtils";
+
+const reviewPageService = new ReviewPageService();
+
+const reviewPageResolvers = {
+  Query: {
+    reviewApplicantPage: async (
+      _parent: undefined,
+      args: { applicantRecordId: string },
+    ): Promise<ApplicationDTO> => {
+      try {
+        return await reviewPageService.getReviewPage(args.applicantRecordId);
+      } catch (error) {
+        throw new Error(getErrorMessage(error));
+      }
+    },
+  },
+};
+
+export default reviewPageResolvers;

backend/typescript/graphql/types/reviewPageType.ts

@@ -0,0 +1,33 @@
+import { gql } from "apollo-server-express";
+
+const reviewPageType = gql`
+  type ApplicationDTO {
+    id: Int!
+    academicOrCoop: String!
+    academicYear: String!
+    email: String!
+    firstChoiceRole: String!
+    firstName: String!
+    heardFrom: String!
+    lastName: String!
+    locationPreference: String!
+    program: String!
+    pronouns: String!
+    pronounsSpecified: String!
+    resumeUrl: String!
+    roleSpecificQuestions: [String!]!
+    secondChoiceRole: String!
+    shortAnswerQuestions: [String!]!
+    status: String!
+    secondChoiceStatus: String!
+    term: String!
+    timesApplied: String!
+    timestamp: Int
+  }
+
+  extend type Query {
+    reviewApplicantPage(applicantRecordId: String!): ApplicationDTO!
+  }
+`;
+
+export default reviewPageType;

backend/typescript/models/applicant.model.ts

@@ -57,8 +57,9 @@ export default class Applicant extends Model {
   submittedAt!: Date;
 
   @HasMany(() => ApplicantRecord, {
-    foreignKey: "id",
-    as: "applicant",
+    foreignKey: "applicantId",
+    sourceKey: "id",
+    as: "applicantRecords",
   })
   applicantRecords?: NonAttribute<ApplicantRecord[]>;
 }

backend/typescript/models/applicantRecord.model.ts

@@ -22,16 +22,16 @@ 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!: number;
+  id!: string;
 
   @ForeignKey(() => Applicant)
-  @Column({ type: DataType.STRING })
-  applicantId!: string;
+  @Column({ type: DataType.INTEGER })
+  applicantId!: number;
 
   @ForeignKey(() => Position)
   @Column({ type: DataType.STRING })

backend/typescript/models/reviewedApplicantRecord.model.ts

@@ -17,7 +17,7 @@ import User from "./user.model";
 export default class ReviewedApplicantRecord extends Model {
   @ForeignKey(() => ApplicantRecord)
   @Column({ type: DataType.STRING, primaryKey: true })
-  applicantRecordId!: number;
+  applicantRecordId!: string;
 
   @ForeignKey(() => User)
   @Column({ type: DataType.INTEGER, primaryKey: true })

backend/typescript/services/implementations/reviewPageService.ts

@@ -0,0 +1,72 @@
+import { ApplicationDTO } from "../../types";
+import IReviewPageService from "../interfaces/IReviewPageService";
+import { getErrorMessage } from "../../utilities/errorUtils";
+import logger from "../../utilities/logger";
+import ApplicantRecord from "../../models/applicantRecord.model";
+import ReviewedApplicantRecord from "../../models/reviewedApplicantRecord.model";
+import Applicant from "../../models/applicant.model";
+
+const Logger = logger(__filename);
+
+function toDTO(model: Applicant): ApplicationDTO {
+  const firstChoice = model.applicantRecords!.find((ar) => ar.choice === 1);
+  const secondChoice = model.applicantRecords!.find((ar) => ar.choice === 2);
+
+  return {
+    id: model.id,
+    academicOrCoop: model.academicOrCoop,
+    academicYear: model.academicYear,
+    email: model.email,
+    firstChoiceRole: firstChoice!.position,
+    firstName: model.firstName,
+    lastName: model.lastName,
+    heardFrom: model.heardFrom,
+    locationPreference: model.locationPreference,
+    program: model.program,
+    timesApplied: model.timesApplied.toString(),
+    pronouns: model.pronouns,
+    pronounsSpecified: model.pronouns,
+    resumeUrl: model.resumeUrl,
+    roleSpecificQuestions: firstChoice!.roleSpecificQuestions,
+    secondChoiceRole: secondChoice ? secondChoice.position : "",
+    shortAnswerQuestions: model.shortAnswerQuestions,
+    status: firstChoice!.status,
+    term: model.term,
+    secondChoiceStatus: secondChoice ? secondChoice.status : "",
+    /* timestamp: model.submittedAt.getSeconds(), */
+  };
+}
+
+class ReviewPageService implements IReviewPageService {
+  /* eslint-disable class-methods-use-this */
+  async getReviewPage(applicantRecordId: string): Promise<ApplicationDTO> {
+    try {
+      const applicantRecord: ApplicantRecord | null =
+        await ApplicantRecord.findOne({
+          where: { id: applicantRecordId },
+          attributes: { exclude: ["createdAt", "updatedAt"] },
+        });
+      if (!applicantRecord)
+        throw new Error(`Database integrity has been violated`);
+
+      const applicant: Applicant | null = await Applicant.findOne({
+        where: { id: applicantRecord.applicantId },
+        attributes: { exclude: ["createdAt", "updatedAt"] },
+        include: [
+          {
+            attributes: { exclude: ["createdAt", "updatedAt"] },
+            association: "applicantRecords",
+          },
+        ],
+      });
+      if (!applicant) throw new Error(`Database integrity has been violated`);
+
+      return toDTO(applicant);
+    } catch (error: unknown) {
+      Logger.error(`Failed to fetch. Reason = ${getErrorMessage(error)}`);
+      throw error;
+    }
+  }
+}
+
+export default ReviewPageService;

backend/typescript/services/interfaces/IReviewPageService.ts

@@ -0,0 +1,11 @@
+import { ApplicationDTO } from "../../types";
+
+interface IReviewPageService {
+  /**
+   * Fetch data from the Applicant and ApplicantRecord table to return an ApplicationDTO object
+   * @Param applicantRecordId the id of the applicant record that the viewer is interested in
+   */
+  getReviewPage(applicantRecordId: string): Promise<ApplicationDTO>;
+}
+
+export default IReviewPageService;

backend/typescript/types.ts

@@ -33,7 +33,6 @@ export type UserDTO = {
   role: Role;
 };
 
-// DEPRECATED - TO BE REMOVED AT THE END OF S25
 export type ApplicationDTO = {
   id: number;
   academicOrCoop: string;
@@ -55,7 +54,7 @@ export type ApplicationDTO = {
   secondChoiceStatus: string;
   term: string;
   timesApplied: string;
-  timestamp: bigint;
+  timestamp?: bigint;
 };
 
 export type ApplicantDTO = {