Track accountID endpoint mode in user-agent (#3000)

Author: lucix-aws

.changelog/1c8f914e6b9a4aef9418a60e7fe62de2.json

@@ -0,0 +1,8 @@
+{
+    "id": "1c8f914e-6b9a-4aef-9418-a60e7fe62de2",
+    "type": "feature",
+    "description": "Track AccountID endpoint mode in user-agent.",
+    "modules": [
+        "service/dynamodb"
+    ]
+}

aws/middleware/user_agent.go

@@ -76,28 +76,39 @@ type UserAgentFeature string
 
 // Enumerates UserAgentFeature.
 const (
-	UserAgentFeatureResourceModel                 UserAgentFeature = "A" // n/a (we don't generate separate resource types)
-	UserAgentFeatureWaiter                                         = "B"
-	UserAgentFeaturePaginator                                      = "C"
-	UserAgentFeatureRetryModeLegacy                                = "D" // n/a (equivalent to standard)
-	UserAgentFeatureRetryModeStandard                              = "E"
-	UserAgentFeatureRetryModeAdaptive                              = "F"
-	UserAgentFeatureS3Transfer                                     = "G"
-	UserAgentFeatureS3CryptoV1N                                    = "H" // n/a (crypto client is external)
-	UserAgentFeatureS3CryptoV2                                     = "I" // n/a
-	UserAgentFeatureS3ExpressBucket                                = "J"
-	UserAgentFeatureS3AccessGrants                                 = "K" // not yet implemented
-	UserAgentFeatureGZIPRequestCompression                         = "L"
-	UserAgentFeatureProtocolRPCV2CBOR                              = "M"
-	UserAgentFeatureRequestChecksumCRC32                           = "U"
-	UserAgentFeatureRequestChecksumCRC32C                          = "V"
-	UserAgentFeatureRequestChecksumCRC64                           = "W"
-	UserAgentFeatureRequestChecksumSHA1                            = "X"
-	UserAgentFeatureRequestChecksumSHA256                          = "Y"
-	UserAgentFeatureRequestChecksumWhenSupported                   = "Z"
-	UserAgentFeatureRequestChecksumWhenRequired                    = "a"
-	UserAgentFeatureResponseChecksumWhenSupported                  = "b"
-	UserAgentFeatureResponseChecksumWhenRequired                   = "c"
+	UserAgentFeatureResourceModel UserAgentFeature = "A" // n/a (we don't generate separate resource types)
+
+	UserAgentFeatureWaiter    = "B"
+	UserAgentFeaturePaginator = "C"
+
+	UserAgentFeatureRetryModeLegacy   = "D" // n/a (equivalent to standard)
+	UserAgentFeatureRetryModeStandard = "E"
+	UserAgentFeatureRetryModeAdaptive = "F"
+
+	UserAgentFeatureS3Transfer      = "G"
+	UserAgentFeatureS3CryptoV1N     = "H" // n/a (crypto client is external)
+	UserAgentFeatureS3CryptoV2      = "I" // n/a
+	UserAgentFeatureS3ExpressBucket = "J"
+	UserAgentFeatureS3AccessGrants  = "K" // not yet implemented
+
+	UserAgentFeatureGZIPRequestCompression = "L"
+
+	UserAgentFeatureProtocolRPCV2CBOR = "M"
+
+	UserAgentFeatureAccountIDEndpoint      = "O" // DO NOT IMPLEMENT: rules output is not currently defined. SDKs should not parse endpoints for feature information.
+	UserAgentFeatureAccountIDModePreferred = "P"
+	UserAgentFeatureAccountIDModeDisabled  = "Q"
+	UserAgentFeatureAccountIDModeRequired  = "R"
+
+	UserAgentFeatureRequestChecksumCRC32          = "U"
+	UserAgentFeatureRequestChecksumCRC32C         = "V"
+	UserAgentFeatureRequestChecksumCRC64          = "W"
+	UserAgentFeatureRequestChecksumSHA1           = "X"
+	UserAgentFeatureRequestChecksumSHA256         = "Y"
+	UserAgentFeatureRequestChecksumWhenSupported  = "Z"
+	UserAgentFeatureRequestChecksumWhenRequired   = "a"
+	UserAgentFeatureResponseChecksumWhenSupported = "b"
+	UserAgentFeatureResponseChecksumWhenRequired  = "c"
 )
 
 // RequestUserAgent is a build middleware that set the User-Agent for the request.

codegen/smithy-aws-go-codegen/src/main/java/software/amazon/smithy/aws/go/codegen/customization/AccountIdEndpointModeUserAgent.java

@@ -0,0 +1,69 @@
+package software.amazon.smithy.aws.go.codegen.customization;
+
+import java.util.List;
+import java.util.Map;
+import software.amazon.smithy.aws.go.codegen.AwsGoDependency;
+import software.amazon.smithy.codegen.core.SymbolProvider;
+import software.amazon.smithy.go.codegen.GoCodegenContext;
+import software.amazon.smithy.go.codegen.GoDelegator;
+import software.amazon.smithy.go.codegen.GoSettings;
+import software.amazon.smithy.go.codegen.SmithyGoDependency;
+import software.amazon.smithy.go.codegen.integration.GoIntegration;
+import software.amazon.smithy.go.codegen.integration.MiddlewareRegistrar;
+import software.amazon.smithy.go.codegen.integration.RuntimeClientPlugin;
+import software.amazon.smithy.model.Model;
+
+import static software.amazon.smithy.aws.go.codegen.customization.AccountIDEndpointRouting.hasAccountIdEndpoints;
+import static software.amazon.smithy.go.codegen.GoWriter.goTemplate;
+import static software.amazon.smithy.go.codegen.SymbolUtils.buildPackageSymbol;
+
+/**
+ * Tracks the retry mode being used by the caller.
+ */
+public class AccountIdEndpointModeUserAgent implements GoIntegration {
+    private static final MiddlewareRegistrar MIDDLEWARE = MiddlewareRegistrar.builder()
+            .resolvedFunction(buildPackageSymbol("addUserAgentAccountIDEndpointMode"))
+            .useClientOptions()
+            .build();
+
+    @Override
+    public List<RuntimeClientPlugin> getClientPlugins() {
+        return List.of(
+                RuntimeClientPlugin.builder()
+                        .servicePredicate(AccountIDEndpointRouting::hasAccountIdEndpoints)
+                        .registerMiddleware(MIDDLEWARE)
+                        .build()
+        );
+    }
+
+    @Override
+    public void writeAdditionalFiles(GoCodegenContext ctx) {
+        if (!hasAccountIdEndpoints(ctx.model(), ctx.settings().getService(ctx.model()))) {
+            return;
+        }
+
+        ctx.writerDelegator().useFileWriter("api_client.go", ctx.settings().getModuleName(), goTemplate("""
+                $aws:D $awsMiddleware:D
+                func addUserAgentAccountIDEndpointMode(stack $stack:P, options Options) error {
+                    ua, err := getOrAddRequestUserAgent(stack)
+                    if err != nil {
+                        return err
+                    }
+
+                    switch options.AccountIDEndpointMode {
+                    case aws.AccountIDEndpointModePreferred:
+                        ua.AddUserAgentFeature(awsmiddleware.UserAgentFeatureAccountIDModePreferred)
+                    case aws.AccountIDEndpointModeRequired:
+                        ua.AddUserAgentFeature(awsmiddleware.UserAgentFeatureAccountIDModeRequired)
+                    case aws.AccountIDEndpointModeDisabled:
+                        ua.AddUserAgentFeature(awsmiddleware.UserAgentFeatureAccountIDModeDisabled)
+                    }
+                    return nil
+                }""",
+                Map.of(
+                        "aws", AwsGoDependency.AWS_CORE,
+                        "awsMiddleware", AwsGoDependency.AWS_MIDDLEWARE,
+                        "stack", SmithyGoDependency.SMITHY_MIDDLEWARE.struct("Stack")
+                )));
+    }
+}

codegen/smithy-aws-go-codegen/src/main/resources/META-INF/services/software.amazon.smithy.go.codegen.integration.GoIntegration

@@ -88,3 +88,4 @@ software.amazon.smithy.aws.go.codegen.customization.BackfillRequiredTrait
 software.amazon.smithy.aws.go.codegen.customization.DeprecateService
 software.amazon.smithy.aws.go.codegen.customization.BasicUserAgentFeatures
 software.amazon.smithy.aws.go.codegen.customization.ChecksumMetricsTracking
+software.amazon.smithy.aws.go.codegen.customization.AccountIdEndpointModeUserAgent