add rollout_active_grace_period to container config (#10315)

* update api client

* pass rollout_active_grace_period from config to api

* add to create application too

* add tests

* changeset

* lint

* fixup validation

* feedback

Author: emily-shen

.changeset/poor-hoops-cover.md

@@ -0,0 +1,7 @@
+---
+"wrangler": patch
+---
+
+Add `rollout_active_grace_period` option to containers configuration.
+
+This allows users to configure how long an active container should keep running for during a rollout, before the upgrade is applied.

packages/containers-shared/src/client/index.ts

@@ -30,6 +30,7 @@ export type { ApplicationNotFoundError } from "./models/ApplicationNotFoundError
 export type { ApplicationPriorities } from "./models/ApplicationPriorities";
 export type { ApplicationPriority } from "./models/ApplicationPriority";
 export { ApplicationRollout } from "./models/ApplicationRollout";
+export type { ApplicationRolloutActiveGracePeriod } from "./models/ApplicationRolloutActiveGracePeriod";
 export type { ApplicationRolloutProgress } from "./models/ApplicationRolloutProgress";
 export type { ApplicationSchedulingHint } from "./models/ApplicationSchedulingHint";
 export type { ApplicationStatus } from "./models/ApplicationStatus";

packages/containers-shared/src/client/models/Application.ts

@@ -10,6 +10,7 @@ import type { ApplicationID } from "./ApplicationID";
 import type { ApplicationJobsConfig } from "./ApplicationJobsConfig";
 import type { ApplicationName } from "./ApplicationName";
 import type { ApplicationPriorities } from "./ApplicationPriorities";
+import type { ApplicationRolloutActiveGracePeriod } from "./ApplicationRolloutActiveGracePeriod";
 import type { ApplicationSchedulingHint } from "./ApplicationSchedulingHint";
 import type { DurableObjectsConfiguration } from "./DurableObjectsConfiguration";
 import type { ISO8601Timestamp } from "./ISO8601Timestamp";
@@ -43,5 +44,6 @@ export type Application = {
 	durable_objects?: DurableObjectsConfiguration;
 	scheduling_hint?: ApplicationSchedulingHint;
 	active_rollout_id?: RolloutID;
+	rollout_active_grace_period?: ApplicationRolloutActiveGracePeriod;
 	health?: ApplicationHealth;
 };

packages/containers-shared/src/client/models/ApplicationRolloutActiveGracePeriod.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Grace period for active instances to stay alive before becoming elibile for shutdown signal due to a rollout, in seconds.
+ * Defaults to 0.
+ *
+ */
+export type ApplicationRolloutActiveGracePeriod = number;

packages/containers-shared/src/client/models/CreateApplicationRequest.ts

@@ -6,6 +6,7 @@ import type { ApplicationAffinities } from "./ApplicationAffinities";
 import type { ApplicationConstraints } from "./ApplicationConstraints";
 import type { ApplicationJobsConfig } from "./ApplicationJobsConfig";
 import type { ApplicationPriorities } from "./ApplicationPriorities";
+import type { ApplicationRolloutActiveGracePeriod } from "./ApplicationRolloutActiveGracePeriod";
 import type { DurableObjectsConfiguration } from "./DurableObjectsConfiguration";
 import type { SchedulingPolicy } from "./SchedulingPolicy";
 import type { UserDeploymentConfiguration } from "./UserDeploymentConfiguration";
@@ -40,4 +41,5 @@ export type CreateApplicationRequest = {
 	durable_objects?: DurableObjectsConfiguration;
 	affinities?: ApplicationAffinities;
 	priorities?: ApplicationPriorities;
+	rollout_active_grace_period?: ApplicationRolloutActiveGracePeriod;
 };

packages/containers-shared/src/client/models/ModifyApplicationRequestBody.ts

@@ -5,6 +5,7 @@
 import type { ApplicationAffinities } from "./ApplicationAffinities";
 import type { ApplicationConstraints } from "./ApplicationConstraints";
 import type { ApplicationPriorities } from "./ApplicationPriorities";
+import type { ApplicationRolloutActiveGracePeriod } from "./ApplicationRolloutActiveGracePeriod";
 import type { ModifyUserDeploymentConfiguration } from "./ModifyUserDeploymentConfiguration";
 import type { SchedulingPolicy } from "./SchedulingPolicy";
 
@@ -30,6 +31,7 @@ export type ModifyApplicationRequestBody = {
 	priorities?: ApplicationPriorities;
 	scheduling_policy?: SchedulingPolicy;
 	constraints?: ApplicationConstraints;
+	rollout_active_grace_period?: ApplicationRolloutActiveGracePeriod;
 	/**
 	 * The deployment configuration of all deployments created by this application.
 	 * Right now, if you modify the application configuration, only new deployments

packages/containers-shared/src/types.ts

@@ -65,6 +65,7 @@ export type SharedContainerConfig = {
 	rollout_step_percentage: number;
 	/** if undefined in config, defaults to "full_auto" */
 	rollout_kind: "full_auto" | "full_manual" | "none";
+	rollout_active_grace_period?: number;
 	constraints: {
 		regions?: string[];
 		cities?: string[];

packages/wrangler/src/__tests__/config/configuration.test.ts

@@ -2436,6 +2436,8 @@ describe("normalizeAndValidateConfig()", () => {
 								image_vars: "invalid",
 								scheduling_policy: "invalid",
 								unknown_field: "value",
+								rollout_active_grace_period: "60s",
+								rollout_step_percentage: "full",
 							},
 						],
 					} as unknown as RawConfig,
@@ -2453,14 +2455,43 @@ describe("normalizeAndValidateConfig()", () => {
 					  - Expected \\"containers.image_build_context\\" to be of type string but got 123.
 					  - The image \\"something\\" does not appear to be a valid path to a Dockerfile, or a valid image registry path:
 					    If this is an image registry path, it needs to include at least a tag ':' (e.g: docker.io/httpd:1)
+					  - \\"containers.rollout_step_percentage\\" field should be a number between 25 and 100, but got \\"full\\"
 					  - Expected \\"containers.rollout_kind\\" field to be one of [\\"full_auto\\",\\"full_manual\\",\\"none\\"] but got \\"invalid\\".
+					  - \\"containers.rollout_active_grace_period\\" field should be a positive number but got \\"60s\\"
 					  - Expected \\"containers.max_instances\\" to be of type number but got \\"invalid\\".
 					  - Expected \\"containers.image_vars\\" to be of type object but got \\"invalid\\".
 					  - Expected \\"containers.scheduling_policy\\" field to be one of [\\"regional\\",\\"moon\\",\\"default\\"] but got \\"invalid\\".
 					  - Expected \\"containers.instance_type\\" field to be one of [\\"dev\\",\\"basic\\",\\"standard\\"] but got \\"invalid\\"."
 				`);
 			});
 
+			it("should error if rollout_active_grace_period and rollout_step_percentage are out of range", () => {
+				const { diagnostics } = normalizeAndValidateConfig(
+					{
+						name: "test-worker",
+						containers: [
+							{
+								image: "blah",
+								class_name: "test-class",
+								rollout_active_grace_period: -1,
+								rollout_step_percentage: 10,
+							},
+						],
+					} as unknown as RawConfig,
+					undefined,
+					undefined,
+					{ env: undefined }
+				);
+
+				expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
+					"Processing wrangler configuration:
+					  - The image \\"blah\\" does not appear to be a valid path to a Dockerfile, or a valid image registry path:
+					    If this is an image registry path, it needs to include at least a tag ':' (e.g: docker.io/httpd:1)
+					  - \\"containers.rollout_step_percentage\\" field should be a number between 25 and 100, but got \\"10\\"
+					  - \\"containers.rollout_active_grace_period\\" field should be a positive number but got \\"-1\\""
+				`);
+			});
+
 			it("should warn for deprecated container fields", () => {
 				const { diagnostics } = normalizeAndValidateConfig(
 					{

packages/wrangler/src/__tests__/containers/config.test.ts

@@ -387,6 +387,7 @@ describe("getNormalizedContainerOptions", () => {
 					scheduling_policy: "regional",
 					rollout_step_percentage: 50,
 					rollout_kind: "full_manual",
+					rollout_active_grace_period: 600,
 					instance_type: "basic",
 					constraints: {
 						tier: 2,
@@ -414,6 +415,7 @@ describe("getNormalizedContainerOptions", () => {
 			scheduling_policy: "regional",
 			rollout_step_percentage: 50,
 			rollout_kind: "full_manual",
+			rollout_active_grace_period: 600,
 			instance_type: "basic",
 			image_uri: "registry.example.com/test:latest",
 			constraints: {

packages/wrangler/src/__tests__/containers/deploy.test.ts

@@ -143,7 +143,12 @@ describe("wrangler deploy with containers", () => {
 		mockGetVersion("Galaxy-Class");
 		writeWranglerConfig({
 			...DEFAULT_DURABLE_OBJECTS,
-			containers: [DEFAULT_CONTAINER_FROM_REGISTRY],
+			containers: [
+				{
+					...DEFAULT_CONTAINER_FROM_REGISTRY,
+					rollout_active_grace_period: 600,
+				},
+			],
 		});
 
 		mockGetApplications([]);
@@ -152,6 +157,7 @@ describe("wrangler deploy with containers", () => {
 			name: "my-container",
 			max_instances: 10,
 			scheduling_policy: SchedulingPolicy.DEFAULT,
+			rollout_active_grace_period: 600,
 		});
 
 		await runWrangler("deploy index.js");
@@ -182,6 +188,7 @@ describe("wrangler deploy with containers", () => {
 			│   scheduling_policy = \\"default\\"
 			│   instances = 0
 			│   max_instances = 10
+			│   rollout_active_grace_period = 600
 			│
 			│     [containers.configuration]
 			│     image = \\"docker.io/hello:world\\"
@@ -512,7 +519,12 @@ describe("wrangler deploy with containers", () => {
 		setupDockerMocks("my-container", "Galaxy");
 		writeWranglerConfig({
 			...DEFAULT_DURABLE_OBJECTS,
-			containers: [DEFAULT_CONTAINER_FROM_DOCKERFILE],
+			containers: [
+				{
+					...DEFAULT_CONTAINER_FROM_DOCKERFILE,
+					rollout_active_grace_period: 600,
+				},
+			],
 		});
 		mockGetApplications([
 			{
@@ -540,6 +552,7 @@ describe("wrangler deploy with containers", () => {
 				durable_objects: {
 					namespace_id: "1",
 				},
+				rollout_active_grace_period: 500,
 			},
 		]);
 		fs.writeFileSync("./Dockerfile", "FROM scratch");
@@ -549,6 +562,7 @@ describe("wrangler deploy with containers", () => {
 				image: "registry.cloudflare.com/some-account-id/my-container:Galaxy",
 			},
 			max_instances: 10,
+			rollout_active_grace_period: 600,
 		});
 		mockCreateApplicationRollout({
 			description: "Progressive update",
@@ -570,6 +584,8 @@ describe("wrangler deploy with containers", () => {
 			│ - max_instances = 2
 			│ + max_instances = 10
 			│   name = \\"my-container\\"
+			│ - rollout_active_grace_period = 500
+			│ + rollout_active_grace_period = 600
 			│   scheduling_policy = \\"default\\"
 			│
 			│     [containers.configuration]