feat: tie scheduled function attemptDeadline to timeoutSeconds

Author: taeold

spec/v2/providers/scheduler.spec.ts

@@ -28,6 +28,7 @@ import { MINIMAL_V2_ENDPOINT } from "../../fixtures";
 import { onInit } from "../../../src/v2/core";
 import { MockRequest } from "../../fixtures/mockrequest";
 import { runHandler } from "../../helper";
+import * as params from "../../../src/params";
 
 const MINIMAL_SCHEDULE_TRIGGER: ManifestEndpoint["scheduleTrigger"] = {
   schedule: "",
@@ -67,7 +68,6 @@ describe("schedule", () => {
       expect(schedule.getOpts(options)).to.deep.eq({
         schedule: "* * * * *",
         timeZone: "utc",
-        attemptDeadlineSeconds: undefined,
         retryConfig: {
           retryCount: 3,
           maxRetrySeconds: 1,
@@ -110,7 +110,7 @@ describe("schedule", () => {
         {
           schedule: "* * * * *",
           timeZone: "utc",
-          attemptDeadlineSeconds: 300,
+          timeoutSeconds: 300,
           retryCount: 3,
           maxRetrySeconds: 10,
           minBackoffSeconds: 11,
@@ -127,6 +127,7 @@ describe("schedule", () => {
         platform: "gcfv2",
         labels: { key: "val" },
         region: ["us-central1"],
+        timeoutSeconds: 300,
         scheduleTrigger: {
           schedule: "* * * * *",
           timeZone: "utc",
@@ -157,13 +158,12 @@ describe("schedule", () => {
         () => console.log(1)
       );
 
-      expect(schfn.__endpoint).to.deep.eq({
+      expect(schfn.__endpoint).to.deep.equal({
         platform: "gcfv2",
         labels: {},
         scheduleTrigger: {
           schedule: "* * * * *",
           timeZone: undefined,
-          attemptDeadlineSeconds: undefined,
           retryConfig: {
             retryCount: undefined,
             maxRetrySeconds: undefined,
@@ -181,6 +181,33 @@ describe("schedule", () => {
       ]);
     });
 
+    it("should cap attemptDeadlineSeconds at 1800s", () => {
+      const schfn = schedule.onSchedule(
+        {
+          schedule: "* * * * *",
+          timeoutSeconds: 3600,
+        },
+        () => undefined
+      );
+
+      expect(schfn.__endpoint.timeoutSeconds).to.deep.eq(3600);
+      expect(schfn.__endpoint.scheduleTrigger?.attemptDeadlineSeconds).to.deep.eq(1800);
+    });
+
+    it("should set attemptDeadlineSeconds from Expression timeoutSeconds", () => {
+      const timeout = params.defineInt("TIMEOUT");
+      const schfn = schedule.onSchedule(
+        {
+          schedule: "* * * * *",
+          timeoutSeconds: timeout,
+        },
+        () => undefined
+      );
+
+      expect(schfn.__endpoint.timeoutSeconds).to.deep.eq(timeout);
+      expect(schfn.__endpoint.scheduleTrigger?.attemptDeadlineSeconds).to.deep.eq(timeout);
+    });
+
     it("should have a .run method", async () => {
       const testObj = {
         foo: "bar",

src/v2/providers/scheduler.ts

@@ -42,7 +42,6 @@ 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;
@@ -64,7 +63,6 @@ export function getOpts(args: string | ScheduleOptions): SeparatedOpts {
   return {
     schedule: args.schedule,
     timeZone: args.timeZone,
-    attemptDeadlineSeconds: args.attemptDeadlineSeconds,
     retryConfig: {
       retryCount: args.retryCount,
       maxRetrySeconds: args.maxRetrySeconds,
@@ -113,12 +111,6 @@ export interface ScheduleOptions extends options.GlobalOptions {
   /** The timezone that the schedule executes in. */
   timeZone?: timezone | Expression<string> | ResetValue;
 
-  /**
-   * The deadline for job attempts in seconds. If the request handler does not respond by this deadline,
-   * the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure.
-   * The value must be between 15 and 1800. Defaults to 180.
-   */
-  attemptDeadlineSeconds?: number | Expression<number> | ResetValue;
 
   /** The number of retry attempts for a failed run. */
   retryCount?: number | Expression<number> | ResetValue;
@@ -205,7 +197,17 @@ export function onSchedule(
     scheduleTrigger: initV2ScheduleTrigger(separatedOpts.schedule, globalOpts, separatedOpts.opts),
   };
 
-  copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone", "attemptDeadlineSeconds");
+  copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone");
+  if (ep.timeoutSeconds) {
+    if (typeof ep.timeoutSeconds === "number") {
+      ep.scheduleTrigger.attemptDeadlineSeconds = Math.min(ep.timeoutSeconds, 1800);
+    } else {
+      // For Expressions, we can't easily cap it here, but Cloud Scheduler will reject it if it's too high.
+      // We'll pass it through and let the backend handle validation if possible, or just set it.
+      // Given the constraints of Expressions, we'll just set it to the expression.
+      ep.scheduleTrigger.attemptDeadlineSeconds = ep.timeoutSeconds;
+    }
+  }
   copyIfPresent(
     ep.scheduleTrigger.retryConfig,
     separatedOpts.retryConfig,