[SSF-133] set up MVP of cron job

apps/backend/src/app.module.ts

@@ -14,6 +14,7 @@ import { ManufacturerModule } from './foodManufacturers/manufacturer.module';
 import { DonationModule } from './donations/donations.module';
 import { DonationItemsModule } from './donationItems/donationItems.module';
 import { AllocationModule } from './allocations/allocations.module';
+import { ScheduleModule } from '@nestjs/schedule';
 
 @Module({
   imports: [
@@ -29,6 +30,7 @@ import { AllocationModule } from './allocations/allocations.module';
       useFactory: async (configService: ConfigService) =>
         configService.get('typeorm'),
     }),
+    ScheduleModule.forRoot(),
     UsersModule,
     AuthModule,
     PantriesModule,

apps/backend/src/donations/donations.module.ts

@@ -7,13 +7,19 @@ import { DonationService } from './donations.service';
 import { DonationsController } from './donations.controller';
 import { ManufacturerModule } from '../foodManufacturers/manufacturer.module';
 import { FoodManufacturer } from '../foodManufacturers/manufacturer.entity';
+import { DonationsSchedulerService } from './donations.scheduler';
 
 @Module({
   imports: [
     TypeOrmModule.forFeature([Donation, FoodManufacturer]),
     ManufacturerModule,
   ],
   controllers: [DonationsController],
-  providers: [DonationService, AuthService, JwtStrategy],
+  providers: [
+    DonationService,
+    AuthService,
+    JwtStrategy,
+    DonationsSchedulerService,
+  ],
 })
 export class DonationModule {}

apps/backend/src/donations/donations.scheduler.ts

@@ -0,0 +1,22 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { DonationService } from './donations.service';
+import { Cron } from '@nestjs/schedule';
+
+@Injectable()
+export class DonationsSchedulerService {
+  private readonly logger = new Logger(DonationsSchedulerService.name);
+
+  constructor(private readonly donationService: DonationService) {}
+
+  // cron pattern:
+  // supported: *, ranges/#'s (e.g. 1-3, 5), steps (e.g. */2)
+  //    * indicates the method should be run every _ unit of time
+  //    range/# indicates method should be run on the _ unit of time/between the _ and _ unit of time
+  //    step indicates the method should be run every _ unit of time
+  // fields in order: second, minute, hour, day of month, month, day of week
+  @Cron('0 30 10 * * *') // Runs every day at 10:30 AM
+  async handleDailyRecurringDonations() {
+    this.logger.log('Running daily donation reminder cron job');
+    await this.donationService.handleRecurringDonations();
+  }
+}

apps/backend/src/donations/donations.service.ts

@@ -78,4 +78,9 @@ export class DonationService {
     donation.status = DonationStatus.FULFILLED;
     return this.repo.save(donation);
   }
+
+  async handleRecurringDonations(): Promise<void> {
+    console.log('Accessing donation service from cron job');
+    // TODO: Implement logic for sending reminder emails
+  }
 }

package.json

@@ -31,6 +31,7 @@
     "@nestjs/core": "^10.0.2",
     "@nestjs/passport": "^10.0.2",
     "@nestjs/platform-express": "^10.0.2",
+    "@nestjs/schedule": "^6.1.0",
     "@nestjs/swagger": "^7.4.2",
     "@nestjs/typeorm": "^10.0.0",
     "@types/google-libphonenumber": "^7.4.30",