Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose Status as a Response extension #2145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tamasfe
Copy link

@tamasfe tamasfe commented Jan 17, 2025

Add the Status itself as an extension to a http::Response so that it is available in middleware.

Motivation

I'd like to implement service-level error inspection. Status contains a source that allows returning pretty much any error, however this is lost when it is converted into a response. The only way to pass information to middleware is headers which is expensive and requires serializable types.

Solution

Simply added the status to the response extensions in Status::into_http(). How a Status is turned into a Response is not specified in the documentation so I did not add additional notes regarding this feature either.

@@ -580,6 +580,7 @@ impl Status {
.headers_mut()
.insert(http::header::CONTENT_TYPE, GRPC_CONTENT_TYPE);
self.add_header(response.headers_mut()).unwrap();
response.extensions_mut().insert(self);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I missing something (its been a while since I looked at this code) but can you not extract the information directly from the headers?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can pass information to the middleware via headers with additional effort when the status is created. Like I said in the PR description, passing more complex types always involves a serialization step (since headers are just bytes) and a deserialization step if a middleware accesses this information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants