DEBUG-log server request rejections
#2597
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
This commit logs server request rejections at the `DEBUG` level in an operation's `FromRequest` implementation. This commit is analogous to the one in PR #2524 for response rejections. However, request rejections are _not_ errors, so they shouldn't be logged at the `ERROR` level. Indeed, they happen every time the server rejects a malformed request. Prior to this commit, the `RuntimeError::NotAcceptable` variant was the only `RuntimeError` variant that was manually constructed. This commit makes it so that it now results from a conversion from a new `RequestRejection::NotAcceptable` variant. We now leverage `futures_util::future::FutureExt::map` to map a future that uses `RequestRejection` as its error into a future that uses `RuntimeError`, and centrally log the rejection there. `futures_util` is already a transitive dependency of server SDKs (via e.g. `hyper` and `tower`), so adding it is a direct dependency is not worse. This helps with #2521.
david-perez
commented
Apr 19, 2023
| @@ -18,6 +18,8 @@ pub enum ResponseRejection { | |||
| pub enum RequestRejection { | |||
| #[error("error converting non-streaming body to bytes: {0}")] | |||
| BufferHttpBodyBytes(crate::Error), | |||
| #[error("request contains invalid value for `Accept` header")] | |||
| NotAcceptable, | |||
There was a problem hiding this comment.
I'll make these take in the invalid HeaderValue in a follow-up PR.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
hlbarber
approved these changes
Apr 19, 2023
| @@ -252,13 +251,19 @@ class ServerHttpBoundProtocolTraitImplGenerator( | |||
| .await | |||
| .map_err(Into::into) | |||
| }; | |||
| use #{FuturesUtil}::future::FutureExt; | |||
There was a problem hiding this comment.
Can we use TryFutureExt::map_err?
There was a problem hiding this comment.
Nice, TIL about TryFutureExt::map_err. I switched over to that in e61ed46, and amended the PR description.
|
Oops, I realized I copy-pasted the |
I was wondering about that :) |
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
unexge
pushed a commit
that referenced
this pull request
Apr 24, 2023
This commit logs server request rejections at the `DEBUG` level in an operation's `FromRequest` implementation. This commit is analogous to the one in PR #2524 for response rejections. However, request rejections are _not_ errors, so they shouldn't be logged at the `ERROR` level. Indeed, they happen every time the server rejects a malformed request. Prior to this commit, the `RuntimeError::NotAcceptable` variant was the only `RuntimeError` variant that was manually constructed. This commit makes it so that it now results from a conversion from a new `RequestRejection::NotAcceptable` variant. We now leverage `futures_util::future::TryFutureExt::map` to map a future that uses `RequestRejection` as its error into a future that uses `RuntimeError`, and centrally log the rejection there. `futures_util` is already a transitive dependency of server SDKs (via e.g. `hyper` and `tower`), so adding it is a direct dependency is not worse. This helps with #2521. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._
rcoh
pushed a commit
that referenced
this pull request
Apr 24, 2023
This commit logs server request rejections at the `DEBUG` level in an operation's `FromRequest` implementation. This commit is analogous to the one in PR #2524 for response rejections. However, request rejections are _not_ errors, so they shouldn't be logged at the `ERROR` level. Indeed, they happen every time the server rejects a malformed request. Prior to this commit, the `RuntimeError::NotAcceptable` variant was the only `RuntimeError` variant that was manually constructed. This commit makes it so that it now results from a conversion from a new `RequestRejection::NotAcceptable` variant. We now leverage `futures_util::future::TryFutureExt::map` to map a future that uses `RequestRejection` as its error into a future that uses `RuntimeError`, and centrally log the rejection there. `futures_util` is already a transitive dependency of server SDKs (via e.g. `hyper` and `tower`), so adding it is a direct dependency is not worse. This helps with #2521. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._
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 commit logs server request rejections at the
DEBUGlevel in anoperation's
FromRequestimplementation.This commit is analogous to the one in PR #2524 for response rejections.
However, request rejections are not errors, so they shouldn't be
logged at the
ERRORlevel. Indeed, they happen every time the serverrejects a malformed request.
Prior to this commit, the
RuntimeError::NotAcceptablevariant was theonly
RuntimeErrorvariant that was manually constructed. This commitmakes it so that it now results from a conversion from a new
RequestRejection::NotAcceptablevariant.We now leverage
futures_util::future::TryFutureExt::mapto map a futurethat uses
RequestRejectionas its error into a future that usesRuntimeError, and centrally log the rejection there.futures_utilisalready a transitive dependency of server SDKs (via e.g.
hyperandtower), so adding it is a direct dependency is not worse.This helps with #2521.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.