feat(wrangler): identify draft and inherit bindings and provision draft ones #7427

edmundhung · 2024-12-03T16:28:29Z

Fixes DEVX-1421 and DEVX-1420

This PR adds the ability to identify draft and inherit bindings by looking up the current binding settings.

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
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):
- Documentation not necessary because: unreleased feature

changeset-bot · 2024-12-03T16:28:33Z

🦋 Changeset detected

Latest commit: ee0a46d

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 · 2024-12-03T16:46:04Z

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/12295632265/npm-package-wrangler-7427

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

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

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

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

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

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

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

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

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

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:*	3.20241205.0
`workerd`	1.20241205.0	1.20241205.0
`workerd --version`	1.20241205.0	2024-12-05

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

andyjessop

This is awesome work! The only suggestion I have is to have a clearer separation of concerns in the provisioner, so that it doesn't get too unwieldy later on, and so we can move more confidently towards modularisation of wrangler modules.

packages/wrangler/src/deployment-bundle/bindings.ts

andyjessop · 2024-12-09T14:54:26Z

packages/wrangler/src/deployment-bundle/bindings.ts

+		logger.debug("No settings found");
+	}
+
+	for (const kv of bindings.kv_namespaces ?? []) {


We could consider providing a simpler path towards modularisation by injecting the various handlers (kv, r2, d1, etc.) so that provisionBindings and runProvisioningFlow stay agnostic?

I was thinking something like this:

interface ResourceHandler { type: string; // The resource type (e.g., 'kv_namespace', 'r2_bucket', etc.) provision( accountId: string, bindings: CfWorkerInit["bindings"], settings: Settings | undefined ): Promise<PendingResource[]>; listExisting(accountId: string): Promise<NormalisedResourceInfo[]>; } interface PendingResource { binding: string; create: (name: string) => Promise<string>; updateId: (id: string) => void; type: string; } class Provisioner { #pendingResources: { [key: string]: PendingResource[] }; constructor(private handlers: ResourceHandler[]) {} async provision( accountId: string, bindings: CfWorkerInit["bindings"], scriptName: string ): Promise<void> { let settings: Settings | undefined; try { settings = await getSettings(accountId, scriptName); } catch (error) { logger.debug("No settings found"); } for (const handler of this.handlers) { pendingResources[handler.type] = await handler.provision( accountId, bindings, settings ); } for (const pendingResource in pendingResources) { await this.#runProvisioningFlow(pendingResource); } } async #runProvisioningFlow(pendingResource: PendingResource) { // ... const handler = this.handlers.find((h) => h.type === pendingResource.type); if (handler && this.#pendingResources.length > 0) { const preExistingResources = await handler.listExisting("accountId"); ... for (const item of this.#pendingResources) { // ... } } } }

You could then define the kvHandler in the kv folder, e.g. /src/kv/provision.ts:

const kvHandler: ResourceHandler = { type: "kv_namespace", async provision( accountId: string, bindings: CfWorkerInit["bindings"], settings: Settings | undefined ): Promise<PendingResources[]> { const pendingResources: PendingResource[] = []; for (const binding of bindings.kv_namespaces || []) { if ( !settings?.bindings.find( (b) => b.name === binding.binding && b.type === "kv_namespace" ) ) { pendingResources.push({ binding: binding.binding, create: async (name: string) => { const id = await createKVNamespace(accountId, name); return id; }, updateId: (id: string) => { binding.id = id; }, type: "kv_namespace", }); } } return pendingResources; }, async listExisting(accountId: string): Promise<NormalisedResourceInfo[]> { const namespaces = await listKVNamespaces(accountId); return namespaces.map((ns) => ({ name: ns.title, id: ns.id })); }, };

And finally, create the provisioner with all the required handlers:

const provisioner = new Provisioner([kvHandler, r2BucketHandler, d1DatabaseHandler]); // await provisioner.provision(accountId, bindings, scriptName);

happy to add to the momentum for modularising wrangler! thanks for the very thorough comment too :)

...although in the interest of time, I'll probably revisit this later (around new year's when i'm on call)?

packages/wrangler/src/deployment-bundle/bindings.ts

emily-shen · 2024-12-10T17:10:38Z

packages/wrangler/e2e/provisioning.test.ts

+		// we need to add d1 back into the config because otherwise wrangler will
+		// call the api for all 5000 or so db's the e2e test account has
+		// :(
+		await helper.seed({


also removing the id-less bindings from the wrangler.toml because otherwise there will be a config error (at least until the PR to add experimental flags to defineCommand lands)

emily-shen · 2024-12-10T17:12:32Z

packages/wrangler/src/config/index.ts

 		...output
 			.map((bindingGroup) => {
 				return [
 					`- ${bindingGroup.name}:`,
-					bindingGroup.entries.map(({ key, value }) => `  - ${key}: ${value}`),
+					bindingGroup.entries.map(
+						({ key, value }) => `  - ${key}${value ? ":" : ""} ${value}`


this just removes the colon if there is no value (ie for inherited bindings). I do think we maybe should print something for inherited bindings (id? name?) and that's totally possible as we've got the worker settings, but just wanted to discuss first and not block this PR on that.

packages/wrangler/e2e/provision.test.ts

penalosa · 2024-12-11T12:42:26Z

packages/wrangler/e2e/provision.test.ts

+		});
+		let output = await helper.run(`wrangler r2 bucket delete ${workerName}-r2`);
+		expect(output.stdout).toContain(`Deleted bucket`);
+		output = await helper.run(`wrangler d1 delete ${workerName}-d1 -y`, {


Can we just delete the D1 ID directly?

apparently not a thing you can do with wrangler - name or binding is the only thing you can pass in.
the various resource delete commands are very inconsistent.

Ah cool, okay. cc @rozenmd out of scope for this PR, but is that something D1 wants to support?

More of a question for @vy-ton, but seems doable to parse whether the incoming value for wrangler d1 delete is a UUID and just send the request to the API

packages/wrangler/e2e/provision.test.ts

packages/wrangler/src/deployment-bundle/bindings.ts

packages/wrangler/src/dev.ts

packages/wrangler/src/deployment-bundle/bindings.ts

edmundhung requested review from a team as code owners December 3, 2024 16:28

edmundhung force-pushed the edmundhung/DEVX-1421 branch from 6dff288 to a1a17b7 Compare December 3, 2024 16:34

edmundhung force-pushed the edmundhung/DEVX-1421 branch from a1a17b7 to 04b5b5b Compare December 3, 2024 17:13

edmundhung added the e2e Run e2e tests on a PR label Dec 3, 2024

emily-shen force-pushed the edmundhung/DEVX-1421 branch 5 times, most recently from b558b43 to 87fd88b Compare December 6, 2024 13:13

emily-shen changed the title ~~feat(wrangler): identify draft and inherit bindings~~ feat(wrangler): identify draft and inherit bindings and provision draft ones Dec 6, 2024

andyjessop reviewed Dec 9, 2024

View reviewed changes

emily-shen force-pushed the edmundhung/DEVX-1421 branch 2 times, most recently from 705532b to 507b26f Compare December 10, 2024 11:10

emily-shen requested a review from a team as a code owner December 10, 2024 16:42

emily-shen reviewed Dec 10, 2024

View reviewed changes

emily-shen force-pushed the edmundhung/DEVX-1421 branch from ea48312 to 906b16e Compare December 10, 2024 17:29

penalosa mentioned this pull request Dec 11, 2024

Improvise provisioning modularisation #7519

Open

penalosa reviewed Dec 11, 2024

View reviewed changes

edmundhung and others added 7 commits December 11, 2024 15:32

feat(wrangler): identify draft and inherit bindings

24e9119

add provisioning ui

fd1ef16

fixup

38855f7

skip question if no existing resources

d68882f

consolidate repetitive bits

e2da7a9

add tests

eb121e1

add default new resource value

0d92c3f

emily-shen added 6 commits December 11, 2024 15:33

update changeset

5ca6705

revert some unnecessary renaming

3617a58

fix tests

0300c54

use wrangler select instead of cli inputPrompt

eb13777

add e2e tests

cad6a80

pr feedback

e0f7b92

emily-shen force-pushed the edmundhung/DEVX-1421 branch from 333002a to e0f7b92 Compare December 11, 2024 15:33

test fixup

bf8f617

penalosa reviewed Dec 11, 2024

View reviewed changes

packages/wrangler/src/deployment-bundle/bindings.ts Show resolved Hide resolved

error on service environments

ee0a46d

penalosa approved these changes Dec 12, 2024

View reviewed changes

penalosa merged commit 3bc0f28 into main Dec 12, 2024
31 checks passed

penalosa deleted the edmundhung/DEVX-1421 branch December 12, 2024 15:49

workers-devprod mentioned this pull request Dec 12, 2024

Version Packages #7514

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(wrangler): identify draft and inherit bindings and provision draft ones #7427

feat(wrangler): identify draft and inherit bindings and provision draft ones #7427

edmundhung commented Dec 3, 2024 •

edited by emily-shen

Loading

changeset-bot bot commented Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading

andyjessop left a comment

andyjessop Dec 9, 2024

emily-shen Dec 10, 2024

emily-shen Dec 10, 2024

penalosa Dec 11, 2024

emily-shen Dec 10, 2024

emily-shen Dec 10, 2024

penalosa Dec 11, 2024

emily-shen Dec 11, 2024

penalosa Dec 11, 2024

rozenmd Dec 11, 2024

feat(wrangler): identify draft and inherit bindings and provision draft ones #7427

feat(wrangler): identify draft and inherit bindings and provision draft ones #7427

Conversation

edmundhung commented Dec 3, 2024 • edited by emily-shen Loading

changeset-bot bot commented Dec 3, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Dec 3, 2024 • edited Loading

andyjessop left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edmundhung commented Dec 3, 2024 •

edited by emily-shen

Loading

changeset-bot bot commented Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading