feat(cloudflare): Add support for `txt` and `bin` cloudflare specific module types

adrianlyjak commented 2 months ago

A follow on feature to #249

Changes

In addition to the existing wasm imports, this adds support for loading .bin and .txt files within cloudflare pages functions
renamed wasm related code and config options to module-loader to clarify that this supports multiple formats
- renamed wasmModuleImports to cloudflareModules, retaining the previous so that this is non-breaking.
supports plain .wasm imports instead of only .wasm?module imports to be consistent with cloudflare pages
Modified the behavior to default to allowing wasmModuleImports by default. Initially we'd decided to keep this opt-in so as to keep the hacky branching from breaking the build: https://github.com/withastro/astro/pull/8542#discussion_r1327315432. There's no more branching, so now the vite plugin here is doing close to nothing except for string comparisons if there's no matching import, so it seems safe to me now. (You'd effectively be opting in by importing the right file format)
long term structure for the implemenation is such that it in the future it can easily be extended to support custom file extensions
- either based on wrangler.toml rules (if cloudflare pages gets support for that, right now it seems to be workers only)
- or perhaps the plugin could rewrite the extensions to one of the supported data types (CompiledWasm -> .wasm, Data -> .bin, or Text -> .txt)

Testing

Added additional test cases for each format to the wasm (now module-loader) test suite

Docs

I changed the name from wasmModuleImports to cloudflareModules in the cloudflare config. The old parameter is still available, but marked as deprecated. Any opinions around terminology here? Most everything I come up with ends up sounding generic, IMO, its hard to name this feature, so I was just going off terminology that cloudflare uses https://developers.cloudflare.com/pages/functions/module-support/.

What's the process for updating documentation? Should I make an associated merge request in the docs repo? https://github.com/withastro/docs/blob/main/src/content/docs/en/guides/integrations-guide/cloudflare.mdx

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: f078e77296341b6f928380655fbea0656fd4060f

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

This PR includes changesets to release 9 packages

| Name | Type | | ------------------------------------------------ | ----- | | @astrojs/cloudflare | Minor | | @test/astro-cloudflare-astro-dev-platform | Patch | | @test/astro-cloudflare-external-image-service | Patch | | @test/astro-cloudflare-wasm | Patch | | @test/astro-cloudflare-no-output | Patch | | @test/astro-cloudflare-prerender-optimizations | Patch | | @test/astro-cloudflare-routes-json | Patch | | @test/astro-cloudflare-with-solid-js | Patch | | @test/astro-cloudflare-wrangler-preview-platform | 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

adrianlyjak commented 2 months ago

better diff here: https://github.com/adrianlyjak/withastro-adapters/compare/fix-cloudflare-wasm...adrianlyjak:withastro-adapters:feat-cloudflare-bundling

alexanderniebuhr commented 2 months ago

@adrianlyjak yeah a docs pr to the docs repo is needed :)

adrianlyjak commented 1 month ago

@alexanderniebuhr @sarah11918 initial merge request for doc updates is here https://github.com/withastro/docs/pull/8211. Let me know if you have any feedback!

alexanderniebuhr commented 1 month ago

Thanks for the update. Will review both PR's ;)

withastro / adapters