chore(codegen): check SigV4 trait for including region

Author: gosar

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsAuthPlugin.java

@@ -15,6 +15,7 @@
 
 package software.amazon.smithy.aws.typescript.codegen;
 
+import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isSigV4Service;
 import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_CONFIG;
 import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_MIDDLEWARE;
 
@@ -24,7 +25,6 @@
 import java.util.Set;
 import java.util.function.Consumer;
 import software.amazon.smithy.aws.traits.ServiceTrait;
-import software.amazon.smithy.aws.traits.auth.SigV4Trait;
 import software.amazon.smithy.codegen.core.SymbolProvider;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.knowledge.TopDownIndex;
@@ -56,7 +56,7 @@ public void addConfigInterfaceFields(
         TypeScriptWriter writer
     ) {
         ServiceShape service = settings.getService(model);
-        if (!serviceUsesAwsAuth(service)) {
+        if (!isSigV4Service(service)) {
             return;
         }
         if (!areAllOptionalAuthOperations(model, service)) {
@@ -71,13 +71,13 @@ public List<RuntimeClientPlugin> getClientPlugins() {
         return ListUtils.of(
             RuntimeClientPlugin.builder()
                     .withConventions(AwsDependency.MIDDLEWARE_SIGNING.dependency, "AwsAuth", HAS_CONFIG)
-                    .servicePredicate((m, s) -> serviceUsesAwsAuth(s) && !areAllOptionalAuthOperations(m, s))
+                    .servicePredicate((m, s) -> isSigV4Service(s) && !areAllOptionalAuthOperations(m, s))
                     .build(),
             RuntimeClientPlugin.builder()
                     .withConventions(AwsDependency.MIDDLEWARE_SIGNING.dependency, "AwsAuth", HAS_MIDDLEWARE)
                     // See operationUsesAwsAuth() below for AwsAuth Middleware customizations.
                     .servicePredicate(
-                        (m, s) -> !testServiceId(s, "STS") && serviceUsesAwsAuth(s) && !hasOptionalAuthOperation(m, s)
+                        (m, s) -> !testServiceId(s, "STS") && isSigV4Service(s) && !hasOptionalAuthOperation(m, s)
                     ).build(),
             RuntimeClientPlugin.builder()
                     .withConventions(AwsDependency.MIDDLEWARE_SIGNING.dependency, "AwsAuth", HAS_MIDDLEWARE)
@@ -94,7 +94,7 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
         LanguageTarget target
     ) {
         ServiceShape service = settings.getService(model);
-        if (!serviceUsesAwsAuth(service) || areAllOptionalAuthOperations(model, service)) {
+        if (!isSigV4Service(service) || areAllOptionalAuthOperations(model, service)) {
             return Collections.emptyMap();
         }
         switch (target) {
@@ -124,10 +124,6 @@ private static boolean testServiceId(Shape serviceShape, String expectedId) {
         return serviceShape.getTrait(ServiceTrait.class).map(ServiceTrait::getSdkId).orElse("").equals(expectedId);
     }
 
-    private static boolean serviceUsesAwsAuth(Shape serviceShape) {
-        return serviceShape.hasTrait(SigV4Trait.class);
-    }
-
     private static boolean operationUsesAwsAuth(Model model, ServiceShape service, OperationShape operation) {
         // STS doesn't need auth for AssumeRoleWithWebIdentity, AssumeRoleWithSAML.
         // Remove when optionalAuth model update is published in 0533102932.
@@ -139,7 +135,7 @@ private static boolean operationUsesAwsAuth(Model model, ServiceShape service, O
         }
 
         // optionalAuth trait doesn't require authentication.
-        if (serviceUsesAwsAuth(service) && hasOptionalAuthOperation(model, service)) {
+        if (isSigV4Service(service) && hasOptionalAuthOperation(model, service)) {
             return !operation.hasTrait(OptionalAuthTrait.class);
         }
         return false;

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddAwsRuntimeConfig.java

@@ -16,6 +16,7 @@
 package software.amazon.smithy.aws.typescript.codegen;
 
 import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isAwsService;
+import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isSigV4Service;
 
 import java.util.Collections;
 import java.util.HashMap;
@@ -33,6 +34,9 @@
 import software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration;
 import software.amazon.smithy.utils.MapUtils;
 
+// TODO: This javadoc is specific to needs of AWS client. However it has elements that would be needed by non-AWS
+// clients too, like logger, region for SigV4. We should refactor these into different Integration or rename this
+// class to be generic.
 /**
  * AWS clients need to know the service name for collecting metrics, the
  * region name used to resolve endpoints, the max attempt to retry a request
@@ -87,7 +91,9 @@ public void addConfigInterfaceFields(
         if (isAwsService(settings, model)) {
             writer.writeDocs("Unique service identifier.\n@internal")
                     .write("serviceId?: string;\n");
-            writer.writeDocs("The AWS region to which this client will send requests")
+        }
+        if (isSigV4Service(settings, model)) {
+            writer.writeDocs("The AWS region to which this client will send requests or use as signingRegion")
                     .write("region?: string | __Provider<string>;\n");
         }
         writer.writeDocs("Value for how many times a request will be made at most in case of retry.")
@@ -128,7 +134,7 @@ private Map<String, Consumer<TypeScriptWriter>> getDefaultConfig(
             Model model
     ) {
         Map<String, Consumer<TypeScriptWriter>> defaultConfigs = new HashMap();
-        boolean isAwsService = isAwsService(settings, model);
+        boolean isSigV4Service = isSigV4Service(settings, model);
         switch (target) {
             case SHARED:
                 return MapUtils.of(
@@ -138,7 +144,7 @@ private Map<String, Consumer<TypeScriptWriter>> getDefaultConfig(
                         }
                 );
             case BROWSER:
-                if (isAwsService) {
+                if (isSigV4Service) {
                     defaultConfigs.put("region", writer -> {
                         writer.addDependency(TypeScriptDependency.INVALID_DEPENDENCY);
                         writer.addImport("invalidProvider", "invalidProvider",
@@ -154,7 +160,8 @@ private Map<String, Consumer<TypeScriptWriter>> getDefaultConfig(
                 });
                 return defaultConfigs;
             case NODE:
-                if (isAwsService) {
+                if (isSigV4Service) {
+                    // TODO: For non-AWS service, figure out how the region should be configured.
                     defaultConfigs.put("region", writer -> {
                         writer.addDependency(AwsDependency.NODE_CONFIG_PROVIDER);
                         writer.addImport("loadConfig", "loadNodeConfig",

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsTraitsUtils.java

@@ -16,6 +16,7 @@
 package software.amazon.smithy.aws.typescript.codegen;
 
 import software.amazon.smithy.aws.traits.ServiceTrait;
+import software.amazon.smithy.aws.traits.auth.SigV4Trait;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.ServiceShape;
 import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
@@ -34,4 +35,12 @@ static boolean isAwsService(TypeScriptSettings settings, Model model) {
     static boolean isAwsService(ServiceShape serviceShape) {
         return serviceShape.hasTrait(ServiceTrait.class);
     }
+
+    static boolean isSigV4Service(TypeScriptSettings settings, Model model) {
+        return isSigV4Service(settings.getService(model));
+    }
+
+    static boolean isSigV4Service(ServiceShape serviceShape) {
+        return serviceShape.hasTrait(SigV4Trait.class);
+    }
 }