feat: add attemptDeadlineSeconds support to scheduled functions

Author: taeold

src/deploy/functions/backend.ts

@@ -23,6 +23,7 @@ export interface ScheduleTrigger {
   schedule?: string;
   timeZone?: string | null;
   retryConfig?: ScheduleRetryConfig | null;
+  attemptDeadlineSeconds?: number | null;
 }
 
 /** Something that has a ScheduleTrigger */

src/deploy/functions/build.ts

@@ -147,6 +147,7 @@ export interface ScheduleTrigger {
   schedule: string | Expression<string>;
   timeZone?: Field<string>;
   retryConfig?: ScheduleRetryConfig | null;
+  attemptDeadlineSeconds?: Field<number>;
 }
 
 export type HttpsTriggered = { httpsTrigger: HttpsTrigger };
@@ -603,6 +604,11 @@ function discoverTrigger(endpoint: Endpoint, region: string, r: Resolver): backe
     } else if (endpoint.scheduleTrigger.retryConfig === null) {
       bkSchedule.retryConfig = null;
     }
+    if (endpoint.scheduleTrigger.attemptDeadlineSeconds) {
+      bkSchedule.attemptDeadlineSeconds = r.resolveInt(
+        endpoint.scheduleTrigger.attemptDeadlineSeconds,
+      );
+    }
     return { scheduleTrigger: bkSchedule };
   } else if ("taskQueueTrigger" in endpoint) {
     const taskQueueTrigger: backend.TaskQueueTrigger = {};

src/deploy/functions/runtimes/discovery/v1alpha1.spec.ts

@@ -716,6 +716,7 @@ describe("buildFromV1Alpha", () => {
           maxRetrySeconds: 120,
           maxDoublings: 10,
         },
+        attemptDeadlineSeconds: 300,
       };
 
       const yaml: v1alpha1.WireManifest = {
@@ -744,6 +745,7 @@ describe("buildFromV1Alpha", () => {
           maxRetrySeconds: "{{ params.RETRY_DURATION }}",
           maxDoublings: "{{ params.DOUBLINGS }}",
         },
+        attemptDeadlineSeconds: "{{ params.ATTEMPT_DEADLINE }}",
       };
 
       const yaml: v1alpha1.WireManifest = {

src/deploy/functions/runtimes/discovery/v1alpha1.ts

@@ -222,6 +222,7 @@ function assertBuildEndpoint(ep: WireEndpoint, id: string): void {
       schedule: "Field<string>",
       timeZone: "Field<string>?",
       retryConfig: "object?",
+      attemptDeadlineSeconds: "Field<number>?",
     });
     if (ep.scheduleTrigger.retryConfig) {
       assertKeyTypes(prefix + ".scheduleTrigger.retryConfig", ep.scheduleTrigger.retryConfig, {
@@ -377,6 +378,7 @@ function parseEndpointForBuild(
     } else if (ep.scheduleTrigger.retryConfig === null) {
       st.retryConfig = null;
     }
+    copyIfPresent(st, ep.scheduleTrigger, "attemptDeadlineSeconds");
     triggered = { scheduleTrigger: st };
   } else if (build.isTaskQueueTriggered(ep)) {
     const tq: build.TaskQueueTrigger = {};

src/gcp/cloudscheduler.spec.ts

@@ -283,5 +283,32 @@ describe("cloudscheduler", () => {
         },
       });
     });
+
+    it("should copy attemptDeadlineSeconds for v1 endpoints", async () => {
+      expect(
+        await cloudscheduler.jobFromEndpoint(
+          {
+            ...V1_ENDPOINT,
+            scheduleTrigger: {
+              schedule: "every 1 minutes",
+              attemptDeadlineSeconds: 300,
+            },
+          },
+          "appEngineLocation",
+          "1234567",
+        ),
+      ).to.deep.equal({
+        name: "projects/project/locations/appEngineLocation/jobs/firebase-schedule-id-region",
+        schedule: "every 1 minutes",
+        timeZone: "America/Los_Angeles",
+        attemptDeadline: "300s",
+        pubsubTarget: {
+          topicName: "projects/project/topics/firebase-schedule-id-region",
+          attributes: {
+            scheduled: "true",
+          },
+        },
+      });
+    });
   });
 });

src/gcp/cloudscheduler.ts

@@ -55,6 +55,7 @@ export interface Job {
   schedule: string;
   description?: string;
   timeZone?: string | null;
+  attemptDeadline?: string | null;
 
   // oneof target
   httpTarget?: HttpTarget;
@@ -195,6 +196,9 @@ function needUpdate(existingJob: Job, newJob: Job): boolean {
   if (existingJob.timeZone !== newJob.timeZone) {
     return true;
   }
+  if (existingJob.attemptDeadline !== newJob.attemptDeadline) {
+    return true;
+  }
   if (newJob.retryConfig) {
     if (!existingJob.retryConfig) {
       return true;
@@ -258,6 +262,11 @@ export async function jobFromEndpoint(
     );
   }
   job.schedule = endpoint.scheduleTrigger.schedule;
+  if (endpoint.scheduleTrigger.attemptDeadlineSeconds) {
+    job.attemptDeadline = proto.durationFromSeconds(
+      endpoint.scheduleTrigger.attemptDeadlineSeconds,
+    );
+  }
   if (endpoint.scheduleTrigger.retryConfig) {
     job.retryConfig = {};
     proto.copyIfPresent(