Skip to content

Enable passing dynamic parameters to RuntimeClientPlugin functions #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -135,6 +137,40 @@ static void writeStreamingMemberType(
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.getClass());
}
}
}

return functionParametersList;
}

/**
* Ease the input streaming member restriction so that users don't need to construct a stream every time.
* This is used for inline type declarations (such as parameters) that need to take more permissive inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -248,7 +249,10 @@ 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.getAdditionalPluginFunctionParameters(
model, service, operation);
List<String> additionalParameters = CodegenUtils.getFunctionParametersList(paramsMap);

String additionalParamsString = additionalParameters.isEmpty()
? ""
: ", { " + String.join(", ", additionalParameters) + "}";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -313,7 +314,10 @@ private void generateConstructor() {
for (RuntimeClientPlugin plugin : runtimePlugins) {
if (plugin.getResolveFunction().isPresent()) {
configVariable++;
List<String> additionalParameters = plugin.getAdditionalResolveFunctionParameters();
Map<String, Object> paramsMap = plugin.getAdditionalResolveFunctionParameters(
model, service, null);
List<String> additionalParameters = CodegenUtils.getFunctionParametersList(paramsMap);

String additionalParamsString = additionalParameters.isEmpty()
? ""
: ", " + String.join(", ", additionalParameters);
Expand Down
Loading