feat(cloudflare): Exclude prerender and unused chunks from server bundle #222

Fryuni · 2024-04-05T03:14:04Z

Changes

Add extra cleanup after the build to exclude chunks used for prerendering routes from the server bundle.
Additionally, after the prerender chunks are excluded, also exclude any unreachable chunk (be it because it already was due to some other post-build processing or because of the exclusion of the prerender chunks)
Closes SSR Output includes files which are only relevant for prerendering #220
Closes Cloudflare v10 the final _workers.js folder/file bundle is too large #218

I'm okay with putting this behind a flag (experimental or not), the wiring is quite trivial to make configurable.

Testing

I added an example of an offending project that includes all content collections in the server bundle even though those are only used in pre-rendered pages, causing unnecessary bloat.

Docs

I don't think this needs any docs changes, but happy to document it if others think it does.

changeset-bot · 2024-04-05T03:14:27Z

🦋 Changeset detected

Latest commit: fc0ff55

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-no-output	Patch
@test/astro-cloudflare-prerender-optimizations	Patch
@test/astro-cloudflare-routes-json	Patch
@test/astro-cloudflare-wasm	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

alexanderniebuhr

@Fryuni can you check node --test "packages/cloudflare/test/wasm.test.js", it's the test that fails 🤔

It is caused because I think because of the "prerendering bug" for endpoints. The hybrid.ts in that project is prerendered, but still get's included in the pageMap here dist/_worker.js/index.ts:

const _page2 = () => import('./chunks/hybrid_Cr-KnQBu.mjs');
const pageMap = new Map([
    ["../../../../../node_modules/.pnpm/astro@4.5.8_@types+node@18.17.8_typescript@5.2.2/node_modules/astro/dist/assets/endpoint/generic.js", _page0],
    ["src/pages/add/[a]/[b].ts", _page1],
    ["src/pages/hybrid.ts", _page2]
]);

And ./chunks/hybrid_Cr-KnQBu.mjs has const page = () => import('./prerender_VBxqEc_S.mjs'); which breaks because ./prerender_VBxqEc_S.mjs got correctly removed.

alexanderniebuhr

Blocked until upstream Astro limitation is fixed.

https://discord.com/channels/830184174198718474/845430950191038464/1225801545699037184

https://discord.com/channels/830184174198718474/845430950191038464/1225858482268405760

alexanderniebuhr · 2024-04-07T06:42:10Z

Some more context/findings:

https://discord.com/channels/830184174198718474/845430950191038464/1226408296672395264
https://discord.com/channels/830184174198718474/845430950191038464/1226411660114133032

alexanderniebuhr

Just some quick comments.
Once we have #227 merged into this one, all tests pass and everything is addressed, I'm happy to get this over the line :)

packages/cloudflare/test/exclude-prerender-only-chunks.test.js

.changeset/pink-rings-agree.md

ematipico

The code looks good, but I am a bit surprised there are no comments explaining why this workaround is needed and how it works.

If next time a developer comes in here, they would have really hard time understanding the context of the logic.

ematipico · 2024-04-12T12:06:40Z

packages/cloudflare/src/index.ts

+											(entry) => !prerenderImports.map((e) => e[1]).includes(entry)
+										);
+										for (const page of prerenderImports) {
+											const importRegex = new RegExp(


I think we should add a comment that points to the actual place where Astro creates/writes these modules, so we know why it's there and how to fix it in case upstream decides to change things, even the name of a page.

alexanderniebuhr · 2024-04-12T14:08:36Z

!preview cf-no-prerender-chunks

github-actions · 2024-04-12T14:09:35Z

Snapshots have been released for the following packages:

@astrojs/cloudflare@experimental--cf-no-prerender-chunks

Publish Log

🦋  warn ===============================IMPORTANT!===============================
🦋  warn Packages will be released under the experimental--cf-no-prerender-chunks tag
🦋  warn ----------------------------------------------------------------------
🦋  info npm info @astrojs/cloudflare
🦋  info npm info @astrojs/netlify
🦋  info @astrojs/cloudflare is being published because our local version (0.0.0-cf-no-prerender-chunks-20240412140922) has not been published on npm
🦋  warn @astrojs/netlify is not being published because version 5.2.0 is already published on npm
🦋  info Publishing "@astrojs/cloudflare" at "0.0.0-cf-no-prerender-chunks-20240412140922"
🦋  success packages published successfully:
🦋  @astrojs/cloudflare@0.0.0-cf-no-prerender-chunks-20240412140922
🦋  Creating git tag...
🦋  New tag:  @astrojs/cloudflare@0.0.0-cf-no-prerender-chunks-20240412140922

Build Log


> root@0.0.0 build /home/runner/work/adapters/adapters
> turbo run build --filter="@astrojs/*"

• Packages in scope: @astrojs/cloudflare, @astrojs/netlify, @astrojs/test-utils
• Running build in 3 packages
• Remote caching disabled
::group::@astrojs/netlify:build
cache miss, executing a68730fc97f3487c

> @astrojs/netlify@5.2.0 build /home/runner/work/adapters/adapters/packages/netlify
> tsc

::endgroup::
::group::@astrojs/cloudflare:build
cache miss, executing 12fa5edd1cdf35df

> @astrojs/cloudflare@0.0.0-cf-no-prerender-chunks-20240412140922 build /home/runner/work/adapters/adapters/packages/cloudflare
> tsc

::endgroup::

 Tasks:    2 successful, 2 total
Cached:    0 cached, 2 total
  Time:    3.63s

ascorbic · 2024-06-13T13:47:18Z

I'm looking at this in reference to withastro/astro#10552 and I'm wondering if this would be better to be in core rather than adapters. The same thing seems to happen for all adapters, and it shouldn't really be the responsibility of an adapter to clean up the build liek this.

Fryuni · 2024-06-13T14:10:05Z

We started discussing how to better solve this in core. It is not on a proper thread, just scattered across the #contribute channel, but here is one message related to the topic

alexanderniebuhr · 2024-06-13T16:31:15Z

@ascorbic take a look at withastro/astro#11245, I'm not totally sure if that fixes the withastro/astro#10552 issue, but it should make this workaround inside the adapter not needed anymore.

ascorbic · 2024-06-13T16:40:10Z

@alexanderniebuhr ooh, nice. Thanks for the pointer

Fryuni added 3 commits April 5, 2024 00:05

Add test for expected result

c3ebcda

Remove prerender chunks and any unused chunk from server bundle

93d1fa7

Add changeset

bbaca1b

Fryuni requested a review from alexanderniebuhr April 5, 2024 03:14

Fryuni self-assigned this Apr 5, 2024

github-actions bot added pkg: cloudflare docs pr labels Apr 5, 2024

Fryuni added 2 commits April 5, 2024 00:16

Fix fixture package name

91a6584

Apply linter

60a7582

alexanderniebuhr requested changes Apr 5, 2024

View reviewed changes

Merge branch 'main' into feat/cloudflare-exclude-prerender-chunks

2619c44

alexanderniebuhr added upstream and removed docs pr labels Apr 7, 2024

alexanderniebuhr approved these changes Apr 10, 2024

View reviewed changes

packages/cloudflare/test/exclude-prerender-only-chunks.test.js Outdated Show resolved Hide resolved

.changeset/pink-rings-agree.md Outdated Show resolved Hide resolved

fix: prerendered pages dynamic imports & pageMap mapping (#227)

a6b5f78

github-actions bot added the docs pr label Apr 11, 2024

alexanderniebuhr added 2 commits April 11, 2024 20:58

Update .changeset/pink-rings-agree.md

b7edd38

Update packages/cloudflare/test/exclude-prerender-only-chunks.test.js

c96b63d

ematipico reviewed Apr 12, 2024

View reviewed changes

alexanderniebuhr and others added 2 commits April 15, 2024 09:48

add comments

2352529

Improve docs and names

fc0ff55

alexanderniebuhr merged commit 8f312da into main Apr 18, 2024
8 checks passed

alexanderniebuhr deleted the feat/cloudflare-exclude-prerender-chunks branch April 18, 2024 05:38

github-actions bot mentioned this pull request Apr 18, 2024

[ci] release #236

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cloudflare): Exclude prerender and unused chunks from server bundle #222

feat(cloudflare): Exclude prerender and unused chunks from server bundle #222

Fryuni commented Apr 5, 2024 •

edited by alexanderniebuhr

Loading

changeset-bot bot commented Apr 5, 2024 •

edited

Loading

alexanderniebuhr left a comment •

edited

Loading

alexanderniebuhr left a comment

alexanderniebuhr commented Apr 7, 2024

alexanderniebuhr left a comment

ematipico left a comment

ematipico Apr 12, 2024

alexanderniebuhr commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

ascorbic commented Jun 13, 2024

Fryuni commented Jun 13, 2024

alexanderniebuhr commented Jun 13, 2024

ascorbic commented Jun 13, 2024

feat(cloudflare): Exclude prerender and unused chunks from server bundle #222

feat(cloudflare): Exclude prerender and unused chunks from server bundle #222

Conversation

Fryuni commented Apr 5, 2024 • edited by alexanderniebuhr Loading

Changes

Testing

Docs

changeset-bot bot commented Apr 5, 2024 • edited Loading

🦋 Changeset detected

alexanderniebuhr left a comment • edited Loading

Choose a reason for hiding this comment

alexanderniebuhr left a comment

Choose a reason for hiding this comment

alexanderniebuhr commented Apr 7, 2024

alexanderniebuhr left a comment

Choose a reason for hiding this comment

ematipico left a comment

Choose a reason for hiding this comment

ematipico Apr 12, 2024

Choose a reason for hiding this comment

alexanderniebuhr commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

ascorbic commented Jun 13, 2024

Fryuni commented Jun 13, 2024

alexanderniebuhr commented Jun 13, 2024

ascorbic commented Jun 13, 2024

Fryuni commented Apr 5, 2024 •

edited by alexanderniebuhr

Loading

changeset-bot bot commented Apr 5, 2024 •

edited

Loading

alexanderniebuhr left a comment •

edited

Loading