Fix a bug where CDC ACM BufferedReceiver repeats data when its future is dropped #4963
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.
This PR fixes a bug where the CDC ACM
BufferedReceivercan repeat previously received data when itsreadfuture is dropped.Under the current implementation of
read, if there's no buffered data and the provided buffer isn't large enough to contain an entire packet,self.startis set to0before awaiting a new packet whileself.endis only updated after a packet arrives. If thereadfuture is dropped at the await point,starthas been reset to0butendretains its old value, causing the next call toreadto repeat the previously received packet.A scenario where you might run into this bug (where I ran into it) is if you want to read with a timeout, e.g.
If the read times out, the
readfuture is dropped mid-execution and theBufferedReceiveris left in an inconsistent state.My fix is to reorder the assignments so they're only updated after receiving a new packet.