Merge pull request #61 from vernu/job-queue

Implement optional job queue for sending sms with delay

Author: vernu

api/.env.example

@@ -19,3 +19,7 @@ MAIL_USER=
 MAIL_PASS=
 MAIL_FROM=
 MAIL_REPLY_TO=textbee.dev@gmail.com
+
+# SMS Queue Configuration
+USE_SMS_QUEUE=false
+REDIS_URL=redis://localhost:6379 # if queue is enabled,  redis url is required

api/package.json

@@ -21,9 +21,12 @@
   },
   "dependencies": {
     "@nest-modules/mailer": "^1.3.22",
+    "@nestjs/bull": "^11.0.2",
     "@nestjs/common": "^10.4.5",
+    "@nestjs/config": "^4.0.1",
     "@nestjs/core": "^10.4.5",
     "@nestjs/jwt": "^10.2.0",
+    "@nestjs/mapped-types": "^2.1.0",
     "@nestjs/mongoose": "^10.0.10",
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.4.5",
@@ -33,10 +36,13 @@
     "@polar-sh/sdk": "^0.30.0",
     "axios": "^1.8.2",
     "bcryptjs": "^2.4.3",
+    "bull": "^4.16.5",
+    "class-validator": "^0.14.1",
     "dotenv": "^16.4.5",
     "express": "^4.21.2",
     "firebase-admin": "^12.6.0",
     "handlebars": "^4.7.8",
+    "ioredis": "^5.6.0",
     "mongoose": "^8.12.1",
     "nodemailer": "^6.10.0",
     "passport": "^0.7.0",

api/pnpm-lock.yaml

@@ -1,4 +1,9 @@
-import { Module } from '@nestjs/common'
+import {
+  MiddlewareConsumer,
+  Module,
+  NestModule,
+  RequestMethod,
+} from '@nestjs/common'
 import { MongooseModule } from '@nestjs/mongoose'
 import { GatewayModule } from './gateway/gateway.module'
 import { AuthModule } from './auth/auth.module'
@@ -7,19 +12,45 @@ import { ThrottlerModule } from '@nestjs/throttler'
 import { APP_GUARD } from '@nestjs/core/constants'
 import { WebhookModule } from './webhook/webhook.module'
 import { ThrottlerByIpGuard } from './auth/guards/throttle-by-ip.guard'
+import { Injectable, NestMiddleware } from '@nestjs/common'
+import { Request, Response, NextFunction } from 'express'
 import { ScheduleModule } from '@nestjs/schedule'
-import { BillingModule } from './billing/billing.module';
+import { BillingModule } from './billing/billing.module'
+import { ConfigModule, ConfigService } from '@nestjs/config'
+import { BullModule } from '@nestjs/bull'
+
+@Injectable()
+export class LoggerMiddleware implements NestMiddleware {
+  use(req: Request, res: Response, next: NextFunction) {
+    console.log('req.originalUrl: ', req.originalUrl)
+    if (next) {
+      next()
+    }
+  }
+}
 
 @Module({
   imports: [
     MongooseModule.forRoot(process.env.MONGO_URI),
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
     ThrottlerModule.forRoot([
       {
         ttl: 60000,
         limit: 60,
       },
     ]),
     ScheduleModule.forRoot(),
+    BullModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (configService: ConfigService) => {
+        return {
+          redis: configService.get('REDIS_URL'),
+        }
+      },
+    }),
     AuthModule,
     UsersModule,
     GatewayModule,
@@ -34,4 +65,10 @@ import { BillingModule } from './billing/billing.module';
     },
   ],
 })
-export class AppModule {}
+export class AppModule implements NestModule {
+  configure(consumer: MiddlewareConsumer) {
+    consumer
+      .apply(LoggerMiddleware)
+      .forRoutes({ path: '*', method: RequestMethod.ALL })
+  }
+}

api/src/app.module.ts

@@ -9,6 +9,10 @@ import { SMS, SMSSchema } from './schemas/sms.schema'
 import { SMSBatch, SMSBatchSchema } from './schemas/sms-batch.schema'
 import { WebhookModule } from 'src/webhook/webhook.module'
 import { BillingModule } from 'src/billing/billing.module'
+import { BullModule } from '@nestjs/bull'
+import { ConfigModule } from '@nestjs/config'
+import { SmsQueueService } from './queue/sms-queue.service'
+import { SmsQueueProcessor } from './queue/sms-queue.processor'
 
 @Module({
   imports: [
@@ -26,13 +30,26 @@ import { BillingModule } from 'src/billing/billing.module'
         schema: SMSBatchSchema,
       },
     ]),
+    BullModule.registerQueue({
+      name: 'sms',
+      defaultJobOptions: {
+        attempts: 2,
+        backoff: {
+          type: 'exponential',
+          delay: 1000,
+        },
+        removeOnComplete: false,
+        removeOnFail: false,
+      },
+    }),
     AuthModule,
     UsersModule,
     WebhookModule,
     forwardRef(() => BillingModule),
+    ConfigModule,
   ],
   controllers: [GatewayController],
-  providers: [GatewayService],
-  exports: [MongooseModule, GatewayService],
+  providers: [GatewayService, SmsQueueService, SmsQueueProcessor],
+  exports: [MongooseModule, GatewayService, SmsQueueService],
 })
 export class GatewayModule {}