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

[miniflare] fix: ensure magic proxy works when starting on non-local hosts, and IPv6 addresses can be used as hosts #5133

Merged
merged 2 commits into from
Mar 1, 2024

Conversation

mrbbot
Copy link
Contributor

@mrbbot mrbbot commented Mar 1, 2024

What this PR solves / how to test

Fixes #4993.

Previously, if Miniflare was configured to start on a host that wasn't 127.0.0.1, ::1, *, ::, or 0.0.0.0, calls to Miniflare API methods relying on the magic proxy (e.g. getKVNamespace(), getWorker(), etc.) would fail. This change ensures workerd is always accessible to Miniflare's internals, by configuring workerd with an additional local-only entry socket in this case. An unrelated issue meant if Miniflare was configured to start on an IPv6 host, it could crash. This change also ensures IPv6 addresses are handled correctly.

This means wrangler dev can now use local network and IPv6 address such as 192.168.0.10 and ::1 with the --ip flag.

To test this, run wrangler dev --ip ::1 in fixtures/worker-app. Use ifconfig to find your local network IP, and try that out with the --ip flag too.

Author has addressed the following

@mrbbot mrbbot requested a review from a team as a code owner March 1, 2024 12:27
Copy link

changeset-bot bot commented Mar 1, 2024

🦋 Changeset detected

Latest commit: 5c813e6

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

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

github-actions bot commented Mar 1, 2024

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/8112124723/npm-package-wrangler-5133

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

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

Or you can use npx with this latest build directly:

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

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


wrangler@3.30.1 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240223.0
workerd 1.20240223.1 1.20240223.1
workerd --version 1.20240223.1 2024-02-23

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

@mrbbot mrbbot marked this pull request as draft March 1, 2024 12:59
Copy link

codecov bot commented Mar 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.38%. Comparing base (89350a0) to head (5c813e6).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5133      +/-   ##
==========================================
+ Coverage   70.32%   70.38%   +0.06%     
==========================================
  Files         298      298              
  Lines       15542    15542              
  Branches     3999     3999              
==========================================
+ Hits        10930    10940      +10     
+ Misses       4612     4602      -10     

see 7 files with indirect coverage changes

@mrbbot mrbbot marked this pull request as ready for review March 1, 2024 13:39
@@ -174,7 +181,7 @@ function validateOptions(
// Initialise return values
const pluginSharedOpts = {} as PluginSharedOptions;
const pluginWorkerOpts = Array.from(Array(workerOpts.length)).map(
() => ({} as PluginWorkerOptions)
() => ({}) as PluginWorkerOptions
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this makes any difference, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think so, just formatted with a different version of Prettier I guess.

@mrbbot mrbbot merged commit 42bcc72 into main Mar 1, 2024
17 checks passed
@mrbbot mrbbot deleted the bcoll/magic-host-fixes branch March 1, 2024 14:26
@workers-devprod workers-devprod mentioned this pull request Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

🐛 BUG: error when specifying specific --ip
2 participants