Skip to content

Error shapes do not explicitly need to reference MetadataBearer #545

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.

Sign up for GitHub

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 1 commit into from
May 18, 2022
Merged

Error shapes do not explicitly need to reference MetadataBearer #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 1 addition & 14 deletions ...script-codegen/src/main/java/software/amazon/smithy/typescript/codegen/SymbolVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,20 +310,7 @@ public Symbol serviceShape(ServiceShape shape) {

@Override
public Symbol structureShape(StructureShape shape) {
Symbol.Builder builder = createObjectSymbolBuilder(shape);

// Errors won't be re-used in locations where being a MetadataBearer is an issue.
if (errorShapes.contains(shape)) {
SymbolReference reference = SymbolReference.builder()
.options(SymbolReference.ContextOption.DECLARE)
.alias("$MetadataBearer")
.symbol(TypeScriptDependency.AWS_SDK_TYPES.createSymbol("MetadataBearer"))
.putProperty(IMPLEMENTS_INTERFACE_PROPERTY, true)
.build();
builder.addReference(reference);
}

return builder.build();
return createObjectSymbolBuilder(shape).build();
}

private Symbol.Builder addSmithyUseImport(Symbol.Builder builder, String name, String as) {
Expand Down
37 changes: 0 additions & 37 deletions ...t-codegen/src/test/java/software/amazon/smithy/typescript/codegen/SymbolProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThan;

import org.junit.jupiter.api.Test;
import software.amazon.smithy.build.MockManifest;
Expand Down Expand Up @@ -145,42 +144,6 @@ public void escapesRecursiveSymbols() {
assertThat(listSymbol.getName(), equalTo("(_Record)[]"));
}

@Test
public void errorStructuresAreMetadataBearers() {
Model model = Model.assembler()
.addImport(getClass().getResource("output-structure.smithy"))
.assemble()
.unwrap();
TypeScriptSettings settings = TypeScriptSettings.from(model, Node.objectNodeBuilder()
.withMember("package", Node.from("example"))
.withMember("packageVersion", Node.from("1.0.0"))
.build());

Shape input = model.expectShape(ShapeId.from("smithy.example#GetFooInput"));
Shape output = model.expectShape(ShapeId.from("smithy.example#GetFooOutput"));
Shape error = model.expectShape(ShapeId.from("smithy.example#GetFooError"));
SymbolProvider provider = TypeScriptCodegenPlugin.createSymbolProvider(model, settings);
Symbol inputSymbol = provider.toSymbol(input);
Symbol outputSymbol = provider.toSymbol(output);
Symbol errorSymbol = provider.toSymbol(error);

// Input and Output does not use MetadataBearer
assertThat(inputSymbol.getReferences().stream()
.filter(ref -> ref.getProperty("extends").isPresent())
.count(), equalTo(0L));
assertThat(outputSymbol.getReferences().stream()
.filter(ref -> ref.getAlias().equals("$MetadataBearer"))
.count(), equalTo(0L));

// Output uses MetadataBearer
assertThat(errorSymbol.getReferences().stream()
.filter(ref -> ref.getProperty(SymbolVisitor.IMPLEMENTS_INTERFACE_PROPERTY).isPresent())
.count(), greaterThan(0L));
assertThat(errorSymbol.getReferences().stream()
.filter(ref -> ref.getAlias().equals("$MetadataBearer"))
.count(), greaterThan(0L));
}

@Test
public void createsCommandModules() {
Model model = Model.assembler()
Expand Down