Skip to content

feat: add attemptDeadlineSeconds support to v2 scheduled functions #1771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
taeold wants to merge 1 commit into from
Closed

feat: add attemptDeadlineSeconds support to v2 scheduled functions #1771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spec/runtime/manifest.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ describe("initScheduleTrigger", () => {
expect(st).to.deep.eq({
schedule: "every 30 minutes",
timeZone: RESET_VALUE,
attemptDeadlineSeconds: RESET_VALUE,
retryConfig: {
retryCount: RESET_VALUE,
maxDoublings: RESET_VALUE,
Expand Down
6 changes: 6 additions & 0 deletions spec/v2/providers/scheduler.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import { runHandler } from "../../helper";
const MINIMAL_SCHEDULE_TRIGGER: ManifestEndpoint["scheduleTrigger"] = {
schedule: "",
timeZone: options.RESET_VALUE,
attemptDeadlineSeconds: options.RESET_VALUE,
retryConfig: {
retryCount: options.RESET_VALUE,
maxRetrySeconds: options.RESET_VALUE,
Expand All @@ -54,6 +55,7 @@ describe("schedule", () => {
const options: schedule.ScheduleOptions = {
schedule: "* * * * *",
timeZone: "utc",
attemptDeadlineSeconds: 300,
retryCount: 3,
maxRetrySeconds: 1,
minBackoffSeconds: 2,
Expand All @@ -66,6 +68,7 @@ describe("schedule", () => {
expect(schedule.getOpts(options)).to.deep.eq({
schedule: "* * * * *",
timeZone: "utc",
attemptDeadlineSeconds: 300,
retryConfig: {
retryCount: 3,
maxRetrySeconds: 1,
Expand Down Expand Up @@ -108,6 +111,7 @@ describe("schedule", () => {
{
schedule: "* * * * *",
timeZone: "utc",
attemptDeadlineSeconds: 600,
retryCount: 3,
maxRetrySeconds: 10,
minBackoffSeconds: 11,
Expand All @@ -127,6 +131,7 @@ describe("schedule", () => {
scheduleTrigger: {
schedule: "* * * * *",
timeZone: "utc",
attemptDeadlineSeconds: 600,
retryConfig: {
retryCount: 3,
maxRetrySeconds: 10,
Expand Down Expand Up @@ -159,6 +164,7 @@ describe("schedule", () => {
scheduleTrigger: {
schedule: "* * * * *",
timeZone: undefined,
attemptDeadlineSeconds: undefined,
retryConfig: {
retryCount: undefined,
maxRetrySeconds: undefined,
Expand Down
8 changes: 7 additions & 1 deletion src/runtime/manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ export interface ManifestEndpoint {
scheduleTrigger?: {
schedule: string | Expression<string>;
timeZone?: string | Expression<string> | ResetValue;
attemptDeadlineSeconds?: number | Expression<number> | ResetValue;
retryConfig?: {
retryCount?: number | Expression<number> | ResetValue;
maxRetrySeconds?: string | Expression<string> | ResetValue;
Expand Down Expand Up @@ -302,5 +303,10 @@ export function initV2ScheduleTrigger(
schedule: string | Expression<string>,
...opts: ManifestOptions[]
): ManifestEndpoint["scheduleTrigger"] {
return initScheduleTrigger(RESETTABLE_V2_SCHEDULE_OPTIONS, schedule, ...opts);
const trigger = initScheduleTrigger(RESETTABLE_V2_SCHEDULE_OPTIONS, schedule, ...opts);
// Set attemptDeadlineSeconds for v2 only
if (trigger.timeZone === RESET_VALUE) {
trigger.attemptDeadlineSeconds = RESET_VALUE;
}
return trigger;
}
7 changes: 6 additions & 1 deletion src/v2/providers/scheduler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import { withInit } from "../../common/onInit";
interface SeparatedOpts {
schedule: string | Expression<string>;
timeZone?: timezone | Expression<string> | ResetValue;
attemptDeadlineSeconds?: number | Expression<number> | ResetValue;
retryConfig?: {
retryCount?: number | Expression<number> | ResetValue;
maxRetrySeconds?: number | Expression<number> | ResetValue;
Expand All @@ -63,6 +64,7 @@ export function getOpts(args: string | ScheduleOptions): SeparatedOpts {
return {
schedule: args.schedule,
timeZone: args.timeZone,
attemptDeadlineSeconds: args.attemptDeadlineSeconds,
retryConfig: {
retryCount: args.retryCount,
maxRetrySeconds: args.maxRetrySeconds,
Expand Down Expand Up @@ -111,6 +113,9 @@ export interface ScheduleOptions extends options.GlobalOptions {
/** The timezone that the schedule executes in. */
timeZone?: timezone | Expression<string> | ResetValue;

/** The deadline for attempting the job in seconds. */
attemptDeadlineSeconds?: number | Expression<number> | ResetValue;

/** The number of retry attempts for a failed run. */
retryCount?: number | Expression<number> | ResetValue;

Expand Down Expand Up @@ -196,7 +201,7 @@ export function onSchedule(
scheduleTrigger: initV2ScheduleTrigger(separatedOpts.schedule, globalOpts, separatedOpts.opts),
};

copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone");
copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone", "attemptDeadlineSeconds");
copyIfPresent(
ep.scheduleTrigger.retryConfig,
separatedOpts.retryConfig,
Expand Down
Loading