soroban-rpc: fix datarace in bufferedResponseWriter.WriteOut #961
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.
What
Fix data race #959 .
Why
When implementing
bufferedResponseWriter.WriteOut
, I attempted to implement the writing to the output stream asynchronously, so that in case of context expiration the writing to the channel would be suspended at once.Unfortuntally, it led to conflict with go http server library : When the
bufferedResponseWriter.WriteOut
could not complete writing to the stream in time, the method would return. However, the writing operation was still going on it's own pace.then, the http server was attempting to write to the stream, creating a data race.
The solution is to write to the stream in smaller chunks, and continuously check the ctx.Err in order to examine when it expires.
Known limitations
n/a