Skip to content

Split server codegen out into a separate plugin #314

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
Apr 29, 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 @@ -45,6 +45,7 @@
import software.amazon.smithy.model.shapes.UnionShape;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.PaginatedTrait;
import software.amazon.smithy.typescript.codegen.TypeScriptSettings.ArtifactType;
import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator;
import software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin;
import software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration;
Expand All @@ -70,15 +71,14 @@ 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, ArtifactType artifactType) {
// Load all integrations.
ClassLoader loader = context.getPluginClassLoader().orElse(getClass().getClassLoader());
LOGGER.info("Attempting to discover TypeScriptIntegration from the classpath...");
Expand All @@ -96,6 +96,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()) {
Expand All @@ -112,16 +113,11 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
settings.generateClient() ? "client" : "server", service.getId()));

// Decorate the symbol provider using integrations.
SymbolProvider resolvedProvider = TypeScriptCodegenPlugin.createSymbolProvider(model, settings);
SymbolProvider resolvedProvider = artifactType.createSymbolProvider(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);
Expand Down Expand Up @@ -204,14 +200,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.
Expand Down Expand Up @@ -290,8 +286,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;
Expand Down Expand Up @@ -334,15 +330,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);
});
}
Expand Down Expand Up @@ -403,10 +399,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);
});
}

Expand All @@ -418,8 +414,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();
}));
}

Expand All @@ -436,8 +432,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());
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -105,7 +104,6 @@ final class HttpProtocolTestGenerator implements Runnable {
Model model,
ShapeId protocol,
SymbolProvider symbolProvider,
SymbolProvider serverSymbolProvider,
TypeScriptDelegator delegator,
ProtocolGenerator protocolGenerator
) {
Expand All @@ -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);
Expand Down Expand Up @@ -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()
Expand All @@ -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
Expand Down Expand Up @@ -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, () -> {
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -32,16 +33,10 @@ public String getName() {

@Override
public void execute(PluginContext context) {
new CodegenVisitor(context).execute();
new CodegenVisitor(context, ArtifactType.CLIENT).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.
*/
@Deprecated
public static SymbolProvider createSymbolProvider(Model model, TypeScriptSettings settings) {
return new SymbolVisitor(model, settings);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* 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.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, ArtifactType.SSDK).execute();
}
}
Loading