fix(storage): check ReadObject options at runtime #12841
Merged
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
Some options for `ReadObject()` can only be freely combined. The application intent is unclear when somebody says `ReadRange(1, 10)` and `ReadLast(7)`. And it is impossible to represent this as two instructions that the service can disambiguate. We were checking for the presence of these options in the parameter pack, but that does not work, because the options can be "set" with no value (maybe at runtime choosing to set either `ReadLast()` or `ReadRange()`). Adding insult to injury, I forgot to `std::decay_t` the types in the parameter pack, so the compile-time check did not always work either. In hindsight we should have represented them by a `absl::variant<>` or some other type that did not allow for illegal combinations, too late to do that.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #12841 +/- ##
=======================================
Coverage 93.54% 93.55%
=======================================
Files 2074 2074
Lines 180381 180430 +49
=======================================
+ Hits 168744 168793 +49
Misses 11637 11637
☔ View full report in Codecov by Sentry. |
devbww
approved these changes
Oct 6, 2023
Comment on lines
321
to
325
| // With the REST API this condition was detected by the server as an error, | ||
| // generally we prefer the server to detect errors because its answers are | ||
| // authoritative. In this case, the server cannot: with gRPC '0' is the same | ||
| // as "not set" and the server would send back the full file, which was | ||
| // unlikely to be the customer's intent. |
There was a problem hiding this comment.
Opt: Some sentence-break/wording suggestions:
// With the REST API this condition was detected by the server as an error.
// Generally we prefer the server to detect errors because its answers are
// authoritative, but in this case it cannot. With gRPC, '0' is the same as
// "not set" so the server would send back the full file, and that is unlikely
// to be the customer's intent.
Address review comments
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.
Some options for
ReadObject()can only be freely combined. The application intent is unclear when somebody saysReadRange(1, 10)andReadLast(7). And it is impossible to represent this as two instructions that the service can disambiguate.We were checking for the presence of these options in the parameter pack, but that does not work, because the options can be "set" with no value (maybe at runtime choosing to set either
ReadLast()orReadRange()). Adding insult to injury, I forgot tostd::decay_tthe types in the parameter pack, so the compile-time check did not always work either.In hindsight we should have represented them by a
absl::variant<>or some other type that did not allow for illegal combinations, too late to do that.This change is