feat(scheduler): add support for attemptDeadline in onSchedule

spec/runtime/manifest.spec.ts

@@ -259,6 +259,7 @@ describe("initScheduleTrigger", () => {
     expect(st).to.deep.eq({
       schedule: "every 30 minutes",
       timeZone: RESET_VALUE,
+      attemptDeadline: RESET_VALUE,
       retryConfig: {
         retryCount: RESET_VALUE,
         maxDoublings: RESET_VALUE,
@@ -286,6 +287,7 @@ describe("initScheduleTrigger", () => {
     expect(st).to.deep.eq({
       schedule: "every 30 minutes",
       timeZone: RESET_VALUE,
+      attemptDeadline: RESET_VALUE,
       retryConfig: {
         retryCount: RESET_VALUE,
         maxDoublings: RESET_VALUE,

spec/v1/cloud-functions.spec.ts

@@ -206,6 +206,7 @@ describe("makeCloudFunction", () => {
       platform: "gcfv1",
       scheduleTrigger: {
         ...schedule,
+        attemptDeadline: RESET_VALUE,
         retryConfig: {
           ...schedule.retryConfig,
           maxBackoffDuration: RESET_VALUE,

spec/v1/providers/fixtures.ts

@@ -47,4 +47,5 @@ export const MINIMAL_SCHEDULE_TRIGGER: ManifestEndpoint["scheduleTrigger"] = {
     minBackoffDuration: options.RESET_VALUE,
     maxDoublings: options.RESET_VALUE,
   },
+  attemptDeadline: options.RESET_VALUE,
 };

spec/v1/providers/pubsub.spec.ts

@@ -215,7 +215,9 @@ describe("Pubsub Functions", () => {
         expect(result.__endpoint.scheduleTrigger).to.deep.equal({
           ...MINIMAL_SCHEDULE_TRIGGER,
           schedule: "every 5 minutes",
-          retryConfig,
+          retryConfig: {
+            ...retryConfig,
+          },
         });
         expect(result.__endpoint.labels).to.be.empty;
       });
@@ -249,7 +251,9 @@ describe("Pubsub Functions", () => {
           expect(result.__endpoint.scheduleTrigger).to.deep.equal({
             ...MINIMAL_SCHEDULE_TRIGGER,
             schedule: "every 5 minutes",
-            retryConfig,
+            retryConfig: {
+              ...retryConfig,
+            },
             timeZone: "America/New_York",
           });
           expect(result.__endpoint.labels).to.be.empty;
@@ -341,7 +345,9 @@ describe("Pubsub Functions", () => {
           ...MINIMAL_SCHEDULE_TRIGGER,
           schedule: "every 5 minutes",
           timeZone: RESET_VALUE,
-          retryConfig,
+          retryConfig: {
+            ...retryConfig,
+          },
         });
         expect(result.__endpoint.region).to.deep.equal(["us-east1"]);
         expect(result.__endpoint.availableMemoryMb).to.deep.equal(256);
@@ -382,7 +388,9 @@ describe("Pubsub Functions", () => {
           ...MINIMAL_SCHEDULE_TRIGGER,
           schedule: "every 5 minutes",
           timeZone: "America/New_York",
-          retryConfig,
+          retryConfig: {
+            ...retryConfig,
+          },
         });
         expect(result.__endpoint.region).to.deep.equal(["us-east1"]);
         expect(result.__endpoint.availableMemoryMb).to.deep.equal(256);

spec/v2/providers/scheduler.spec.ts

@@ -39,6 +39,7 @@ const MINIMAL_SCHEDULE_TRIGGER: ManifestEndpoint["scheduleTrigger"] = {
     maxBackoffSeconds: options.RESET_VALUE,
     maxDoublings: options.RESET_VALUE,
   },
+  attemptDeadline: options.RESET_VALUE,
 };
 
 describe("schedule", () => {
@@ -59,6 +60,7 @@ describe("schedule", () => {
         minBackoffSeconds: 2,
         maxBackoffSeconds: 3,
         maxDoublings: 4,
+        attemptDeadline: "120s",
         memory: "128MiB",
         region: "us-central1",
       };
@@ -73,6 +75,7 @@ describe("schedule", () => {
           maxBackoffSeconds: 3,
           maxDoublings: 4,
         },
+        attemptDeadline: "120s",
         opts: {
           ...options,
           memory: "128MiB",
@@ -103,6 +106,20 @@ describe("schedule", () => {
       ]);
     });
 
+    it("should create a schedule function with attemptDeadline", () => {
+      const schfn = schedule.onSchedule(
+        {
+          schedule: "* * * * *",
+          attemptDeadline: "320s",
+        },
+        () => undefined
+      );
+
+      expect(schfn.__endpoint.scheduleTrigger?.attemptDeadline).to.equal(
+        "320s"
+      );
+    });
+
     it("should create a schedule function given options", () => {
       const schfn = schedule.onSchedule(
         {
@@ -113,6 +130,7 @@ describe("schedule", () => {
           minBackoffSeconds: 11,
           maxBackoffSeconds: 12,
           maxDoublings: 2,
+          attemptDeadline: "120s",
           region: "us-central1",
           labels: { key: "val" },
         },
@@ -134,6 +152,7 @@ describe("schedule", () => {
             maxBackoffSeconds: 12,
             maxDoublings: 2,
           },
+          attemptDeadline: "120s",
         },
       });
       expect(schfn.__requiredAPIs).to.deep.eq([
@@ -159,6 +178,7 @@ describe("schedule", () => {
         scheduleTrigger: {
           schedule: "* * * * *",
           timeZone: undefined,
+          attemptDeadline: undefined,
           retryConfig: {
             retryCount: undefined,
             maxRetrySeconds: undefined,

src/runtime/manifest.ts

@@ -108,6 +108,7 @@ export interface ManifestEndpoint {
       minBackoffDuration?: string | Expression<string> | ResetValue;
       maxBackoffDuration?: string | Expression<string> | ResetValue;
     };
+    attemptDeadline?: string | Expression<string> | ResetValue;
   };
 
   blockingTrigger?: {
@@ -280,7 +281,7 @@ function initScheduleTrigger(
     for (const key of Object.keys(resetOptions)) {
       scheduleTrigger.retryConfig[key] = RESET_VALUE;
     }
-    scheduleTrigger = { ...scheduleTrigger, timeZone: RESET_VALUE };
+    scheduleTrigger = { ...scheduleTrigger, timeZone: RESET_VALUE, attemptDeadline: RESET_VALUE };
   }
   return scheduleTrigger;
 }

src/v1/cloud-functions.ts

@@ -485,7 +485,7 @@ export function makeCloudFunction<EventData>({
           "maxDoublings",
           "maxBackoffDuration",
           "maxRetryDuration",
-          "minBackoffDuration"
+          "minBackoffDuration",
         );
       } else {
         endpoint.eventTrigger = {

src/v1/function-configuration.ts

@@ -110,6 +110,11 @@ export interface ScheduleRetryConfig {
    * @defaultValue 5
    */
   maxDoublings?: number | Expression<number> | ResetValue;
+
+  /**
+   * The deadline for each job attempt, specified as a duration string (e.g. "600s").
+   */
+  attemptDeadline?: string | Expression<string> | ResetValue;
 }
 
 /**

src/v2/providers/scheduler.ts

@@ -49,6 +49,7 @@ interface SeparatedOpts {
     maxBackoffSeconds?: number | Expression<number> | ResetValue;
     maxDoublings?: number | Expression<number> | ResetValue;
   };
+  attemptDeadline?: string | Expression<string> | ResetValue;
   opts: options.GlobalOptions;
 }
 
@@ -60,6 +61,7 @@ export function getOpts(args: string | ScheduleOptions): SeparatedOpts {
       opts: {} as options.GlobalOptions,
     };
   }
+
   return {
     schedule: args.schedule,
     timeZone: args.timeZone,
@@ -70,6 +72,7 @@ export function getOpts(args: string | ScheduleOptions): SeparatedOpts {
       maxBackoffSeconds: args.maxBackoffSeconds,
       maxDoublings: args.maxDoublings,
     },
+    attemptDeadline: args.attemptDeadline,
     opts: args as options.GlobalOptions,
   };
 }
@@ -125,6 +128,12 @@ export interface ScheduleOptions extends options.GlobalOptions {
 
   /** The time between will double max doublings times. */
   maxDoublings?: number | Expression<number> | ResetValue;
+
+  /**
+   * The deadline for each job attempt, specified as a duration string (e.g. "600s").
+   * See: https://cloud.google.com/scheduler/docs/reference/rest/v1/projects.locations.jobs#Job
+   */
+  attemptDeadline?: string | Expression<string> | ResetValue;
 }
 
 /**
@@ -197,14 +206,15 @@ export function onSchedule(
   };
 
   copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone");
+  copyIfPresent(ep.scheduleTrigger, separatedOpts, "attemptDeadline");
   copyIfPresent(
     ep.scheduleTrigger.retryConfig,
     separatedOpts.retryConfig,
     "retryCount",
     "maxRetrySeconds",
     "minBackoffSeconds",
     "maxBackoffSeconds",
-    "maxDoublings"
+    "maxDoublings",
   );
   func.__endpoint = ep;