Split server codegen out into a separate plugin

JordonPhillips · JordonPhillips · commit 6cfc06eafb25 · 2021-04-19T15:55:50.000+02:00
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CodegenVisitor.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CodegenVisitor.java
@@ -25,6 +25,7 @@
 import java.util.ServiceLoader;
 import java.util.Set;
 import java.util.TreeSet;
+import java.util.function.BiFunction;
 import java.util.logging.Logger;
 import software.amazon.smithy.build.FileManifest;
 import software.amazon.smithy.build.PluginContext;
@@ -70,15 +71,18 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
     private final ServiceShape service;
     private final FileManifest fileManifest;
     private final SymbolProvider symbolProvider;
-    private final SymbolProvider serverSymbolProvider;
     private final Model nonTraits;
     private final TypeScriptDelegator writers;
     private final List<TypeScriptIntegration> integrations = new ArrayList<>();
     private final List<RuntimeClientPlugin> runtimePlugins = new ArrayList<>();
     private final ProtocolGenerator protocolGenerator;
     private final ApplicationProtocol applicationProtocol;
 
-    CodegenVisitor(PluginContext context) {
+    CodegenVisitor(
+            PluginContext context,
+            BiFunction<Model, TypeScriptSettings, SymbolProvider> createSymbolProvider,
+            TypeScriptSettings.ArtifactType artifactType
+    ) {
         // Load all integrations.
         ClassLoader loader = context.getPluginClassLoader().orElse(getClass().getClassLoader());
         LOGGER.info("Attempting to discover TypeScriptIntegration from the classpath...");
@@ -96,6 +100,7 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
 
         // Preprocess model using integrations.
         TypeScriptSettings typescriptSettings = TypeScriptSettings.from(context.getModel(), context.getSettings());
+        typescriptSettings.setArtifactType(artifactType);
         for (TypeScriptIntegration integration : integrations) {
             Model modifiedModel = integration.preprocessModel(context, typescriptSettings);
             if (modifiedModel != context.getModel()) {
@@ -111,16 +116,11 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
         LOGGER.info(() -> "Generating TypeScript for service " + service.getId());
 
         // Decorate the symbol provider using integrations.
-        SymbolProvider resolvedProvider = TypeScriptCodegenPlugin.createSymbolProvider(model, settings);
+        SymbolProvider resolvedProvider = createSymbolProvider.apply(model, settings);
         for (TypeScriptIntegration integration : integrations) {
             resolvedProvider = integration.decorateSymbolProvider(settings, model, resolvedProvider);
         }
         symbolProvider = SymbolProvider.cache(resolvedProvider);
-        if (settings.generateServerSdk()) {
-            serverSymbolProvider = SymbolProvider.cache(new ServerSymbolVisitor(model, symbolProvider));
-        } else {
-            serverSymbolProvider = symbolProvider;
-        }
 
         // Resolve the nullable protocol generator and application protocol.
         protocolGenerator = resolveProtocolGenerator(integrations, service, settings);
@@ -203,14 +203,14 @@ void execute() {
 
         if (settings.generateServerSdk()) {
             // Generate index for server
-            IndexGenerator.writeServerIndex(settings, model, serverSymbolProvider, fileManifest);
+            IndexGenerator.writeServerIndex(settings, model, symbolProvider, fileManifest);
         }
 
         // Generate protocol tests IFF found in the model.
         if (protocolGenerator != null) {
             ShapeId protocol = protocolGenerator.getProtocol();
             new HttpProtocolTestGenerator(
-                    settings, model, protocol, symbolProvider, serverSymbolProvider, writers, protocolGenerator).run();
+                    settings, model, protocol, symbolProvider, writers, protocolGenerator).run();
         }
 
         // Write each pending writer.
@@ -289,8 +289,8 @@ public Void stringShape(StringShape shape) {
     @Override
     public Void operationShape(OperationShape operation) {
         if (settings.generateServerSdk()) {
-            writers.useShapeWriter(operation, serverSymbolProvider, w -> {
-                ServerGenerator.generateOperationHandler(serverSymbolProvider, service, operation, w);
+            writers.useShapeWriter(operation, symbolProvider, w -> {
+                ServerGenerator.generateOperationHandler(symbolProvider, service, operation, w);
             });
         }
         return null;
@@ -333,15 +333,15 @@ public Void serviceShape(ServiceShape shape) {
                 }
                 if (context.getSettings().generateServerSdk()) {
                     ProtocolGenerator.GenerationContext serverContext =
-                            context.withSymbolProvider(serverSymbolProvider);
+                            context.withSymbolProvider(symbolProvider);
                     protocolGenerator.generateRequestDeserializers(serverContext);
                     protocolGenerator.generateResponseSerializers(serverContext);
                     protocolGenerator.generateFrameworkErrorSerializer(serverContext);
-                    writers.useShapeWriter(shape, serverSymbolProvider, w -> {
+                    writers.useShapeWriter(shape, symbolProvider, w -> {
                         protocolGenerator.generateServiceHandlerFactory(serverContext.withWriter(w));
                     });
                     for (OperationShape operation: TopDownIndex.of(model).getContainedOperations(service)) {
-                        writers.useShapeWriter(operation, serverSymbolProvider, w -> {
+                        writers.useShapeWriter(operation, symbolProvider, w -> {
                             protocolGenerator.generateOperationHandlerFactory(serverContext.withWriter(w), operation);
                         });
                     }
@@ -402,10 +402,10 @@ private void generateClient(ServiceShape shape) {
     private void generateServiceInterface(ServiceShape shape) {
         TopDownIndex topDownIndex = TopDownIndex.of(model);
         Set<OperationShape> operations = new TreeSet<>(topDownIndex.getContainedOperations(shape));
-        writers.useShapeWriter(shape, serverSymbolProvider, writer -> {
-            ServerGenerator.generateOperationsType(serverSymbolProvider, shape, operations, writer);
-            ServerGenerator.generateServerInterfaces(serverSymbolProvider, shape, operations, writer);
-            ServerGenerator.generateServiceHandler(serverSymbolProvider, shape, operations, writer);
+        writers.useShapeWriter(shape, symbolProvider, writer -> {
+            ServerGenerator.generateOperationsType(symbolProvider, shape, operations, writer);
+            ServerGenerator.generateServerInterfaces(symbolProvider, shape, operations, writer);
+            ServerGenerator.generateServiceHandler(symbolProvider, shape, operations, writer);
         });
     }
 
@@ -417,8 +417,8 @@ private void generateServerErrors(ServiceShape service) {
                 .distinct()
                 .map(id -> model.expectShape(id).asStructureShape().orElseThrow(IllegalArgumentException::new))
                 .sorted()
-                .forEachOrdered(error -> writers.useShapeWriter(service, serverSymbolProvider, writer -> {
-                    new ServerErrorGenerator(settings, model, error, serverSymbolProvider, writer).run();
+                .forEachOrdered(error -> writers.useShapeWriter(service, symbolProvider, writer -> {
+                    new ServerErrorGenerator(settings, model, error, symbolProvider, writer).run();
                 }));
     }
 
@@ -435,8 +435,8 @@ private void generateCommands(ServiceShape shape) {
             }
 
             if (settings.generateServerSdk()) {
-                writers.useShapeWriter(operation, serverSymbolProvider, commandWriter -> new ServerCommandGenerator(
-                        settings, model, operation, serverSymbolProvider, commandWriter,
+                writers.useShapeWriter(operation, symbolProvider, commandWriter -> new ServerCommandGenerator(
+                        settings, model, operation, symbolProvider, commandWriter,
                         protocolGenerator, applicationProtocol).run());
             }
         }
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/HttpProtocolTestGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/HttpProtocolTestGenerator.java
@@ -90,7 +90,6 @@ final class HttpProtocolTestGenerator implements Runnable {
     private final ServiceShape service;
     private final SymbolProvider symbolProvider;
     private final Symbol serviceSymbol;
-    private final SymbolProvider serverSymbolProvider;
     private final Set<String> additionalStubs = new TreeSet<>();
     private final ProtocolGenerator protocolGenerator;
 
@@ -105,7 +104,6 @@ final class HttpProtocolTestGenerator implements Runnable {
             Model model,
             ShapeId protocol,
             SymbolProvider symbolProvider,
-            SymbolProvider serverSymbolProvider,
             TypeScriptDelegator delegator,
             ProtocolGenerator protocolGenerator
     ) {
@@ -114,7 +112,6 @@ final class HttpProtocolTestGenerator implements Runnable {
         this.protocol = protocol;
         this.service = settings.getService(model);
         this.symbolProvider = symbolProvider;
-        this.serverSymbolProvider = serverSymbolProvider;
         this.delegator = delegator;
         this.protocolGenerator = protocolGenerator;
         serviceSymbol = symbolProvider.toSymbol(service);
@@ -266,7 +263,7 @@ private void generateClientRequestTest(OperationShape operation, HttpRequestTest
     }
 
     private void generateServerRequestTest(OperationShape operation, HttpRequestTestCase testCase) {
-        Symbol operationSymbol = serverSymbolProvider.toSymbol(operation);
+        Symbol operationSymbol = symbolProvider.toSymbol(operation);
 
         // Lowercase all the headers we're expecting as this is what we'll get.
         Map<String, String> headers = testCase.getHeaders().entrySet().stream()
@@ -279,7 +276,7 @@ private void generateServerRequestTest(OperationShape operation, HttpRequestTest
         String testName = testCase.getId() + ":ServerRequest";
         testCase.getDocumentation().ifPresent(writer::writeDocs);
         writer.openBlock("it($S, async () => {", "});\n", testName, () -> {
-            Symbol serviceSymbol = serverSymbolProvider.toSymbol(service);
+            Symbol serviceSymbol = symbolProvider.toSymbol(service);
             Symbol handlerSymbol = serviceSymbol.expectProperty("handler", Symbol.class);
 
             // Create a mock function to set in place of the server operation function so we can capture
@@ -480,8 +477,8 @@ private String registerBodyComparatorStub(String mediaType) {
     }
 
     public void generateServerResponseTest(OperationShape operation, HttpResponseTestCase testCase) {
-        Symbol serviceSymbol = serverSymbolProvider.toSymbol(service);
-        Symbol operationSymbol = serverSymbolProvider.toSymbol(operation);
+        Symbol serviceSymbol = symbolProvider.toSymbol(service);
+        Symbol operationSymbol = symbolProvider.toSymbol(operation);
         testCase.getDocumentation().ifPresent(writer::writeDocs);
         String testName = testCase.getId() + ":ServerResponse";
         writer.openBlock("it($S, async () => {", "});\n", testName, () -> {
@@ -527,10 +524,10 @@ private void generateServerErrorResponseTest(
             StructureShape error,
             HttpResponseTestCase testCase
     ) {
-        Symbol serviceSymbol = serverSymbolProvider.toSymbol(service);
-        Symbol operationSymbol = serverSymbolProvider.toSymbol(operation);
+        Symbol serviceSymbol = symbolProvider.toSymbol(service);
+        Symbol operationSymbol = symbolProvider.toSymbol(operation);
         Symbol outputType = operationSymbol.expectProperty("outputType", Symbol.class);
-        Symbol errorSymbol = serverSymbolProvider.toSymbol(error);
+        Symbol errorSymbol = symbolProvider.toSymbol(error);
         ErrorTrait errorTrait = error.expectTrait(ErrorTrait.class);
 
         testCase.getDocumentation().ifPresent(writer::writeDocs);
@@ -565,8 +562,8 @@ private void generateServerErrorResponseTest(
     }
 
     private void writeServerResponseTest(OperationShape operation, HttpResponseTestCase testCase) {
-        Symbol serviceSymbol = serverSymbolProvider.toSymbol(service);
-        Symbol operationSymbol = serverSymbolProvider.toSymbol(operation);
+        Symbol serviceSymbol = symbolProvider.toSymbol(service);
+        Symbol operationSymbol = symbolProvider.toSymbol(operation);
         Symbol handlerSymbol = serviceSymbol.expectProperty("handler", Symbol.class);
         Symbol serializerSymbol = operationSymbol.expectProperty("serializerType", Symbol.class);
         Symbol serviceOperationsSymbol = serviceSymbol.expectProperty("operations", Symbol.class);
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptCodegenPlugin.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptCodegenPlugin.java
@@ -19,6 +19,7 @@
 import software.amazon.smithy.build.SmithyBuildPlugin;
 import software.amazon.smithy.codegen.core.SymbolProvider;
 import software.amazon.smithy.model.Model;
+import software.amazon.smithy.typescript.codegen.TypeScriptSettings.ArtifactType;
 
 /**
  * Plugin to trigger TypeScript code generation.
@@ -32,7 +33,11 @@ public String getName() {
 
     @Override
     public void execute(PluginContext context) {
-        new CodegenVisitor(context).execute();
+        new CodegenVisitor(
+                context,
+                TypeScriptCodegenPlugin::createSymbolProvider,
+                ArtifactType.CLIENT
+        ).execute();
     }
 
     /**
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptServerCodegenPlugin.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptServerCodegenPlugin.java
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.smithy.typescript.codegen;
+
+import software.amazon.smithy.build.PluginContext;
+import software.amazon.smithy.build.SmithyBuildPlugin;
+import software.amazon.smithy.codegen.core.SymbolProvider;
+import software.amazon.smithy.model.Model;
+import software.amazon.smithy.typescript.codegen.TypeScriptSettings.ArtifactType;
+
+/**
+ * Plugin to trigger TypeScript SSDK code generation.
+ */
+public class TypeScriptServerCodegenPlugin implements SmithyBuildPlugin {
+
+    @Override
+    public String getName() {
+        return "typescript-ssdk-codegen";
+    }
+
+    @Override
+    public void execute(PluginContext context) {
+        new CodegenVisitor(
+                context,
+                TypeScriptServerCodegenPlugin::createSymbolProvider,
+                ArtifactType.SSDK
+        ).execute();
+    }
+
+    /**
+     * Creates a TypeScript symbol provider.
+     *
+     * @param model Model to generate symbols for.
+     * @param settings Settings used by the plugin.
+     * @return Returns the created provider.
+     */
+    public static SymbolProvider createSymbolProvider(Model model, TypeScriptSettings settings) {
+        return new ServerSymbolVisitor(model, new SymbolVisitor(model, settings));
+    }
+}
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java
@@ -47,8 +47,6 @@ public final class TypeScriptSettings {
     private static final String SERVICE = "service";
     private static final String PROTOCOL = "protocol";
     private static final String PRIVATE = "private";
-    private static final String GENERATE_CLIENT = "generateClient";
-    private static final String GENERATE_SERVER_SDK = "generateServerSdk";
 
     private String packageName;
     private String packageDescription = "";
@@ -58,8 +56,7 @@ public final class TypeScriptSettings {
     private ObjectNode pluginSettings = Node.objectNode();
     private ShapeId protocol;
     private boolean isPrivate;
-    private boolean generateClient;
-    private boolean generateServerSdk;
+    private ArtifactType artifactType = ArtifactType.CLIENT;
 
     /**
      * Create a settings object from a configuration object node.
@@ -72,7 +69,7 @@ public static TypeScriptSettings from(Model model, ObjectNode config) {
         TypeScriptSettings settings = new TypeScriptSettings();
         config.warnIfAdditionalProperties(Arrays.asList(
                 PACKAGE, PACKAGE_DESCRIPTION, PACKAGE_JSON, PACKAGE_VERSION,
-                SERVICE, PROTOCOL, TARGET_NAMESPACE, PRIVATE, GENERATE_CLIENT, GENERATE_SERVER_SDK));
+                SERVICE, PROTOCOL, TARGET_NAMESPACE, PRIVATE));
 
         // Get the service from the settings or infer one from the given model.
         settings.setService(config.getStringMember(SERVICE)
@@ -86,9 +83,6 @@ public static TypeScriptSettings from(Model model, ObjectNode config) {
         settings.packageJson = config.getObjectMember(PACKAGE_JSON).orElse(Node.objectNode());
         config.getStringMember(PROTOCOL).map(StringNode::getValue).map(ShapeId::from).ifPresent(settings::setProtocol);
         settings.setPrivate(config.getBooleanMember(PRIVATE).map(BooleanNode::getValue).orElse(false));
-        settings.setGenerateClient(config.getBooleanMember(GENERATE_CLIENT).map(BooleanNode::getValue).orElse(true));
-        settings.setGenerateServerSdk(
-                config.getBooleanMember(GENERATE_SERVER_SDK).map(BooleanNode::getValue).orElse(false));
 
         settings.setPluginSettings(config);
         return settings;
@@ -222,29 +216,34 @@ public void setPrivate(boolean isPrivate) {
     }
 
     /**
-     * Returns if the generated package will include a client.
+     * Returns if the generated package will be a client.
      *
      * @return If the package will include a client.
      */
     public boolean generateClient() {
-        return generateClient;
-    }
-
-    public void setGenerateClient(boolean generateClient) {
-        this.generateClient = generateClient;
+        return artifactType.equals(ArtifactType.CLIENT);
     }
 
     /**
-     * Returns if the generated package will include a server sdk.
+     * Returns if the generated package will be a server sdk.
      *
      * @return If the package will include a server sdk.
      */
     public boolean generateServerSdk() {
-        return generateServerSdk;
+        return artifactType.equals(ArtifactType.SSDK);
     }
 
-    public void setGenerateServerSdk(boolean generateServerSdk) {
-        this.generateServerSdk = generateServerSdk;
+    /**
+     * Returns the type of artifact being generated, such as a client or ssdk.
+     *
+     * @return The artifact type.
+     */
+    public ArtifactType getArtifactType() {
+        return artifactType;
+    }
+
+    public void setArtifactType(ArtifactType artifactType) {
+        this.artifactType = artifactType;
     }
 
     /**
@@ -313,4 +312,12 @@ public ShapeId resolveServiceProtocol(Model model, ServiceShape service, Set<Sha
     public void setProtocol(ShapeId protocol) {
         this.protocol = Objects.requireNonNull(protocol);
     }
+
+    /**
+     * An enum indicating the type of artifact the code generator will produce.
+     */
+    public enum ArtifactType {
+        CLIENT,
+        SSDK
+    }
 }
diff --git a/smithy-typescript-codegen/src/main/resources/META-INF/services/software.amazon.smithy.build.SmithyBuildPlugin b/smithy-typescript-codegen/src/main/resources/META-INF/services/software.amazon.smithy.build.SmithyBuildPlugin
@@ -1 +1,2 @@
 software.amazon.smithy.typescript.codegen.TypeScriptCodegenPlugin
+software.amazon.smithy.typescript.codegen.TypeScriptServerCodegenPlugin

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`software.amazon.smithy.typescript.codegen.TypeScriptCodegenPlugin`
	`2`	`+software.amazon.smithy.typescript.codegen.TypeScriptServerCodegenPlugin`