fix(statusor)!: remove status() accessor returning non-const lvalue #7150
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
google-cla
bot
added
the
cla: yes
This function would allow callers to assign to the contained `Status`
and potentially violate class invariants. For example:
```cc
StatusOr<Foo> sor; // constructed with kUnknown and no Foo
sor.status() = Status{}; // BUG
auto v = sor.value(); // :-|
```
This PR fixes the above API bug by removing the `status()` accessor that
returns the lvalue to non-const T.
I also remove the `status()` overload that returns the rvalue-ref to
const-T, because I don't think it adds any new functionality to the
class, and a "move" isn't actually happening behind the scenes. Also,
the two access that remain (`const &` and `&&`) are the same two that
`absl::StatusOr` [1] has, so we match there.
[1]: https://github.com/abseil/abseil-cpp/blob/bf31a10b65d945665cecfb9d8807702ae4a7fde1/absl/status/statusor.h#L492-L493
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Codecov Report
@@ Coverage Diff @@
## main #7150 +/- ##
==========================================
- Coverage 94.49% 94.49% -0.01%
==========================================
Files 1310 1310
Lines 113220 113212 -8
==========================================
- Hits 106989 106981 -8
Misses 6231 6231
Continue to review full report at Codecov.
|
devjgm
force-pushed
the
fix-statusor-accessors
branch
from
a016b81 to
1b635a4
Compare
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
coryan
approved these changes
Aug 10, 2021
CHANGELOG.md
Outdated
| **BREAKING CHANGES**: | ||
|
|
||
| * `google::cloud::StatusOr<T>` had an accessor that returned an lvalue | ||
| reference to non-const `Status`, which could allow callers to modify the |
There was a problem hiding this comment.
s/, which could allow/. This allowed/ ?
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
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.
This function would allow callers to assign to the contained
Statusand potentially violate class invariants. For example:
This PR fixes the above API bug by removing the
status()accessor thatreturns the lvalue to non-const T.
I also remove the
status()overload that returns the rvalue-ref toconst-T, because I don't think it adds any new functionality to the
class, and a "move" isn't actually happening behind the scenes. Also,
the two access that remain (
const &and&&) are the same two thatabsl::StatusOr1 has, so we match there.This change is