fix: await async callbacks in CommandHandle.wait()#1261
Open
YizukiAme wants to merge 3 commits intoe2b-dev:mainfrom
Open
fix: await async callbacks in CommandHandle.wait()#1261YizukiAme wants to merge 3 commits intoe2b-dev:mainfrom
YizukiAme wants to merge 3 commits intoe2b-dev:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 7e915b3 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 |
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.
Fixes #1259
Problem
The
CommandHandle.wait()method firesonStdout,onStderr, andonPtycallbacks withoutawait, so async callbacks run as fire-and-forget microtasks. If a callback performs I/O (e.g. writing to a file, sending over network),wait()can resolve before the callback finishes, leading to lost data or race conditions.Fix
Add
awaitbefore each optional-chain callback invocation:This is fully backwards compatible —
await-ing a sync function's return value is a no-op.Tests
3 parameterized test cases (
stdout,stderr,pty) verify thatwait()does not resolve until an async callback's promise settles.This fix was developed with AI assistance and reviewed by a human.