Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: prevent bundling entire package.json in built code #6753

Merged
merged 1 commit into from
Sep 24, 2024

Conversation

bluwy
Copy link
Contributor

@bluwy bluwy commented Sep 18, 2024

What this PR solves / how to test

Fixes N/A

I noticed that the package.json was bundled in wrangler/wrangler-dist/cli.js. I found that we can simplify the package.json import to prevent that from happening.

The package.json is used by the check-update dependency, but it only requires the name and version to detect updates: https://github.com/vercel/update-check/blob/4338e215c9d089f46c6edff45ba41941c070d39f/index.js#L169-L201. So we only need to import the name and version to satisfy it.

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because: refactors
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because: refactors
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Changeset included
    • Changeset not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: internal refactor

@bluwy bluwy requested a review from a team as a code owner September 18, 2024 18:27
Copy link

changeset-bot bot commented Sep 18, 2024

🦋 Changeset detected

Latest commit: 26715c3

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

This PR includes changesets to release 2 packages
Name Type
wrangler Patch
@cloudflare/vitest-pool-workers 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

Copy link
Contributor

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/10928000964/npm-package-wrangler-6753

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-wrangler-6753 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-create-cloudflare-6753 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-cloudflare-kv-asset-handler-6753
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-miniflare-6753
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-cloudflare-pages-shared-6753
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-cloudflare-vitest-pool-workers-6753
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-cloudflare-workers-editor-shared-6753
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10928000964/npm-package-cloudflare-workers-shared-6753

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


[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240909.2
workerd 1.20240909.0 1.20240909.0
workerd --version 1.20240909.0 2024-09-09

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

Copy link
Contributor

@penalosa penalosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for this!

@edmundhung edmundhung merged commit 4e33f2c into cloudflare:main Sep 24, 2024
19 of 20 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes an open-source contribution, big or small label Sep 24, 2024
Copy link

holopin-bot bot commented Sep 24, 2024

Congratulations @bluwy, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm1gdjl6n02620cjn0svxj1ut

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

@bluwy bluwy deleted the no-package-json-bundle branch September 24, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution [Holopin] Recognizes an open-source contribution, big or small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants