Fix appending the API_BODY_SUFFIX twice #36
Closed
Conversation
This file contains 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
prost 0.7 uses `intersperse` of which there are two implementations available – in itertools and, since recently, in the standard library. These implementatinos are compatible, but the compiler is not able to know which one is intended, so its an error.
When the message batch approaches the limit we will hit the branch within which we accidentally appended the trailing `]}` twice to the request body. This branch was previously covered by our tests, in particular the `segmenter_preserves_order_when_splitting`, but due to the lack of assertions we never actually verified that the JSON we produce is valid. Here we remove the invalid append, and some debug assertions as well as a regression test for this issue.
Off-by-ones are scary.
rnarubin
reviewed
Oct 20, 2021
There was a problem hiding this comment.
bumping prost is a major version change -- I'm not opposed to that, but it would be a shame to tie that to this bug fix. Docs say this is still unstable https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.intersperse is it only a problem with users of recent nightly builds?
|
Ah, it was in beta and would've made its way into stable… tomorrow. But I didn't see rust-lang/rust#89638, I'll undo the prost change. |
rnarubin
approved these changes
Oct 20, 2021
|
Merged in e698054 |
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.
When the message batch approaches the limit we will hit the branch
within which we accidentally appended the trailing
]}twice to therequest body.
This branch was previously covered by our tests, in particular the
segmenter_preserves_order_when_splitting, but due to the lack ofassertions we never actually verified that the JSON we produce is valid.
Here we remove the invalid append, and some debug assertions as well as
a regression test for this issue.
NB: this is a short term fix before #34 is ready.