add more validation to containers config #9934
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "wrangler": patch | ||
| --- | ||
|
|
||
| Add more thorough validation to containers configuration |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2421,7 +2421,6 @@ function validateContainerApp( | |
| name += config === undefined ? "" : `-${envName}`; | ||
| containerAppOptional.name = name.toLowerCase().replace(/ /g, "-"); | ||
| } | ||
| if ( | ||
| !containerAppOptional.configuration?.image && | ||
| !containerAppOptional.image | ||
|
|
@@ -2430,6 +2429,11 @@ function validateContainerApp( | |
| `"containers.image" field must be defined for each container app. This should be the path to your Dockerfile or a image URI pointing to the Cloudflare registry.` | ||
| ); | ||
| } | ||
| if ("configuration" in containerAppOptional) { | ||
| diagnostics.warnings.push( | ||
| `"containers.configuration" is deprecated. Use top level "containers" fields instead. "configuration.image" should be "image", "configuration.disk" should be set via "instance_type".` | ||
| ); | ||
| } | ||
|
|
||
| // Validate that we have an image configuration for this container app. | ||
| // For legacy reasons we have to check both at containerAppOptional.image and | ||
|
|
@@ -2469,19 +2473,6 @@ function validateContainerApp( | |
| `"containers.rollout_step_percentage" field should be a number between 25 and 100, but got ${containerAppOptional.rollout_step_percentage}` | ||
| ); | ||
| } | ||
| // Leaving for legacy reasons | ||
| // TODO: When cleaning up container.configuration usage in other places clean this up | ||
| // as well. | ||
|
|
@@ -2490,14 +2481,99 @@ function validateContainerApp( | |
| `"containers.configuration" is defined as an array, it should be an object` | ||
| ); | ||
| } | ||
| validateOptionalProperty( | ||
| diagnostics, | ||
| field, | ||
| "rollout_kind", | ||
| containerAppOptional.rollout_kind, | ||
| "string", | ||
| ["full_auto", "full_manual", "none"] | ||
| ); | ||
| validateOptionalProperty( | ||
| diagnostics, | ||
| field, | ||
| "instance_type", | ||
| containerAppOptional.instance_type, | ||
| "string", | ||
| ["dev", "basic", "standard"] | ||
| ); | ||
| validateOptionalProperty( | ||
| diagnostics, | ||
| field, | ||
| "max_instances", | ||
| containerAppOptional.max_instances, | ||
| "number" | ||
| ); | ||
| if ( | ||
| containerAppOptional.max_instances !== undefined && | ||
| containerAppOptional.max_instances < 0 | ||
| ) { | ||
| diagnostics.errors.push( | ||
| `"containers.max_instances" field should be a positive number, but got ${containerAppOptional.max_instances}` | ||
| ); | ||
| } | ||
| validateOptionalProperty( | ||
| diagnostics, | ||
| field, | ||
| "image_build_context", | ||
| containerAppOptional.image_build_context, | ||
| "string" | ||
| ); | ||
| validateOptionalProperty( | ||
| diagnostics, | ||
| field, | ||
| "image_vars", | ||
| containerAppOptional.image_vars, | ||
| "object" | ||
| ); | ||
| validateOptionalProperty( | ||
| diagnostics, | ||
| field, | ||
| "scheduling_policy", | ||
| containerAppOptional.scheduling_policy, | ||
| "string", | ||
| ["regional", "moon", "default"] | ||
| ); | ||
|
|
||
| // Add deprecation warnings for legacy fields | ||
| if ("instances" in containerAppOptional) { | ||
| diagnostics.warnings.push( | ||
| `"containers.instances" is deprecated. Use "containers.max_instances" instead.` | ||
| ); | ||
| } | ||
| if ("durable_objects" in containerAppOptional) { | ||
| diagnostics.warnings.push( | ||
| `"containers.durable_objects" is deprecated. Use the "class_name" field instead.` | ||
| ); | ||
| } | ||
|
|
||
| validateAdditionalProperties( | ||
| diagnostics, | ||
| field, | ||
| Object.keys(containerAppOptional), | ||
| [ | ||
| "name", | ||
| "instances", | ||
| "max_instances", | ||
| "image", | ||
| "image_build_context", | ||
| "image_vars", | ||
| "class_name", | ||
| "scheduling_policy", | ||
| "instance_type", | ||
| "configuration", | ||
| "constraints", | ||
| "rollout_step_percentage", | ||
| "rollout_kind", | ||
| "durable_objects", | ||
| ] | ||
| ); | ||
| if ("configuration" in containerAppOptional) { | ||
| validateAdditionalProperties( | ||
| diagnostics, | ||
| `${field}.configuration`, | ||
| Object.keys(containerAppOptional.configuration), | ||
| ["image", "secrets", "labels", "disk", "vcpu", "memory_mib"] | ||
|
Member
There was a problem hiding this comment. I don't think workers-sdk/packages/wrangler/src/config/environment.ts Lines 109 to 114 in 64af5da Users shouldn't be able to set these directly in the Wrangler config anyway, they are set by the instance type.
Member
There was a problem hiding this comment. these fields are being used right now for customers that need custom instance types, see #9962 for better handling for custom instance types
Member
There was a problem hiding this comment. Do they need to be added to the type definition then?
Contributor
Author
There was a problem hiding this comment. i'd strongly prefer to have them in the type definition so that we're not trying to read values that typescript doesn't expect to be there. they're hidden from the wrangler config schema, so we don't need to worry about showing this to the general user.
Member
There was a problem hiding this comment. I agree, they should be in the type definition |
||
| ); | ||
| } | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.