Add matchSettings() to RuntimeClientPlugins

Enable `RuntimeClientPlugin`s to be filtered based on settings, and filter at the top-level of `DirectedTypeScriptCodegen`.

Author: Steven Yuan

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/DirectedTypeScriptCodegen.java

@@ -92,8 +92,12 @@ public TypeScriptCodegenContext createContext(CreateContextDirective<TypeScriptS
         directive.integrations().forEach(integration -> {
             LOGGER.info(() -> "Adding TypeScriptIntegration: " + integration.getClass().getName());
             integration.getClientPlugins().forEach(runtimePlugin -> {
-                LOGGER.info(() -> "Adding TypeScript runtime plugin: " + runtimePlugin);
-                runtimePlugins.add(runtimePlugin);
+                if (runtimePlugin.matchesSettings(directive.model(), directive.service(), directive.settings())) {
+                    LOGGER.info(() -> "Adding TypeScript runtime plugin: " + runtimePlugin);
+                    runtimePlugins.add(runtimePlugin);
+                } else {
+                    LOGGER.info(() -> "Skipping TypeScript runtime plugin based on settings: " + runtimePlugin);
+                }
             });
         });
 

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/RuntimeClientPlugin.java

@@ -28,6 +28,7 @@
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
 import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
+import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
 import software.amazon.smithy.utils.SmithyBuilder;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 import software.amazon.smithy.utils.StringUtils;
@@ -54,6 +55,7 @@ public final class RuntimeClientPlugin implements ToSmithyBuilder<RuntimeClientP
     private final SymbolReference destroyFunction;
     private final BiPredicate<Model, ServiceShape> servicePredicate;
     private final OperationPredicate operationPredicate;
+    private final SettingsPredicate settingsPredicate;
 
     private RuntimeClientPlugin(Builder builder) {
         inputConfig = builder.inputConfig;
@@ -65,6 +67,7 @@ private RuntimeClientPlugin(Builder builder) {
         destroyFunction = builder.destroyFunction;
         operationPredicate = builder.operationPredicate;
         servicePredicate = builder.servicePredicate;
+        settingsPredicate = builder.settingsPredicate;
 
         boolean allNull = (inputConfig == null) && (resolvedConfig == null) && (resolveFunction == null);
         boolean allSet = (inputConfig != null) && (resolvedConfig != null) && (resolveFunction != null);
@@ -93,6 +96,19 @@ public interface OperationPredicate {
         boolean test(Model model, ServiceShape service, OperationShape operation);
     }
 
+    @FunctionalInterface
+    public interface SettingsPredicate {
+        /**
+         * Tests if runtime client plugin should be applied based on settings.
+         *
+         * @param model Model the operation belongs to.
+         * @param service Service the operation belongs to.
+         * @param settings Settings from smithy-build configuration.
+         * @return Returns true if runtime client plugin should be applied.
+         */
+        boolean test(Model model, ServiceShape service, TypeScriptSettings settings);
+    }
+
     @FunctionalInterface
     public interface FunctionParamsSupplier {
         /**
@@ -298,6 +314,18 @@ public boolean matchesOperation(Model model, ServiceShape service, OperationShap
         return operationPredicate.test(model, service, operation);
     }
 
+    /**
+     * Returns true if this plugin applies given a smithy-build configuration.
+     *
+     * @param model Model the operation belongs to.
+     * @param service Service the operation belongs to.
+     * @param settings Settings from smithy-build configuration to test against.
+     * @return Returns true if the plugin is applied given a smithy-build configuration.
+     */
+    public boolean matchesSettings(Model model, ServiceShape service, TypeScriptSettings settings) {
+        return settingsPredicate.test(model, service, settings);
+    }
+
     public static Builder builder() {
         return new Builder();
     }
@@ -369,6 +397,7 @@ public static final class Builder implements SmithyBuilder<RuntimeClientPlugin>
         private SymbolReference destroyFunction;
         private BiPredicate<Model, ServiceShape> servicePredicate = (model, service) -> true;
         private OperationPredicate operationPredicate = (model, service, operation) -> false;
+        private SettingsPredicate settingsPredicate = (model, service, settings) -> true;
 
         @Override
         public RuntimeClientPlugin build() {
@@ -676,6 +705,22 @@ public Builder appliesOnlyToOperations(Set<String> operationNames) {
             return servicePredicate((model, service) -> false);
         }
 
+        /**
+         * Configures a predicate that applies the plugin to a service if the
+         * predicate matches a given model and service and settings.
+         *
+         * <p>Setting a custom settings predicate is useful for plugins
+         * that should only be applied based on certain smithy-build
+         * configurations.
+         *
+         * @param settingsPredicate Settings predicate.
+         * @return Returns the builder.
+         */
+        public Builder settingsPredicate(SettingsPredicate settingsPredicate) {
+            this.settingsPredicate = Objects.requireNonNull(settingsPredicate);
+            return this;
+        }
+
         /**
          * Configures a predicate that applies the plugin to a service if the
          * predicate matches a given model and service.

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/integration/RuntimeClientPluginTest.java

@@ -12,7 +12,7 @@
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
-import software.amazon.smithy.utils.ListUtils;
+import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
 
 public class RuntimeClientPluginTest {
     @Test
@@ -68,6 +68,25 @@ public void allowsConfigurableServicePredicate() {
         assertThat(plugin.matchesOperation(model, service2, operation), equalTo(false));
     }
 
+    @Test
+    public void allowsConfigurableSettingsPredicate() {
+        ServiceShape service = ServiceShape.builder().id("a.b#C").version("123").build();
+        Model model = Model.assembler()
+                .addShapes(service)
+                .assemble()
+                .unwrap();
+        RuntimeClientPlugin createDefaultReadmeFlagPlugin = RuntimeClientPlugin.builder()
+                .settingsPredicate((m, s, settings) -> settings.createDefaultReadme())
+                .build();
+
+        TypeScriptSettings createDefaultReadmeTrueSettings = new TypeScriptSettings();
+        createDefaultReadmeTrueSettings.setCreateDefaultReadme(true);
+        assertThat(createDefaultReadmeFlagPlugin.matchesSettings(model, service, createDefaultReadmeTrueSettings), equalTo(true));
+
+        TypeScriptSettings createDefaultReadmeFalseSettings = new TypeScriptSettings();
+        assertThat(createDefaultReadmeFlagPlugin.matchesSettings(model, service, createDefaultReadmeFalseSettings), equalTo(false));
+    }
+
     @Test
     public void configuresWithDefaultConventions() {
         Map<String, Object> resolveFunctionParams = new HashMap<String, Object>() {{