thomasgauvin: support automatic updates of wrangler.jsonc when creating a new resource in a worker project #9816

thomasgauvin · 2025-07-01T22:13:23Z

addresses #9730

Only support wrangler.jsonc. Supports KV, R2, D1, Hyperdrive, Vectorize
Make updating wrangler.jsonc optional, interactive, logs to console otherwise
Provide a flag to permit updating wrangler.jsonc from initial command line (--update-config)
Try to add binding and add _2, _3... to binding variable in event of conflict
Don't support auto-adding preview KV namespaces
Preserves comments and structure of wrangler.jsonc

…ng a new resource in a worker project

changeset-bot · 2025-07-01T22:13:27Z

⚠️ No Changeset found

Latest commit: 86b763f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

pkg-pr-new · 2025-07-01T22:15:48Z

create-cloudflare

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

@cloudflare/kv-asset-handler

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

miniflare

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

@cloudflare/pages-shared

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

@cloudflare/unenv-preset

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

@cloudflare/vite-plugin

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

@cloudflare/vitest-pool-workers

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

@cloudflare/workers-editor-shared

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

wrangler

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

commit: 86b763f

dario-piotrowicz · 2025-07-02T21:54:11Z

packages/wrangler/src/config/auto-update.ts

+	// Generate a unique binding name that doesn't conflict
+	const bindingName = generateUniqueBindingName(config, resource);


Why do we want to generate the binding name in this way?

Couldn't we just add another interactive question asking the user for what binding name they'd like to use? 🤔

(then check the config file to make sure there isn't a conflict)

Basically what I was thinking was something along the lines of for example:

Would you like to update the wrangler.jsonc file with the new KV Namespace binding? … yes What binding name would you like to use? MY_KV Updated wrangler.jsonc with new KV Namespace binding: MY_KV (my-kv, ID: 6d2dd6ae297441688c8376c43e4360d6)

Potentially with an error/or other questions in case there are conflicts

I don't think that just creating the binding with generic names is very polished 🤔

using generic names is what we often have in docs/dashboard, and it's faster, so i wanted to match that. how about I default to generic and allow writing a custom binding?

using generic names is what we often have in docs/dashboard

Yeah, but there (especially in the docs) aren't really dealing with the user specific configs so it does make sense to use a generic naming 🤔

how about I default to generic and allow writing a custom binding?

Sorry what do you mean by allowing writing a custom binding?

PS: to be clear I don't think that using a generic binding name is terrible, I just think that not doing so would provide a better DX for our users

dario-piotrowicz · 2025-07-02T22:03:16Z

packages/wrangler/src/kv/index.ts

@@ -80,6 +80,11 @@ export const kvNamespaceCreateCommand = createCommand({
 			type: "boolean",
 			describe: "Interact with a preview namespace",
 		},
+		"update-config": {


Again I don't think this feels very polished and I would suggest to have something different, for example a flag config-binding-name that once set to a string it adds a binding with such name to the wrangler config (+ naming conflict to either error or create a new unique name)

For example:

npx wrangler kv namespace create my-kvvvv3 --config-binding-name MY_KV Creating namespace with title "my-kv" Success! Updated wrangler.jsonc with new KV Namespace binding: MY_KV (my-kv, ID: 3e22ff5cbc63489984343bca4b825fe4)

dario-piotrowicz

Thanks for the PR 🙂

Code wise I think some things need to be polished also more testing (fixtures) will be needed anyways for now I just left some comments regarding the DX, I don't think it's very polished to just create the bindings names for the user and that we should instead ask the user what names they do want to use instead

thomasgauvin · 2025-07-03T04:48:29Z

Thanks @dario-piotrowicz for the feedback & insights, I've started to address the DX ideas (interactive + config-binding-name) so am converting this to a draft PR for now

…n, added interactive prompting for binding name

vicb · 2025-07-03T07:42:29Z

packages/wrangler/src/config/auto-update.ts

+		updateJsonConfig(config.configPath!, resource, config);
+	} else {
+		// Show snippet only
+		const envString = args.env ? ` under [env.${args.env}]` : "";


This looks unused?

vicb · 2025-07-03T07:43:25Z

packages/wrangler/src/config/auto-update.ts

+	}
+}
+
+export function updateJsonConfig(


Could you please add JSDoc to this function?

vicb · 2025-07-03T07:47:28Z

packages/wrangler/src/config/auto-update-helpers.ts

+				if (binding.binding && typeof binding.binding === "string") {
+					if (binding.binding.toUpperCase() === normalizedName) {
+						return true;
+					}


Collapse the 2 conditions?

if (binding.binding && typeof binding.binding === "string" && binding.binding.toUpperCase() === normalizedName) { return true; }

I don't think binding.binding is needed with the typeof?

if (typeof binding.binding === "string" && binding.binding.toUpperCase() === normalizedName) { return true; }

vicb · 2025-07-03T07:50:00Z

packages/wrangler/src/config/auto-update-helpers.ts

+
+		const validation = validateBindingName(config, bindingName);
+		if (validation.valid) {
+			isValid = true;


Do you need isValid here or can you while(true) and return bindingName; here?

vicb · 2025-07-03T07:52:04Z

packages/wrangler/src/config/auto-update.ts

+ */
+export async function handleResourceBindingAndConfigUpdate(
+	args: { configBindingName?: string; env?: string },
+	config: RawConfig & { configPath?: string },


Looking at the calls outside of tests, I see

{ ...config, configPath: config.configPath },

Would it make sense for configPath to be a distinct parameter?

vicb · 2025-07-03T07:53:51Z

packages/wrangler/src/config/auto-update.ts

+
+	// We now have a valid binding name. We can use it to update the wrangler.jsonc config.
+	if (resource.binding) {
+		updateJsonConfig(config.configPath!, resource, config);


config.configPath! -> should the value be required instead of optional ?

vicb · 2025-07-03T07:55:33Z

packages/wrangler/src/config/auto-update.ts

+	config: RawConfig
+) {
+	// Read the original file content to preserve formatting and comments
+	const originalContent = readFileSync(configPath);


nit: use async version? (also for write)

vicb · 2025-07-03T07:59:07Z

packages/wrangler/src/d1/create.ts

-				config.configPath
-			)
+
+		// Handle binding name and config update using unified utility


I love to see code comments and I must say you have done a great job in this PR!
But (nit) this one does not look to add value over the fn name?

Suggested change

// Handle binding name and config update using unified utility

thomasgauvin: support automatic updates of wrangler.jsonc when creati…

9d4a32f

…ng a new resource in a worker project

thomasgauvin self-assigned this Jul 1, 2025

thomasgauvin requested review from a team as code owners July 1, 2025 22:13

workers-devprod added this to workers-sdk Jul 1, 2025

github-project-automation bot moved this to Untriaged in workers-sdk Jul 1, 2025

thomasgauvin requested review from GregBrimble and dario-piotrowicz July 1, 2025 22:17

dario-piotrowicz reviewed Jul 2, 2025

View reviewed changes

thomasgauvin marked this pull request as draft July 3, 2025 04:47

thomasgauvin: made config-binding-name a string arg instead of boolea…

86b763f

…n, added interactive prompting for binding name

vicb reviewed Jul 3, 2025

View reviewed changes

packages/wrangler/src/config/auto-update.ts

}

}

export function updateJsonConfig(

Copy link

Contributor

vicb Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add JSDoc to this function?

vicb reviewed Jul 3, 2025

View reviewed changes

		// Generate a unique binding name that doesn't conflict
		const bindingName = generateUniqueBindingName(config, resource);

thomasgauvin: support automatic updates of wrangler.jsonc when creating a new resource in a worker project #9816

Are you sure you want to change the base?

thomasgauvin: support automatic updates of wrangler.jsonc when creating a new resource in a worker project #9816

Conversation

thomasgauvin commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomasgauvin Jul 2, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dario-piotrowicz left a comment

Choose a reason for hiding this comment

Uh oh!

thomasgauvin commented Jul 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vicb Jul 3, 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

thomasgauvin commented Jul 1, 2025 •

edited

Loading

changeset-bot bot commented Jul 1, 2025 •

edited

Loading

pkg-pr-new bot commented Jul 1, 2025 •

edited

Loading

thomasgauvin Jul 2, 2025 •

edited

Loading

vicb Jul 3, 2025 •

edited

Loading