feat: tag services and environments #10546

1000hz · 2025-09-03T18:39:29Z

This PR adds tagging behavior that applies appropriate service and environment tags to Workers with multiple environments when deploying or uploading a new version. If any environments are detected in the Wrangler config file, running wrangler deploy or wrangler version upload will apply a cf:service=${topLevelName} and (if a --env was specified) a cf:environment=${environmentName} tag. This metadata will be used by the Cloudflare Dashboard to group these Workers together in a more user-friendly way.

This PR also adds a new definedEnvironments computed field to Wrangler config that can be used to more easily determine whether a Worker uses environments.

Tests
- Tests included
- Tests not necessary because:
Public documentation
- Cloudflare docs PR(s):
- Documentation not necessary because: not a public-facing Wrangler feature
Wrangler V3 Backport
- Wrangler PR:
- Not necessary because: Not scoped for v3

changeset-bot · 2025-09-03T18:39:33Z

🦋 Changeset detected

Latest commit: f31edfc

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

This PR includes changesets to release 3 packages

Name	Type
wrangler	Minor
@cloudflare/vite-plugin	Major
@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

pkg-pr-new · 2025-09-03T18:42:18Z

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@10546

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@10546

miniflare

npm i https://pkg.pr.new/miniflare@10546

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@10546

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@10546

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@10546

@cloudflare/vitest-pool-workers

npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@10546

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@10546

wrangler

npm i https://pkg.pr.new/wrangler@10546

commit: f31edfc

jamesopstad

Hi @1000hz. This doesn't account for redirected configs (as used by the Vite plugin, Nitro and possibly others), which flatten the configuration using the selected environment at build time. See the following:

workers-sdk/packages/wrangler/src/config/validation.ts

Lines 168 to 181 in cc47b51

    
           	if (isRedirectedConfig && definedEnvironments.length > 0) { 
        
           		diagnostics.errors.push( 
        
           			dedent` 
        
           				Redirected configurations cannot include environments but the following have been found:\n${definedEnvironments 
        
           					.map((env) => `	- ${env}`) 
        
           					.join("\n")} 
        
           				Such configurations are generated by tools, meaning that one of the tools 
        
           				your application is using is generating the incorrect configuration. 
        
           				Report this issue to the tool's author so that this can be fixed there. 
        
           				` 
        
           		); 
        
           	}

We propose that an environmentName property is added to ComputedFields that is included in the output of readConfig. Then, for redirected configs (which are configs that have been generated by readConfig), this value can be used to provide the env to applyServiceAndEnvironmentTags. Does that sound OK?

…wrangler config

…vironments is deployed or has a new version upload.

jamesopstad

Looks good to me! Thanks for doing the extra work to support the redirected config. It would be good to add some tests for that scenario but it's not blocking. I think we probably need a writeRedirectedWranglerConfig helper equivalent to writeWranglerConfig to make this more straightforward.

penalosa

Can you add a test for redirectied config?

penalosa · 2025-09-11T11:02:15Z

packages/wrangler/src/config/config.ts

@@ -48,6 +50,10 @@ export interface ComputedFields {
 	 * It can be useful to know what the top-level name was before the flattening.
 	 */
 	topLevelName: string | undefined;
+	/** A list of environment names declared in the raw configuration. */
+	definedEnvironments: string[] | undefined;


Why do we need definedEnvironments? It looks like it's only used to decide whether or not to apply environment tags, but surely the presence of a target environment is enough to decide that?

target environment alone is not sufficient. we need to apply service tags as long as there are any environments defined in the config file, even when you're targeting the top-level environment (i.e. target environment would be empty).

That makes sense, but to play devils advocate for a second, did you consider just always adding the service name tag, regardless of whether the user has environments in their config?

We potentially could, but there'd be some undesirable implications on other parts of the system that we'd need to handle (i.e. service grouping) and it'd be better to only apply it where necessary for now.

penalosa · 2025-09-11T11:03:48Z

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

+			let requestCount = 0;
+			mockPatchScriptSettings(async ({ request }) => {
+				requestCount++;
+				if (requestCount === 2) {


Why are we sending three requests to this endpoint?

we are sending two. why not bundle setting the tags into the existing request? there's a chance updating the tags will fail if the additional tags push the worker beyond the tag limit, so I didn't want to jeopardize syncing the other script settings.

Is there no way we can exempt these specific tags from the tag limit server side? I'm not going to block on this because we already do this all over the place in Wrangler, but I'd definitely prefer we get closer to 1 API call being a deploy, rather than further away

yeah, now that we're qualifying these tags with a cf: prefix, we probably should exempt these two specific tags from the limit.

1000hz · 2025-09-12T18:54:00Z

Spoke with @penalosa and decided I'll follow up this PR with another one to add additional test coverage

1000hz requested a review from a team as a code owner September 3, 2025 18:39

workers-devprod added this to workers-sdk Sep 3, 2025

github-project-automation bot moved this to Untriaged in workers-sdk Sep 3, 2025

1000hz force-pushed the cina/tag-services-and-environments branch from b1172e7 to 45c8035 Compare September 3, 2025 19:39

jamesopstad requested changes Sep 4, 2025

View reviewed changes

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

petebacondarwin marked this pull request as draft September 8, 2025 13:36

1000hz force-pushed the cina/tag-services-and-environments branch from 45c8035 to af14df0 Compare September 10, 2025 16:27

1000hz marked this pull request as ready for review September 10, 2025 16:27

1000hz requested a review from jamesopstad September 10, 2025 16:28

add definedEnvironments and targetEnvironment computed fields to …

94c690d

…wrangler config

1000hz force-pushed the cina/tag-services-and-environments branch 2 times, most recently from 0f2b7ac to cd128b7 Compare September 10, 2025 19:55

feat: add service and environment tags when a Worker with multiple en…

f31edfc

…vironments is deployed or has a new version upload.

1000hz force-pushed the cina/tag-services-and-environments branch from cd128b7 to f31edfc Compare September 10, 2025 20:13

jamesopstad approved these changes Sep 10, 2025

View reviewed changes

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

penalosa reviewed Sep 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: tag services and environments #10546

feat: tag services and environments #10546

Uh oh!

1000hz commented Sep 3, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Sep 3, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Sep 3, 2025 •

edited

Loading

Uh oh!

jamesopstad left a comment

Uh oh!

jamesopstad left a comment

Uh oh!

penalosa left a comment

Uh oh!

penalosa Sep 11, 2025

Uh oh!

1000hz Sep 11, 2025

Uh oh!

penalosa Sep 12, 2025

Uh oh!

1000hz Sep 12, 2025

Uh oh!

penalosa Sep 11, 2025

Uh oh!

1000hz Sep 11, 2025 •

edited

Loading

Uh oh!

penalosa Sep 12, 2025

Uh oh!

1000hz Sep 12, 2025

Uh oh!

1000hz commented Sep 12, 2025

Uh oh!

Uh oh!

	if (isRedirectedConfig && definedEnvironments.length > 0) {
	diagnostics.errors.push(
	dedent`
	Redirected configurations cannot include environments but the following have been found:\n${definedEnvironments
	.map((env) => ` - ${env}`)
	.join("\n")}


	Such configurations are generated by tools, meaning that one of the tools
	your application is using is generating the incorrect configuration.
	Report this issue to the tool's author so that this can be fixed there.
	`
	);
	}

feat: tag services and environments #10546

Are you sure you want to change the base?

feat: tag services and environments #10546

Uh oh!

Conversation

1000hz commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

pkg-pr-new bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jamesopstad left a comment

Choose a reason for hiding this comment

Uh oh!

jamesopstad left a comment

Choose a reason for hiding this comment

Uh oh!

penalosa left a comment

Choose a reason for hiding this comment

Uh oh!

penalosa Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

1000hz Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

penalosa Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

1000hz Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

penalosa Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

1000hz Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

penalosa Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

1000hz Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

1000hz commented Sep 12, 2025

Uh oh!

Uh oh!

1000hz commented Sep 3, 2025 •

edited

Loading

changeset-bot bot commented Sep 3, 2025 •

edited

Loading

pkg-pr-new bot commented Sep 3, 2025 •

edited

Loading

1000hz Sep 11, 2025 •

edited

Loading