Merge pull request #144 from nitrictech/enable-cron

Add cron schedules

Author: tjholm

src/faas/v0/start.ts

@@ -22,6 +22,7 @@ import {
   HeaderValue,
   TriggerResponse,
   TopicResponseContext,
+  ScheduleCron,
   ScheduleRate,
   SubscriptionWorker,
   ScheduleWorker,
@@ -41,11 +42,11 @@ import {
   TriggerMiddleware,
 } from '.';
 
-import { ApiWorkerOptions, RateWorkerOptions, SubscriptionWorkerOptions } from "../../resources";
+import { ApiWorkerOptions, CronWorkerOptions, RateWorkerOptions, SubscriptionWorkerOptions } from "../../resources";
 
 class FaasWorkerOptions {}
 
-type FaasClientOptions = ApiWorkerOptions | RateWorkerOptions | FaasWorkerOptions; 
+type FaasClientOptions = ApiWorkerOptions | RateWorkerOptions | CronWorkerOptions | FaasWorkerOptions; 
 
 /**
  *
@@ -214,6 +215,13 @@ export class Faas {
       rate.setRate(`${this.options.rate} ${this.options.frequency}`);
       scheduleWorker.setRate(rate);
       initRequest.setSchedule(scheduleWorker);
+    } else if (this.options instanceof CronWorkerOptions) {
+      const scheduleWorker = new ScheduleWorker();
+      scheduleWorker.setKey(this.options.description);
+      const cron = new ScheduleCron();
+      cron.setCron(this.options.cron);
+      scheduleWorker.setCron(cron);
+      initRequest.setSchedule(scheduleWorker);
     } else if (this.options instanceof SubscriptionWorkerOptions) {
       const subscriptionWorker = new SubscriptionWorker()
       subscriptionWorker.setTopic(this.options.topic);

src/resources/schedule.test.ts

@@ -24,6 +24,25 @@ describe('Schedule', () => {
 		jest.clearAllMocks();
 	});
 
+	describe("when creating a new schedule with cron expression", () => {
+		let error = undefined;
+		afterAll(() => {
+			jest.resetAllMocks();
+		});
+
+		beforeAll(async () => {
+			try {
+				await schedule("main").cron("0 10 * * *", mockFn);
+			} catch (err) {
+				error = err
+			}
+		});
+
+		it("should not return an error", () => {
+			expect(error).toBe(undefined);
+		});
+	});
+
 	describe("when creating a new schedule with an invalid rate", () => {
 		let error = undefined;
 		afterAll(() => {
@@ -40,7 +59,7 @@ describe('Schedule', () => {
 
 		it("should return an error", () => {
 			expect(error).not.toBe(undefined);
-		})
+		});
 	});
 
 	describe("when creating a new schedule with an invalid frequency", () => {
@@ -59,7 +78,7 @@ describe('Schedule', () => {
 
 		it("should throw an error", () => {
 			expect(error).not.toBe(undefined);
-		})
+		});
 	});
 
 	["day", "hour", "minute"].forEach(rate => {

src/resources/schedule.ts

@@ -29,6 +29,16 @@ export class RateWorkerOptions {
 	}
 }
 
+export class CronWorkerOptions {
+	public readonly description: string;
+	public readonly cron: string;
+
+	constructor(description: string, cron: string) {
+		this.description = description;
+		this.cron = cron;
+	}
+}
+
 /**
  * Provides a rate based schedule
  * 
@@ -65,6 +75,26 @@ class Rate {
 	}
 }
 
+/**
+ * Provides a cron based schedule
+ */
+class Cron {
+	public readonly schedule: Schedule;
+	private readonly faas: Faas;
+
+	constructor(schedule: Schedule, cron: string, ...mw: EventMiddleware[]) {
+		this.schedule = schedule;
+		this.faas = new Faas(
+			new CronWorkerOptions(schedule['description'], cron)
+		);
+		this.faas.event(...mw);
+	}
+
+	private async start(): Promise<void> {
+		return this.faas.start();
+	}
+}
+
 /**
  * Providers a scheduled worker.
  */
@@ -92,6 +122,12 @@ class Schedule {
 		// Start the new rate immediately
 		return r['start']();
 	}
+
+	cron = (expression: string, ...mw: EventMiddleware[]): Promise<void> => {
+		const r = new Cron(this, expression, ...mw);
+		// Start the new cron immediately
+		return r['start']();
+	}
 }
 
 /**