Skip to content

change runtime config from constant to provider functions #381

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 2 commits into from
Jul 21, 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 @@ -46,118 +46,118 @@ final class RuntimeConfigGenerator {
writer.addDependency(TypeScriptDependency.AWS_SDK_NODE_HTTP_HANDLER);
writer.addImport("NodeHttpHandler", "NodeHttpHandler",
TypeScriptDependency.AWS_SDK_NODE_HTTP_HANDLER.packageName);
writer.write("requestHandler: new NodeHttpHandler(),");
writer.write("new NodeHttpHandler()");
},
"sha256", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_HASH_NODE);
writer.addImport("Hash", "Hash",
TypeScriptDependency.AWS_SDK_HASH_NODE.packageName);
writer.write("sha256: Hash.bind(null, \"sha256\"),");
writer.write("Hash.bind(null, \"sha256\")");
},
"bodyLengthChecker", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_BODY_LENGTH_NODE);
writer.addImport("calculateBodyLength", "calculateBodyLength",
TypeScriptDependency.AWS_SDK_UTIL_BODY_LENGTH_NODE.packageName);
writer.write("bodyLengthChecker: calculateBodyLength,");
writer.write("calculateBodyLength");
},
"streamCollector", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_NODE_HTTP_HANDLER);
writer.addImport("streamCollector", "streamCollector",
TypeScriptDependency.AWS_SDK_NODE_HTTP_HANDLER.packageName);
writer.write("streamCollector,");
writer.write("streamCollector");
},
"base64Decoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_BASE64_NODE);
writer.addImport("fromBase64", "fromBase64",
TypeScriptDependency.AWS_SDK_UTIL_BASE64_NODE.packageName);
writer.write("base64Decoder: fromBase64,");
writer.write("fromBase64");
},
"base64Encoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_BASE64_NODE);
writer.addImport("toBase64", "toBase64",
TypeScriptDependency.AWS_SDK_UTIL_BASE64_NODE.packageName);
writer.write("base64Encoder: toBase64,");
writer.write("toBase64");
},
"utf8Decoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_UTF8_NODE);
writer.addImport("fromUtf8", "fromUtf8",
TypeScriptDependency.AWS_SDK_UTIL_UTF8_NODE.packageName);
writer.write("utf8Decoder: fromUtf8,");
writer.write("fromUtf8");
},
"utf8Encoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_UTF8_NODE);
writer.addImport("toUtf8", "toUtf8",
TypeScriptDependency.AWS_SDK_UTIL_UTF8_NODE.packageName);
writer.write("utf8Encoder: toUtf8,");
writer.write("toUtf8");
}
);
private final Map<String, Consumer<TypeScriptWriter>> browserRuntimeConfigDefaults = MapUtils.of(
"requestHandler", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_FETCH_HTTP_HANDLER);
writer.addImport("FetchHttpHandler", "FetchHttpHandler",
TypeScriptDependency.AWS_SDK_FETCH_HTTP_HANDLER.packageName);
writer.write("requestHandler: new FetchHttpHandler(),");
writer.write("new FetchHttpHandler()");
},
"sha256", writer -> {
writer.addDependency(TypeScriptDependency.AWS_CRYPTO_SHA256_BROWSER);
writer.addImport("Sha256", "Sha256",
TypeScriptDependency.AWS_CRYPTO_SHA256_BROWSER.packageName);
writer.write("sha256: Sha256,");
writer.write("Sha256");
},
"bodyLengthChecker", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_BODY_LENGTH_BROWSER);
writer.addImport("calculateBodyLength", "calculateBodyLength",
TypeScriptDependency.AWS_SDK_UTIL_BODY_LENGTH_BROWSER.packageName);
writer.write("bodyLengthChecker: calculateBodyLength,");
writer.write("calculateBodyLength");
},
"streamCollector", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_FETCH_HTTP_HANDLER);
writer.addImport("streamCollector", "streamCollector",
TypeScriptDependency.AWS_SDK_FETCH_HTTP_HANDLER.packageName);
writer.write("streamCollector,");
writer.write("streamCollector");
},
"base64Decoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_BASE64_BROWSER);
writer.addImport("fromBase64", "fromBase64",
TypeScriptDependency.AWS_SDK_UTIL_BASE64_BROWSER.packageName);
writer.write("base64Decoder: fromBase64,");
writer.write("fromBase64");
},
"base64Encoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_BASE64_BROWSER);
writer.addImport("toBase64", "toBase64",
TypeScriptDependency.AWS_SDK_UTIL_BASE64_BROWSER.packageName);
writer.write("base64Encoder: toBase64,");
writer.write("toBase64");
},
"utf8Decoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_UTF8_BROWSER);
writer.addImport("fromUtf8", "fromUtf8",
TypeScriptDependency.AWS_SDK_UTIL_UTF8_BROWSER.packageName);
writer.write("utf8Decoder: fromUtf8,");
writer.write("fromUtf8");
},
"utf8Encoder", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_UTIL_UTF8_BROWSER);
writer.addImport("toUtf8", "toUtf8",
TypeScriptDependency.AWS_SDK_UTIL_UTF8_BROWSER.packageName);
writer.write("utf8Encoder: toUtf8,");
writer.write("toUtf8");
}
);
private final Map<String, Consumer<TypeScriptWriter>> reactNativeRuntimeConfigDefaults = MapUtils.of(
"sha256", writer -> {
writer.addDependency(TypeScriptDependency.AWS_CRYPTO_SHA256_JS);
writer.addImport("Sha256", "Sha256",
TypeScriptDependency.AWS_CRYPTO_SHA256_JS.packageName);
writer.write("sha256: Sha256,");
writer.write("Sha256");
}
);
private final Map<String, Consumer<TypeScriptWriter>> sharedRuntimeConfigDefaults = MapUtils.of(
"disableHostPrefix", writer -> {
writer.write("disableHostPrefix: false,");
writer.write("false");
},
"urlParser", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_URL_PARSER);
writer.addImport("parseUrl", "parseUrl",
TypeScriptDependency.AWS_SDK_URL_PARSER.packageName);
writer.write("urlParser: parseUrl,");
writer.write("parseUrl");
}
);

Expand All @@ -180,24 +180,31 @@ void generate(LanguageTarget target) {
String template = TypeScriptUtils.loadResourceAsString(target.getTemplateFileName());
String contents = template
.replace("${clientModuleName}", symbolProvider.toSymbol(service).getNamespace())
.replace("${clientConfigName}", symbolProvider.toSymbol(service).getName() + "Config")
.replace("${apiVersion}", service.getVersion())
.replace("$", "$$") // sanitize template place holders.
.replace("$${customizations}", "${L@customizations}");

delegator.useFileWriter(target.getTargetFilename(), writer -> {
// Inject customizations into the ~template.
writer.onSection("customizations", original -> {
writer.indent();
writer.indent().onSection("customizations", original -> {
// Start with defaults, use a TreeMap for keeping entries sorted.
Map<String, Consumer<TypeScriptWriter>> configs =
new TreeMap<>(getDefaultRuntimeConfigs(target));
// Add any integration supplied runtime config writers.
for (TypeScriptIntegration integration : integrations) {
configs.putAll(integration.getRuntimeConfigWriters(settings, model, symbolProvider, target));
}
configs.values().forEach(value -> value.accept(writer));
writer.dedent();
int indentation = target.equals(LanguageTarget.SHARED) ? 1 : 2;
configs.forEach((key, value) -> {
writer.indent(indentation).disableNewlines().openBlock("$1L: config.$1L ?? ", ",\n", key,
() -> {
value.accept(writer);
});
writer.dedent(indentation);
});
});
writer.dedent();
writer.write(contents, "");
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ static String getResolvedConfigTypeName(Symbol symbol) {
@Override
public void run() {
writer.addImport("Client", "__Client", "@aws-sdk/smithy-client");
writer.addImport("ClientDefaultValues", "__ClientDefaultValues", "./runtimeConfig");
writer.addImport("getRuntimeConfig", "__getRuntimeConfig", "./runtimeConfig");

// Normalize the input and output types of the command to account for
// things like an operation adding input where there once wasn't any
Expand Down Expand Up @@ -302,10 +302,8 @@ private void generateConstructor() {
writer.pushState(CLIENT_CONSTRUCTOR_SECTION);

int configVariable = 0;
writer.write("let $L = {\n"
+ " ...__ClientDefaultValues,\n"
+ " ...configuration\n"
+ "};", generateConfigVariable(configVariable));
writer.write("let $L = __getRuntimeConfig(configuration);",
generateConfigVariable(configVariable));

// Add runtime plugin "resolve" method calls. These are invoked one
// after the other until all of the runtime plugins have been called.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,26 +86,26 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
writer.addDependency(TypeScriptDependency.STREAM_HASHER_NODE);
writer.addImport("fileStreamHasher", "streamHasher",
TypeScriptDependency.STREAM_HASHER_NODE.packageName);
writer.write("streamHasher,");
writer.write("streamHasher");
},
"md5", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_TYPES);
writer.addImport("HashConstructor", "__HashConstructor",
TypeScriptDependency.AWS_SDK_TYPES.packageName);
writer.write("md5: Hash.bind(null, \"md5\"),");
writer.write("Hash.bind(null, \"md5\")");
});
case BROWSER:
return MapUtils.of(
"streamHasher", writer -> {
writer.addDependency(TypeScriptDependency.STREAM_HASHER_BROWSER);
writer.addImport("blobHasher", "streamHasher",
TypeScriptDependency.STREAM_HASHER_BROWSER.packageName);
writer.write("streamHasher,");
writer.write("streamHasher");
},
"md5", writer -> {
writer.addDependency(TypeScriptDependency.MD5_BROWSER);
writer.addImport("Md5", "Md5", TypeScriptDependency.MD5_BROWSER.packageName);
writer.write("md5: Md5,");
writer.write("Md5");
});
default:
return Collections.emptyMap();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,14 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
writer.addDependency(TypeScriptDependency.AWS_SDK_EVENTSTREAM_SERDE_NODE);
writer.addImport("eventStreamSerdeProvider", "eventStreamSerdeProvider",
TypeScriptDependency.AWS_SDK_EVENTSTREAM_SERDE_NODE.packageName);
writer.write("eventStreamSerdeProvider,");
writer.write("eventStreamSerdeProvider");
});
case BROWSER:
return MapUtils.of("eventStreamSerdeProvider", writer -> {
writer.addDependency(TypeScriptDependency.AWS_SDK_EVENTSTREAM_SERDE_BROWSER);
writer.addImport("eventStreamSerdeProvider", "eventStreamSerdeProvider",
TypeScriptDependency.AWS_SDK_EVENTSTREAM_SERDE_BROWSER.packageName);
writer.write("eventStreamSerdeProvider,");
writer.write("eventStreamSerdeProvider");
});
default:
return Collections.emptyMap();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,18 +297,18 @@ default void addConfigInterfaceFields(
* // runtimeConfig file.
* Map<String, Consumer<TypeScriptWriter>> config = new HashMap<>();
* config.put("foo", writer -> {
* writer.write("foo: some static value,"); // Note the trailing comma!
* writer.write("some static value");
* });
*
* switch (target) {
* case NODE:
* config.put("bar", writer -> {
* writer.write("bar: someNodeValue,");
* writer.write("(() => someNodeValue)"); // Note the parenthesis surrounding arrow functions
* });
* break;
* case BROWSER:
* config.put("bar", writer -> {
* writer.write("bar: someBrowserValue,");
* writer.write("someBrowserValue");
* });
* break;
* case SHARED:
Expand Down Expand Up @@ -342,7 +342,7 @@ default void addConfigInterfaceFields(
* String someTraitValue = settings.getModel(model).getTrait(SomeTrait.class)
* .map(SomeTrait::getValue)
* .orElse("");
* writer.write("someTraitValue: $S,", someTraitValue);
* writer.write(someTraitValue);
* });
* }
* }
Expand All @@ -361,6 +361,6 @@ default Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
SymbolProvider symbolProvider,
LanguageTarget target
) {
return Collections.emptyMap();
return Collections.emptyMap();
}
}
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
import { ClientDefaults } from "${clientModuleName}";
import { ClientSharedValues } from "./runtimeConfig.shared";
import { ${clientConfigName} } from "${clientModuleName}";
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";

/**
* @internal
*/
export const ClientDefaultValues: Required<ClientDefaults> = {
...ClientSharedValues,
runtime: "browser",
export const getRuntimeConfig = (config: ${clientConfigName}) => {
const clientSharedValues = getSharedRuntimeConfig(config);
return {
...clientSharedValues,
...config,
runtime: "browser",
${customizations}
};
};
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
import { ClientDefaults } from "${clientModuleName}";
import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser";
import { ${clientConfigName} } from "${clientModuleName}";
import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";

/**
* @internal
*/
export const ClientDefaultValues: Required<ClientDefaults> = {
...BrowserDefaults,
runtime: "react-native",
export const getRuntimeConfig = (config: ${clientConfigName}) => {
const browserDefaults = getBrowserRuntimeConfig(config);
return {
...browserDefaults,
...config,
runtime: "react-native",
${customizations}
};
};
};
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { ${clientConfigName} } from "${clientModuleName}";

/**
* @internal
*/
export const ClientSharedValues = {
export const getRuntimeConfig = (config: ${clientConfigName}) => ({
apiVersion: "${apiVersion}",
${customizations}
};
});
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
import { ClientDefaults } from "${clientModuleName}";
import { ClientSharedValues } from "./runtimeConfig.shared";
import { ${clientConfigName} } from "${clientModuleName}";
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";

/**
* @internal
*/
export const ClientDefaultValues: Required<ClientDefaults> = {
...ClientSharedValues,
runtime: "node",
export const getRuntimeConfig = (config: ${clientConfigName}) => {
const clientSharedValues = getSharedRuntimeConfig(config);
return {
...clientSharedValues,
...config,
runtime: "node",
${customizations}
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -93,23 +93,24 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
// Does the runtimeConfig.ts file expand the template properties properly?
String runtimeConfigContents = manifest.getFileString("runtimeConfig.ts").get();
assertThat(runtimeConfigContents,
containsString("import { ClientDefaults } from \"./ExampleClient\";"));
containsString("import { ExampleClientConfig } from \"./ExampleClient\";"));
assertThat(runtimeConfigContents, containsString("syn: 'ack2',"));
assertThat(runtimeConfigSharedContents, containsString("foo: 'bar',"));

// Does the runtimeConfig.browser.ts file expand the template properties properly?
String runtimeConfigBrowserContents = manifest.getFileString("runtimeConfig.browser.ts").get();
assertThat(runtimeConfigBrowserContents,
containsString("import { ClientDefaults } from \"./ExampleClient\";"));
containsString("import { ExampleClientConfig } from \"./ExampleClient\";"));
assertThat(runtimeConfigContents, containsString("syn: 'ack2',"));
assertThat(runtimeConfigSharedContents, containsString("foo: 'bar',"));

// Does the runtimeConfig.native.ts file expand the browser template properties properly?
String runtimeConfigNativeContents = manifest.getFileString("runtimeConfig.native.ts").get();
assertThat(runtimeConfigNativeContents,
containsString("import { ClientDefaults } from \"./ExampleClient\";"));
containsString("import { ExampleClientConfig } from \"./ExampleClient\";"));
assertThat(runtimeConfigNativeContents,
containsString("import { ClientDefaultValues as BrowserDefaults } from \"./runtimeConfig.browser\";"));
containsString(
"import { getRuntimeConfig as getBrowserRuntimeConfig } from \"./runtimeConfig.browser\";"));
assertThat(runtimeConfigContents, containsString("syn: 'ack2',"));
assertThat(runtimeConfigSharedContents, containsString("foo: 'bar',"));
}
Expand Down