-
Notifications
You must be signed in to change notification settings - Fork 6k
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
[rust-server] Enhance middleware support (+ perf fix) #8114
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
@technical_committee and relevant person: @frol @farcaller @wing328 The description above should give a good idea of the motivation for these changes. |
bjgill
changed the title
Context changes
[rust-server] Enhance middleware support (+ perf fix)
May 1, 2018
LGTM |
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.
PR checklist
./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
and./bin/security/{LANG}-petstore.sh
if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\
.3.0.0
branch for changes related to OpenAPI spec 3.0. Default:master
.Description of the PR
Stop re-creating hyper clients
To workaround a bug in pre-async
hyper
, we had to re-create the HTTP client for each client call. This bug has since been fixed, so we can remove the workaround for an unquantified performance benefit.Context
enhancementUpdates rust-server to use v0.12.1 of the swagger-rs crate. This replaces the old
Context
struct with a generic type parameter, using trait bounds to specify what each hyper service expects the context to contain. This allows hyper middleware layers to exchange data without intermediate layers needing to know about it.The traits for manipulating contexts are
Has<T>
(for accessing a field of typeT
in the context),Push<T>
(for adding a field of typeT
to the context) andPop<T>
(for removing a field of typeT
from the context).The following changes will be neccessary in the
main.rs
file of a service using rust-server:NoAuthentication
struct fromswagger-rs
withAddContext
from the same crate. This is a simple renaming.EmptyContext
type fromswagger-rs
. Do this if you are not using any hyper services other thanAddContext
and those generated by swagger-codegen.new_context_type!
macro fromswagger-rs
to define a new context builder and empty context type, passing the macro a list of types that will be stored in the context. Do this if you use a hyper middleware layer that adds anything else to the context.EmptyContext
(or the new empty context type you defined withnew_context_type!
) as an explicit type parameter to theAddContext
struct that you instantiate.For example, the following code
would be replaced with
See the rust-server petstore sample code, and the doc comments and test module in
swagger-rs/src/context.rs
for more details and examples.(with thanks to @tca-ms, @alango and @NigelThorpe)