-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cron) implement Deno.cron() (#21019)
This PR adds unstable `Deno.cron` API to trigger execution of cron jobs. * State: All cron state is in memory. Cron jobs are scheduled according to the cron schedule expression and the current time. No state is persisted to disk. * Time zone: Cron expressions specify time in UTC. * Overlapping executions: not permitted. If the next scheduled execution time occurs while the same cron job is still executing, the scheduled execution is skipped. * Retries: failed jobs are automatically retried until they succeed or until retry threshold is reached. Retry policy can be optionally specified using `options.backoffSchedule`.
- Loading branch information
Showing
19 changed files
with
918 additions
and
4 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. | ||
| import { assertEquals, assertThrows, deferred } from "./test_util.ts"; | ||
|
|
||
| const sleep = (time: number) => new Promise((r) => setTimeout(r, time)); | ||
|
|
||
| Deno.test(function noNameTest() { | ||
| assertThrows( | ||
| // @ts-ignore test | ||
| () => Deno.cron(), | ||
| TypeError, | ||
| "Deno.cron requires a unique name", | ||
| ); | ||
| }); | ||
|
|
||
| Deno.test(function noSchedule() { | ||
| assertThrows( | ||
| // @ts-ignore test | ||
| () => Deno.cron("foo"), | ||
| TypeError, | ||
| "Deno.cron requires a valid schedule", | ||
| ); | ||
| }); | ||
|
|
||
| Deno.test(function noHandler() { | ||
| assertThrows( | ||
| // @ts-ignore test | ||
| () => Deno.cron("foo", "*/1 * * * *"), | ||
| TypeError, | ||
| "Deno.cron requires a handler", | ||
| ); | ||
| }); | ||
|
|
||
| Deno.test(function invalidNameTest() { | ||
| assertThrows( | ||
| () => Deno.cron("abc[]", "*/1 * * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron name", | ||
| ); | ||
| assertThrows( | ||
| () => Deno.cron("a**bc", "*/1 * * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron name", | ||
| ); | ||
| assertThrows( | ||
| () => Deno.cron("abc<>", "*/1 * * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron name", | ||
| ); | ||
| assertThrows( | ||
| () => Deno.cron(";']", "*/1 * * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron name", | ||
| ); | ||
| assertThrows( | ||
| () => | ||
| Deno.cron( | ||
| "0000000000000000000000000000000000000000000000000000000000000000000000", | ||
| "*/1 * * * *", | ||
| () => {}, | ||
| ), | ||
| TypeError, | ||
| "Cron name is too long", | ||
| ); | ||
| }); | ||
|
|
||
| Deno.test(function invalidScheduleTest() { | ||
| assertThrows( | ||
| () => Deno.cron("abc", "bogus", () => {}), | ||
| TypeError, | ||
| "Invalid cron schedule", | ||
| ); | ||
| assertThrows( | ||
| () => Deno.cron("abc", "* * * * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron schedule", | ||
| ); | ||
| assertThrows( | ||
| () => Deno.cron("abc", "* * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron schedule", | ||
| ); | ||
| assertThrows( | ||
| () => Deno.cron("abc", "m * * * *", () => {}), | ||
| TypeError, | ||
| "Invalid cron schedule", | ||
| ); | ||
| }); | ||
|
|
||
| Deno.test(function invalidBackoffScheduleTest() { | ||
| assertThrows( | ||
| () => | ||
| Deno.cron("abc", "*/1 * * * *", () => {}, { | ||
| backoffSchedule: [1, 1, 1, 1, 1, 1], | ||
| }), | ||
| TypeError, | ||
| "Invalid backoff schedule", | ||
| ); | ||
| assertThrows( | ||
| () => | ||
| Deno.cron("abc", "*/1 * * * *", () => {}, { | ||
| backoffSchedule: [3600001], | ||
| }), | ||
| TypeError, | ||
| "Invalid backoff schedule", | ||
| ); | ||
| }); | ||
|
|
||
| Deno.test(async function tooManyCrons() { | ||
| const crons: Promise<void>[] = []; | ||
| const ac = new AbortController(); | ||
| for (let i = 0; i <= 100; i++) { | ||
| const c = Deno.cron(`abc_${i}`, "*/1 * * * *", () => {}, { | ||
| signal: ac.signal, | ||
| }); | ||
| crons.push(c); | ||
| } | ||
|
|
||
| try { | ||
| assertThrows( | ||
| () => { | ||
| Deno.cron("next-cron", "*/1 * * * *", () => {}, { signal: ac.signal }); | ||
| }, | ||
| TypeError, | ||
| "Too many crons", | ||
| ); | ||
| } finally { | ||
| ac.abort(); | ||
| for (const c of crons) { | ||
| await c; | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| Deno.test(async function duplicateCrons() { | ||
| const ac = new AbortController(); | ||
| const c = Deno.cron("abc", "*/20 * * * *", () => { | ||
| }, { signal: ac.signal }); | ||
| try { | ||
| assertThrows( | ||
| () => Deno.cron("abc", "*/20 * * * *", () => {}), | ||
| TypeError, | ||
| "Cron with this name already exists", | ||
| ); | ||
| } finally { | ||
| ac.abort(); | ||
| await c; | ||
| } | ||
| }); | ||
|
|
||
| Deno.test(async function basicTest() { | ||
| Deno.env.set("DENO_CRON_TEST_SCHEDULE_OFFSET", "100"); | ||
|
|
||
| let count = 0; | ||
| const promise = deferred(); | ||
| const ac = new AbortController(); | ||
| const c = Deno.cron("abc", "*/20 * * * *", () => { | ||
| count++; | ||
| if (count > 5) { | ||
| promise.resolve(); | ||
| } | ||
| }, { signal: ac.signal }); | ||
| try { | ||
| await promise; | ||
| } finally { | ||
| ac.abort(); | ||
| await c; | ||
| } | ||
| }); | ||
|
|
||
| Deno.test(async function multipleCrons() { | ||
| Deno.env.set("DENO_CRON_TEST_SCHEDULE_OFFSET", "100"); | ||
|
|
||
| let count0 = 0; | ||
| let count1 = 0; | ||
| const promise0 = deferred(); | ||
| const promise1 = deferred(); | ||
| const ac = new AbortController(); | ||
| const c0 = Deno.cron("abc", "*/20 * * * *", () => { | ||
| count0++; | ||
| if (count0 > 5) { | ||
| promise0.resolve(); | ||
| } | ||
| }, { signal: ac.signal }); | ||
| const c1 = Deno.cron("xyz", "*/20 * * * *", () => { | ||
| count1++; | ||
| if (count1 > 5) { | ||
| promise1.resolve(); | ||
| } | ||
| }, { signal: ac.signal }); | ||
| try { | ||
| await promise0; | ||
| await promise1; | ||
| } finally { | ||
| ac.abort(); | ||
| await c0; | ||
| await c1; | ||
| } | ||
| }); | ||
|
|
||
| Deno.test(async function overlappingExecutions() { | ||
| Deno.env.set("DENO_CRON_TEST_SCHEDULE_OFFSET", "100"); | ||
|
|
||
| let count = 0; | ||
| const promise0 = deferred(); | ||
| const promise1 = deferred(); | ||
| const ac = new AbortController(); | ||
| const c = Deno.cron("abc", "*/20 * * * *", async () => { | ||
| promise0.resolve(); | ||
| count++; | ||
| await promise1; | ||
| }, { signal: ac.signal }); | ||
| try { | ||
| await promise0; | ||
| } finally { | ||
| await sleep(2000); | ||
| promise1.resolve(); | ||
| ac.abort(); | ||
| await c; | ||
| } | ||
| assertEquals(count, 1); | ||
| }); | ||
|
|
||
| Deno.test(async function retriesWithBackkoffSchedule() { | ||
| Deno.env.set("DENO_CRON_TEST_SCHEDULE_OFFSET", "5000"); | ||
|
|
||
| let count = 0; | ||
| const ac = new AbortController(); | ||
| const c = Deno.cron("abc", "*/20 * * * *", async () => { | ||
| count += 1; | ||
| await sleep(10); | ||
| throw new TypeError("cron error"); | ||
| }, { signal: ac.signal, backoffSchedule: [10, 20] }); | ||
| try { | ||
| await sleep(6000); | ||
| } finally { | ||
| ac.abort(); | ||
| await c; | ||
| } | ||
|
|
||
| // The cron should have executed 3 times (1st attempt and 2 retries). | ||
| assertEquals(count, 3); | ||
| }); |
Oops, something went wrong.