Skip to content

Commit 3d0db56

Browse files
authored
Categorize orchestrator TODO comments into Launch and Cleanup (#2774)
This PR categorizes orchestrator TODO comments into `Launch` and `Cleanup`: - `enableNewSmithyRuntimeLaunch`: Comment needs to be addressed before orchestrator launch - `enableNewSmithyRuntimeCleanup`: Comment needs to be addressed after launch when removing middleware ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._
1 parent 45885b1 commit 3d0db56

File tree

54 files changed

+87
-91
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+87
-91
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
test:
8585
- action: check-aws-sdk-adhoc-tests
8686
runner: ubuntu-latest
87-
# TODO(enableNewSmithyRuntime): Remove `check-aws-sdk-orchestrator-impl` when cleaning up middleware
87+
# TODO(enableNewSmithyRuntimeCleanup): Remove `check-aws-sdk-orchestrator-impl` when cleaning up middleware
8888
- action: check-aws-sdk-orchestrator-impl
8989
runner: smithy_ubuntu-latest_8-core
9090
- action: check-client-codegen-integration-tests

aws/rust-runtime/aws-config/src/sso.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ async fn load_sso_credentials(
217217
.region(sso_provider_config.region.clone())
218218
.credentials_cache(CredentialsCache::no_caching())
219219
.build();
220-
// TODO(enableNewSmithyRuntime): Use `customize().config_override()` to set the region instead of creating a new client once middleware is removed
220+
// TODO(enableNewSmithyRuntimeCleanup): Use `customize().config_override()` to set the region instead of creating a new client once middleware is removed
221221
let client = SsoClient::from_conf(config);
222222
let resp = client
223223
.get_role_credentials()

aws/rust-runtime/aws-http/src/recursion_detection.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use http::HeaderValue;
1111
use percent_encoding::{percent_encode, CONTROLS};
1212
use std::borrow::Cow;
1313

14-
// TODO(enableNewSmithyRuntime): Delete this module
14+
// TODO(enableNewSmithyRuntimeCleanup): Delete this module
1515

1616
/// Recursion Detection Middleware
1717
///

aws/rust-runtime/aws-http/src/user_agent.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ impl fmt::Display for ExecEnvMetadata {
513513
}
514514
}
515515

516-
// TODO(enableNewSmithyRuntime): Delete the user agent Tower middleware and consider moving all the remaining code into aws-runtime
516+
// TODO(enableNewSmithyRuntimeCleanup): Delete the user agent Tower middleware and consider moving all the remaining code into aws-runtime
517517

518518
/// User agent middleware
519519
#[non_exhaustive]

aws/rust-runtime/aws-inlineable/src/glacier_checksums.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
// TODO(enableNewSmithyRuntime): Delete this file when cleaning up middleware
6+
// TODO(enableNewSmithyRuntimeCleanup): Delete this file when cleaning up middleware
77

88
use aws_sig_auth::signer::SignableBody;
99
use aws_smithy_http::body::SdkBody;

aws/rust-runtime/aws-runtime/src/request_info.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ impl RequestInfoInterceptor {
5454
&self,
5555
cfg: &ConfigBag,
5656
) -> Option<(Cow<'static, str>, Cow<'static, str>)> {
57-
// TODO(enableNewSmithyRuntime) What config will we actually store in the bag? Will it be a whole config or just the max_attempts part?
5857
if let Some(retry_config) = cfg.get::<RetryConfig>() {
5958
let max_attempts = retry_config.max_attempts().to_string();
6059
Some((Cow::Borrowed("max"), Cow::Owned(max_attempts)))

aws/rust-runtime/aws-sig-auth/src/event_stream.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
// TODO(enableNewSmithyRuntime): Remove this blanket allow once the old implementations are deleted
6+
// TODO(enableNewSmithyRuntimeCleanup): Remove this blanket allow once the old implementations are deleted
77
#![allow(deprecated)]
88

99
use crate::middleware::Signature;
@@ -123,7 +123,7 @@ mod tests {
123123
}
124124
}
125125

126-
// TODO(enableNewSmithyRuntime): Delete this old implementation that was kept around to support patch releases.
126+
// TODO(enableNewSmithyRuntimeCleanup): Delete this old implementation that was kept around to support patch releases.
127127
#[deprecated = "use aws_sig_auth::event_stream::SigV4MessageSigner instead (this may require upgrading the smithy-rs code generator)"]
128128
#[derive(Debug)]
129129
/// Event Stream SigV4 signing implementation.
@@ -199,7 +199,7 @@ impl SignMessage for SigV4Signer {
199199
}
200200
}
201201

202-
// TODO(enableNewSmithyRuntime): Delete this old implementation that was kept around to support patch releases.
202+
// TODO(enableNewSmithyRuntimeCleanup): Delete this old implementation that was kept around to support patch releases.
203203
#[cfg(test)]
204204
mod old_tests {
205205
use crate::event_stream::SigV4Signer;

aws/rust-runtime/aws-sig-auth/src/middleware.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ use crate::event_stream::SigV4MessageSigner as EventStreamSigV4Signer;
2525
#[cfg(feature = "sign-eventstream")]
2626
use aws_smithy_eventstream::frame::DeferredSignerSender;
2727

28-
// TODO(enableNewSmithyRuntime): Delete `Signature` when switching to the orchestrator
28+
// TODO(enableNewSmithyRuntimeCleanup): Delete `Signature` when switching to the orchestrator
2929
/// Container for the request signature for use in the property bag.
3030
#[non_exhaustive]
3131
#[derive(Debug, Clone)]
@@ -151,7 +151,7 @@ fn signing_config(
151151
request_ts: config
152152
.get::<SharedTimeSource>()
153153
.map(|t| t.now())
154-
// TODO(enableNewSmithyRuntime): Remove this fallback
154+
// TODO(enableNewSmithyRuntimeLaunch): Remove this fallback
155155
.unwrap_or_else(|| SharedTimeSource::default().now()),
156156
region,
157157
payload_override,

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsCustomizableOperationDecorator.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class CustomizableOperationTestHelpers(runtimeConfig: RuntimeConfig) :
8585
*codegenScope,
8686
)
8787
} else {
88-
// TODO(enableNewSmithyRuntime): Delete this branch when middleware is no longer used
88+
// TODO(enableNewSmithyRuntimeCleanup): Delete this branch when middleware is no longer used
8989
rustTemplate(
9090
"""
9191
##[doc(hidden)]

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsPresigningDecorator.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ class AwsPresigningDecorator internal constructor(
140140
}
141141
}
142142

143-
// TODO(enableNewSmithyRuntime): Delete this class when cleaning up middleware
143+
// TODO(enableNewSmithyRuntimeCleanup): Delete this class when cleaning up middleware
144144
class AwsInputPresignedMethod(
145145
private val codegenContext: ClientCodegenContext,
146146
private val operationShape: OperationShape,

0 commit comments

Comments
 (0)