Skip to content

Commit 9630892

Browse files
authored
Rename make_token to idempotency_token_provider (#2783)
## Motivation and Context Incorporates suggestion made in #2762 (comment) ## Description This PR renames `make_token` to `idempotency_token_provider` for clarity wherever it is referred to in the fields and API in service configs and their builders. ## Testing Existing tests in CI ## 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: Yuki Saito <awsaito@amazon.com>
1 parent 2e472d0 commit 9630892

File tree

4 files changed

+27
-15
lines changed

4 files changed

+27
-15
lines changed

CHANGELOG.next.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,3 +550,15 @@ let plugin = plugin_from_operation_fn(map);
550550
references = ["smithy-rs#2740", "smithy-rs#2759", "smithy-rs#2779"]
551551
meta = { "breaking" = true, "tada" = false, "bug" = false }
552552
author = "hlbarber"
553+
554+
[[smithy-rs]]
555+
message = "The naming `make_token` for fields and the API of `IdempotencyTokenProvider` in service configs and their builders has now been updated to `idempotency_token_provider`."
556+
references = ["smithy-rs#2783"]
557+
meta = { "breaking" = true, "tada" = false, "bug" = false, "target" = "client" }
558+
author = "ysaito1001"
559+
560+
[[aws-sdk-rust]]
561+
message = "The naming `make_token` for fields and the API of `IdempotencyTokenProvider` in service configs and their builders has now been updated to `idempotency_token_provider`."
562+
references = ["smithy-rs#2783"]
563+
meta = { "breaking" = true, "tada" = false, "bug" = false }
564+
author = "ysaito1001"

aws/sdk/integration-tests/timestreamquery/tests/endpoint_disco.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ async fn do_endpoint_discovery() {
2929
.time_source(SharedTimeSource::new(ts.clone()))
3030
.build();
3131
let conf = query::config::Builder::from(&config)
32-
.make_token("0000-0000-0000")
32+
.idempotency_token_provider("0000-0000-0000")
3333
.build();
3434
let (client, reloader) = query::Client::from_conf(conf)
3535
.enable_endpoint_discovery()

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/IdempotencyTokenGenerator.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class IdempotencyTokenGenerator(codegenContext: CodegenContext, operationShape:
3232
rustTemplate(
3333
"""
3434
if ${section.input}.$memberName.is_none() {
35-
${section.input}.$memberName = #{Some}(${section.config}.make_token.make_idempotency_token());
35+
${section.input}.$memberName = #{Some}(${section.config}.idempotency_token_provider.make_idempotency_token());
3636
}
3737
""",
3838
*preludeScope,

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/config/IdempotencyTokenProviderCustomization.kt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType.Companion.pre
1515
import software.amazon.smithy.rust.codegen.core.smithy.customize.NamedCustomization
1616

1717
/**
18-
* Add a `make_token` field to Service config. See below for the resulting generated code.
18+
* Add an `idempotency_token_provider` field to Service config.
1919
*/
2020
class IdempotencyTokenProviderCustomization(codegenContext: ClientCodegenContext) : NamedCustomization<ServiceConfig>() {
2121
private val runtimeConfig = codegenContext.runtimeConfig
@@ -30,7 +30,7 @@ class IdempotencyTokenProviderCustomization(codegenContext: ClientCodegenContext
3030
return when (section) {
3131
is ServiceConfig.ConfigStruct -> writable {
3232
if (runtimeMode.defaultToMiddleware) {
33-
rustTemplate("pub (crate) make_token: #{IdempotencyTokenProvider},", *codegenScope)
33+
rustTemplate("pub (crate) idempotency_token_provider: #{IdempotencyTokenProvider},", *codegenScope)
3434
}
3535
}
3636

@@ -41,7 +41,7 @@ class IdempotencyTokenProviderCustomization(codegenContext: ClientCodegenContext
4141
/// Returns a copy of the idempotency token provider.
4242
/// If a random token provider was configured,
4343
/// a newly-randomized token provider will be returned.
44-
pub fn make_token(&self) -> #{IdempotencyTokenProvider} {
44+
pub fn idempotency_token_provider(&self) -> #{IdempotencyTokenProvider} {
4545
self.inner.load::<#{IdempotencyTokenProvider}>().expect("the idempotency provider should be set").clone()
4646
}
4747
""",
@@ -53,8 +53,8 @@ class IdempotencyTokenProviderCustomization(codegenContext: ClientCodegenContext
5353
/// Returns a copy of the idempotency token provider.
5454
/// If a random token provider was configured,
5555
/// a newly-randomized token provider will be returned.
56-
pub fn make_token(&self) -> #{IdempotencyTokenProvider} {
57-
self.make_token.clone()
56+
pub fn idempotency_token_provider(&self) -> #{IdempotencyTokenProvider} {
57+
self.idempotency_token_provider.clone()
5858
}
5959
""",
6060
*codegenScope,
@@ -63,21 +63,21 @@ class IdempotencyTokenProviderCustomization(codegenContext: ClientCodegenContext
6363
}
6464

6565
ServiceConfig.BuilderStruct -> writable {
66-
rustTemplate("make_token: #{Option}<#{IdempotencyTokenProvider}>,", *codegenScope)
66+
rustTemplate("idempotency_token_provider: #{Option}<#{IdempotencyTokenProvider}>,", *codegenScope)
6767
}
6868

6969
ServiceConfig.BuilderImpl -> writable {
7070
rustTemplate(
7171
"""
7272
/// Sets the idempotency token provider to use for service calls that require tokens.
73-
pub fn make_token(mut self, make_token: impl #{Into}<#{IdempotencyTokenProvider}>) -> Self {
74-
self.set_make_token(#{Some}(make_token.into()));
73+
pub fn idempotency_token_provider(mut self, idempotency_token_provider: impl #{Into}<#{IdempotencyTokenProvider}>) -> Self {
74+
self.set_idempotency_token_provider(#{Some}(idempotency_token_provider.into()));
7575
self
7676
}
7777
7878
/// Sets the idempotency token provider to use for service calls that require tokens.
79-
pub fn set_make_token(&mut self, make_token: #{Option}<#{IdempotencyTokenProvider}>) -> &mut Self {
80-
self.make_token = make_token;
79+
pub fn set_idempotency_token_provider(&mut self, idempotency_token_provider: #{Option}<#{IdempotencyTokenProvider}>) -> &mut Self {
80+
self.idempotency_token_provider = idempotency_token_provider;
8181
self
8282
}
8383
""",
@@ -88,19 +88,19 @@ class IdempotencyTokenProviderCustomization(codegenContext: ClientCodegenContext
8888
ServiceConfig.BuilderBuild -> writable {
8989
if (runtimeMode.defaultToOrchestrator) {
9090
rustTemplate(
91-
"layer.store_put(self.make_token.unwrap_or_else(#{default_provider}));",
91+
"layer.store_put(self.idempotency_token_provider.unwrap_or_else(#{default_provider}));",
9292
*codegenScope,
9393
)
9494
} else {
9595
rustTemplate(
96-
"make_token: self.make_token.unwrap_or_else(#{default_provider}),",
96+
"idempotency_token_provider: self.idempotency_token_provider.unwrap_or_else(#{default_provider}),",
9797
*codegenScope,
9898
)
9999
}
100100
}
101101

102102
is ServiceConfig.DefaultForTests -> writable {
103-
rust("""${section.configBuilderRef}.set_make_token(Some("00000000-0000-4000-8000-000000000000".into()));""")
103+
rust("""${section.configBuilderRef}.set_idempotency_token_provider(Some("00000000-0000-4000-8000-000000000000".into()));""")
104104
}
105105

106106
else -> writable { }

0 commit comments

Comments
 (0)