feat: create script to schedule adding Pending Summaries To Queue instead of Cron (#66)

Author: kshitij-k-osmosys

apps/api/Dockerfile

@@ -26,4 +26,4 @@ RUN npm run build
 EXPOSE 3000
 
 # Command to start your NestJS application
-CMD ["node", "dist/main.js"]
+CMD ./scheduler.sh & node dist/main.js

apps/api/docs/development-setup.md

@@ -68,7 +68,7 @@ sudo systemctl status mariadb
    GPT_MODEL="gpt-4o"
 
    # Docker env
-   COMPOSE_PROJECT_NAME=transcript-summarizer-api 
+   COMPOSE_PROJECT_NAME=transcript-summarizer-api
    ```
 
    Alternatively, use the `.env.example` file instead.
@@ -92,3 +92,11 @@ sudo systemctl status mariadb
    ```
 
    Transcript Summarizer API will now be running locally at `http://localhost:3000`.
+
+6. Run the scheduler script:
+
+   ```sh
+   ./scheduler.sh
+   ```
+
+   This should start the service function that adds all pending summaries to queue for processing.

apps/api/docs/usage-guide.md

@@ -42,6 +42,7 @@ Follow the development setup guides for API and portal to set up the codebase be
 ## 3. Using the Transcript Summarizer Portal
 
 1. **Start the API**
+    Run the scheduler script (see [Codebase Setup](#codebase) for details).
 2. **Start the Portal**
     The Transcript Summarizer Portal should now be running locally at:
     - `http://localhost:4200` (Standard setup)
@@ -68,7 +69,7 @@ When using the API, you'll need to set your **Microsoft authentication token** a
 
 ### Getting your Microsoft authentication token
 
-1. Start the API
+1. Start the API and scheduler (see [Codebase Setup](#codebase) for details).
 2. Start the Portal
 3. Transcript Summarizer Portal should be running locally at `http://localhost:4200` (or `http://localhost:5000` for docker setup).
 4. Open the portal URL. You will be prompted to log in to your Microsoft account.

apps/api/scheduler.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+SCHEDULE_TIME=1
+
+source ".env"
+
+BASE_URL="http://localhost:${SERVER_PORT}/summary"
+
+add_pending_summaries_to_queue() {
+  curl -X POST "${BASE_URL}/schedule" -H "Content-Type: application/json" -d '{}'
+}
+
+while true; do
+  add_pending_summaries_to_queue
+  sleep $SCHEDULE_TIME
+done

apps/api/src/config/logger.config.ts

@@ -35,7 +35,7 @@ const transportsConfig = [
     format: format.combine(
       format.timestamp(),
       format.ms(),
-      nestWinstonModuleUtilities.format.nestLike('OsmosysAssistant'),
+      nestWinstonModuleUtilities.format.nestLike('TranscriptSummarizer'),
     ),
   }),
 

apps/api/src/modules/summary/schedule/schedule.service.ts

@@ -1,5 +1,4 @@
 import { Injectable, Logger, OnModuleInit, OnModuleDestroy } from '@nestjs/common';
-import { Cron, CronExpression } from '@nestjs/schedule';
 import { SummaryService } from '../summary.service';
 import { ConfigService } from '@nestjs/config';
 import Redis from 'ioredis';
@@ -22,7 +21,6 @@ export class ScheduleService implements OnModuleInit, OnModuleDestroy {
     });
   }
 
-  @Cron(CronExpression.EVERY_SECOND)
   async addSummaryToQueue(): Promise<void> {
     if (this.isProcessing) {
       return;

apps/api/src/modules/summary/summary.controller.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { SummaryController } from './summary.controller';
+
+describe('SummaryController', () => {
+  let controller: SummaryController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [SummaryController],
+    }).compile();
+
+    controller = module.get<SummaryController>(SummaryController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

apps/api/src/modules/summary/summary.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Post } from '@nestjs/common';
+import { ScheduleService } from './schedule/schedule.service';
+
+@Controller('summary')
+export class SummaryController {
+  constructor(private readonly scheduleService: ScheduleService) {}
+
+  @Post('schedule')
+  async addPendingSummariesToQueue(): Promise<void> {
+    this.scheduleService.addSummaryToQueue();
+  }
+}

apps/api/src/modules/summary/summary.module.ts

@@ -10,6 +10,7 @@ import { ScheduleService } from './schedule/schedule.service';
 import { ConfigService } from '@nestjs/config';
 import { summaryQueueConfig } from './queues/summary.queue';
 import { MeetingSummaryService } from 'src/modules/summary/summarizer/summarizer.service';
+import { SummaryController } from './summary.controller';
 
 @Module({
   imports: [TypeOrmModule.forFeature([Summary]), BullModule.registerQueue(summaryQueueConfig)],
@@ -23,5 +24,6 @@ import { MeetingSummaryService } from 'src/modules/summary/summarizer/summarizer
     MeetingSummaryService,
   ],
   exports: [SummaryService, MeetingSummaryService],
+  controllers: [SummaryController],
 })
 export class SummaryModule {}