Support generating non-AWS client (aws#2222)

* feat(config-resolver): make region optional for non-AWS client

* feat(codegen): skip integrations that are not relevant for non-AWS services

This is an initial version to get a working version of generated code
that compiles without manual edits in smithy-typescript-ssdk-demo. I
expect to make updates to this logic.

* chore(codegen): address code comments

The minor ones from adamthom-amzn#1

* fix(codegen): use SigV4Trait check instead of ServiceTrait

AddAwsRuntimeConfigTest is checking for some behaviors from
AddAwsAuthPlugin too, which was failing with missing aws.auth#sigv4
trait after my change. Added the trait for now to the test, but unit
tests will need to be added/refactored for all these changes.

* chore(codegen): move isAwsService check to utils class

* chore(codegen): code style formatting

* 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;
 
@@ -46,6 +47,7 @@
 /**
  * Configure clients with AWS auth configurations and plugin.
  */
+// TODO: Think about AWS Auth supported for only some operations and not all, when not AWS service, with say @auth([])
 public final class AddAwsAuthPlugin implements TypeScriptIntegration {
     static final String STS_CLIENT_PREFIX = "sts-client-";
     static final String ROLE_ASSUMERS_FILE = "defaultRoleAssumers";
@@ -59,6 +61,9 @@ public void addConfigInterfaceFields(
         TypeScriptWriter writer
     ) {
         ServiceShape service = settings.getService(model);
+        if (!isSigV4Service(service)) {
+            return;
+        }
         if (!areAllOptionalAuthOperations(model, service)) {
             writer.addImport("Credentials", "__Credentials", TypeScriptDependency.AWS_SDK_TYPES.packageName);
             writer.writeDocs("Default credentials provider; Not available in browser runtime.")
@@ -71,7 +76,9 @@ public List<RuntimeClientPlugin> getClientPlugins() {
         return ListUtils.of(
             RuntimeClientPlugin.builder()
                     .withConventions(AwsDependency.MIDDLEWARE_SIGNING.dependency, "AwsAuth", HAS_CONFIG)
-                    .servicePredicate((m, s) -> !areAllOptionalAuthOperations(m, s) && !testServiceId(s, "STS"))
+                    .servicePredicate((m, s) -> isSigV4Service(s)
+                            && !areAllOptionalAuthOperations(m, s)
+                            && !testServiceId(s, "STS"))
                     .build(),
             RuntimeClientPlugin.builder()
                     .withConventions(AwsDependency.STS_MIDDLEWARE.dependency,
@@ -83,7 +90,7 @@ public List<RuntimeClientPlugin> getClientPlugins() {
                     .withConventions(AwsDependency.MIDDLEWARE_SIGNING.dependency, "AwsAuth", HAS_MIDDLEWARE)
                     // See operationUsesAwsAuth() below for AwsAuth Middleware customizations.
                     .servicePredicate(
-                        (m, s) -> !testServiceId(s, "STS") && !hasOptionalAuthOperation(m, s)
+                        (m, s) -> !testServiceId(s, "STS") && isSigV4Service(s) && !hasOptionalAuthOperation(m, s)
                     ).build(),
             RuntimeClientPlugin.builder()
                     .withConventions(AwsDependency.MIDDLEWARE_SIGNING.dependency, "AwsAuth", HAS_MIDDLEWARE)
@@ -100,7 +107,7 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
         LanguageTarget target
     ) {
         ServiceShape service = settings.getService(model);
-        if (areAllOptionalAuthOperations(model, service)) {
+        if (!isSigV4Service(service) || areAllOptionalAuthOperations(model, service)) {
             return Collections.emptyMap();
         }
         switch (target) {
@@ -187,8 +194,8 @@ private static boolean operationUsesAwsAuth(Model model, ServiceShape service, O
         }
 
         // optionalAuth trait doesn't require authentication.
-        if (hasOptionalAuthOperation(model, service)) {
-            return !operation.getTrait(OptionalAuthTrait.class).isPresent();
+        if (isSigV4Service(service) && hasOptionalAuthOperation(model, service)) {
+            return !operation.hasTrait(OptionalAuthTrait.class);
         }
         return false;
     }
@@ -197,7 +204,7 @@ private static boolean hasOptionalAuthOperation(Model model, ServiceShape servic
         TopDownIndex topDownIndex = TopDownIndex.of(model);
         Set<OperationShape> operations = topDownIndex.getContainedOperations(service);
         for (OperationShape operation : operations) {
-            if (operation.getTrait(OptionalAuthTrait.class).isPresent()) {
+            if (operation.hasTrait(OptionalAuthTrait.class)) {
                 return true;
             }
         }
@@ -208,7 +215,7 @@ private static boolean areAllOptionalAuthOperations(Model model, ServiceShape se
         TopDownIndex topDownIndex = TopDownIndex.of(model);
         Set<OperationShape> operations = topDownIndex.getContainedOperations(service);
         for (OperationShape operation : operations) {
-            if (!operation.getTrait(OptionalAuthTrait.class).isPresent()) {
+            if (!operation.hasTrait(OptionalAuthTrait.class)) {
                 return false;
             }
         }

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

@@ -15,6 +15,9 @@
 
 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;
 import java.util.Map;
@@ -31,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
@@ -82,10 +88,14 @@ public void addConfigInterfaceFields(
         writer.addImport("Provider", "__Provider", TypeScriptDependency.AWS_SDK_TYPES.packageName);
         writer.addImport("Logger", "__Logger", TypeScriptDependency.AWS_SDK_TYPES.packageName);
 
-        writer.writeDocs("Unique service identifier.\n@internal")
-                .write("serviceId?: string;\n");
-        writer.writeDocs("The AWS region to which this client will send requests")
-                .write("region?: string | __Provider<string>;\n");
+        if (isAwsService(settings, model)) {
+            writer.writeDocs("Unique service identifier.\n@internal")
+                    .write("serviceId?: string;\n");
+        }
+        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.")
                 .write("maxAttempts?: number | __Provider<number>;\n");
         writer.writeDocs("Optional logger for logging debug/info/warn/error.")
@@ -114,11 +124,17 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
                         + "trait was found on " + service.getId());
             }
         }
-        runtimeConfigs.putAll(getDefaultConfig(target));
+        runtimeConfigs.putAll(getDefaultConfig(target, settings, model));
         return runtimeConfigs;
     }
 
-    private Map<String, Consumer<TypeScriptWriter>> getDefaultConfig(LanguageTarget target) {
+    private Map<String, Consumer<TypeScriptWriter>> getDefaultConfig(
+            LanguageTarget target,
+            TypeScriptSettings settings,
+            Model model
+    ) {
+        Map<String, Consumer<TypeScriptWriter>> defaultConfigs = new HashMap();
+        boolean isSigV4Service = isSigV4Service(settings, model);
         switch (target) {
             case SHARED:
                 return MapUtils.of(
@@ -128,40 +144,46 @@ private Map<String, Consumer<TypeScriptWriter>> getDefaultConfig(LanguageTarget
                         }
                 );
             case BROWSER:
-                return MapUtils.of(
-                        "region", writer -> {
-                            writer.addDependency(TypeScriptDependency.INVALID_DEPENDENCY);
-                            writer.addImport("invalidProvider", "invalidProvider",
-                                    TypeScriptDependency.INVALID_DEPENDENCY.packageName);
-                            writer.write("region: invalidProvider(\"Region is missing\"),");
-                        },
-                        "maxAttempts", writer -> {
-                            writer.addDependency(TypeScriptDependency.MIDDLEWARE_RETRY);
-                            writer.addImport("DEFAULT_MAX_ATTEMPTS", "DEFAULT_MAX_ATTEMPTS",
-                                    TypeScriptDependency.MIDDLEWARE_RETRY.packageName);
-                            writer.write("maxAttempts: DEFAULT_MAX_ATTEMPTS,");
-                        }
-                );
+                if (isSigV4Service) {
+                    defaultConfigs.put("region", writer -> {
+                        writer.addDependency(TypeScriptDependency.INVALID_DEPENDENCY);
+                        writer.addImport("invalidProvider", "invalidProvider",
+                                TypeScriptDependency.INVALID_DEPENDENCY.packageName);
+                        writer.write("region: invalidProvider(\"Region is missing\"),");
+                    });
+                }
+                defaultConfigs.put("maxAttempts", writer -> {
+                    writer.addDependency(TypeScriptDependency.MIDDLEWARE_RETRY);
+                    writer.addImport("DEFAULT_MAX_ATTEMPTS", "DEFAULT_MAX_ATTEMPTS",
+                            TypeScriptDependency.MIDDLEWARE_RETRY.packageName);
+                    writer.write("maxAttempts: DEFAULT_MAX_ATTEMPTS,");
+                });
+                return defaultConfigs;
             case NODE:
-                return MapUtils.of(
-                        "region", writer -> {
-                            writer.addDependency(AwsDependency.NODE_CONFIG_PROVIDER);
-                            writer.addImport("loadConfig", "loadNodeConfig",
-                                    AwsDependency.NODE_CONFIG_PROVIDER.packageName);
-                            writer.addDependency(TypeScriptDependency.CONFIG_RESOLVER);
-                            writer.addImport("NODE_REGION_CONFIG_OPTIONS", "NODE_REGION_CONFIG_OPTIONS",
-                                    TypeScriptDependency.CONFIG_RESOLVER.packageName);
-                            writer.addImport("NODE_REGION_CONFIG_FILE_OPTIONS", "NODE_REGION_CONFIG_FILE_OPTIONS",
-                                    TypeScriptDependency.CONFIG_RESOLVER.packageName);
-                            writer.write(
+                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",
+                                AwsDependency.NODE_CONFIG_PROVIDER.packageName);
+                        writer.addDependency(TypeScriptDependency.CONFIG_RESOLVER);
+                        writer.addImport("NODE_REGION_CONFIG_OPTIONS", "NODE_REGION_CONFIG_OPTIONS",
+                                TypeScriptDependency.CONFIG_RESOLVER.packageName);
+                        writer.addImport("NODE_REGION_CONFIG_FILE_OPTIONS", "NODE_REGION_CONFIG_FILE_OPTIONS",
+                                TypeScriptDependency.CONFIG_RESOLVER.packageName);
+                        writer.write(
                                 "region: loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),");
-                        },
-                        "maxAttempts", writer -> {
-                            writer.addImport("NODE_MAX_ATTEMPT_CONFIG_OPTIONS", "NODE_MAX_ATTEMPT_CONFIG_OPTIONS",
-                                TypeScriptDependency.MIDDLEWARE_RETRY.packageName);
-                            writer.write("maxAttempts: loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),");
-                        }
-                );
+                    });
+                }
+                defaultConfigs.put("maxAttempts", writer -> {
+                    writer.addDependency(AwsDependency.NODE_CONFIG_PROVIDER);
+                    writer.addImport("loadConfig", "loadNodeConfig",
+                            AwsDependency.NODE_CONFIG_PROVIDER.packageName);
+                    writer.addImport("NODE_MAX_ATTEMPT_CONFIG_OPTIONS", "NODE_MAX_ATTEMPT_CONFIG_OPTIONS",
+                        TypeScriptDependency.MIDDLEWARE_RETRY.packageName);
+                    writer.write("maxAttempts: loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),");
+                });
+                return defaultConfigs;
             default:
                 return Collections.emptyMap();
         }

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

@@ -15,6 +15,7 @@
 
 package software.amazon.smithy.aws.typescript.codegen;
 
+import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isAwsService;
 import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_CONFIG;
 import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_MIDDLEWARE;
 
@@ -44,6 +45,7 @@ public List<RuntimeClientPlugin> getClientPlugins() {
         return ListUtils.of(
                 RuntimeClientPlugin.builder()
                         .withConventions(TypeScriptDependency.CONFIG_RESOLVER.dependency, "Region", HAS_CONFIG)
+                        .servicePredicate((m, s) -> isAwsService(s))
                         .build(),
                 RuntimeClientPlugin.builder()
                         .withConventions(TypeScriptDependency.CONFIG_RESOLVER.dependency, "Endpoints", HAS_CONFIG)

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

@@ -15,6 +15,8 @@
 
 package software.amazon.smithy.aws.typescript.codegen;
 
+import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isAwsService;
+
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -33,12 +35,15 @@
 /**
  * Add client plubins and configs to support injecting user agent.
  */
+// TODO: Looks to add this back for non-AWS service clients, by fixing the dependency on ClientSharedValues.serviceId
 public class AddUserAgentDependency implements TypeScriptIntegration {
     @Override
     public List<RuntimeClientPlugin> getClientPlugins() {
         return ListUtils.of(
                 RuntimeClientPlugin.builder()
-                        .withConventions(AwsDependency.MIDDLEWARE_USER_AGENT.dependency, "UserAgent").build());
+                        .withConventions(AwsDependency.MIDDLEWARE_USER_AGENT.dependency, "UserAgent")
+                        .servicePredicate((m, s) -> isAwsService(s))
+                        .build());
     }
 
     @Override
@@ -48,6 +53,9 @@ public void addConfigInterfaceFields(
             SymbolProvider symbolProvider,
             TypeScriptWriter writer
     ) {
+        if (!isAwsService(settings, model)) {
+            return;
+        }
         writer.addImport("Provider", "Provider", TypeScriptDependency.AWS_SDK_TYPES.packageName);
         writer.addImport("UserAgent", "__UserAgent", TypeScriptDependency.AWS_SDK_TYPES.packageName);
         writer.writeDocs("The provider populating default tracking information to be sent with `user-agent`, "
@@ -62,6 +70,9 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
         SymbolProvider symbolProvider,
         LanguageTarget target
     ) {
+        if (!isAwsService(settings, model)) {
+            return Collections.emptyMap();
+        }
         switch (target) {
             case NODE:
                 return MapUtils.of(

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

@@ -15,6 +15,8 @@
 
 package software.amazon.smithy.aws.typescript.codegen;
 
+import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isAwsService;
+
 import java.util.Collections;
 import java.util.Map;
 import java.util.function.BiConsumer;
@@ -39,7 +41,7 @@ public void writeAdditionalFiles(
             SymbolProvider symbolProvider,
             BiConsumer<String, Consumer<TypeScriptWriter>> writerFactory
     ) {
-        if (!settings.generateClient()) {
+        if (!settings.generateClient() || !isAwsService(settings, model)) {
             return;
         }
 
@@ -55,7 +57,7 @@ public void addConfigInterfaceFields(
             SymbolProvider symbolProvider,
             TypeScriptWriter writer
     ) {
-        if (!settings.generateClient()) {
+        if (!settings.generateClient() || !isAwsService(settings, model)) {
             return;
         }
 
@@ -71,7 +73,7 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
             SymbolProvider symbolProvider,
             LanguageTarget target
     ) {
-        if (!settings.generateClient()) {
+        if (!settings.generateClient() || !isAwsService(settings, model)) {
             return Collections.emptyMap();
         }
 

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

@@ -15,6 +15,8 @@
 
 package software.amazon.smithy.aws.typescript.codegen;
 
+import static software.amazon.smithy.aws.typescript.codegen.AwsTraitsUtils.isAwsService;
+
 import java.util.Arrays;
 import java.util.Calendar;
 import java.util.function.BiConsumer;
@@ -56,7 +58,8 @@ public void writeAdditionalFiles(
             writer.write(resource);
         });
 
-        if (!settings.generateClient()) {
+        // TODO: May need to generate a different/modified README.md for these cases
+        if (!settings.generateClient() || !isAwsService(settings, model)) {
             return;
         }
 

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

@@ -44,6 +44,7 @@ public SymbolProvider decorateSymbolProvider(
                 return symbol;
             }
 
+            // TODO: Should this WARNING be avoided somehow if client is not for an AWS service?
             // If the SDK service ID trait is present, use that, otherwise fall back to
             // the default naming strategy for the service.
             return shape.getTrait(ServiceTrait.class)

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

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+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;
+
+/**
+ * Utility methods related to AWS traits.
+ */
+final class AwsTraitsUtils {
+
+    private AwsTraitsUtils() {}
+
+    static boolean isAwsService(TypeScriptSettings settings, Model model) {
+        return isAwsService(settings.getService(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);
+    }
+}