- added relationships between the table models ❤️

- made new type for table row
- made new query interface, service, resolver
- wrote some joins to build a row

Author: ruiichen

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 reviewDashboardResolvers from "./resolvers/reviewDashboardResolvers";
+import reviewDashboardType from "./types/reviewDashboardType";
 
 const query = gql`
   type Query {
@@ -41,13 +43,15 @@ const executableSchema = makeExecutableSchema({
     simpleEntityType,
     userType,
     dashboardType,
+    reviewDashboardType,
   ],
   resolvers: merge(
     authResolvers,
     entityResolvers,
     simpleEntityResolvers,
     userResolvers,
     dashboardResolvers,
+    reviewDashboardResolvers,
   ),
 });
 

backend/typescript/graphql/resolvers/reviewDashboardResolvers.ts

@@ -0,0 +1,26 @@
+import ReviewDashboardService from "../../services/implementations/reviewDashboardService";
+import { ReviewDashoardRowDTO } from "../../types";
+import { getErrorMessage } from "../../utilities/errorUtils";
+
+const reviewDashboardService = new ReviewDashboardService();
+
+const reviewDashboardResolvers = {
+  Query: {
+    reviewDashboard: async (
+      _parent: undefined,
+      { pageNumber }: { pageNumber: number },
+      { resultsPerPage }: { resultsPerPage: number },
+    ): Promise<ReviewDashoardRowDTO[]> => {
+      try {
+        return await reviewDashboardService.getReviewDashboard(
+          pageNumber,
+          resultsPerPage,
+        );
+      } catch (error) {
+        throw new Error(getErrorMessage(error));
+      }
+    },
+  },
+};
+
+export default reviewDashboardResolvers;

backend/typescript/graphql/types/reviewDashboardType.ts

@@ -0,0 +1,29 @@
+import { gql } from "apollo-server-express";
+import { ApplicationStatus, PositionTitle, ReviewerDTO } from "../../types";
+
+const reviewDashboardType = gql`
+  type ReviewerDTO {
+    firstName: String!
+    lastName: String!
+  }
+
+  type ReviewDashboardRowDTO {
+    firstName: String!
+    lastName: String!
+    position: Int!
+    timesApplied: String!
+    applicationStatus: String!
+    choice: Int!
+    reviewers: [ReviewerDTO!]!
+    totalScore: Int
+  }
+
+  extend type Query {
+    reviewDashboard(
+      pageNumber: Int
+      resultsPerPage: Int
+    ): [ReviewDashboardRowDTO!]!
+  }
+`;
+
+export default reviewDashboardType;

backend/typescript/models/applicant.model.ts

@@ -1,6 +1,8 @@
 /* eslint import/no-cycle: 0 */
 
-import { Column, DataType, Model, Table } from "sequelize-typescript";
+import { Column, DataType, HasMany, Model, Table } from "sequelize-typescript";
+import { NonAttribute } from "sequelize";
+import ApplicantRecord from "./applicantRecord.model";
 
 @Table({ tableName: "applicants" })
 export default class Applicant extends Model {
@@ -10,7 +12,7 @@ export default class Applicant extends Model {
     unique: true,
     autoIncrement: true,
   })
-  id!: string;
+  id!: number;
 
   @Column({ type: DataType.STRING })
   academicOrCoop!: string;
@@ -53,4 +55,10 @@ export default class Applicant extends Model {
 
   @Column({ type: DataType.DATE })
   submittedAt!: Date;
+
+  @HasMany(() => ApplicantRecord, {
+    foreignKey: "id",
+    as: "applicant",
+  })
+  applicantRecords?: NonAttribute<ApplicantRecord[]>;
 }

backend/typescript/models/applicantRecord.model.ts

@@ -1,19 +1,23 @@
 /* eslint import/no-cycle: 0 */
 
 import {
+  BelongsTo,
   Column,
   DataType,
   ForeignKey,
+  HasMany,
   Model,
   Table,
 } from "sequelize-typescript";
+import { NonAttribute } from "sequelize";
 import {
   ApplicantRecordExtraInfo,
   ApplicationStatus,
   SkillCategory,
 } 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 {
@@ -23,7 +27,7 @@ export default class ApplicantRecord extends Model {
     unique: true,
     autoIncrement: true,
   })
-  id!: string;
+  id!: number;
 
   @ForeignKey(() => Applicant)
   @Column({ type: DataType.STRING })
@@ -47,4 +51,10 @@ export default class ApplicantRecord extends Model {
 
   @Column({ type: DataType.JSONB, allowNull: true })
   extraInfo!: ApplicantRecordExtraInfo;
+
+  @BelongsTo(() => Applicant, "applicantId")
+  applicant?: NonAttribute<Applicant>;
+
+  @HasMany(() => ReviewedApplicantRecord, "applicantRecordId")
+  reviewedApplicantRecords?: NonAttribute<ReviewedApplicantRecord[]>;
 }

backend/typescript/models/reviewedApplicantRecord.model.ts

@@ -6,7 +6,9 @@ import {
   ForeignKey,
   Model,
   Table,
+  BelongsTo,
 } from "sequelize-typescript";
+import { NonAttribute } from "sequelize";
 import User from "./user.model";
 import { Review, ReviewStatus, ReviewStatusEnum } from "../types";
 import ApplicantRecord from "./applicantRecord.model";
@@ -29,4 +31,7 @@ export default class ReviewedApplicantRecord extends Model {
     defaultValue: ReviewStatusEnum.TODO,
   })
   status!: ReviewStatus;
+
+  @BelongsTo(() => User, { foreignKey: "reviewerId", targetKey: "id" })
+  user?: NonAttribute<User>;
 }

backend/typescript/models/user.model.ts

@@ -8,9 +8,11 @@ import {
   Model,
   Table,
 } from "sequelize-typescript";
+import { NonAttribute } from "sequelize";
 import { PositionTitle, PositionTitles, Role } from "../types";
 import ApplicationDashboardTable from "./applicationDashboard.model";
 import Position from "./position.model";
+import ReviewedApplicantRecord from "./reviewedApplicantRecord.model";
 
 @Table({ tableName: "users" })
 export default class User extends Model {
@@ -38,4 +40,10 @@ export default class User extends Model {
 
   @HasMany(() => ApplicationDashboardTable)
   applicationDashboards?: ApplicationDashboardTable[];
+
+  @HasMany(() => ReviewedApplicantRecord, {
+    foreignKey: "reviewerId",
+    as: "user",
+  })
+  reviewedApplicantRecords?: NonAttribute<ReviewedApplicantRecord[]>;
 }

backend/typescript/services/implementations/reviewDashboardService.ts

@@ -0,0 +1,66 @@
+import { PositionTitle, Review, ReviewDashoardRowDTO } from "../../types";
+import IReviewDashboardService from "../interfaces/IReviewDashboardService";
+import { getErrorMessage } from "../../utilities/errorUtils";
+import logger from "../../utilities/logger";
+import ApplicantRecord from "../../models/applicantRecord.model";
+
+const Logger = logger(__filename);
+
+function toDTO(model: ApplicantRecord): ReviewDashoardRowDTO {
+  return {
+    firstName: model.applicant!.firstName,
+    lastName: model.applicant!.lastName,
+    position: model.position as PositionTitle,
+    timesApplied: model.applicant!.timesApplied.toString(),
+    applicationStatus: model.status,
+    choice: model.choice,
+    reviewers: model.reviewedApplicantRecords!.map((r) => ({
+      firstName: r.user!.first_name,
+      lastName: r.user!.last_name,
+    })),
+    totalScore: null,
+  };
+}
+
+class ReviewDashboardService implements IReviewDashboardService {
+  /* eslint-disable class-methods-use-this */
+  async getReviewDashboard(
+    page: number,
+    resultsPerPage: number,
+  ): Promise<ReviewDashoardRowDTO[]> {
+    try {
+      // get applicant_record
+      // JOIN applicant ON applicant_id
+      // JOIN reviewed_applicant_record ON applicant_record_id
+      // JOIN user ON reviewer_id
+      const applicants: Array<ApplicantRecord> | null =
+        await ApplicantRecord.findAll({
+          attributes: { exclude: ["createdAt", "updatedAt"] },
+          include: [
+            {
+              attributes: { exclude: ["createdAt", "updatedAt"] },
+              association: "reviewedApplicantRecords",
+              include: [
+                {
+                  attributes: { exclude: ["createdAt", "updatedAt"] },
+                  association: "user",
+                },
+              ],
+            },
+            {
+              attributes: { exclude: ["createdAt", "updatedAt"] },
+              association: "applicant",
+            },
+          ],
+        });
+      return applicants.map(toDTO);
+    } catch (error: unknown) {
+      Logger.error(
+        `Failed to get dashboard. Reason = ${getErrorMessage(error)}`,
+      );
+      throw error;
+    }
+  }
+}
+
+export default ReviewDashboardService;

backend/typescript/services/interfaces/IReviewDashboardService.ts

@@ -0,0 +1,15 @@
+import { ReviewDashoardRowDTO } from "../../types";
+
+interface IReviewDashboardService {
+  /**
+   * Pagination-supporting viewing of the virtual review dashboard
+   * @Param page the page the viewer is on
+   * @Param resultsPerPage the number of results per page
+   */
+  getReviewDashboard(
+    page: number,
+    resultsPerPage: number,
+  ): Promise<ReviewDashoardRowDTO[]>;
+}
+
+export default IReviewDashboardService;

backend/typescript/types.ts

@@ -127,6 +127,22 @@ export type ApplicationDashboardRowDTO = {
   reviewers: UserDTO[];
 };
 
+export type ReviewerDTO = {
+  firstName: string;
+  lastName: string;
+};
+
+export type ReviewDashoardRowDTO = {
+  firstName: string;
+  lastName: string;
+  position: PositionTitle;
+  timesApplied: string;
+  applicationStatus: ApplicationStatus;
+  choice: number;
+  reviewers: ReviewerDTO[];
+  totalScore: number | null;
+};
+
 export type CreateUserDTO = Omit<UserDTO, "id" | "firstName" | "lastName">;
 
 export type UpdateUserDTO = Omit<UserDTO, "id">;