Implement Automatic remainder sending email service

package.json

@@ -56,6 +56,7 @@
     "@types/jsonwebtoken": "^9.0.2",
     "@types/multer": "^1.4.11",
     "@types/node": "^20.1.4",
+    "@types/node-cron": "^3.0.11",
     "@types/nodemailer": "^6.4.15",
     "@types/passport": "^1.0.12",
     "@types/passport-google-oauth20": "^2.0.14",

src/app.ts

@@ -18,7 +18,6 @@ import mentorRouter from './routes/mentor/mentor.route'
 import profileRouter from './routes/profile/profile.route'
 import path from 'path'
 import countryRouter from './routes/country/country.route'
-
 const app = express()
 const staticFolder = 'uploads'
 export const certificatesDir = path.join(__dirname, 'certificates')

src/controllers/admin/email.controller.ts

@@ -4,6 +4,7 @@ import { type ApiResponse } from '../../types'
 import type Email from '../../entities/email.entity'
 import { ProfileTypes } from '../../enums'
 import { sendEmail } from '../../services/admin/email.service'
+import { ReminderService } from '../../services/admin/reminder.service'
 
 export const sendEmailController = async (
   req: Request,
@@ -30,3 +31,31 @@ export const sendEmailController = async (
     throw err
   }
 }
+
+const reminderService = new ReminderService()
+
+export const processEmailReminderHandler = async (
+  req: Request,
+  res: Response
+): Promise<void> => {
+  try {
+    const { statusCode, message } = await reminderService.processReminders()
+    res.status(statusCode).json({ message })
+  } catch (err) {
+    console.error('Error enabling reminder', err)
+    res.status(500).json({ message: 'Error enabling reminder' })
+  }
+}
+
+export const scheduleNewReminderHandler = async (
+  req: Request,
+  res: Response
+): Promise<void> => {
+  try {
+    const { statusCode, message } = await reminderService.scheduleNewReminders()
+    res.status(statusCode).json({ message })
+  } catch (err) {
+    console.error('Error scheduling reminder', err)
+    res.status(500).json({ message: 'Error scheduling reminder' })
+  }
+}

src/entities/mentee.entity.ts

@@ -21,6 +21,9 @@ class Mentee extends BaseEntity {
   @Column({ type: 'timestamp', nullable: true })
   status_updated_date!: Date
 
+  @Column({ type: 'timestamp', nullable: true })
+  last_monthlycheck_reminder_date!: Date
+
   @Column({ type: 'json' })
   application: Record<string, unknown>
 

src/entities/menteeReminders.entity.ts

@@ -0,0 +1,62 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  Index,
+  JoinColumn,
+  OneToOne
+} from 'typeorm'
+import Mentee from './mentee.entity'
+import { ReminderStatus } from '../enums'
+
+@Entity('mentee_reminders')
+class MenteeReminder extends BaseEntity {
+  @Column({ type: 'uuid', primary: true })
+  @Index({ unique: true })
+  menteeId!: string
+
+  @Column({
+    type: 'enum',
+    enum: ReminderStatus,
+    default: ReminderStatus.PENDING
+  })
+  status!: ReminderStatus
+
+  @Column({ type: 'int', default: 0 })
+  remindersSent!: number
+
+  @Column({ type: 'timestamp', nullable: true })
+  firstReminderSentAt?: Date | null
+
+  @Column({ type: 'timestamp', nullable: true })
+  lastReminderSentAt?: Date | null
+
+  @Column({ type: 'timestamp', nullable: true })
+  nextReminderDue?: Date | null
+
+  @Column({ type: 'int', default: 0 })
+  retryCount!: number
+
+  @Column({ type: 'timestamp', nullable: true })
+  nextRetryAt?: Date | null
+
+  @Column({ type: 'varchar', nullable: true, length: 255 })
+  lastErrorMessage?: string | null
+
+  @Column({ type: 'boolean', default: false })
+  isComplete!: boolean
+
+  @OneToOne(() => Mentee)
+  @JoinColumn({ name: 'menteeId' })
+  mentee!: Mentee
+
+  constructor(menteeId: string) {
+    super()
+    this.menteeId = menteeId
+    this.remindersSent = 0
+    this.retryCount = 0
+    this.isComplete = false
+  }
+}
+
+export default MenteeReminder

src/enums/index.ts

@@ -27,3 +27,14 @@ export enum StatusUpdatedBy {
   ADMIN = 'admin',
   MENTOR = 'mentor'
 }
+
+export enum ReminderStatus {
+  PENDING = 'pending',
+  SENDING = 'sending',
+  COMPLETE = 'complete',
+  FAILED = 'failed',
+  DONE = 'done',
+  SCHEDULED = 'scheduled',
+  SENT = 'sent',
+  WAITING = 'waiting'
+}

src/migrations/1730362421047-mentee_reminders.ts

@@ -0,0 +1,41 @@
+import { type MigrationInterface, type QueryRunner } from 'typeorm'
+
+export class MenteeReminders1730362421047 implements MigrationInterface {
+  name = 'MenteeReminders1730362421047'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE "mentee_reminders" ("menteeId" uuid NOT NULL, "remindersSent" integer NOT NULL DEFAULT '0', "firstReminderSentAt" TIMESTAMP, "lastReminderSentAt" TIMESTAMP, "nextReminderDue" TIMESTAMP, "retryCount" integer NOT NULL DEFAULT '0', "nextRetryAt" TIMESTAMP, "lastErrorMessage" character varying(255), "isComplete" boolean NOT NULL DEFAULT false, CONSTRAINT "PK_a2ae4434fe95f781453ed896f14" PRIMARY KEY ("menteeId"))`
+    )
+    await queryRunner.query(
+      `CREATE UNIQUE INDEX "IDX_a2ae4434fe95f781453ed896f1" ON "mentee_reminders" ("menteeId") `
+    )
+    await queryRunner.query(`ALTER TABLE "mentor" ADD "countryUuid" uuid`)
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminder_configs" ALTER COLUMN "nextReminderDue" DROP NOT NULL`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentor" ADD CONSTRAINT "FK_3302c22eb1636f239d605eb61c3" FOREIGN KEY ("countryUuid") REFERENCES "country"("uuid") ON DELETE NO ACTION ON UPDATE NO ACTION`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminders" ADD CONSTRAINT "FK_a2ae4434fe95f781453ed896f14" FOREIGN KEY ("menteeId") REFERENCES "mentee"("uuid") ON DELETE NO ACTION ON UPDATE NO ACTION`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminders" DROP CONSTRAINT "FK_a2ae4434fe95f781453ed896f14"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentor" DROP CONSTRAINT "FK_3302c22eb1636f239d605eb61c3"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminder_configs" ALTER COLUMN "nextReminderDue" SET NOT NULL`
+    )
+    await queryRunner.query(`ALTER TABLE "mentor" DROP COLUMN "countryUuid"`)
+    await queryRunner.query(
+      `DROP INDEX "public"."IDX_a2ae4434fe95f781453ed896f1"`
+    )
+    await queryRunner.query(`DROP TABLE "mentee_reminders"`)
+  }
+}

src/migrations/1730443452480-AddReminderStatus.ts

@@ -0,0 +1,133 @@
+import { type MigrationInterface, type QueryRunner } from 'typeorm'
+
+export class AddReminderStatus1730443452480 implements MigrationInterface {
+  name = 'AddReminderStatus1730443452480'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TYPE "public"."mentee_reminders_status_enum" AS ENUM('pending', 'sending', 'complete', 'failed', 'done', 'scheduled', 'sent')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminders" ADD "status" "public"."mentee_reminders_status_enum" NOT NULL DEFAULT 'pending'`
+    )
+    await queryRunner.query(
+      `ALTER TYPE "public"."email_reminders_status_enum" RENAME TO "email_reminders_status_enum_old"`
+    )
+    await queryRunner.query(
+      `CREATE TYPE "public"."email_reminders_status_enum" AS ENUM('pending', 'sending', 'complete', 'failed', 'done', 'scheduled', 'sent')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "email_reminders" ALTER COLUMN "status" DROP DEFAULT`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "email_reminders" ALTER COLUMN "status" TYPE "public"."email_reminders_status_enum" USING "status"::"text"::"public"."email_reminders_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "email_reminders" ALTER COLUMN "status" SET DEFAULT 'pending'`
+    )
+    await queryRunner.query(
+      `DROP TYPE "public"."email_reminders_status_enum_old"`
+    )
+    await queryRunner.query(
+      `ALTER TYPE "public"."reminder_attempts_status_enum" RENAME TO "reminder_attempts_status_enum_old"`
+    )
+    await queryRunner.query(
+      `CREATE TYPE "public"."reminder_attempts_status_enum" AS ENUM('pending', 'sending', 'complete', 'failed', 'done', 'scheduled', 'sent')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" DROP DEFAULT`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" TYPE "public"."reminder_attempts_status_enum" USING "status"::"text"::"public"."reminder_attempts_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" SET DEFAULT 'pending'`
+    )
+    await queryRunner.query(
+      `DROP TYPE "public"."reminder_attempts_status_enum_old"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminder_configs" ALTER COLUMN "nextReminderDue" SET NOT NULL`
+    )
+    await queryRunner.query(
+      `ALTER TYPE "public"."reminder_attempts_status_enum" RENAME TO "reminder_attempts_status_enum_old"`
+    )
+    await queryRunner.query(
+      `CREATE TYPE "public"."reminder_attempts_status_enum" AS ENUM('pending', 'sending', 'complete', 'failed', 'done', 'scheduled', 'sent')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" DROP DEFAULT`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" TYPE "public"."reminder_attempts_status_enum" USING "status"::"text"::"public"."reminder_attempts_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" SET DEFAULT 'pending'`
+    )
+    await queryRunner.query(
+      `DROP TYPE "public"."reminder_attempts_status_enum_old"`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TYPE "public"."reminder_attempts_status_enum_old" AS ENUM('pending', 'processing', 'complete', 'failed', 'done')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" DROP DEFAULT`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" TYPE "public"."reminder_attempts_status_enum_old" USING "status"::"text"::"public"."reminder_attempts_status_enum_old"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" SET DEFAULT 'pending'`
+    )
+    await queryRunner.query(
+      `DROP TYPE "public"."reminder_attempts_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TYPE "public"."reminder_attempts_status_enum_old" RENAME TO "reminder_attempts_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminder_configs" ALTER COLUMN "nextReminderDue" DROP NOT NULL`
+    )
+    await queryRunner.query(
+      `CREATE TYPE "public"."reminder_attempts_status_enum_old" AS ENUM('pending', 'processing', 'complete', 'failed', 'done')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" DROP DEFAULT`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" TYPE "public"."reminder_attempts_status_enum_old" USING "status"::"text"::"public"."reminder_attempts_status_enum_old"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "reminder_attempts" ALTER COLUMN "status" SET DEFAULT 'pending'`
+    )
+    await queryRunner.query(
+      `DROP TYPE "public"."reminder_attempts_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TYPE "public"."reminder_attempts_status_enum_old" RENAME TO "reminder_attempts_status_enum"`
+    )
+    await queryRunner.query(
+      `CREATE TYPE "public"."email_reminders_status_enum_old" AS ENUM('pending', 'processing', 'complete', 'failed', 'done')`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "email_reminders" ALTER COLUMN "status" DROP DEFAULT`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "email_reminders" ALTER COLUMN "status" TYPE "public"."email_reminders_status_enum_old" USING "status"::"text"::"public"."email_reminders_status_enum_old"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "email_reminders" ALTER COLUMN "status" SET DEFAULT 'pending'`
+    )
+    await queryRunner.query(`DROP TYPE "public"."email_reminders_status_enum"`)
+    await queryRunner.query(
+      `ALTER TYPE "public"."email_reminders_status_enum_old" RENAME TO "email_reminders_status_enum"`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "mentee_reminders" DROP COLUMN "status"`
+    )
+    await queryRunner.query(`DROP TYPE "public"."mentee_reminders_status_enum"`)
+  }
+}

src/routes/admin/admin.route.ts

@@ -3,12 +3,14 @@ import userRouter from './user/user.route'
 import mentorRouter from './mentor/mentor.route'
 import categoryRouter from './category/category.route'
 import menteeRouter from './mentee/mentee.route'
+import reminderRouter from './remainder/remainder.route'
 
 const adminRouter = express()
 
 adminRouter.use('/users', userRouter)
 adminRouter.use('/mentors', mentorRouter)
 adminRouter.use('/mentees', menteeRouter)
 adminRouter.use('/categories', categoryRouter)
+adminRouter.use('/reminders', reminderRouter)
 
 export default adminRouter

src/routes/admin/remainder/remainder.route.ts

@@ -0,0 +1,12 @@
+import express from 'express'
+import {
+  processEmailReminderHandler,
+  scheduleNewReminderHandler
+} from '../../../controllers/admin/email.controller'
+
+const reminderRouter = express.Router()
+
+reminderRouter.get('/process', processEmailReminderHandler)
+reminderRouter.get('/schedule', scheduleNewReminderHandler)
+
+export default reminderRouter