Skip to content

Remove TypeScriptIntegration.writeAdditionalFiles #604

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

Closed
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 @@ -404,16 +404,6 @@ public void customizeBeforeIntegrations(
}
}

// Write each custom file.
for (TypeScriptIntegration integration : directive.context().integrations()) {
LOGGER.finer(() -> "Calling writeAdditionalFiles on " + integration.getClass().getCanonicalName());
integration.writeAdditionalFiles(
directive.settings(),
directive.model(),
directive.symbolProvider(),
directive.context().writerDelegator()::useFileWriter);
}

// Generate index for client.
IndexGenerator.writeIndex(
directive.settings(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@
package software.amazon.smithy.typescript.codegen.integration;

import java.nio.file.Paths;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.codegen.core.SymbolProvider;
import software.amazon.smithy.codegen.core.SymbolReference;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.ServiceShape;
import software.amazon.smithy.model.traits.ErrorTrait;
import software.amazon.smithy.typescript.codegen.CodegenUtils;
import software.amazon.smithy.typescript.codegen.TypeScriptCodegenContext;
import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
Expand All @@ -37,17 +36,17 @@
public final class AddBaseServiceExceptionClass implements TypeScriptIntegration {

@Override
public void writeAdditionalFiles(
TypeScriptSettings settings,
Model model,
SymbolProvider symbolProvider,
BiConsumer<String, Consumer<TypeScriptWriter>> writerFactory
) {
boolean isClientSdk = settings.generateClient();
public void customize(TypeScriptCodegenContext codegenContext) {
boolean isClientSdk = codegenContext.settings().generateClient();
if (isClientSdk) {
String serviceName = getServiceName(settings, model, symbolProvider);
String serviceName = getServiceName(
codegenContext.settings(),
codegenContext.model(),
codegenContext.symbolProvider());
String serviceExceptionName = getServiceExceptionName(serviceName);
writerFactory.accept(

// Write the ServiceException class for the service.
codegenContext.writerDelegator().useFileWriter(
Paths.get(CodegenUtils.SOURCE_FOLDER, "models", serviceExceptionName + ".ts").toString(),
writer -> {
writer.addImport("ServiceException", "__ServiceException",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
import java.util.HashMap;
import java.util.List;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.codegen.core.SymbolDependency;
import software.amazon.smithy.codegen.core.SymbolProvider;
Expand All @@ -32,6 +30,7 @@
import software.amazon.smithy.model.traits.HttpApiKeyAuthTrait;
import software.amazon.smithy.model.traits.OptionalAuthTrait;
import software.amazon.smithy.typescript.codegen.CodegenUtils;
import software.amazon.smithy.typescript.codegen.TypeScriptCodegenContext;
import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
import software.amazon.smithy.utils.IoUtils;
Expand Down Expand Up @@ -101,17 +100,12 @@ public List<RuntimeClientPlugin> getClientPlugins() {
}

@Override
public void writeAdditionalFiles(
TypeScriptSettings settings,
Model model,
SymbolProvider symbolProvider,
BiConsumer<String, Consumer<TypeScriptWriter>> writerFactory
) {
ServiceShape service = settings.getService(model);
public void customize(TypeScriptCodegenContext codegenContext) {
ServiceShape service = codegenContext.settings().getService(codegenContext.model());

// If the service doesn't use HTTP API keys, we don't need to do anything and the generated
// code doesn't need any additional files.
if (!hasEffectiveHttpApiKeyAuthTrait(model, service)) {
if (!hasEffectiveHttpApiKeyAuthTrait(codegenContext.model(), service)) {
return;
}

Expand All @@ -120,7 +114,7 @@ public void writeAdditionalFiles(
+ "src/main/resources/software/amazon/smithy/aws/typescript/codegen/integration/";

// Write the middleware source.
writerFactory.accept(
codegenContext.writerDelegator().useFileWriter(
Paths.get(CodegenUtils.SOURCE_FOLDER, "middleware", INTEGRATION_NAME, "index.ts").toString(),
writer -> {
String source = IoUtils.readUtf8Resource(getClass(), "http-api-key-auth.ts");
Expand All @@ -129,7 +123,7 @@ public void writeAdditionalFiles(
});

// Write the middleware tests.
writerFactory.accept(
codegenContext.writerDelegator().useFileWriter(
Paths.get(CodegenUtils.SOURCE_FOLDER, "middleware", INTEGRATION_NAME, "index.spec.ts").toString(),
writer -> {
writer.addDependency(SymbolDependency.builder()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import software.amazon.smithy.codegen.core.SmithyIntegration;
import software.amazon.smithy.codegen.core.Symbol;
Expand All @@ -41,45 +40,8 @@
public interface TypeScriptIntegration
extends SmithyIntegration<TypeScriptSettings, TypeScriptWriter, TypeScriptCodegenContext> {

/**
* Writes additional files.
*
* <pre>
* {@code
* public final class MyIntegration implements TypeScriptIntegration {
* public writeAdditionalFiles(
* TypeScriptSettings settings,
* Model model,
* SymbolProvider symbolProvider,
* BiConsumer<String, Consumer<TypeScriptWriter>> writerFactory
* ) {
* writerFactory.accept("foo.ts", writer -> {
* writer.write("// Hello!");
* });
* }
* }
* }</pre>
*
* @param settings Settings used to generate.
* @param model Model to generate from.
* @param symbolProvider Symbol provider used for codegen.
* @param writerFactory A factory function that takes the name of a file
* to write and a {@code Consumer} that receives a
* {@link TypeScriptWriter} to perform the actual writing to the file.
*/
default void writeAdditionalFiles(
TypeScriptSettings settings,
Model model,
SymbolProvider symbolProvider,
BiConsumer<String, Consumer<TypeScriptWriter>> writerFactory
) {
// pass
}

/**
* Write additional export statement to client root index.ts.
* The files generated by {@link TypeScriptIntegration#writeAdditionalFiles}
* can be exported with this method.
*
* <pre>
* {@code
Expand All @@ -99,7 +61,6 @@ default void writeAdditionalFiles(
* @param model Model to generate from.
* @param symbolProvider Symbol provider used for codegen.
* @param writer TypeScript writer that works with the file.
* @see #writeAdditionalFiles(TypeScriptSettings, Model, SymbolProvider, BiConsumer)
*/
default void writeAdditionalExports(
TypeScriptSettings settings,
Expand Down