refactor(wrangler): generate bundle meta file by vicb · Pull Request #7927 · cloudflare/workers-sdk

vicb · 2025-01-28T08:25:25Z

Hey @penalosa or @petebacondarwin, could you please point me to the best place to add tests for that?
I tested locally and it works fine but we need to add test.
Thanks!

I'll also add a changeset before merging.

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s):
- Documentation not necessary because: I'll update the docs once merged

changeset-bot · 2025-01-28T08:25:29Z

⚠️ No Changeset found

Latest commit: 539ab96

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2025-01-28T08:31:25Z

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/13011893122/npm-package-wrangler-7927

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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

wrangler@3.106.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20250124.0
`workerd`	1.20250124.0	1.20250124.0
`workerd --version`	1.20250124.0	2025-01-24

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

vicb · 2025-01-28T13:50:11Z

I added a test.

Could anybody please confirm that generating the file in the outdir will not get it uploaded?

petebacondarwin · 2025-01-28T13:53:43Z

I added a test.

Could anybody please confirm that generating the file in the outdir will not get it uploaded?

That will depend upon whether it matches a "additional module rule" and whether find_additional_modules and/or no_bundle are true.

petebacondarwin

I think this should be explicitly opt-in rather than inferred from the outdir.
E.g. --metafile or similar

The opt-in would default to false. A value equivalent to true could default to putting the metafile in the outdir if no other value is provided.

E.g. --metafile=path/to/metafile.json.

vicb · 2025-01-28T14:27:56Z

Thanks for the review @petebacondarwin, I have a few follow up questions:

Could anybody please confirm that generating the file in the outdir will not get it uploaded?

That will depend upon whether it matches a "additional module rule" and whether find_additional_modules and/or no_bundle are true.

Could you please point me to the code?
(That was my fear but the additional modules should be looking for files in the source folder, not the outdir?)

I think this should be explicitly opt-in rather than inferred from the outdir.
E.g. --metafile=path/to/metafile.json

--metafile=path/to/metafile.json was my first thought.

Then I thought that we already have an outdir and we can re-use that, so it should probably just be --metafile (i.e. only to enable but do not offer to override the path).

I also see that we always generate the metadata so the only override here is to dump to disk. So I'm wondering if we really need that --metafile at all - which is what I implemented in this PR. I think simpler is better but happy to change that if needed.

petebacondarwin · 2025-01-28T14:49:06Z

Could you please point me to the code?
(That was my fear but the additional modules should be looking for files in the source folder, not the outdir?)

It is not uncommon to run wrangler build to generate a compiled Worker and then wrangler deploy with no_bundle on to deploy from that output directory.

petebacondarwin · 2025-01-28T14:50:20Z

I also see that we always generate the metadata so the only override here is to dump to disk. So I'm wondering if we really need that --metafile at all - which is what I implemented in this PR. I think simpler is better but happy to change that if needed.

Yes I was proposing that we have a --metafile option that by itself would dump the metadata to disk in the outdir directory. I think this should still be opt-in, i.e. not to dump the file unless this flag is on.

vicb · 2025-01-29T08:38:02Z

It is not uncommon to run wrangler build to generate a compiled Worker and then wrangler deploy with no_bundle on to deploy from that output directory.

Oh I see, good point - and in this case the .map is not an issue because it doesn't match any of the implicit rules.

I'll update the PR to add --metafile later this week.

DaniFoldi · 2025-03-23T16:40:39Z

Hey @vicb,

Is there anything I can help with to land this? The feature request issue has been open for a long time, and I'd love to be able to see which dependency is increasing the bundle size (which is an important metric for startup time) without having to patch wrangler.

vicb · 2025-03-24T07:06:17Z

Hey @vicb,

Is there anything I can help with to land this? The feature request issue has been open for a long time, and I'd love to be able to see which dependency is increasing the bundle size (which is an important metric for startup time) without having to patch wrangler.

We need to add a --metafile flag to enable the generation of the file - do you want to get a stab at this?

ItsWendell · 2025-03-28T17:40:32Z

Hey @vicb,
Is there anything I can help with to land this? The feature request issue has been open for a long time, and I'd love to be able to see which dependency is increasing the bundle size (which is an important metric for startup time) without having to patch wrangler.

We need to add a --metafile flag to enable the generation of the file - do you want to get a stab at this?

@vicb I did a attempt here, #8716

I added a simple --metafile flag and adjusted / added some more tests. I was doubting whether to allow the --metafile flag to be string to change the location but didn't see any value in that in this case since the build process is highly managed by the worker itself anyway.

Curious on how I could best document this further for docs, and whether I missed a build path if you have any insights into this.

Also not sure what the best workflow is for me to contribute to this particular PR itself, I now opened a PR to be merged into this branch.

vicb · 2025-04-16T07:30:47Z

Superseded by #8716

vicb requested a review from a team as a code owner January 28, 2025 08:25

vicb added ci:e2e Run wrangler + vite-plugin E2E tests on a pull request ci:no-changeset-required Skip pull request checks for a valid changeset labels Jan 28, 2025

vicb added 2 commits January 28, 2025 14:26

refactor(wrangler): generate bundle meta file

d7931e6

fixup! add test

539ab96

vicb force-pushed the meta-file branch from 056eab6 to 539ab96 Compare January 28, 2025 13:49

vicb requested a review from a team as a code owner January 28, 2025 13:49

petebacondarwin requested changes Jan 28, 2025

View reviewed changes

ItsWendell mentioned this pull request Mar 28, 2025

refactor(wrangler): add metafile flag, pass to build functions, adjus… #8716

Merged

12 tasks

vicb closed this Apr 16, 2025

github-project-automation Bot moved this from In Review to Done in workers-sdk Apr 16, 2025

vicb deleted the meta-file branch July 24, 2025 06:29

Conversation

vicb commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions Bot commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vicb commented Jan 28, 2025

Uh oh!

petebacondarwin commented Jan 28, 2025

Uh oh!

petebacondarwin left a comment

Choose a reason for hiding this comment

Uh oh!

vicb commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petebacondarwin commented Jan 28, 2025

Uh oh!

petebacondarwin commented Jan 28, 2025

Uh oh!

vicb commented Jan 29, 2025

Uh oh!

DaniFoldi commented Mar 23, 2025

Uh oh!

vicb commented Mar 24, 2025

Uh oh!

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

Uh oh!

Uh oh!

vicb commented Apr 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vicb commented Jan 28, 2025 •

edited

Loading

changeset-bot Bot commented Jan 28, 2025 •

edited

Loading

github-actions Bot commented Jan 28, 2025 •

edited

Loading

vicb commented Jan 28, 2025 •

edited

Loading

ItsWendell commented Mar 28, 2025 •

edited

Loading