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

fix(vite-plugin): use ESM exports of ws for vite dev server #8223

Closed
wants to merge 1 commit into from

Conversation

zebp
Copy link
Contributor

@zebp zebp commented Feb 22, 2025

Fixes #8222

Uses the ESM export WebSocketServer of ws since Server isn't present in ws's ESM package as described by this comment by a ws maintainer, which was causing the vite plugin to crash when starting the dev server in some ESM environments.


  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because:
  • Wrangler 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: bug fix to match documented behavior

@zebp zebp requested review from a team as code owners February 22, 2025 15:54
Copy link

changeset-bot bot commented Feb 22, 2025

🦋 Changeset detected

Latest commit: 13d2a40

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

This PR includes changesets to release 1 package
Name Type
@cloudflare/vite-plugin 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/13474402320/npm-package-wrangler-8223

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13474402320/npm-package-wrangler-8223 dev path/to/script.js
Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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


wrangler@3.109.2 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20250214.0
workerd 1.20250214.0 1.20250214.0
workerd --version 1.20250214.0 2025-02-14

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

@thomasgauvin
Copy link
Contributor

thomasgauvin commented Feb 23, 2025

Thanks @zebp, seems to work!

@zebp
Copy link
Contributor Author

zebp commented Feb 23, 2025

I'm not sure what to do for testing here, the existing tests should have caught this and I'm not sure why they haven't. If I use the install the dependencies of playground/worker with anything other than pnpm the dev-server fails to start. I suspect pnpm's workspace is changing something about the module resolution but I have no idea on how to isolate this in-repo.

@petebacondarwin
Copy link
Contributor

Thanks for putting up this PR @zebp - I already had a fix in flight, which I just pushed (#8231) and also re-enables the skipped e2e test. So I am going to close this one in favour of that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

🐛 BUG: Vite plugin dev-server fails to start in some ESM environments
3 participants