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

[wrangler] fix: make sure getPlatformProxy's ctx methods throw illegal invocation errors like workerd #6199

Merged
merged 2 commits into from
Jul 5, 2024

Conversation

dario-piotrowicz
Copy link
Member

@dario-piotrowicz dario-piotrowicz commented Jul 4, 2024

What this PR solves / how to test

in workerd detaching the waitUntil and passThroughOnException methods from the ExecutionContext
object results in them throwing illegal invocation errors, such as for example:

export default {
	async fetch(_request, _env, { waitUntil }) {
		waitUntil(() => {}); // <-- throws an illegal invocation error
		return new Response("Hello World!");
	},
};

this PR makes sure that the same behavior is applied to the ctx object returned by getPlatformProxy

To test it simply use the prerelease and try destructuring and calling the methods of the getPlatformProxy'sctx object

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because:
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included
    • Not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Not necessary because: just aligning the local dev behavior with the production one

Note

The same sort of logic would ideally need to be applied to bindings, that however involves the magic proxy so it likely won't be as straightforward as it was here for ctx, thus I thought not to cram both in this PR, so I'll try to do the bindings one in a followup PR (see: #6200)

@dario-piotrowicz dario-piotrowicz requested a review from a team as a code owner July 4, 2024 14:05
Copy link

changeset-bot bot commented Jul 4, 2024

🦋 Changeset detected

Latest commit: 6353fba

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

github-actions bot commented Jul 4, 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/9800742834/npm-package-wrangler-6199

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

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

Or you can use npx with this latest build directly:

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

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.20240701.0
workerd 1.20240701.0 1.20240701.0
workerd --version 1.20240701.0 2024-07-01

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

@dario-piotrowicz dario-piotrowicz changed the title [wrangler] fix: make sure getPlatformProxy's ctx method throw illegal invocation errors like workerd [wrangler] fix: make sure getPlatformProxy's ctx methods throw illegal invocation errors like workerd Jul 4, 2024
@dario-piotrowicz dario-piotrowicz merged commit 88313e5 into main Jul 5, 2024
18 checks passed
@dario-piotrowicz dario-piotrowicz deleted the getPlatformProxy-illegal-ctx-invocation branch July 5, 2024 09:00
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.

None yet

2 participants