feat: use Workers Static Assets #13427
Open
+2,776
−1,151
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This changes the adapter to stop using the old Workers Sites (kv-asset-handler) approach.
Instead, making use of the new Workers Static Assets feature, which is embedded into Cloudflare natively.
Also this change removes the extra esbuild step that was being run inside the adapter, relying upon Wrangler to do the bundling.
The extra esbuild step required a hardcoded list of Node.js compatible modules.
This is no longer needed since Wrangler now manages all of that.
- This version of the adapter requires Wrangler version 3.87.0 or later.
Run `npm add -D wrangler@latest` (or similar) in your project to update Wrangler.
- The user's Wrangler configuration (`wrangler.toml`) must be migrated from using Workers Sites to using Workers Assets.
Previously a user's `wrangler.toml` might look like:
```toml
name = "<your-site-name>"
account_id = "<your-account-id>"
compatibility_date = "2021-11-12"
main = "./.cloudflare/worker.js"
# Workers Sites configuration
site.bucket = "./.cloudflare/public"
```
Change it to to look like:
```toml
name = "<your-site-name>"
account_id = "<your-account-id>"
compatibility_date = "2021-11-12"`
main = ".svelte-kit/cloudflare/server/index.js"
# Workers Assets configuration
assets = { directory = ".svelte-kit/cloudflare/client" }
```
- Workers Assets defaults to serving assets directly for a matching request, rather than routing it through the Worker code.
The previous adapter would add custom headers to assets responses (such as `cache-control`, `content-type`, and `x-robots-tag`. Such direct asset responses no longer contain these headers - but the will include eTag headers that have proven (in Pages) to be an effective caching strategy for assets.
If you wish to always run the Worker before every request then add `serve_directly = false` to the assets configuration section. For example:
```toml
assets = { directory = ".svelte-kit/cloudflare/client", serve_directly = false }
```
- Removed detailed examples to keep the entry concise. - Provided documentation links for reference.
🦋 Changeset detectedLatest commit: b278361 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
documentation/docs/25-build-and-deploy/70-adapter-cloudflare-workers.md
Outdated
Show resolved
Hide resolved
eltigerchino
added
documentation
eltigerchino
changed the title
|
I don't think the original PR stalled. I'm guessing it's just not ready to be merged or to be continued yet since the Workers Static Assets feature is still in beta. @petebacondarwin what are your thoughts on this? Should we try to get support out during the beta period? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves #13360
resolves #13071
resolves #13005
resolves #12813
This PR builds upon the excellent work by @petebacondarwin in PR #13072, focusing on incorporating reviewer feedback and refining the documentation.
Since the original PR seemed to have stalled, I wanted to help move things forward by addressing the feedback. I didn’t make any code changes—just focused on improving the documentation.
Huge thanks to @petebacondarwin for the initial implementation and to the reviewers for their insights.
Looking forward to any additional feedback to get this merged!
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Ideally, include a test that fails without this PR but passes with it.These adapters don't appear to have tests.Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits