Repository navigation
fix: unwrap Promise return types in Pool.exec() - #605
Open
AkaashParmar wants to merge 1 commit into
Open
AkaashParmar wants to merge 1 commit into
AkaashParmar wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix double Promise typing in Pool.exec()
Fixes #485
Problem
The JSDoc return type of
Pool.exec()was declared asPromise<ReturnType<T>>.When a worker function returns a native Promise, such as
async function encode(): Promise<Blob>, TypeScript inferred an incorrectly nested Promise type. However, workerpool resolves asynchronous results at runtime before returning them to the caller.Solution
Updated the return annotation in
src/Pool.jsto:Promise<Awaited<ReturnType<T>>>This correctly unwraps Promise and Promise-like return types while preserving synchronous return types.
Tests
Added compile-time regression tests in
test/types/workerpool-tests.tscovering:Promise<Blob>Promise<void>Validation
npm run build:types— Passednpm run test:types— Passedgit diff --check— PassedOne worker graceful-exit timeout was reproduced on the clean upstream branch in the same Windows environment. The other timeout has not yet been independently verified against upstream.