feat: compute review status on API level

This commit adds
1. the functionality to compute the review status for all reviews when queried from the database. This computation is done on the API level and is not stored in the db.

2. a new "rejected" review status based on the criteria outlined [here](#294)

api/app/controllers/review.controller.ts

@@ -3,7 +3,7 @@ import { Op } from "sequelize";
 
 import { Review, Transaction, Transcript, User } from "../db/models";
 import { DB_QUERY_LIMIT, DB_START_PAGE } from "../utils/constants";
-import { buildCondition, buildReviewResponse } from "../utils/review.inference";
+import { buildCondition, buildReviewResponse, computeReviewStatus } from "../utils/review.inference";
 import { parseMdToJSON } from "../helpers/transcript";
 import axios from "axios";
 import { BaseParsedMdContent, TranscriptAttributes } from "../types/transcript";
@@ -161,7 +161,8 @@ export async function findOne(req: Request, res: Response) {
     const branchUrl = data.branchUrl;
     const transcriptData = data.transcript.dataValues;
     const transcript = await transcriptWrapper(transcriptData, branchUrl);
-    return res.status(200).send({ ...data.dataValues, transcript });
+    const reviewWithComputedStatus = computeReviewStatus(data);
+    return res.status(200).send({ ...reviewWithComputedStatus.dataValues, transcript });
   } catch (err) {
     res.status(500).send({
       message: "Error retrieving review with id=" + id,
@@ -325,10 +326,11 @@ export const getReviewsByPaymentStatus = async (
     );
     const unpaidMergedReviews = mergedReviews.filter(
       (review) => !creditTransactionReviewIds.includes(review.id)
-    );
+    ).map((review) => computeReviewStatus(review));
     const paidMergedReviews = mergedReviews.filter((review) =>
       creditTransactionReviewIds.includes(review.id)
-    );
+    ).map((review) => computeReviewStatus(review))
+
 
     let response: {
       totalItems: number;

api/app/types/review.ts

@@ -1,3 +1,11 @@
+import { Review } from "../db/models";
+
+// This type combines the ReviewAttributes and Review model
+// because the Review model which extends the Model class
+// does not have the status field in the database schema.
+// It is only present in the API level and is not stored in the database.
+export type IReview = Review & ReviewAttributes;
+
 export interface ReviewAttributes {
   id?: number;
   submittedAt?: Date | null;
@@ -7,9 +15,9 @@ export interface ReviewAttributes {
   transcriptId: number;
   pr_url?: string | null;
   branchUrl?: string | null;
+  status?: string;
 }
 
-
 export interface BuildConditionArgs {
   status?: string;
   transcriptId?: number;

api/app/utils/review.inference.ts

@@ -4,8 +4,7 @@ import { Op } from "sequelize";
 import { TranscriptAttributes } from "../types/transcript";
 import { wordCount } from "./functions";
 import { EXPIRYTIMEINHOURS, HOUR_END_OF_DAY, MILLISECOND_END_OF_DAY, MINUTE_END_OF_DAY, QUERY_REVIEW_STATUS, SECOND_END_OF_DAY } from "./constants";
-import { Review } from "../db/models";
-import { BuildConditionArgs } from "../types/review";
+import { BuildConditionArgs, IReview } from "../types/review";
 
 const unixEpochTimeInMilliseconds = getUnixTimeFromHours(EXPIRYTIMEINHOURS);
 
@@ -260,7 +259,7 @@ export const buildCondition = ({
 };
 
 export const buildReviewResponse = (
-  reviews: Review[],
+  reviews: IReview[],
   page: number,
   limit: number,
   totalItems: number
@@ -269,6 +268,10 @@ export const buildReviewResponse = (
   const hasNextPage = page < totalPages;
   const hasPreviousPage = page > 1;
 
+  reviews.forEach((review) => {
+    computeReviewStatus(review);
+  });
+
   return {
     totalItems,
     totalPages,
@@ -280,6 +283,52 @@ export const buildReviewResponse = (
   };
 };
 
+export const computeReviewStatus = (review: IReview) => {
+  const currentTime = new Date().getTime();
+  const isExpiredReview = (review: IReview) => {
+    return (
+      (!review.submittedAt && !review.mergedAt && !review.archivedAt && review.createdAt < new Date(currentTime - unixEpochTimeInMilliseconds)) ||
+      (!review.submittedAt && !review.mergedAt && review.archivedAt && review.createdAt < new Date(currentTime - unixEpochTimeInMilliseconds))
+    );
+  }
+
+  const isActiveReview = (review: IReview) => {
+    const timeStringAt24HoursPrior = new Date(
+      currentTime - unixEpochTimeInMilliseconds
+    ).toISOString();
+    return (
+      !review.submittedAt &&
+      !review.mergedAt &&
+      !review.archivedAt &&
+      review.createdAt > timeStringAt24HoursPrior
+    );
+  }
+
+  const isPendingReview = (review: IReview) => {
+    return review.submittedAt && !review.mergedAt && !review.archivedAt;
+  }
+
+  const isRejectedReview = (review: IReview) => {
+    return review.archivedAt && review.submittedAt && !review.mergedAt;
+  }
+
+  if (isPendingReview(review)) {
+    review.dataValues.status = QUERY_REVIEW_STATUS.PENDING;
+  } else if (isActiveReview(review)) {
+    review.dataValues.status = QUERY_REVIEW_STATUS.ACTIVE;
+  } else if (isExpiredReview(review)) {
+    review.dataValues.status = "expired";
+  } else if (review.mergedAt && !review.archivedAt) {
+    review.dataValues.status = QUERY_REVIEW_STATUS.MERGED;
+  }else if (isRejectedReview(review)) {
+    review.dataValues.status = "rejected";
+  } else {
+    review.dataValues.status = "unknown";
+  }
+
+  return review;
+}
+
 export {
   getUnixTimeFromHours,
   buildIsActiveCondition,