Merge pull request #1100 from origranot/add-disbaled-flag

feat(cron): add disabled flag to cron jobs

lib/decorators/cron.decorator.ts

@@ -29,6 +29,12 @@ export interface CronOptions {
    * If you have code that keeps the event loop running and want to stop the node process when that finishes regardless of the state of your cronjob, you can do so making use of this parameter. This is off by default and cron will run as if it needs to control the event loop. For more information take a look at [timers#timers_timeout_unref](https://nodejs.org/api/timers.html#timers_timeout_unref) from the NodeJS docs.
    */
   unrefTimeout?: boolean;
+
+  /**
+   * This flag indicates whether the job will be executed at all.
+   * @default false
+   */
+  disabled?: boolean;
 }
 
 /**

lib/scheduler.orchestrator.ts

@@ -67,6 +67,11 @@ export class SchedulerOrchestrator
     const cronKeys = Object.keys(this.cronJobs);
     cronKeys.forEach((key) => {
       const { options, target } = this.cronJobs[key];
+
+      if (options.disabled) {
+        return;
+      }
+
       const cronJob = new CronJob(
         options.cronTime,
         target as any,

tests/e2e/cron-jobs.spec.ts

@@ -94,6 +94,17 @@ describe('Cron', () => {
     expect(job.running).toBeFalsy();
   });
 
+  it(`should not run "cron" at all`, async () => {
+    const service = app.get(CronService);
+
+    await app.init();
+    const registry = app.get(SchedulerRegistry);
+
+    expect(() => {
+      registry.getCronJob('DISABLED');
+    }).toThrow();
+  });
+
   it(`should return cron id by name`, async () => {
     await app.init();
     const registry = app.get(SchedulerRegistry);

tests/src/cron.service.ts

@@ -57,6 +57,12 @@ export class CronService {
     }
   }
 
+  @Cron(CronExpression.EVERY_30_SECONDS, {
+    name: 'DISABLED',
+    disabled: true,
+  })
+  handleDisabledCron() {}
+
   addCronJob(): CronJob {
     const job = new CronJob(CronExpression.EVERY_SECOND, () => {
       ++this.dynamicCallsCount;