-
Notifications
You must be signed in to change notification settings - Fork 195
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change timeout settings to merge them when configuration is merged (#…
…3405) ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here --> For context, see #3408 ## Description <!--- Describe your changes in detail --> - During `invoke`, load all timeout configs and merge them via a custom loader. - Fix config bag bugs that prevented using a Stored type that differed from `T`. - Add new e2e and codegen integration test validating that timeout settings are properly merged. - Add fallback for an empty timeout config being equivalent to `TimeoutConfig::disabled`. ## Checklist <!--- If a checkbox below is not applicable, then please DELETE it rather than leaving it unchecked --> - [x] I have updated `CHANGELOG.next.toml` if I made changes to the smithy-rs codegen or runtime crates - [x] I have updated `CHANGELOG.next.toml` if I made changes to the AWS SDK, generated SDK code, or SDK runtime crates ---- _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: John DiSanti <jdisanti@amazon.com>
- Loading branch information
Showing
9 changed files
with
537 additions
and
54 deletions.
There are no files selected for viewing
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 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 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
172 changes: 172 additions & 0 deletions
172
aws/sdk-codegen/src/test/kotlin/software/amazon/smithy/rustsdk/TimeoutConfigMergingTest.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package software.amazon.smithy.rustsdk | ||
|
|
||
| import SdkCodegenIntegrationTest | ||
| import org.junit.jupiter.api.Test | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.Attribute | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.rustTemplate | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.writable | ||
| import software.amazon.smithy.rust.codegen.core.testutil.integrationTest | ||
|
|
||
| class TimeoutConfigMergingTest { | ||
| @Test | ||
| fun testTimeoutSettingsProperlyMerged() { | ||
| awsSdkIntegrationTest(SdkCodegenIntegrationTest.model) { ctx, crate -> | ||
| val name = ctx.moduleUseName() | ||
| crate.integrationTest("timeout_settings_properly_merged") { | ||
| rustTemplate( | ||
| """ | ||
| use $name::Client; | ||
| use aws_smithy_runtime::test_util::capture_test_logs::capture_test_logs; | ||
| use aws_smithy_runtime_api::box_error::BoxError; | ||
| use aws_smithy_runtime_api::client::interceptors::context::BeforeTransmitInterceptorContextRef; | ||
| use aws_smithy_runtime_api::client::interceptors::Intercept; | ||
| use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents; | ||
| use aws_smithy_runtime::client::http::test_util::infallible_client_fn; | ||
| use aws_smithy_types::config_bag::ConfigBag; | ||
| use aws_smithy_types::timeout::TimeoutConfig; | ||
| use aws_smithy_types::body::SdkBody; | ||
| use aws_types::SdkConfig; | ||
| use std::sync::Arc; | ||
| use std::sync::Mutex; | ||
| use std::time::Duration; | ||
| ##[derive(Debug, Clone)] | ||
| struct CaptureConfigInterceptor { | ||
| timeout_config: Arc<Mutex<Option<TimeoutConfig>>>, | ||
| } | ||
| impl Intercept for CaptureConfigInterceptor { | ||
| fn name(&self) -> &'static str { | ||
| "capture config interceptor" | ||
| } | ||
| fn read_before_attempt( | ||
| &self, | ||
| _context: &BeforeTransmitInterceptorContextRef<'_>, | ||
| _runtime_components: &RuntimeComponents, | ||
| cfg: &mut ConfigBag, | ||
| ) -> Result<(), BoxError> { | ||
| *self.timeout_config.lock().unwrap() = cfg.load::<TimeoutConfig>().cloned(); | ||
| Ok(()) | ||
| } | ||
| } | ||
| #{tokio_test} | ||
| async fn test_all_timeouts() { | ||
| let (_logs, _guard) = capture_test_logs(); | ||
| let connect_timeout = Duration::from_secs(1); | ||
| let read_timeout = Duration::from_secs(2); | ||
| let operation_attempt = Duration::from_secs(3); | ||
| let operation = Duration::from_secs(4); | ||
| let http_client = infallible_client_fn(|_req| http::Response::builder().body(SdkBody::empty()).unwrap()); | ||
| let sdk_config = SdkConfig::builder() | ||
| .timeout_config( | ||
| TimeoutConfig::builder() | ||
| .connect_timeout(connect_timeout) | ||
| .build(), | ||
| ) | ||
| .http_client(http_client) | ||
| .build(); | ||
| let client_config = $name::config::Builder::from(&sdk_config) | ||
| .timeout_config(TimeoutConfig::builder().read_timeout(read_timeout).build()) | ||
| .build(); | ||
| let client = Client::from_conf(client_config); | ||
| let interceptor = CaptureConfigInterceptor { | ||
| timeout_config: Default::default(), | ||
| }; | ||
| let _err = client | ||
| .some_operation() | ||
| .customize() | ||
| .config_override( | ||
| $name::Config::builder().timeout_config( | ||
| TimeoutConfig::builder() | ||
| .operation_attempt_timeout(operation_attempt) | ||
| .operation_timeout(operation) | ||
| .build(), | ||
| ), | ||
| ) | ||
| .interceptor(interceptor.clone()) | ||
| .send() | ||
| .await; | ||
| let _ = dbg!(_err); | ||
| assert_eq!( | ||
| interceptor | ||
| .timeout_config | ||
| .lock() | ||
| .unwrap() | ||
| .as_ref() | ||
| .expect("timeout config not set"), | ||
| &TimeoutConfig::builder() | ||
| .operation_timeout(operation) | ||
| .operation_attempt_timeout(operation_attempt) | ||
| .read_timeout(read_timeout) | ||
| .connect_timeout(connect_timeout) | ||
| .build(), | ||
| "full set of timeouts set from all three sources." | ||
| ); | ||
| // disable timeouts | ||
| let _err = client | ||
| .some_operation() | ||
| .customize() | ||
| .config_override( | ||
| $name::Config::builder().timeout_config( | ||
| TimeoutConfig::disabled(), | ||
| ), | ||
| ) | ||
| .interceptor(interceptor.clone()) | ||
| .send() | ||
| .await; | ||
| let _ = dbg!(_err); | ||
| assert_eq!( | ||
| interceptor | ||
| .timeout_config | ||
| .lock() | ||
| .unwrap() | ||
| .as_ref() | ||
| .expect("timeout config not set"), | ||
| &TimeoutConfig::disabled(), | ||
| "timeouts disabled by config override" | ||
| ); | ||
| // override one field | ||
| let _err = client | ||
| .some_operation() | ||
| .customize() | ||
| .config_override( | ||
| $name::Config::builder().timeout_config( | ||
| TimeoutConfig::builder().read_timeout(Duration::from_secs(10)).build(), | ||
| ), | ||
| ) | ||
| .interceptor(interceptor.clone()) | ||
| .send() | ||
| .await; | ||
| let _ = dbg!(_err); | ||
| assert_eq!( | ||
| interceptor | ||
| .timeout_config | ||
| .lock() | ||
| .unwrap() | ||
| .as_ref() | ||
| .expect("timeout config not set"), | ||
| &TimeoutConfig::builder() | ||
| .read_timeout(Duration::from_secs(10)) | ||
| .connect_timeout(connect_timeout) | ||
| .disable_operation_attempt_timeout() | ||
| .disable_operation_timeout() | ||
| .build(), | ||
| "read timeout overridden" | ||
| ); | ||
| } | ||
| """, | ||
| "tokio_test" to writable { Attribute.TokioTest.render(this) }, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } |
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 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
Oops, something went wrong.