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: render a helpful build error if a Service Worker mode Worker has imports #6872

Merged
merged 3 commits into from
Oct 2, 2024

Conversation

petebacondarwin
Copy link
Contributor

@petebacondarwin petebacondarwin commented Oct 1, 2024

A common mistake is to forget to export from the entry-point of a Worker, which causes
Wrangler to infer that we are in "Service Worker" mode.

In this mode, imports to external modules are not allowed.
Currently this only fails at runtime, because our esbuild step converts these imports to an internal __require() call that throws an error.
The error message is misleading and does not help the user identify the cause of the problem.
This is particularly tricky where the external imports are added by a library or our own node.js polyfills.

Fixes #6648

What this PR solves / how to test

Fixes #[insert GH or internal issue number(s)].

Author has addressed the following

  • 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:
  • 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: bug fix

… imports

A common mistake is to forget to export from the entry-point of a Worker, which causes
Wrangler to infer that we are in "Service Worker" mode.

In this mode, imports to external modules are not allowed.
Currently this only fails at runtime, because our esbuild step converts these imports to an internal `__require()` call that throws an error.
The error message is misleading and does not help the user identify the cause of the problem.
This is particularly tricky where the external imports are added by a library or our own node.js polyfills.

Fixes #6648
@petebacondarwin petebacondarwin requested a review from a team as a code owner October 1, 2024 15:07
Copy link

changeset-bot bot commented Oct 1, 2024

🦋 Changeset detected

Latest commit: f3ce6ee

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

@petebacondarwin petebacondarwin added the e2e Run e2e tests on a PR label Oct 1, 2024
@threepointone
Copy link
Contributor

Are you sure we can't make it actually work? I think require()s work in the runtime.
If we make both modules/SW workers compile to esm, would that fix tthis?

format: entry.format === "modules" ? "esm" : "iife",

(Happy to be wrong)

@threepointone
Copy link
Contributor

If esm is an issue, making that cjs might also do it

@threepointone
Copy link
Contributor

For posterity, I was wrong, can't do imports/requires in a Service Worker

Copy link
Contributor

github-actions bot commented Oct 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/11130701217/npm-package-wrangler-6872

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

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

Or you can use npx with this latest build directly:

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

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.20240925.0
workerd 1.20240925.0 1.20240925.0
workerd --version 1.20240925.0 2024-09-25

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

@petebacondarwin petebacondarwin merged commit b2d094e into main Oct 2, 2024
24 checks passed
@petebacondarwin petebacondarwin deleted the pbd/fix-dynamic-require-error-6648 branch October 2, 2024 16:43
@workers-devprod workers-devprod mentioned this pull request Oct 2, 2024
Copy link
Contributor

@irvinebroque irvinebroque left a comment

Choose a reason for hiding this comment

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

🙌 👏 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e2e Run e2e tests on a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 BUG: Dynamic require of "node:stream" is not supported
4 participants