Make `assets` field optional in the Worker config when using assets #8545

jamesopstad · 2025-03-18T11:50:31Z

This makes the assets field optional when using assets. Assets are now included at build time if the client environment is being built.

I've also replaced use of assert in cases of user error and ensured that Worker config warnings are only displayed once at build time.

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: N/A
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s):
- Documentation not necessary because: coming soon
Wrangler V3 Backport
- TODO (before merge)
- PR:
- Not necessary because: N/A

changeset-bot · 2025-03-18T11:50:35Z

🦋 Changeset detected

Latest commit: a43c246

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

This PR includes changesets to release 1 package

Name	Type
@cloudflare/vite-plugin	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-18T11:56:21Z

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/13958531711/npm-package-wrangler-8545

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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

wrangler@4.2.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	4.20250317.1
`workerd`	1.20250317.0	1.20250317.0
`workerd --version`	1.20250317.0	2025-03-17

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

dario-piotrowicz

Looks good to me, I just left a couple of small questions 🙂

packages/vite-plugin-cloudflare/src/workers-configs.ts

dario-piotrowicz · 2025-03-18T13:54:12Z

packages/vite-plugin-cloudflare/src/plugin-config.ts

+	if (!configPath) {
+		throw new Error(
+			`Config not found. Have you created a wrangler.json(c) or wrangler.toml file?`
+		);
+	}


like my other comment I am wondering about the reason to change this here, if we want to move away from asserts shouldn't the other assert calls in this file be converted as well?

Generally I believe that assertions should be checking that our assumptions about the state of the code is correct, e.g. that a value is indeed defined when we believe it should, or that a string is not empty, etc. A failing assert() call raises an AssertionError rather than an Error, which we could capture and send to Sentry, for example.

A failing assertion should indicate a bug in our code. We don't want "expected" user errors from polluting that signal.

I would be surprised if this is contentious.

Makes sense to me, I was just wondering, thanks for the clarification 🙂

I wonder if we should switch other assert calls to also check + throw (e.g. https://github.com/cloudflare/workers-sdk/pull/8545/files/f38f7894727403adb95a081810bb968c0aaf1ea0#diff-07b674c7cc878770162aa8ec047d225e4341a1cc0ce4eca507d29217ebdbca62R139) mainly for consistency sake 🤔

packages/vite-plugin-cloudflare/src/index.ts

… build

jamesopstad added the vite-plugin Relating to the `@cloudflare/vite-plugin` package label Mar 18, 2025

jamesopstad requested review from a team as code owners March 18, 2025 11:50

jamesopstad force-pushed the james/zero-config-assets branch from 34bc4b1 to 2200e9f Compare March 18, 2025 11:51

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

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

dario-piotrowicz approved these changes Mar 18, 2025

View reviewed changes

github-project-automation bot moved this from Untriaged to Approved in workers-sdk Mar 18, 2025

jamesopstad added 16 commits March 19, 2025 23:07

Set default value for assets field

4f463c2

Removed default assets value and set assets value at build time

3b4d0fa

Fixed Worker config warnings displaying multiple times

2f48cf9

Set assets to undefined in ouput Worker config if there is not client…

304e115

… build

Added static playground

c65ff4a

Added tests for static playground, with and without api

1b317a2

Fix workers-types version in playground

3721cd4

Added changeset

f254d81

Don't apply no_bundle and rules when output is assets only

73ba858

Add empty line

6c6ee18

Throw rather than assert when config path is not found

0d73eef

Updated changeset

be2da00

Add turbo.json to static playground

4c8124b

Remove assets binding from static playground api

f8db424

Fix formatting

5e7ac09

Fix lock file

a43c246

jamesopstad force-pushed the james/zero-config-assets branch from f38f789 to a43c246 Compare March 19, 2025 23:16

jamesopstad merged commit aadb49c into main Mar 20, 2025
25 of 27 checks passed

jamesopstad deleted the james/zero-config-assets branch March 20, 2025 00:26

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

workers-devprod mentioned this pull request Mar 20, 2025

Version Packages #8571

Merged

smorimoto mentioned this pull request Mar 25, 2025

Remove empty assets object from wrangler config remix-run/react-router#13302

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make `assets` field optional in the Worker config when using assets #8545

Make `assets` field optional in the Worker config when using assets #8545

Uh oh!

jamesopstad commented Mar 18, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

dario-piotrowicz left a comment

Uh oh!

Uh oh!

dario-piotrowicz Mar 18, 2025 •

edited

Loading

Uh oh!

petebacondarwin Mar 18, 2025

Uh oh!

dario-piotrowicz Mar 18, 2025 •

edited

Loading

Uh oh!

dario-piotrowicz Mar 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Make assets field optional in the Worker config when using assets #8545

Make assets field optional in the Worker config when using assets #8545

Uh oh!

Conversation

jamesopstad commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Mar 18, 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 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dario-piotrowicz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dario-piotrowicz Mar 18, 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!

petebacondarwin Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

dario-piotrowicz Mar 18, 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!

dario-piotrowicz Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Make `assets` field optional in the Worker config when using assets #8545

Make `assets` field optional in the Worker config when using assets #8545

jamesopstad commented Mar 18, 2025 •

edited

Loading

changeset-bot bot commented Mar 18, 2025 •

edited

Loading

github-actions bot commented Mar 18, 2025 •

edited

Loading

dario-piotrowicz Mar 18, 2025 •

edited

Loading

dario-piotrowicz Mar 18, 2025 •

edited

Loading