[GOAL2-784] Fix random network unit test failures #75
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.
Summary
Our existing websocket library would fail to flush the first few messages, as long as the messages accumulated size is below 4096 bytes.
Explanation
The websocket library is creating a thread that is responsible for flushing the pending buffer content. When a write operation is complete, the flushing thread is being woken up to flush the buffer content.
The issue is that upon startup, the connection might get created, followed by several messages being sent. If that happens before the flushing thread start to execute, the flushing thread might miss the signal which indicates it needs to flush the outgoing buffer content.
In the context of our unit tests, where we send two small messages and wait until they reach the other socket, it being expressed as a flaky test.
Solution
The first for this is pretty straight forward; on the flushing thread, just flush the content of the buffer upon startup without waiting for a signal. Then, wait for the signal which would handle the subsequent iteration.