FIX Flaky test: Clean up a clientSocket #2721
Merged
Conversation
This file contains 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
Test 'should be able to close sio sending a port' defined a clientSocket but didn't set 'reconnection: false'. Now, the default behavior of a clientSocket is 'reconnection: true'. As a result, the clientSocket was "leaked" from the test case and seemed to intermittently connect to the servers in subsequent test cases. This would cause other tests to timeout unexpectedly. It's not clear to me why this would happen, since the test case assigns a unique port number to the socket. However, if you go into socket.io-client and assign and log unique IDs to each socket, then you'll see that this clientSocket shows up in other test cases if the reconnectionDelay strikes unluckily.
|
Thanks! |
dzad
pushed a commit
to dzad/socket.io
that referenced
this pull request
May 29, 2023
Test 'should be able to close sio sending a port' defined a clientSocket but didn't set 'reconnection: false'. Now, the default behavior of a clientSocket is 'reconnection: true'. As a result, the clientSocket was "leaked" from the test case and seemed to intermittently connect to the servers in subsequent test cases. This would cause other tests to timeout unexpectedly. It's not clear to me why this would happen, since the test case assigns a unique port number to the socket. However, if you go into socket.io-client and assign and log unique IDs to each socket, then you'll see that this clientSocket shows up in other test cases if the reconnectionDelay strikes unluckily.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Test 'should be able to close sio sending a port' defined a clientSocket
but didn't set 'reconnection: false'.
Now, the default behavior of a clientSocket is 'reconnection: true'.
As a result, the clientSocket was "leaked" from the test case
and seemed to intermittently connect to the servers in subsequent
test cases. This would cause other tests to timeout unexpectedly.
It's not clear to me why this would happen, since the test case
assigns a unique port number to the socket.
However, if you go into socket.io-client and assign and log
unique IDs to each socket, then you'll see that this clientSocket
shows up in other test cases if the reconnectionDelay strikes
unluckily.
A better fix might be to close the socket before exiting the test, but I'm not 100% sure how to do that since I don't see a call to done() anywhere.