feat(vitest-pool-workers): tolerate post-stop() socket error events when configured#14794
Conversation
workerd can segfault during shutdown on linux-x64 / WSL2 and macOS-arm64 (cloudflare/workerd#6763). After every test in a file has already reported as passing, the segfault propagates as a WebSocket `error` event which vitest surfaces as `[vitest-pool]: Worker cloudflare-pool emitted error`, failing an otherwise-passing run with exit 1. Add an opt-in `tolerateWorkerShutdownErrors: boolean` option (default `false`). When enabled, `error` events received after `stop()` has begun are logged via `NODE_DEBUG=vitest-pool-workers` and not forwarded to vitest as fatal. Errors received while the pool worker is still running are propagated unchanged. This complements the dispose-side fix in cloudflare#14793 (which wraps the Miniflare and remote-proxy session `dispose()` calls with `catch()`): the dispose fix tolerates teardown promise rejections, while this option tolerates the post-teardown WebSocket `error` event. Both opt-in; both default `false`. Reproduction (matches the linked upstream issue): Tests 794 passed (794) ❌ vitest exit 1 [vitest-pool]: Worker cloudflare-pool emitted error. Caused by: Worker exited unexpectedly With `tolerateWorkerShutdownErrors: true`, the same suite reports `794 passed` and exits 0. The segfault is still printed to stderr under `NODE_DEBUG=vitest-pool-workers`; only the test-side exit suppression changes. Scope is a test-side mitigation only — the upstream `Received signal cloudflare#11` still needs to be fixed in workerd itself.
🦋 Changeset detectedLatest commit: 0f8d2c8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
Codeowners approval required for this PR:
Show detailed file reviewers
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| "@cloudflare/vitest-pool-workers": patch | ||
| --- | ||
|
|
||
| fix: tolerate post-`stop()` socket `error` events when configured |
There was a problem hiding this comment.
🟡 Changeset title uses a forbidden conventional-commit prefix
The changeset headline starts with a fix: type prefix (.changeset/pool-worker-tolerate-shutdown-socket-errors.md:5), which the repository's review guidelines explicitly forbid for changeset titles.
Impact: The changelog entry will be formatted against the project's stated conventions and may require rework before release.
Rule source in REVIEW.md
REVIEW.md's Changesets section states: "Do NOT prefix changeset titles with a 'type' (e.g. fix:, feat:, chore:). The changeset title should be a plain description without conventional commit prefixes." The title on .changeset/pool-worker-tolerate-shutdown-socket-errors.md:5 begins with fix:.
| fix: tolerate post-`stop()` socket `error` events when configured | |
| Tolerate post-`stop()` socket `error` events when configured |
Was this helpful? React with 👍 or 👎 to provide feedback.
| @@ -0,0 +1,43 @@ | |||
| --- | |||
| "@cloudflare/vitest-pool-workers": patch | |||
There was a problem hiding this comment.
🟡 New opt-in option is released as a patch instead of a minor version
The changeset is declared as patch (.changeset/pool-worker-tolerate-shutdown-socket-errors.md:2) even though the change introduces a brand-new user-facing configuration option, which the repository's semver rules classify as a minor.
Impact: The new capability ships in a patch release, understating the change and diverging from the project's versioning policy.
Rule source in REVIEW.md
REVIEW.md's Semver Classification lists "new commands/flags/options, new API capabilities" under Minor. This PR adds the new tolerateWorkerShutdownErrors option (packages/vitest-pool-workers/src/pool/config.ts:90), so the changeset front-matter on .changeset/pool-worker-tolerate-shutdown-socket-errors.md:2 should be minor rather than patch.
| "@cloudflare/vitest-pool-workers": patch | |
| "@cloudflare/vitest-pool-workers": minor |
Was this helpful? React with 👍 or 👎 to provide feedback.
3 participants
What
When workerd segfaults during shutdown (cloudflare/workerd#6763), miniflare's WebSocket dispatches an
errorevent after every test in the file has already been reported as passing. vitest then surfaces this as[vitest-pool]: Worker cloudflare-pool emitted errorand fails the run with exit 1.This change adds a new opt-in
tolerateWorkerShutdownErrors: booleanoption to the cloudflare-pool worker configuration. When enabled,errorevents received afterstop()has begun are logged viaNODE_DEBUG=vitest-pool-workersand not propagated to vitest as fatal errors. The default behavior is unchanged.Relationship to #14793
This PR is intentionally distinct from #14793 (which wraps Miniflare#dispose() and the remote-proxy session dispose() with .catch()). The two changes tolerate different amplifiers in the same root-cause chain:
Both are useful. They can be enabled together or independently. Neither fixes the underlying workerd SIGSEGV — that needs to be done in workerd itself.
Root-cause recap
The workerd SIGSEGV is the trigger; the test-side non-zero exit is three layers deep:
Reproduction
With
tolerateWorkerShutdownErrors: true, the same suite reports794 passedand exits 0. The segfault is still printed to stderr; only the test-side exit suppression changes.Implementation notes
Related
wrangler publish#2) of Bug: workerd segfaults intermittently on shutdown under vitest-pool-workers (linux-x64 and macOS-arm64) workerd#6763.wrangler dev#1).🤖 Generated with Claude Code