[wrangler] add validation to redirected configs in regards to environments by dario-piotrowicz · Pull Request #8596 · cloudflare/workers-sdk

dario-piotrowicz · 2025-03-20T16:35:17Z

This PR adds the following validation behaviors to wrangler deploy commands, that relate
to redirected configs (i.e. config files specified by .wrangler/deploy/config.json files):

redirected configs are supposed to be already flattened configurations without any
environment (i.e. a build tool should generate redirected configs already targeting specific
environments), so if wrangler encounters a redirected config with some environments defined
it should error
given the point above, specifying an environment (--env=my-env) when using redirected
configs is incorrect, so these environments should be ignored and a warning should be
presented to the user

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
Wrangler E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): add note about environments in generated wrangler configuration section cloudflare-docs#21119
- Documentation not necessary because:
Wrangler V3 Backport
- TODO (before merge)
- Wrangler PR: V3 Backport (add validation to redirected configs in regards to environments #8596) #8600
- Not necessary because:

changeset-bot · 2025-03-20T16:35:21Z

🦋 Changeset detected

Latest commit: eabdbf7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
wrangler	Patch
@cloudflare/vitest-pool-workers	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-03-20T17:57:28Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-wrangler-8596

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/8596/npm-package-wrangler-8596

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-wrangler-8596 dev path/to/script.js

Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-workers-bindings-extension-8596 -O ./cloudflare-workers-bindings-extension.0.0.0-vd08c4fc84.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-vd08c4fc84.vsix

create-cloudflare:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-create-cloudflare-8596 --no-auto-update

@cloudflare/kv-asset-handler:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-kv-asset-handler-8596

miniflare:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-miniflare-8596

@cloudflare/pages-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-pages-shared-8596

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-unenv-preset-8596

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-vite-plugin-8596

@cloudflare/vitest-pool-workers:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-vitest-pool-workers-8596

@cloudflare/workers-editor-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-workers-editor-shared-8596

@cloudflare/workers-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-workers-shared-8596

@cloudflare/workflows-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/14271950047/npm-package-cloudflare-workflows-shared-8596

Note that these links will no longer work once the GitHub Actions artifact expires.

[email protected] includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	4.20250321.2
`workerd`	1.20250404.0	1.20250404.0
`workerd --version`	1.20250404.0	2025-04-04

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

dario-piotrowicz · 2025-03-20T18:23:03Z

Pages doesn't really support environments and even shows errors when they are used:

workers-sdk/packages/wrangler/src/pages/deploy.ts

Line 118 in ad774e4

    
           "Pages does not support targeting an environment with the --env flag. Use the --branch flag to target your production or preview branch",

So I don't think that adding tests for this for the pages commands is necessary here 🤔

emily-shen

this would be great to get in!

packages/wrangler/src/config/validation.ts

emily-shen · 2025-04-04T10:11:18Z

packages/wrangler/src/config/validation.ts

+	const definedEnvironments = Object.keys(rawConfig.env ?? {});
+
+	if (isRedirectedConfig && definedEnvironments.length > 0) {
+		diagnostics.errors.push(


is there any way for the user to resolve this? or is this a build tool problem?

is it a build tool problem, build tools should not generate configs containing environments 😕

yeah if a user were to get this there wouldn't be much they could do about it 😕

Perhaps we should ask them to contact the maker of the tool that generated the redirected file?

emily-shen

lock file seems to be broken though

packages/wrangler/src/config/validation.ts

…ments

Co-authored-by: emily-shen <[email protected]>

Co-authored-by: James Opstad <[email protected]>

dario-piotrowicz · 2025-04-04T16:40:38Z

lock file seems to be broken though

lock file fixed 🫡

petebacondarwin · 2025-04-05T13:01:12Z

fixtures/redirected-config-worker/tests/index.test.ts

 		expect(text).toMatchInlineSnapshot(`"Generated: true"`);
 	});

+	it("specifying an environment cause an error since they are supported in redirected configs", async ({


Suggested change

it("specifying an environment cause an error since they are supported in redirected configs", async ({

it("specifying an environment causes an error since they are not supported in redirected configs", async ({

petebacondarwin · 2025-04-05T13:06:54Z

packages/wrangler/src/config/validation.ts

+	const definedEnvironments = Object.keys(rawConfig.env ?? {});
+
+	if (isRedirectedConfig && definedEnvironments.length > 0) {
+		diagnostics.errors.push(


Perhaps we should ask them to contact the maker of the tool that generated the redirected file?

…onments #8596) (#8600) * [wrangler] add validation to redirected configs in regards to environments * error instead of warning on specified environments * Update packages/wrangler/src/config/validation.ts Co-authored-by: emily-shen <[email protected]> * Update packages/wrangler/src/config/validation.ts Co-authored-by: James Opstad <[email protected]> * update lock file * update fixture tests * update lock file --------- Co-authored-by: Dario Piotrowicz <[email protected]> Co-authored-by: emily-shen <[email protected]> Co-authored-by: James Opstad <[email protected]>

Closes #704 cloudflare/workers-sdk#8596

dario-piotrowicz requested a review from a team as a code owner March 20, 2025 16:35

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch from f51b420 to 06b83c9 Compare March 20, 2025 16:36

workers-devprod mentioned this pull request Mar 20, 2025

V3 Backport (add validation to redirected configs in regards to environments #8596) #8600

Merged

workers-devprod added this to workers-sdk Mar 20, 2025

github-project-automation bot moved this to Untriaged in workers-sdk Mar 20, 2025

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch from 06b83c9 to 31466bf Compare March 20, 2025 17:57

dario-piotrowicz added the e2e Run wrangler + vite-plugin e2e tests on a PR label Mar 20, 2025

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch 3 times, most recently from 0c2b095 to 4a1748a Compare March 21, 2025 11:00

dario-piotrowicz requested a review from a team March 21, 2025 11:05

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch 3 times, most recently from 8caffe9 to cca92dc Compare March 25, 2025 10:47

dario-piotrowicz mentioned this pull request Mar 25, 2025

add note about environments in generated wrangler configuration section cloudflare/cloudflare-docs#21119

Merged

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch from cca92dc to 8cbe58d Compare March 25, 2025 11:44

dario-piotrowicz requested a review from petebacondarwin March 25, 2025 14:18

emily-shen requested changes Apr 4, 2025

View reviewed changes

github-project-automation bot moved this from Untriaged to In Review in workers-sdk Apr 4, 2025

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch from 8cbe58d to 66f711a Compare April 4, 2025 12:01

dario-piotrowicz requested a review from emily-shen April 4, 2025 14:19

emily-shen approved these changes Apr 4, 2025

View reviewed changes

packages/wrangler/src/config/validation.ts Outdated Show resolved Hide resolved

github-project-automation bot moved this from In Review to Approved in workers-sdk Apr 4, 2025

jamesopstad approved these changes Apr 4, 2025

View reviewed changes

packages/wrangler/src/config/validation.ts Outdated Show resolved Hide resolved

dario-piotrowicz requested a review from a team April 4, 2025 16:07

dario-piotrowicz added 2 commits April 4, 2025 17:08

[wrangler] add validation to redirected configs in regards to environ…

285f30c

…ments

error instead of warning on specified environments

f47f46a

dario-piotrowicz and others added 2 commits April 4, 2025 17:08

Update packages/wrangler/src/config/validation.ts

1705c2b

Co-authored-by: emily-shen <[email protected]>

Update packages/wrangler/src/config/validation.ts

bb5fa7d

Co-authored-by: James Opstad <[email protected]>

dario-piotrowicz force-pushed the dario/8359/wrangler/redirected-config-env branch from d010e40 to bb5fa7d Compare April 4, 2025 16:08

update lock file

eabdbf7

update fixture tests

b55b257

petebacondarwin reviewed Apr 5, 2025

View reviewed changes

petebacondarwin merged commit 75b454c into main Apr 7, 2025
25 of 27 checks passed

petebacondarwin deleted the dario/8359/wrangler/redirected-config-env branch April 7, 2025 08:53

github-project-automation bot moved this from Approved to Done in workers-sdk Apr 7, 2025

workers-devprod mentioned this pull request Apr 7, 2025

Version Packages #8796

Merged

dario-piotrowicz mentioned this pull request Apr 7, 2025

Improve error message displayed when a redirected config includes multiple environments #8809

Merged

12 tasks

dario-piotrowicz mentioned this pull request Apr 13, 2025

fix redirected config env validation breaking wrangler pages commands #8924

Merged

12 tasks

RihanArfan added a commit to nuxt-hub/core that referenced this pull request Dec 15, 2025

fix(build): merge nitro generated env to root in wrangler.json

06a2469

Closes #704 cloudflare/workers-sdk#8596

RihanArfan mentioned this pull request Dec 15, 2025

fix(build): merge nitro generated env to root in wrangler.json nuxt-hub/core#720

Merged

	it("specifying an environment cause an error since they are supported in redirected configs", async ({
	it("specifying an environment causes an error since they are not supported in redirected configs", async ({

Conversation

dario-piotrowicz commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dario-piotrowicz commented Mar 20, 2025

Uh oh!

emily-shen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

emily-shen Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

dario-piotrowicz Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

petebacondarwin Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

emily-shen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dario-piotrowicz commented Apr 4, 2025

Uh oh!

petebacondarwin Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

petebacondarwin Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dario-piotrowicz commented Mar 20, 2025 •

edited

Loading

changeset-bot bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading