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: make vitest-pool-workers not crash with scripts that have Workflows #8208

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

LuisDuarte1
Copy link
Contributor

@LuisDuarte1 LuisDuarte1 commented Feb 20, 2025

Because vitest-pool-workers uses its runner worker as the entrypoint and not the user provided worker. The user provided worker is loaded AFAICT though eval (vitest-pool-workers enables eval) so we need, at startup time, to add the required entrypoints and make them dynamically call the user one.

Not only that, if you try to create a workflow instance it would throw a isolated storage error - I suspect that is this caused by engine still being active at the end of the test (since workflows are async, not in the request path, and might take undefinite time to complete).

In order to fix this, I've bypassed the isolated storage check for workflows internal DOs. I wonder if there might be collisions between test files if there are any concurrency regarding test files (aka singleWorker is false) - I think that this is fine to do, the point of this PR is not to make workflows really testable yet but to at least to make vitest-pool-workers not crash if a user includes a workflow in the worker definition.

Fixes #7414.


  • 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: doesn't add support to individually test workflows but only makes vitest not crash if they are defined

Because `vitest-pool-workers` uses its runner worker as the entrypoint
and not the user provided worker. The user provided worker is loaded
AFAICT though eval (`vitest-pool-workers` enables eval) so we need, at
startup time, to add the required entrypoints and make them dynamically
call the user one.

Not only that, if you try to create a workflow instance it would throw a
`isolated storage` error - I suspect that is this caused by engine still
being active at the end of the test (since workflows are async, not in
the request path, and might take undefinite time to complete).

In order to fix this, I've bypassed the isolated storage check for
workflows internal DOs. I wonder if there might be collisions between
test files if there are any concurrency regarding test files (aka
`singleWorker` is false) - I think that this is fine to do, the point of
this PR is not to make workflows really testable yet but to at least
to make `vitest-pool-workers` **not** crash if a user includes a
workflow in the worker definition.
@LuisDuarte1 LuisDuarte1 requested a review from a team as a code owner February 20, 2025 14:40
Copy link

changeset-bot bot commented Feb 20, 2025

🦋 Changeset detected

Latest commit: dce74d6

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

This PR includes changesets to release 1 package
Name Type
@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

@LuisDuarte1 LuisDuarte1 added the e2e Run wrangler e2e tests on a PR label Feb 20, 2025
Copy link
Contributor

github-actions bot commented Feb 20, 2025

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/13455342618/npm-package-wrangler-8208

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

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

Or you can use npx with this latest build directly:

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

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.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.

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

Successfully merging this pull request may close these issues.

🐛 BUG: Vitest does not work with workflows
1 participant