Fix handshake never starting when using options.stream - #1518
Open
u9g wants to merge 1 commit into
Open
Conversation
tcp_dns emitted 'connect' synchronously inside options.connect(), before setProtocol had subscribed, so clients created with a custom stream hung without ever sending the handshake. Defer the emit one tick.
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.
Problem
Creating a client with a custom stream (
options.stream) hangs forever without sending the handshake:For offline auth,
createClientcallsoptions.connect(client)beforeonReady()runs. The stream branch intcp_dns.jsemits'connect'synchronously inside that call, sosetProtocol(which subscribes inonReady()and sendsset_protocolon'connect') never sees the event. The plain-socket path doesn't hit this becausenet.connectcompletes asynchronously.It reproduces whenever the provided stream doesn't emit its own
'connect'later — e.g. an already-connected socket, or any generic Duplex (I hit this tunneling the protocol bytes over a WebSocket).Fix
Defer the emit one tick so listeners registered after
options.connect()returns still see it.Added a regression test in
serverTest.js— it times out on master and passes with the fix, across all supported versions.