Skip to content

Fix buffered worker send failures escape the WorkerError channel - #7114

Merged
tim-smart merged 2 commits into
mainfrom
audit/repro-b206fa5d76-worker-buffered-send-error
Aug 7, 2026
Merged

Fix buffered worker send failures escape the WorkerError channel#7114
tim-smart merged 2 commits into
mainfrom
audit/repro-b206fa5d76-worker-buffered-send-error

Conversation

@fubhy

@fubhy fubhy commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

Buffered workers previously called port.postMessage directly while draining messages queued before readiness, so synchronous platform failures escaped as Effect defects.

This change routes both buffered and ready sends through the same error translation, surfacing failures as WorkerError with reason WorkerSendError. It keeps the focused regression in the module's existing WorkerError.test.ts file and adds a patch changeset.

Validation

  • pnpm test --run packages/effect/test/unstable/workers/WorkerError.test.ts
  • pnpm test --run --project effect
  • pnpm --filter effect check
  • pnpm lint
  • pnpm changeset status --since origin/main

Audit provenance

  • Audit ID: relsem-worker-buffered-send-error
  • Audit base: b206fa5d7655c1634c9993410a9203f6616a5ca2
  • Reproduction base: b206fa5d7655c1634c9993410a9203f6616a5ca2

Closes EFF-549

@fubhy fubhy added the audit Findings originating from the Effect runtime correctness audit label Aug 7, 2026
@changeset-bot

changeset-bot Bot commented Aug 7, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0c926cc

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

This PR includes changesets to release 30 packages
Name Type
effect Patch
@effect/ai-anthropic Patch
@effect/ai-openai Patch
@effect/ai-openai-compat Patch
@effect/ai-openrouter Patch
@effect/atom-react Patch
@effect/atom-solid Patch
@effect/atom-vue Patch
@effect/docgen Patch
@effect/doctest Patch
@effect/openapi-generator Patch
@effect/opentelemetry Patch
@effect/platform-browser Patch
@effect/platform-bun Patch
@effect/platform-deno Patch
@effect/platform-node Patch
@effect/platform-node-shared Patch
@effect/sql-clickhouse Patch
@effect/sql-d1 Patch
@effect/sql-libsql Patch
@effect/sql-mssql Patch
@effect/sql-mysql2 Patch
@effect/sql-pg Patch
@effect/sql-pglite Patch
@effect/sql-sqlite-bun Patch
@effect/sql-sqlite-do Patch
@effect/sql-sqlite-node Patch
@effect/sql-sqlite-react-native Patch
@effect/sql-sqlite-wasm Patch
@effect/vitest 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

@effect-slopcop effect-slopcop Bot added 4.0 bug Something isn't working labels Aug 7, 2026

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Important

This PR currently adds only the regression test; the implementation fix in packages/effect/src/unstable/workers/Worker.ts is not yet included, so the new test fails as expected and CI cannot pass.

Reviewed changes

  • Added a focused reproduction test in packages/effect/test/unstable/workers/WorkerError.test.ts that verifies a synchronous postMessage failure during the buffered-send drain is surfaced as WorkerError with reason WorkerSendError rather than escaping as an Effect defect.

⚠️ Implementation fix is missing

The failing test confirms the bug. The fix needs to wrap the buffered drain at packages/effect/src/unstable/workers/Worker.ts:210-215 in the same try/catch that send uses at lines 227-238, converting the thrown error into a WorkerSendError failure. A shared helper would avoid duplicating the WorkerError construction.

Technical details
# Buffered send error handling

## Affected sites
- `packages/effect/src/unstable/workers/Worker.ts:210-215``port.postMessage` is called directly inside the ready-path buffer loop, outside any `try/catch`

## Required outcome
- Synchronous `postMessage` failures during buffered-send drain must be caught and converted to `WorkerError` with reason `WorkerSendError`, matching the non-buffered `send` path.

## Suggested approach
- Extract the `try/catch`/`WorkerSendError` logic from `send` into a helper and call it once per buffered message before clearing the buffer, or inline the same `try/catch` in the drain loop.

ℹ️ Nitpicks

  • The PR title says "Fix..." but the diff contains only the test; consider renaming the PR or adding the fix before merging.

Pullfrog  | ⚠️ this action is pinned to a commit SHA, which freezes the cleanup step — switch to @v0 or keep the SHA fresh with Dependabot | Fix it ➔View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes

  • Added a shared sendToPort helper in packages/effect/src/unstable/workers/Worker.ts that wraps port.postMessage in Effect.try and converts synchronous failures to WorkerError with reason WorkerSendError.
  • Replaced the direct postMessage call in the buffered-send drain with yield* sendToPort(...), so failures during drain are surfaced as failures instead of defects.
  • Replaced the inline try/catch in the ready-send path with a return sendToPort(...), unifying both send paths under the same error translation.
  • Added a patch changeset describing the runtime behavior change.

Pullfrog  | ⚠️ this action is pinned to a commit SHA, which freezes the cleanup step — switch to @v0 or keep the SHA fresh with Dependabot | View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Bundle Size Analysis

Generated from PR build output; treat the content below as untrusted.

File Name Current Size Previous Size Difference
basic.ts 6.92 KB 6.92 KB 0.00 KB (0.00%)
batching.ts 9.72 KB 9.72 KB 0.00 KB (0.00%)
brand.ts 6.60 KB 6.60 KB 0.00 KB (0.00%)
cache.ts 10.59 KB 10.59 KB 0.00 KB (0.00%)
config.ts 20.83 KB 20.83 KB 0.00 KB (0.00%)
differ.ts 19.67 KB 19.67 KB 0.00 KB (0.00%)
http-client.ts 21.50 KB 21.50 KB 0.00 KB (0.00%)
logger.ts 10.81 KB 10.81 KB 0.00 KB (0.00%)
metric.ts 8.86 KB 8.86 KB 0.00 KB (0.00%)
optic.ts 6.68 KB 6.68 KB 0.00 KB (0.00%)
pubsub.ts 14.86 KB 14.86 KB 0.00 KB (0.00%)
queue.ts 11.54 KB 11.54 KB 0.00 KB (0.00%)
schedule.ts 10.71 KB 10.71 KB 0.00 KB (0.00%)
schema-class.ts 19.38 KB 19.38 KB 0.00 KB (0.00%)
schema-fromJsonSchemaDocument.ts 29.24 KB 29.24 KB 0.00 KB (0.00%)
schema-representation-roundtrip.ts 25.51 KB 25.51 KB 0.00 KB (0.00%)
schema-string-transformation.ts 13.49 KB 13.49 KB 0.00 KB (0.00%)
schema-string.ts 11.03 KB 11.03 KB 0.00 KB (0.00%)
schema-template-literal.ts 15.30 KB 15.30 KB 0.00 KB (0.00%)
schema-toArbitraryLazy.ts 21.43 KB 21.43 KB 0.00 KB (0.00%)
schema-toCodeDocument.ts 23.87 KB 23.87 KB 0.00 KB (0.00%)
schema-toCodecJson.ts 18.64 KB 18.64 KB 0.00 KB (0.00%)
schema-toEquivalence.ts 18.47 KB 18.47 KB 0.00 KB (0.00%)
schema-toFormatter.ts 18.32 KB 18.32 KB 0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts 22.09 KB 22.09 KB 0.00 KB (0.00%)
schema-toRepresentation.ts 19.01 KB 19.01 KB 0.00 KB (0.00%)
schema.ts 18.62 KB 18.62 KB 0.00 KB (0.00%)
stm.ts 12.59 KB 12.59 KB 0.00 KB (0.00%)
stream.ts 9.67 KB 9.67 KB 0.00 KB (0.00%)

@tim-smart
tim-smart merged commit 6310a8c into main Aug 7, 2026
20 checks passed
@tim-smart
tim-smart deleted the audit/repro-b206fa5d76-worker-buffered-send-error branch August 7, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.0 audit Findings originating from the Effect runtime correctness audit bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants