feat(scheduler): add support for attemptDeadline in onSchedule

Author: Skyfury2651

spec/runtime/manifest.spec.ts

@@ -265,6 +265,7 @@ describe("initScheduleTrigger", () => {
         maxRetryDuration: RESET_VALUE,
         minBackoffDuration: RESET_VALUE,
         maxBackoffDuration: RESET_VALUE,
+        attemptDeadline: RESET_VALUE,
       },
     });
   });
@@ -292,6 +293,7 @@ describe("initScheduleTrigger", () => {
         maxRetrySeconds: RESET_VALUE,
         minBackoffSeconds: RESET_VALUE,
         maxBackoffSeconds: RESET_VALUE,
+        attemptDeadline: RESET_VALUE,
       },
     });
   });

spec/v1/cloud-functions.spec.ts

@@ -212,6 +212,7 @@ describe("makeCloudFunction", () => {
           maxDoublings: RESET_VALUE,
           maxRetryDuration: RESET_VALUE,
           minBackoffDuration: RESET_VALUE,
+          attemptDeadline: RESET_VALUE,
         },
       },
       labels: {},

spec/v1/providers/fixtures.ts

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

spec/v1/providers/pubsub.spec.ts

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

spec/v2/providers/scheduler.spec.ts

@@ -38,6 +38,7 @@ const MINIMAL_SCHEDULE_TRIGGER: ManifestEndpoint["scheduleTrigger"] = {
     minBackoffSeconds: options.RESET_VALUE,
     maxBackoffSeconds: options.RESET_VALUE,
     maxDoublings: options.RESET_VALUE,
+    attemptDeadline: options.RESET_VALUE,
   },
 };
 
@@ -103,6 +104,20 @@ describe("schedule", () => {
       ]);
     });
 
+    it("should create a schedule function with attemptDeadline", () => {
+      const schfn = schedule.onSchedule(
+        {
+          schedule: "* * * * *",
+          attemptDeadline: "320s",
+        },
+        () => undefined
+      );
+
+      expect(schfn.__endpoint.scheduleTrigger?.retryConfig?.attemptDeadline).to.equal(
+        "320s"
+      );
+    });
+
     it("should create a schedule function given options", () => {
       const schfn = schedule.onSchedule(
         {
@@ -133,6 +148,7 @@ describe("schedule", () => {
             minBackoffSeconds: 11,
             maxBackoffSeconds: 12,
             maxDoublings: 2,
+            attemptDeadline: options.RESET_VALUE,
           },
         },
       });

src/runtime/manifest.ts

@@ -107,6 +107,7 @@ export interface ManifestEndpoint {
       maxRetryDuration?: string | Expression<string> | ResetValue;
       minBackoffDuration?: string | Expression<string> | ResetValue;
       maxBackoffDuration?: string | Expression<string> | ResetValue;
+      attemptDeadline?: string | Expression<string> | ResetValue;
     };
   };
 
@@ -254,6 +255,7 @@ const RESETTABLE_V1_SCHEDULE_OPTIONS: Omit<
   maxRetryDuration: null,
   maxBackoffDuration: null,
   minBackoffDuration: null,
+  attemptDeadline: null,
 };
 
 const RESETTABLE_V2_SCHEDULE_OPTIONS: Omit<
@@ -265,6 +267,7 @@ const RESETTABLE_V2_SCHEDULE_OPTIONS: Omit<
   maxRetrySeconds: null,
   minBackoffSeconds: null,
   maxBackoffSeconds: null,
+  attemptDeadline: null,
 };
 
 function initScheduleTrigger(

src/v1/cloud-functions.ts

@@ -485,7 +485,8 @@ export function makeCloudFunction<EventData>({
           "maxDoublings",
           "maxBackoffDuration",
           "maxRetryDuration",
-          "minBackoffDuration"
+          "minBackoffDuration",
+          "attemptDeadline"
         );
       } 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

@@ -48,6 +48,7 @@ interface SeparatedOpts {
     minBackoffSeconds?: number | Expression<number> | ResetValue;
     maxBackoffSeconds?: number | Expression<number> | ResetValue;
     maxDoublings?: number | Expression<number> | ResetValue;
+    attemptDeadline?: string | Expression<string> | ResetValue;
   };
   opts: options.GlobalOptions;
 }
@@ -60,16 +61,22 @@ export function getOpts(args: string | ScheduleOptions): SeparatedOpts {
       opts: {} as options.GlobalOptions,
     };
   }
+  const retryConfig: any = {
+    retryCount: args.retryCount,
+    maxRetrySeconds: args.maxRetrySeconds,
+    minBackoffSeconds: args.minBackoffSeconds,
+    maxBackoffSeconds: args.maxBackoffSeconds,
+    maxDoublings: args.maxDoublings,
+  };
+  
+  if (args.attemptDeadline !== undefined) {
+    retryConfig.attemptDeadline = args.attemptDeadline;
+  }
+
   return {
     schedule: args.schedule,
     timeZone: args.timeZone,
-    retryConfig: {
-      retryCount: args.retryCount,
-      maxRetrySeconds: args.maxRetrySeconds,
-      minBackoffSeconds: args.minBackoffSeconds,
-      maxBackoffSeconds: args.maxBackoffSeconds,
-      maxDoublings: args.maxDoublings,
-    },
+    retryConfig,
     opts: args as options.GlobalOptions,
   };
 }
@@ -125,6 +132,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;
 }
 
 /**
@@ -204,7 +217,8 @@ export function onSchedule(
     "maxRetrySeconds",
     "minBackoffSeconds",
     "maxBackoffSeconds",
-    "maxDoublings"
+    "maxDoublings",
+    "attemptDeadline"
   );
   func.__endpoint = ep;