development/deno
development/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno synced 2024-08-25 02:57:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

BREAKING(unstable): remove Deno.cron() overload (#22035)

Browse source 
This change removes the currently deprecated `Deno.cron()` overload with
`options` as a potential last argument.

This might be fine to do now, in a major release, as `Deno.cron()` is an
unstable API. I thought of doing this while working on #22021. If this
is not ready to remove, I can instead set the removal version of this
overload for Deno v2.

Note: this overload was deprecated in Deno v1.38.2 (#21225). So it's
been deprecated for over 2 months.
This commit is contained in:
Asher Gomez 2024-01-23 23:07:54 +11:00 committed by GitHub
parent 6238b0a457
commit d6d437c4dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 23 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
cli/tests/unit/cron_test.ts
View file

@ -297,13 +297,13 @@ Deno.test(async function retriesWithBackoffScheduleOldApi() {
let count = 0;
const ac = new AbortController();
const c = Deno.cron("abc2", "*/20 * * * *", async () => {
const c = Deno.cron("abc2", "*/20 * * * *", {
signal: ac.signal,
backoffSchedule: [10, 20],
}, async () => {
count += 1;
await sleep(10);
throw new TypeError("cron error");
}, {
signal: ac.signal,
backoffSchedule: [10, 20],
});
try {
@ -380,3 +380,14 @@ Deno.test("Parse schedule to string - string", () => {
const result = parseScheduleToString("* * * * *");
assertEquals(result, "* * * * *");
});
Deno.test("error on two handlers", () => {
assertThrows(
() => {
// @ts-ignore test
Deno.cron("abc", "* * * * *", () => {}, () => {});
},
TypeError,
"Deno.cron requires a single handler",
);
});

31
cli/tsc/dts/lib.deno.unstable.d.ts vendored
View file

@ -1263,37 +1263,6 @@ declare namespace Deno {
handler: () => Promise<void> | void,
): Promise<void>;
/** **UNSTABLE**: New API, yet to be vetted.
*
* Create a cron job that will periodically execute the provided handler
* callback based on the specified schedule.
*
* `schedule` can be a string in the Unix cron format or in JSON format
* as specified by interface {@linkcode CronSchedule}, where time is specified
* using UTC time zone.
*
* ```ts
* Deno.cron("sample cron", "20 * * * *", () => {
* console.log("cron job executed");
* });
* ```
* `backoffSchedule` option can be used to specify the retry policy for failed
* executions. Each element in the array represents the number of milliseconds
* to wait before retrying the execution. For example, `[1000, 5000, 10000]`
* means that a failed execution will be retried at most 3 times, with 1
* second, 5 seconds, and 10 seconds delay between each retry.
*
* @category Cron
* @deprecated Use other {@linkcode cron} overloads instead. This overload
* will be removed in the future.
*/
export function cron(
name: string,
schedule: string | CronSchedule,
handler: () => Promise<void> | void,
options: { backoffSchedule?: number[]; signal?: AbortSignal },
): Promise<void>;
/** **UNSTABLE**: New API, yet to be vetted.
*
* A key to be persisted in a {@linkcode Deno.Kv}. A key is a sequence

17
ext/cron/01_cron.ts
View file

@ -84,9 +84,7 @@ function cron(
handlerOrOptions1:
| (() => Promise<void> | void)
| ({ backoffSchedule?: number[]; signal?: AbortSignal }),
handlerOrOptions2?:
| (() => Promise<void> | void)
| ({ backoffSchedule?: number[]; signal?: AbortSignal }),
handler2?: () => Promise<void> | void,
) {
if (name === undefined) {
throw new TypeError("Deno.cron requires a unique name");
@ -98,16 +96,17 @@ function cron(
schedule = parseScheduleToString(schedule);
let handler: () => Promise<void> | void;
let options: { backoffSchedule?: number[]; signal?: AbortSignal } | undefined;
let options:
| { backoffSchedule?: number[]; signal?: AbortSignal }
| undefined = undefined;
if (typeof handlerOrOptions1 === "function") {
handler = handlerOrOptions1;
if (typeof handlerOrOptions2 === "function") {
throw new TypeError("options must be an object");
if (handler2 !== undefined) {
throw new TypeError("Deno.cron requires a single handler");
}
options = handlerOrOptions2;
} else if (typeof handlerOrOptions2 === "function") {
handler = handlerOrOptions2;
} else if (typeof handler2 === "function") {
handler = handler2;
options = handlerOrOptions1;
} else {
throw new TypeError("Deno.cron requires a handler");