[Rust-Axum][Breaking Change] Implement a customizable error handler #20463
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 implements a way to handle errors that are not handled in the API implementations with the creation of a new
ErrorHandler
trait. This is beneficial for dealing with unknown possible errors, as well as dealing with the repetitive code that comes from manually handling recurring errors between multiple different endpoints.The breaking changes are minimal and unlikely that they will affect people. These are:
Send + Sync + 'static
crate::apis::ErrorHandler
The default implementation sets the error type to
() / unit
, this makes users migrating to the newer version to only be required to add the lineimpl data_models::apis::ErrorHandler for ServerImpl {}
to complete the migration.The error handler itself defaults to logging the returned error with its Debug implementation on the error log level. Users that wish to use their own error type only need to change the Result::Err return type of the methods in the API traits implementations, as well as specify the same error type as the generic type of the
ErrorHandler
trait being implemented in the server implementation.PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples, as manually written tests may be removed.
master
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)@wing328 @linxGnu