Ensure proper ReqResp response stream termination #5556
Merged
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.
Issue Addressed
Noted that while serving ResResp BlobsByRoot for some errors we properly terminate the stream with an error, while other don't. I believe this is a typo, and caused by the fact that every return statement from the function must include an outbound event. This requirement is prone to typos, and may not be apparent to a contributor.
Proposed Changes
Wrap ReqResp handling functions with a
terminate_response_*
function that forces every handler call to terminate properly:My hope is that future contributors will just extend this PR's pattern and not let streams hanging.
Additional Info
I can't cover the
blocks_by*
methods are their termination is handled on an spawned function. @michaelsproul any way to get the return value from some variant ofexecutor.spawn
to be able to change the signature ofhandle_blocks_by_range_request
toResult<StreamTerminator, RPCError>
?