Skip to content

Remove ServiceMetadata dependencies from client creation #7074

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.

Sign up for GitHub

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

Open
S-Saranya1 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove ServiceMetadata dependencies from client creation #7074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 54 additions & 16 deletions ...gen/src/main/java/software/amazon/awssdk/codegen/poet/builder/BaseClientBuilderClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import static software.amazon.awssdk.codegen.poet.client.traits.HttpChecksumTrait.hasRequestAlgorithmMember;
import static software.amazon.awssdk.codegen.poet.client.traits.HttpChecksumTrait.hasResponseAlgorithms;

import java.net.URI;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.CodeBlock;
import com.squareup.javapoet.FieldSpec;
Expand All @@ -46,9 +47,15 @@
import software.amazon.awssdk.awscore.client.builder.AwsDefaultClientBuilder;
import software.amazon.awssdk.awscore.client.config.AwsClientOption;
import software.amazon.awssdk.awscore.endpoint.AwsClientEndpointProvider;
import software.amazon.awssdk.core.ClientEndpointProvider;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.endpoints.Endpoint;
import software.amazon.awssdk.utils.CompletableFutureUtils;
import software.amazon.awssdk.codegen.internal.Utils;
import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
import software.amazon.awssdk.codegen.model.rules.endpoints.BuiltInParameter;
import software.amazon.awssdk.codegen.model.rules.endpoints.ParameterModel;
import software.amazon.awssdk.codegen.model.service.ClientContextParam;
import software.amazon.awssdk.codegen.poet.ClassSpec;
import software.amazon.awssdk.codegen.poet.PoetExtension;
Expand Down Expand Up @@ -86,7 +93,6 @@
import software.amazon.awssdk.identity.spi.IdentityProviders;
import software.amazon.awssdk.identity.spi.TokenIdentity;
import software.amazon.awssdk.protocols.json.internal.unmarshall.SdkClientJsonProtocolAdvancedOption;
import software.amazon.awssdk.regions.ServiceMetadataAdvancedOption;
import software.amazon.awssdk.utils.AttributeMap;
import software.amazon.awssdk.utils.CollectionUtils;
import software.amazon.awssdk.utils.StringUtils;
Expand Down Expand Up @@ -225,6 +231,11 @@ private boolean resolveDefaultEndpointDiscovery() {
.orElse(false);
}

private boolean hasBuiltInParam(BuiltInParameter builtIn) {
return model.getEndpointRuleSetModel().getParameters().values().stream()
.anyMatch(p -> p.getBuiltInEnum() == builtIn);
}

private MethodSpec signingNameMethod() {
return MethodSpec.methodBuilder("signingName")
.addAnnotation(Override.class)
Expand Down Expand Up @@ -514,21 +525,48 @@ private MethodSpec finalizeServiceConfigurationMethod() {
String serviceNameForSystemProperty = model.getNamingStrategy().getServiceNameForSystemProperties();
String serviceNameForProfileFile = model.getNamingStrategy().getServiceNameForProfileFile();

builder.addCode("builder.lazyOptionIfAbsent($T.CLIENT_ENDPOINT_PROVIDER, c ->", SdkClientOption.class)
.addCode(" $T.builder()", AwsClientEndpointProvider.class)
.addCode(" .serviceEndpointOverrideEnvironmentVariable($S)", "AWS_ENDPOINT_URL_" + serviceNameForEnvVar)
.addCode(" .serviceEndpointOverrideSystemProperty($S)", "aws.endpointUrl" + serviceNameForSystemProperty)
.addCode(" .serviceProfileProperty($S)", serviceNameForProfileFile)
.addCode(" .serviceEndpointPrefix(serviceEndpointPrefix())")
.addCode(" .defaultProtocol($S)", "https")
.addCode(" .region(c.get($T.AWS_REGION))", AwsClientOption.class)
.addCode(" .profileFile(c.get($T.PROFILE_FILE_SUPPLIER))", SdkClientOption.class)
.addCode(" .profileName(c.get($T.PROFILE_NAME))", SdkClientOption.class)
.addCode(" .putAdvancedOption($T.DEFAULT_S3_US_EAST_1_REGIONAL_ENDPOINT,", ServiceMetadataAdvancedOption.class)
.addCode(" c.get($T.DEFAULT_S3_US_EAST_1_REGIONAL_ENDPOINT))", ServiceMetadataAdvancedOption.class)
.addCode(" .dualstackEnabled(c.get($T.DUALSTACK_ENDPOINT_ENABLED))", AwsClientOption.class)
.addCode(" .fipsEnabled(c.get($T.FIPS_ENDPOINT_ENABLED))", AwsClientOption.class)
.addCode(" .build());");
builder.addCode("builder.lazyOptionIfAbsent($T.CLIENT_ENDPOINT_PROVIDER, c -> {\n", SdkClientOption.class)
.addCode(" $T<$T> fromOverrides = $T.builder()\n",
Optional.class, ClientEndpointProvider.class, AwsClientEndpointProvider.class)
.addCode(" .serviceEndpointOverrideEnvironmentVariable($S)\n", "AWS_ENDPOINT_URL_" + serviceNameForEnvVar)
.addCode(" .serviceEndpointOverrideSystemProperty($S)\n", "aws.endpointUrl" + serviceNameForSystemProperty)
.addCode(" .serviceProfileProperty($S)\n", serviceNameForProfileFile)
.addCode(" .profileFile(c.get($T.PROFILE_FILE_SUPPLIER))\n", SdkClientOption.class)
.addCode(" .profileName(c.get($T.PROFILE_NAME))\n", SdkClientOption.class)
.addCode(" .buildOptional();\n")
.addCode(" if (fromOverrides.isPresent()) {\n")
.addCode(" return fromOverrides.get();\n")
.addCode(" }\n")
.addCode(" $T endpointProvider = defaultEndpointProvider();\n",
endpointRulesSpecUtils.providerInterfaceName())
.addCode(" $T params = $T.builder()\n",
endpointRulesSpecUtils.parametersClassName(),
endpointRulesSpecUtils.parametersClassName())
.addCode(" .region(c.get($T.AWS_REGION))\n", AwsClientOption.class);

if (hasBuiltInParam(BuiltInParameter.AWS_USE_FIPS)) {
builder.addCode(" .useFips(c.get($T.FIPS_ENDPOINT_ENABLED))\n", AwsClientOption.class);
}
if (hasBuiltInParam(BuiltInParameter.AWS_USE_DUAL_STACK)) {
builder.addCode(" .useDualStack(c.get($T.DUALSTACK_ENDPOINT_ENABLED))\n", AwsClientOption.class);
}

builder.addCode(" .build();\n")
.addCode(" try {\n")
.addCode(" $T endpoint = $T.joinLikeSync(endpointProvider.resolveEndpoint(params));\n",
Endpoint.class, CompletableFutureUtils.class)
.addCode(" $T endpointUrl = endpoint.url();\n", URI.class)
.addCode(" if (endpointUrl.getHost() == null) {\n")
.addCode(" throw $T.create(\"Configured region (\" + c.get($T.AWS_REGION) + \") resulted in an invalid\"\n",
SdkClientException.class, AwsClientOption.class)
.addCode(" + \" URI. This is usually caused by an invalid region configuration.\");\n")
.addCode(" }\n")
.addCode(" return $T.create(endpointUrl, false);\n", ClientEndpointProvider.class)
.addCode(" } catch ($T e) {\n", NullPointerException.class)
.addCode(" return $T.create($T.create(\"https://localhost\"), false);\n",
ClientEndpointProvider.class, URI.class)
.addCode(" }\n")
.addCode("});\n");

if (model.getMetadata().isJsonProtocol()) {
builder.addStatement("builder.option($1T.ENABLE_FAST_UNMARSHALLER, true)",
Expand Down
37 changes: 25 additions & 12 deletions .../src/main/java/software/amazon/awssdk/awscore/client/builder/AwsDefaultClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
import software.amazon.awssdk.identity.spi.IdentityProviders;
import software.amazon.awssdk.profiles.ProfileFile;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.regions.ServiceMetadataAdvancedOption;
import software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain;
import software.amazon.awssdk.retries.api.RetryStrategy;
Expand Down Expand Up @@ -316,8 +315,30 @@ private AttributeMap mergeSmartHttpDefaults(LazyValueSource config, AttributeMap
* Resolve the signing region from the default-applied configuration.
*/
private Region resolveSigningRegion(LazyValueSource config) {
return ServiceMetadata.of(serviceEndpointPrefix())
.signingRegion(config.get(AwsClientOption.AWS_REGION));
Region clientRegion = config.get(AwsClientOption.AWS_REGION);

if (clientRegion.isGlobalRegion()) {
return Region.of(implicitGlobalRegion(clientRegion));
}

return clientRegion;
}

private String implicitGlobalRegion(Region globalRegion) {
String regionId = globalRegion.id();
if (regionId.startsWith("aws-cn")) {
return "cn-northwest-1";
} else if (regionId.startsWith("aws-us-gov")) {
return "us-gov-west-1";
} else if (regionId.startsWith("aws-iso-b")) {
return "us-isob-east-1";
} else if (regionId.startsWith("aws-iso-e")) {
return "us-iso-east-1";
} else if (regionId.startsWith("aws-iso")) {
return "us-iso-east-1";
}
// Default: aws-global -> us-east-1
return "us-east-1";
}

/**
Expand All @@ -326,18 +347,10 @@ private Region resolveSigningRegion(LazyValueSource config) {
* This is only used for older client versions. Newer clients specify this value themselves.
*/
private ClientEndpointProvider resolveClientEndpointProvider(LazyValueSource config) {
ServiceMetadataAdvancedOption<String> useGlobalS3EndpointProperty =
ServiceMetadataAdvancedOption.DEFAULT_S3_US_EAST_1_REGIONAL_ENDPOINT;
return AwsClientEndpointProvider.builder()
.serviceEndpointPrefix(serviceEndpointPrefix())
.defaultProtocol(DEFAULT_ENDPOINT_PROTOCOL)
.region(config.get(AwsClientOption.AWS_REGION))
.clientEndpointOverride(URI.create("https://localhost"))
.profileFile(config.get(SdkClientOption.PROFILE_FILE_SUPPLIER))
.profileName(config.get(SdkClientOption.PROFILE_NAME))
.putAdvancedOption(useGlobalS3EndpointProperty,
config.get(useGlobalS3EndpointProperty))
.dualstackEnabled(config.get(AwsClientOption.DUALSTACK_ENDPOINT_ENABLED))
.fipsEnabled(config.get(AwsClientOption.FIPS_ENDPOINT_ENABLED))
.build();
}

Expand Down
Loading
Loading