Deny anyhow #32135
Open
Deny anyhow #32135
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
Denies the use of the anyhow `anyhow` and `bail` macros, which are the main entry points to anyhow. It does not prevent using the error/result types as they're often just passed through. Part of MaterializeInc/database-issues#9092 Signed-off-by: Moritz Hoffmann <[email protected]>
Signed-off-by: Moritz Hoffmann <[email protected]>
antiguru
requested review from
a team,
ggevay,
teskje and
ParkMyCar
as code owners
pH14
reviewed
Apr 10, 2025
There was a problem hiding this comment.
The risks outlined in https://github.com/MaterializeInc/database-issues/issues/9092 seem reasonable, but we should also make the path forward very obvious to anyone touching the code because it might be surprising that anyhow is to be avoided.
Following the deprecation warnings, we should be able to answer:
- If someone is writing net-new error handling code, what does it look like in absence of
anyhow? Are there any references to model after? - If someone needs to update the existing code, what should they do?
| @@ -88,9 +88,12 @@ disallowed-macros = [ | |||
| { path = "proptest::prop_oneof", reason = "use `proptest::strategy::Union::new` instead" }, | |||
| { path = "log::log", reason = "use the macros provided by `tracing` instead (database-issues#3001)" }, | |||
| { path = "tracing::instrument", reason = "use `mz_ore::instrument` instead" }, | |||
| { path = "anyhow::anyhow", reason = "use structured errors instead" }, | |||
| { path = "anyhow::bail", reason = "use structured errors instead" }, | |||
There was a problem hiding this comment.
imo this would be more valuable with a fleshed out example to point people towards
| @@ -7,6 +7,9 @@ | |||
| // the Business Source License, use of this software will be governed | |||
| // by the Apache License, Version 2.0. | |||
|
|
|||
| // database-issues#9092: anyhow should not be used. | |||
There was a problem hiding this comment.
the breadcrumb trail here should also lead folks to the right solution
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.
Deny access to anyhow macros and some types
Deny access to the anyhow macros
anyhowandbail, and theResulttype. This covers most of our use of anyhow where we're not just passing errors around.We could also deny
anyhow::Error, but that would need us to silence another 1000+ warnings, which I feel has diminishing returns: we're mostly interested to finding places where we construct errors, which are covered by this change. Unfortunately, anyhow allows silent error conversion, meaning any?operator can convert from an error toanyhow, so we should eventually denyanyhow::Error, too.In support of MaterializeInc/database-issues#9092
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.