Allow for configuring interceptors on generic client #2697
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 adds newtypes `SharedInterceptor` and `AddOnlyInterceptors` around existing types so that they can be used outside of their defining crates without revealing the implementation details.
This commit allows users to pass their own interceptors to `ConfigLoader` and to `SdkConfig`. The docs for their methods are marked as `#[doc(hidden)]` until the orchestrator is fully functional.
This commit updates the codegen to register user-passed-in interceptors. Registration takes place at the client config level and the operation config level. The former is handled in `ServiceRuntimePlugin` and the latter in service config `Builder`.
This commit updates `sra_test` to verify interceptors can be configured at the client config level. It also adds a test to ensure interceptors registered run according to the pre-defined priority.
Co-authored-by: John DiSanti <jdisanti@amazon.com>
Co-authored-by: John DiSanti <jdisanti@amazon.com>
Co-authored-by: John DiSanti <jdisanti@amazon.com>
…egen/client/smithy/customizations/InterceptorConfigCustomization.kt Co-authored-by: John DiSanti <jdisanti@amazon.com>
…egen/client/smithy/customizations/InterceptorConfigCustomization.kt Co-authored-by: John DiSanti <jdisanti@amazon.com>
…egen/client/smithy/generators/config/ServiceConfigGenerator.kt Co-authored-by: John DiSanti <jdisanti@amazon.com>
…ps://github.com/awslabs/smithy-rs into ysaito/configure-interceptors-at-various-levels
This commit addresses #2669 (comment)
This commit addresses #2669 (comment)
This commit addresses the following discussions: #2669 (comment) #2669 (comment)
This commit addresses the following discussions: #2669 (comment) #2669 (comment)
This commit addresses #2669 (comment)
ysaito1001
commented
May 12, 2023
| @@ -216,7 +216,7 @@ async fn make_an_attempt( | |||
| Ok(checkpoint) | |||
| } | |||
|
|
|||
| #[cfg(all(test, feature = "test-util"))] | |||
| #[cfg(all(test, feature = "test-util", feature = "anonymous-auth"))] | |||
There was a problem hiding this comment.
We may want to move what's in anonymous_auth to test-util if it's meant to be used only for testing, but that should probably be discussed & handled in a separate PR if needed. We just specify anonymous-auth here to unblock this PR.
There was a problem hiding this comment.
I don't think it's just for testing, but I'm not 100% on that yet. The question will be: is the absence of an auth scheme/option automatically anonymous, or should we keep this thing around? Probably the former so that a model can explicitly say that an operation doesn't require auth. However, I don't think Smithy has any way to communicate that currently.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
jdisanti
approved these changes
May 12, 2023
aws/sra-test/integration-tests/aws-sdk-s3/tests/interceptors.rs
Outdated
Show resolved
Hide resolved
...re/amazon/smithy/rust/codegen/client/smithy/customizations/InterceptorConfigCustomization.kt
Outdated
Show resolved
Hide resolved
...tware/amazon/smithy/rust/codegen/client/smithy/generators/OperationRuntimePluginGenerator.kt
Outdated
Show resolved
Hide resolved
...oftware/amazon/smithy/rust/codegen/client/smithy/generators/ServiceRuntimePluginGenerator.kt
Outdated
Show resolved
Hide resolved
This commit addresses #2697 (comment)
This commit addresses #2697 (comment)
This commit addresses #2697 (comment)
This commit incorporates feedback #2697 (comment)
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
david-perez
pushed a commit
that referenced
this pull request
May 18, 2023
## Description This PR allows users to pass-in interceptors to a generic client. Client-level configured interceptors are eventually added to `client_interceptors` and operation-level interceptors to `operation_interceptors`, both of which are fields in the `aws-smithy-runtime-api::client::interceptors::Interceptors`. The relevant code is generated only in the orchestrator mode. The SDK registers a default set of (client-level & operation-level) interceptors, and the passed-in interceptors by a user will run _after_ those default interceptors. ## Testing - Added integration tests `operation_interceptor_test` and `interceptor_priority` in `sra_test`. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Yuki Saito <awsaito@amazon.com> Co-authored-by: John DiSanti <jdisanti@amazon.com>
david-perez
pushed a commit
that referenced
this pull request
May 22, 2023
## Description This PR allows users to pass-in interceptors to a generic client. Client-level configured interceptors are eventually added to `client_interceptors` and operation-level interceptors to `operation_interceptors`, both of which are fields in the `aws-smithy-runtime-api::client::interceptors::Interceptors`. The relevant code is generated only in the orchestrator mode. The SDK registers a default set of (client-level & operation-level) interceptors, and the passed-in interceptors by a user will run _after_ those default interceptors. ## Testing - Added integration tests `operation_interceptor_test` and `interceptor_priority` in `sra_test`. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Yuki Saito <awsaito@amazon.com> Co-authored-by: John DiSanti <jdisanti@amazon.com>
david-perez
pushed a commit
that referenced
this pull request
May 22, 2023
## Description This PR allows users to pass-in interceptors to a generic client. Client-level configured interceptors are eventually added to `client_interceptors` and operation-level interceptors to `operation_interceptors`, both of which are fields in the `aws-smithy-runtime-api::client::interceptors::Interceptors`. The relevant code is generated only in the orchestrator mode. The SDK registers a default set of (client-level & operation-level) interceptors, and the passed-in interceptors by a user will run _after_ those default interceptors. ## Testing - Added integration tests `operation_interceptor_test` and `interceptor_priority` in `sra_test`. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Co-authored-by: Yuki Saito <awsaito@amazon.com> Co-authored-by: John DiSanti <jdisanti@amazon.com>
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.
Description
This PR allows users to pass-in interceptors to a generic client. Client-level configured interceptors are eventually added to
client_interceptorsand operation-level interceptors tooperation_interceptors, both of which are fields in theaws-smithy-runtime-api::client::interceptors::Interceptors. The relevant code is generated only in the orchestrator mode.The SDK registers a default set of (client-level & operation-level) interceptors, and the passed-in interceptors by a user will run after those default interceptors.
Testing
operation_interceptor_testandinterceptor_priorityinsra_test.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.