Enable passing dynamic parameters to RuntimeClientPlugin functions

This is a requirement for advanced use cases of Endpoint Discovery logic.
Currently, only Symbols and strings are generated for parameters. In future,
boolean and Map<String, String> support would be added.

Author: trivikr

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

@@ -17,7 +17,9 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.stream.Collectors;
+import software.amazon.smithy.codegen.core.CodegenException;
 import software.amazon.smithy.codegen.core.Symbol;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.knowledge.EventStreamIndex;
@@ -134,4 +136,38 @@ static void writeStreamingMemberType(
                 + " `%2$s` defined in {@link %1$s}", containerSymbol.getName(), memberName));
         writer.write("export interface $1L extends $1LType {}", typeName);
     }
+
+    /**
+     * Returns the list of function parameter key-value pairs to be written for
+     * provided parameters map.
+     *
+     * @param paramsMap Map of paramters to generate a parameters string for.
+     * @return The list of parameters to be written.
+     */
+    static List<String> getFunctionParametersList(Map<String, Object> paramsMap) {
+        List<String> functionParametersList = new ArrayList<String>();
+
+        if (!paramsMap.isEmpty()) {
+            for (Map.Entry<String, Object> param : paramsMap.entrySet()) {
+                String key = param.getKey();
+                Object value = param.getValue();
+                if (value instanceof Symbol) {
+                    String symbolName = ((Symbol) value).getName();
+                    if (key.equals(symbolName)) {
+                        functionParametersList.add(key);
+                    } else {
+                        functionParametersList.add(String.format("%s: %s", key, symbolName));
+                    }
+                } else if (value instanceof String) {
+                    functionParametersList.add(String.format("%s: '%s'", key, value));
+                } else {
+                    // Future support for param type should be added in else if.
+                    throw new CodegenException("plugin function parameters not supported for type"
+                            + value.toString());
+                }
+            }
+        }
+
+        return functionParametersList;
+    }
 }

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

@@ -19,6 +19,7 @@
 import static software.amazon.smithy.typescript.codegen.CodegenUtils.writeStreamingMemberType;
 
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.stream.Collectors;
 import software.amazon.smithy.codegen.core.Symbol;
@@ -248,7 +249,9 @@ private void addCommandSpecificPlugins() {
         // the service's middleware stack.
         for (RuntimeClientPlugin plugin : runtimePlugins) {
             plugin.getPluginFunction().ifPresent(symbol -> {
-                List<String> additionalParameters = plugin.getAdditionalPluginFunctionParameters();
+                Map<String, Object> paramsMap = plugin.getPluginFunctionParameters(model, service, operation);
+                List<String> additionalParameters = CodegenUtils.getFunctionParametersList(paramsMap);
+
                 String additionalParamsString = additionalParameters.isEmpty()
                     ? ""
                     : ", { " + String.join(", ", additionalParameters) + "}";

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

@@ -17,6 +17,7 @@
 
 import java.util.Comparator;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -313,7 +314,9 @@ private void generateConstructor() {
             for (RuntimeClientPlugin plugin : runtimePlugins) {
                 if (plugin.getResolveFunction().isPresent()) {
                     configVariable++;
-                    List<String> additionalParameters = plugin.getAdditionalResolveFunctionParameters();
+                    Map<String, Object> paramsMap = plugin.getResolveFunctionParameters(model, service, null);
+                    List<String> additionalParameters = CodegenUtils.getFunctionParametersList(paramsMap);
+
                     String additionalParamsString = additionalParameters.isEmpty()
                             ? ""
                             : ", " + String.join(", ", additionalParameters);

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

@@ -15,8 +15,8 @@
 
 package software.amazon.smithy.typescript.codegen.integration;
 
-import java.util.ArrayList;
-import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
@@ -28,7 +28,6 @@
 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.utils.ListUtils;
 import software.amazon.smithy.utils.SmithyBuilder;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 import software.amazon.smithy.utils.StringUtils;
@@ -49,9 +48,9 @@ public final class RuntimeClientPlugin implements ToSmithyBuilder<RuntimeClientP
     private final SymbolReference inputConfig;
     private final SymbolReference resolvedConfig;
     private final SymbolReference resolveFunction;
-    private final List<String> additionalResolveFunctionParameters;
+    private final FunctionParamsSupplier resolveFunctionParamsSupplier;
     private final SymbolReference pluginFunction;
-    private final List<String> additionalPluginFunctionParameters;
+    private final FunctionParamsSupplier pluginFunctionParamsSupplier;
     private final SymbolReference destroyFunction;
     private final BiPredicate<Model, ServiceShape> servicePredicate;
     private final OperationPredicate operationPredicate;
@@ -60,21 +59,13 @@ private RuntimeClientPlugin(Builder builder) {
         inputConfig = builder.inputConfig;
         resolvedConfig = builder.resolvedConfig;
         resolveFunction = builder.resolveFunction;
-        additionalResolveFunctionParameters = ListUtils.copyOf(builder.additionalResolveFunctionParameters);
+        resolveFunctionParamsSupplier = builder.resolveFunctionParamsSupplier;
         pluginFunction = builder.pluginFunction;
-        additionalPluginFunctionParameters = ListUtils.copyOf(builder.additionalPluginFunctionParameters);
+        pluginFunctionParamsSupplier = builder.pluginFunctionParamsSupplier;
         destroyFunction = builder.destroyFunction;
         operationPredicate = builder.operationPredicate;
         servicePredicate = builder.servicePredicate;
 
-        if (!additionalResolveFunctionParameters.isEmpty() && resolveFunction == null) {
-            throw new IllegalStateException("Additional parameters can only be set if a resolve function is set.");
-        }
-
-        if (!additionalPluginFunctionParameters.isEmpty() && pluginFunction == null) {
-            throw new IllegalStateException("Additional parameters can only be set if a plugin function is set.");
-        }
-
         boolean allNull = (inputConfig == null) && (resolvedConfig == null) && (resolveFunction == null);
         boolean allSet = (inputConfig != null) && (resolvedConfig != null) && (resolveFunction != null);
         if (!(allNull || allSet)) {
@@ -102,6 +93,19 @@ public interface OperationPredicate {
         boolean test(Model model, ServiceShape service, OperationShape operation);
     }
 
+    @FunctionalInterface
+    public interface FunctionParamsSupplier {
+        /**
+         * Returns dynamic parameters for resolve function.
+         *
+         * @param model Model the operation belongs to.
+         * @param service Service the operation belongs to.
+         * @param operation Operation to test.
+         * @return Returns true if middleware should be applied to the operation.
+         */
+        Map<String, Object> apply(Model model, ServiceShape service, OperationShape operation);
+    }
+
     /**
      * Gets the optionally present symbol reference that points to the
      * <em>Input configuration interface</em> for the plugin.
@@ -163,7 +167,6 @@ public Optional<SymbolReference> getResolvedConfig() {
      *
      * @return Returns the optionally present resolve function.
      * @see #getInputConfig()
-     * @see #getAdditionalResolveFunctionParameters()
      * @see #getResolvedConfig()
      */
     public Optional<SymbolReference> getResolveFunction() {
@@ -173,14 +176,23 @@ public Optional<SymbolReference> getResolveFunction() {
     /**
      * Gets a list of additional parameters to be supplied to the
      * resolve function. These parameters are to be supplied to resolve
-     * function as Nth(N &gt; 1) positional arguments. The list is empty if
-     * there are no additional parameters.
+     * function as second argument. The map is empty if there are
+     * no additional parameters.
      *
-     * @return Returns the optionally present list of parameters.
-     * @see #getResolveFunction()
+     * @param model Model the operation belongs to.
+     * @param service Service the operation belongs to.
+     * @param operation Operation to test against.
+     * @return Returns the optionally present map of parameters.
      */
-    public List<String> getAdditionalResolveFunctionParameters() {
-        return additionalResolveFunctionParameters;
+    public Map<String, Object> getResolveFunctionParameters(
+        Model model,
+        ServiceShape service,
+        OperationShape operation
+    ) {
+        if (resolveFunctionParamsSupplier != null) {
+            return resolveFunctionParamsSupplier.apply(model, service, operation);
+        }
+        return new HashMap<String, Object>();
     }
 
     /**
@@ -211,14 +223,23 @@ public Optional<SymbolReference> getPluginFunction() {
     /**
      * Gets a list of additional parameters to be supplied to the
      * plugin function. These parameters are to be supplied to plugin
-     * function as an options hash. The list is empty if
-     * there are no additional parameters.
+     * function as second argument. The map is empty if there are
+     * no additional parameters.
      *
-     * @return Returns the optionally present list of parameters.
-     * @see #getPluginFunction()
+     * @param model Model the operation belongs to.
+     * @param service Service the operation belongs to.
+     * @param operation Operation to test against.
+     * @return Returns the optionally present map of parameters.
      */
-    public List<String> getAdditionalPluginFunctionParameters() {
-        return additionalPluginFunctionParameters;
+    public Map<String, Object> getPluginFunctionParameters(
+        Model model,
+        ServiceShape service,
+        OperationShape operation
+    ) {
+        if (pluginFunctionParamsSupplier != null) {
+            return pluginFunctionParamsSupplier.apply(model, service, operation);
+        }
+        return new HashMap<String, Object>();
     }
 
     /**
@@ -284,7 +305,9 @@ public Builder toBuilder() {
                 .inputConfig(inputConfig)
                 .resolvedConfig(resolvedConfig)
                 .resolveFunction(resolveFunction)
+                .resolveFunctionParamsSupplier(resolveFunctionParamsSupplier)
                 .pluginFunction(pluginFunction)
+                .pluginFunctionParamsSupplier(pluginFunctionParamsSupplier)
                 .destroyFunction(destroyFunction);
 
         // Set these directly since their setters have mutual side-effects.
@@ -300,9 +323,7 @@ public String toString() {
                + "inputConfig=" + inputConfig
                + ", resolvedConfig=" + resolvedConfig
                + ", resolveFunction=" + resolveFunction
-               + ", additionalResolveFunctionParameters=" + additionalResolveFunctionParameters
                + ", pluginFunction=" + pluginFunction
-               + ", additionalPluginFunctionParameters=" + additionalPluginFunctionParameters
                + ", destroyFunction=" + destroyFunction
                + '}';
     }
@@ -319,9 +340,9 @@ public boolean equals(Object o) {
         return Objects.equals(inputConfig, that.inputConfig)
                && Objects.equals(resolvedConfig, that.resolvedConfig)
                && Objects.equals(resolveFunction, that.resolveFunction)
-               && Objects.equals(additionalResolveFunctionParameters, that.additionalResolveFunctionParameters)
+               && Objects.equals(resolveFunctionParamsSupplier, that.resolveFunctionParamsSupplier)
                && Objects.equals(pluginFunction, that.pluginFunction)
-               && Objects.equals(additionalPluginFunctionParameters, that.additionalPluginFunctionParameters)
+               && Objects.equals(pluginFunctionParamsSupplier, that.pluginFunctionParamsSupplier)
                && Objects.equals(destroyFunction, that.destroyFunction)
                && servicePredicate.equals(that.servicePredicate)
                && operationPredicate.equals(that.operationPredicate);
@@ -339,9 +360,9 @@ public static final class Builder implements SmithyBuilder<RuntimeClientPlugin>
         private SymbolReference inputConfig;
         private SymbolReference resolvedConfig;
         private SymbolReference resolveFunction;
-        private List<String> additionalResolveFunctionParameters = new ArrayList<>();
+        private FunctionParamsSupplier resolveFunctionParamsSupplier;
         private SymbolReference pluginFunction;
-        private List<String> additionalPluginFunctionParameters = new ArrayList<>();
+        private FunctionParamsSupplier pluginFunctionParamsSupplier;
         private SymbolReference destroyFunction;
         private BiPredicate<Model, ServiceShape> servicePredicate = (model, service) -> true;
         private OperationPredicate operationPredicate = (model, service, operation) -> false;
@@ -433,13 +454,16 @@ public Builder resolveFunction(SymbolReference resolveFunction) {
          * {@link #inputConfig} must also be set.
          *
          * @param resolveFunction Function used to convert input to resolved.
-         * @param additionalParameters Additional parameters to be generated as resolve function input.
+         * @param resolveFunctionParamsSupplier Function which returns params to be passed as resolve function input.
          * @return Returns the builder.
          * @see #getResolveFunction()
          */
-        public Builder resolveFunction(SymbolReference resolveFunction, String... additionalParameters) {
+        public Builder resolveFunction(
+                SymbolReference resolveFunction,
+                FunctionParamsSupplier resolveFunctionParamsSupplier
+        ) {
             this.resolveFunction = resolveFunction;
-            this.additionalResolveFunctionParameters = ListUtils.of(additionalParameters);
+            this.resolveFunctionParamsSupplier = resolveFunctionParamsSupplier;
             return this;
         }
 
@@ -466,27 +490,33 @@ public Builder resolveFunction(Symbol resolveFunction) {
          * {@link #inputConfig} must also be set.
          *
          * @param resolveFunction Function used to convert input to resolved.
-         * @param additionalParameters Additional parameters to be generated as resolve function input.
+         * @param resolveFunctionParamsSupplier Function which returns params to be passed as resolve function input.
          * @return Returns the builder.
          * @see #getResolveFunction()
          */
-        public Builder resolveFunction(Symbol resolveFunction, String... additionalParameters) {
-            return resolveFunction(SymbolReference.builder().symbol(resolveFunction).build(), additionalParameters);
+        public Builder resolveFunction(
+            Symbol resolveFunction,
+            FunctionParamsSupplier resolveFunctionParamsSupplier
+        ) {
+            return resolveFunction(
+                SymbolReference.builder().symbol(resolveFunction).build(),
+                resolveFunctionParamsSupplier
+            );
         }
 
         /**
-         * Set additional positional input parameters to resolve function. Set
-         * this with no arguments to remove the current parameters.
+         * Set function which returns input parameters to resolve function. Set
+         * function to return empty map to remove the current parameters.
          *
          * <p>If this is set, then all of {@link #resolveFunction},
          * {@link #resolvedConfig} and {@link #inputConfig} must also be set.
          *
-         * @param additionalParameters Additional parameters to be generated as resolve function input.
+         * @param resolveFunctionParamsSupplier Function which returns params to be passed as resolve function input.
          * @return Returns the builder.
          * @see #getResolveFunction()
          */
-        public Builder additionalResolveFunctionParameters(String... additionalParameters) {
-            this.additionalResolveFunctionParameters = ListUtils.of(additionalParameters);
+        public Builder resolveFunctionParamsSupplier(FunctionParamsSupplier resolveFunctionParamsSupplier) {
+            this.resolveFunctionParamsSupplier = resolveFunctionParamsSupplier;
             return this;
         }
 
@@ -508,13 +538,16 @@ public Builder pluginFunction(SymbolReference pluginFunction) {
          * commands to use a specific middleware function.
          *
          * @param pluginFunction Plugin function symbol to invoke.
-         * @param additionalParameters Additional parameters to be generated as plugin function input.
+         * @param pluginFunctionParamsSupplier Function which returns params to be passed as plugin function input.
          * @return Returns the builder.
          * @see #getPluginFunction()
          */
-        public Builder pluginFunction(SymbolReference pluginFunction, String... additionalParameters) {
+        public Builder pluginFunction(
+                SymbolReference pluginFunction,
+                FunctionParamsSupplier pluginFunctionParamsSupplier
+        ) {
             this.pluginFunction = pluginFunction;
-            this.additionalPluginFunctionParameters = ListUtils.of(additionalParameters);
+            this.pluginFunctionParamsSupplier = pluginFunctionParamsSupplier;
             return this;
         }
 
@@ -535,24 +568,30 @@ public Builder pluginFunction(Symbol pluginFunction) {
          * use a specific middleware function.
          *
          * @param pluginFunction Plugin function symbol to invoke.
-         * @param additionalParameters Additional parameters to be generated as plugin function input.
+         * @param pluginFunctionParamsSupplier Function which returns params to be passed as plugin function input.
          * @return Returns the builder.
          * @see #getPluginFunction()
          */
-        public Builder pluginFunction(Symbol pluginFunction, String... additionalParameters) {
-            return pluginFunction(SymbolReference.builder().symbol(pluginFunction).build(), additionalParameters);
+        public Builder pluginFunction(
+            Symbol pluginFunction,
+            FunctionParamsSupplier pluginFunctionParamsSupplier
+        ) {
+            return pluginFunction(
+                SymbolReference.builder().symbol(pluginFunction).build(),
+                pluginFunctionParamsSupplier
+            );
         }
 
         /**
-         * Set additional positional input parameters to plugin function. Set
-         * this with no arguments to remove the current parameters.
+         * Set function which returns input parameters to plugin function. Set
+         * function to return empty map to remove the current parameters.
          *
-         * @param additionalParameters Additional parameters to be generated as plugin function input.
+         * @param pluginFunctionParamsSupplier Function which returns params to be passed as plugin function input.
          * @return Returns the builder.
          * @see #getPluginFunction()
          */
-        public Builder additionalPluginFunctionParameters(String... additionalParameters) {
-            this.additionalPluginFunctionParameters = ListUtils.of(additionalParameters);
+        public Builder pluginFunctionParamsSupplier(FunctionParamsSupplier pluginFunctionParamsSupplier) {
+            this.pluginFunctionParamsSupplier = pluginFunctionParamsSupplier;
             return this;
         }