fix(app): Ensure streams are pruned after done #178
Conversation
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
erickpintor
force-pushed
the
erick/fix-streams-map-pruning
branch
from
72fad53 to
170b65e
Compare
Previous code called `StreamState::is_done` inside `StreamState::insert` to check if the stream was complete. If so, it would transfer ownership of its inner parts to the returned `ProposalParts`, making subsequent calls to `is_done` return `false`. The `StreamState::is_done` was also called after `StreamState::insert` by `PartStreamsMap::insert` to check if the stream was complete and remove it from the pending streams map. Since the second call to `is_done` after the stream is complete always returns `false`, the streams map was never pruned. This patch modifies the ownership requirements of `StreamState::insert` so it takes ownership over the current stream state. If the stream is incomplete, it returns the ownership back. On completed streams, however, it consumes its inner components and return a `ProposedParts`. This approach prevents future use of the stream state after its inner components have been transferred to the returned `ProposedParts`.
erickpintor
force-pushed
the
erick/fix-streams-map-pruning
branch
from
170b65e to
e4cc848
Compare
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.
Previous code called
StreamState::is_doneinsideStreamState::insertto check if the stream was complete. If so, it would transfer ownership of its inner parts to the returnedProposalParts, making subsequent calls tois_donereturnfalse.The
StreamState::is_donewas also called afterStreamState::insertbyPartStreamsMap::insertto check if the stream was complete and remove it from the pending streams map. Since the second call tois_doneafter the stream is complete always returnsfalse, the streams map was never pruned.This patch modifies the ownership requirements of
StreamState::insertso it takes ownership over the current stream state. If the stream is incomplete, it returns the ownership back. On completed streams, however, it consumes its inner components and return aProposedParts.This approach prevents future use of the stream state after its inner components have been transferred to the returned
ProposedParts.