Allow users to run getPlatformProxy on static asset workers when the assets dir doesn't exist

[dario-piotrowicz]

Users running getPlatformProxy might include in their config file an assets directory that not yet exists. The changes in this PR allow getPlatformProxy to work even if the assets directory doesn't exist yet.

All other commands like wrangler dev and wrangler deploy still fails if the directory doesn't exist at deploy time

---

• Tests
  • Tests included/updated
  • Automated tests not possible - manual testing has been completed as follows:
  • Additional testing not necessary because:
• Public documentation
  • Cloudflare docs PR(s):
  • Documentation not necessary because: self-documenting improvement

A picture of a cute animal (not mandatory, but encouraged)

---

[changeset-bot]

🦋 Changeset detected

Latest commit: e568780

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

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]

✅ All changesets look good

[pkg-pr-new]

create-cloudflare

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

@cloudflare/kv-asset-handler

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

miniflare

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

@cloudflare/pages-shared

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

@cloudflare/unenv-preset

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

@cloudflare/vite-plugin

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

@cloudflare/vitest-pool-workers

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

@cloudflare/workers-editor-shared

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

@cloudflare/workers-utils

npm i https://pkg.pr.new/@cloudflare/workers-utils@13116

wrangler

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

commit: e568780

[penalosa]

How does this compare to #13079?

[dario-piotrowicz]

How does this compare to #13079?

isn't #13079 addressing the case when a directory is not specified in the config file?

this PR instead is handling the case when a directory is specified but doesn't actually (yet) exist on the filesystem

no?

[workers-devprod]

Codeowners approval required for this PR:

• @cloudflare/wrangler

Show detailed file reviewers

• packages/miniflare/src/plugins/assets/index.ts: [@cloudflare/wrangler]
• packages/miniflare/test/plugins/assets/index.spec.ts: [@cloudflare/wrangler]
• packages/wrangler/src/tests/assets.test.ts: [@cloudflare/wrangler]
• packages/wrangler/src/tests/dev.test.ts: [@cloudflare/wrangler]
• packages/wrangler/src/api/integrations/platform/index.ts: [@cloudflare/wrangler]
• packages/wrangler/src/api/startDevWorker/ConfigController.ts: [@cloudflare/wrangler]
• packages/wrangler/src/assets.ts: [@cloudflare/wrangler]
• packages/wrangler/src/deploy/index.ts: [@cloudflare/wrangler]
• packages/wrangler/src/dev.ts: [@cloudflare/wrangler]
• packages/wrangler/src/triggers/index.ts: [@cloudflare/wrangler]
• packages/wrangler/src/versions/upload.ts: [@cloudflare/wrangler]

[penalosa]

@dario-piotrowicz do you have a link to an issue or something where this was discussed? I'm not 100% sure this is a good idea, and I think I would generally expect a missing assets dir to trigger a hard error. Vite deals with this by making the assets dir config field optional, which feels right to me.

[dario-piotrowicz]

@dario-piotrowicz do you have a link to an issue or something where this was discussed? I'm not 100% sure this is a good idea, and I think I would generally expect a missing assets dir to trigger a hard error. Vite deals with this by making the assets dir config field optional, which feels right to me.

I thought there was a general consensus that we shouldn't hard error... 🤔

See: https://github.com/cloudflare/workers-sdk/blame/9282493b11ba07bcadb981c2cfc255e8eb5b9b15/packages/wrangler/src/api/integrations/platform/index.ts#L277-L279

[penalosa]

@dario-piotrowicz maybe I'm talking nonsense, and definitely feel free to disagree with me! But in general my thinking is:

• not erroring in getPlatformProxy() makes sense, because that's used at dev time in dev servers that probably haven't built assets yet
• not erroring when assets directory isn't specified makes sense, because that's either Vite, or a mistake that will give a clear error at dev/deploy-time
• not erroring when assets directory doesn't exist but is specified seems more dangerous, because there are lots of ways that could happen. In particular, I'd be worried about typos etc... and then a really frustrating debugging experience trying to figure out why assets aren't available

[dario-piotrowicz]

@dario-piotrowicz maybe I'm talking nonsense, and definitely feel free to disagree with me! But in general my thinking is:

• not erroring in getPlatformProxy() makes sense, because that's used at dev time in dev servers that probably haven't built assets yet
• not erroring when assets directory isn't specified makes sense, because that's either Vite, or a mistake that will give a clear error at dev/deploy-time
• not erroring when assets directory doesn't exist but is specified seems more dangerous, because there are lots of ways that could happen. In particular, I'd be worried about typos etc... and then a really frustrating debugging experience trying to figure out why assets aren't available

Sounds good 👍 , I'll update the PR accordingly

The only point that I don't fully agree is the last one, if users run something like wrangler dev and the assets dir doesn't exist, I don't see much danger in that since we're talking about local dev anyways, but I understand your point that this could surprise users/create a bit of a frustrating debugging experience 👍

[workers-devprod]

Codeowners approval required for this PR:

• ✅ @cloudflare/wrangler

Show detailed file reviewers

[workers-devprod]

Codeowners reviews satisfied

[dario-piotrowicz]

For posterity, I DMed Ben and he did re-review the changes before I merged the PR 🙂