Make runtime client plugins more flexible

Runtime client plugins now refer to each part of the plugin using symbol
references rather than just naming conventions. This allows different
aspects of the plugins to span different packages and naming formats.
Methods are provided on the Builder class for a RuntimeClientPlugin to
generate symbol references based on recommended naming conventions
(e.g., "getFooPlugin", "resolveFooConfig", "FooInputConfig",
"FooResolvedConfig", "destroyFooConfig").

Author: mtdowling

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

@@ -92,7 +92,7 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
                     LOGGER.info(() -> "Adding TypeScriptIntegration: " + integration.getClass().getName());
                     integrations.add(integration);
                     integration.getClientPlugins().forEach(runtimePlugin -> {
-                        LOGGER.info(() -> "Adding TypeScript runtime plugin: " + runtimePlugin.getSymbol());
+                        LOGGER.info(() -> "Adding TypeScript runtime plugin: " + runtimePlugin);
                         runtimePlugins.add(runtimePlugin);
                     });
                 });

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

@@ -69,7 +69,7 @@ final class CommandGenerator implements Runnable {
         this.symbolProvider = symbolProvider;
         this.writer = writer;
         this.runtimePlugins = runtimePlugins.stream()
-                .filter(plugin -> plugin.getOperationNames().contains(operation.getId().getName()))
+                .filter(plugin -> plugin.matchesOperation(model, service, operation))
                 .collect(Collectors.toList());
         this.applicationProtocol = applicationProtocol;
 
@@ -147,7 +147,7 @@ private void generateCommandMiddlewareResolver(String configType) {
                 .dedent();
         writer.openBlock("): Handler<$L, $L> {", "}", inputType, outputType, () -> {
             // Add serialization and deserialization plugin.
-            writer.write("this.use($T(configuration, this.serialize, this.deserialize));", serde);
+            writer.write("this.middlewareStack.use($T(configuration, this.serialize, this.deserialize));", serde);
 
             // Add customizations.
             addCommandSpecificPlugins();
@@ -188,9 +188,9 @@ private void addCommandSpecificPlugins() {
         // applied automatically when the Command's middleware stack is copied from
         // the service's middleware stack.
         for (RuntimeClientPlugin plugin : runtimePlugins) {
-            if (plugin.hasMiddleware() && plugin.getOperationNames().contains(operation.getId().getName())) {
-                writer.write("this.use($T.getMiddleware(configuration));", plugin.getSymbol());
-            }
+            plugin.getPluginFunction().ifPresent(symbol -> {
+                writer.write("this.middlewareStack.use($T(configuration));", symbol);
+            });
         }
     }
 

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

@@ -70,7 +70,7 @@ final class ServiceGenerator implements Runnable {
         this.writer = writer;
         this.runtimePlugins = runtimePlugins.stream()
                 // Only apply plugins that target the entire client.
-                .filter(plugin -> plugin.getOperationNames().isEmpty())
+                .filter(plugin -> plugin.matchesService(model, service))
                 .collect(Collectors.toList());
         this.applicationProtocol = applicationProtocol;
 
@@ -127,22 +127,21 @@ private void generateConfig() {
         // Hook for intercepting the client configuration.
         writer.pushState(CLIENT_CONFIG_SECTION);
 
+        // The default configuration type is always just the base-level
+        // Smithy configuration requirements.
+        writer.write("export type $L = SmithyConfiguration<$T>", configType, applicationProtocol.getOptionsType());
+
         // Get the configuration symbol types to reference in code. These are
         // all "&"'d together to create a big configuration type that aggregates
         // more modular configuration types.
-        List<SymbolReference> configTypes = runtimePlugins.stream()
-                .filter(RuntimeClientPlugin::hasConfig)
-                .map(RuntimeClientPlugin::getSymbol)
+        List<SymbolReference> inputTypes = runtimePlugins.stream()
+                .flatMap(p -> OptionalUtils.stream(p.getInputConfig()))
                 .collect(Collectors.toList());
 
-        // The default configuration type is always just the base-level
-        // Smithy configuration requirements.
-        writer.write("export type $L = SmithyConfiguration<$T>", configType, applicationProtocol.getOptionsType());
-
-        if (!configTypes.isEmpty()) {
+        if (!inputTypes.isEmpty()) {
             writer.indent();
-            for (SymbolReference symbolReference : configTypes) {
-                writer.write("& $T.Input", symbolReference);
+            for (SymbolReference symbolReference : inputTypes) {
+                writer.write("& $T", symbolReference);
             }
             writer.dedent();
         }
@@ -152,11 +151,12 @@ private void generateConfig() {
         writer.write("");
         writer.write("export type $L = SmithyResolvedConfiguration<$T>",
                      resolvedConfigType, applicationProtocol.getOptionsType());
-        if (!configTypes.isEmpty()) {
+
+        if (!inputTypes.isEmpty()) {
             writer.indent();
-            for (SymbolReference symbolReference : configTypes) {
-                writer.write("& $T.Resolved", symbolReference);
-            }
+            runtimePlugins.stream()
+                    .flatMap(p -> OptionalUtils.stream(p.getResolvedConfig()))
+                    .forEach(symbol -> writer.write("& $T", symbol));
             writer.dedent();
         }
 
@@ -200,11 +200,11 @@ private void generateConstructor() {
             // configuration is updated, the configuration variable is incremented
             // (e.g., _config_0, _config_1, etc).
             for (RuntimeClientPlugin plugin : runtimePlugins) {
-                if (plugin.hasConfig()) {
+                if (plugin.getResolveFunction().isPresent()) {
                     configVariable++;
-                    writer.write("let $L = $T.resolve($L);",
+                    writer.write("let $L = $T($L);",
                                  generateConfigVariable(configVariable),
-                                 plugin.getSymbol(),
+                                 plugin.getResolveFunction().get(),
                                  generateConfigVariable(configVariable - 1));
                 }
             }
@@ -215,9 +215,9 @@ private void generateConstructor() {
             // Add runtime plugins that contain middleware to the middleware stack
             // of the client.
             for (RuntimeClientPlugin plugin : runtimePlugins) {
-                if (plugin.hasMiddleware()) {
-                    writer.write("super.use($T.getMiddleware(this.config));", plugin.getSymbol());
-                }
+                plugin.getPluginFunction().ifPresent(symbol -> {
+                    writer.write("this.middlewareStack.use($T(this.config));", symbol);
+                });
             }
 
             writer.popState();
@@ -234,9 +234,9 @@ private void generateDestroyMethod() {
         writer.openBlock("destroy(): void {", "}", () -> {
             writer.pushState(CLIENT_DESTROY_SECTION);
             for (RuntimeClientPlugin plugin : runtimePlugins) {
-                if (plugin.hasDestroy()) {
-                    writer.write("$T.destroy(this, this.config);", plugin.getSymbol());
-                }
+                plugin.getDestroyFunction().ifPresent(destroy -> {
+                    writer.write("$T(this.config);", destroy);
+                });
             }
             writer.popState();
         });