Skip to content
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

Update NodeMapper to handle Trait sourceLocation #865

Merged
merged 3 commits into from
Jul 19, 2021
Merged

Update NodeMapper to handle Trait sourceLocation #865

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c1ebfd
Update NodeMapper to handle Trait sourceLocation
JordonPhillips Jul 15, 2021
17aec73
Make NodeMapper pass along source location
JordonPhillips Jul 16, 2021
187b9fd
Check if builder return type is self-assignable
JordonPhillips Jul 19, 2021
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
16 changes: 14 additions & 2 deletions smithy-model/src/main/java/software/amazon/smithy/model/node/DefaultNodeDeserializers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import software.amazon.smithy.model.FromSourceLocation;
import software.amazon.smithy.model.SourceLocation;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.AbstractTraitBuilder;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.MapUtils;
import software.amazon.smithy.utils.Pair;
Expand Down Expand Up @@ -373,8 +374,8 @@ private static boolean isBeanOrBuilderSetter(Method method, Class<?> type, Strin
return false;
}

// Must either return the target class itself (like a builder) or void.
if (method.getReturnType() != void.class && method.getReturnType() != type) {
JordonPhillips marked this conversation as resolved.
Show resolved Hide resolved

if (!hasSetterReturnType(method, type, propertyName)) {
return false;
}

Expand All @@ -391,6 +392,16 @@ private static boolean isBeanOrBuilderSetter(Method method, Class<?> type, Strin
return false;
}

private static boolean hasSetterReturnType(Method method, Class<?> type, String propertyName) {
// This is a hack to make source location work. Work needs to be done in resolveClassFromType to
// make sourceLocation work without a hack like this.
if (propertyName.equals("sourceLocation") && method.getReturnType() == AbstractTraitBuilder.class) {
return true;
}
// Must either return the target class itself (like a builder) or void.
return method.getReturnType() == void.class || method.getReturnType() == type;
}

private static Class<?> determineParameterizedType(Method setter) {
Type genericParameters = setter.getGenericParameterTypes()[0];
Class<?> containingType = setter.getParameterTypes()[0];
Expand Down Expand Up @@ -431,6 +442,7 @@ private static Class<?> resolveClassFromType(Type type) {
} else if (type instanceof WildcardType) {
return resolveClassFromType(((WildcardType) type).getUpperBounds()[0]);
} else if (type instanceof TypeVariable<?>) {
// TODO: implement this to enable sourceLocation setting without hacks
throw new IllegalArgumentException("TypeVariable targets are not implemented: " + type);
} else if (type instanceof GenericArrayType) {
throw new IllegalArgumentException("GenericArrayType targets are not implemented: " + type);
Expand Down
9 changes: 8 additions & 1 deletion smithy-model/src/main/java/software/amazon/smithy/model/node/DefaultNodeSerializers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ public Node serialize(ToNode value, Set<Object> serializedObjects, NodeMapper ma
return null;
}

// TODO: make sure every instance of `toNode` is setting this
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this comment mean? I'm not sure I understand what needs to be checked and where?

Copy link
Contributor Author

@JordonPhillips JordonPhillips Jul 19, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything that implements the ToNode interface needs to set source location on the node. I think your PR does that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment does not clarify that you are talking about sourceLocation.

return value.toNode();
}
};
Expand Down Expand Up @@ -362,7 +363,13 @@ public Node serialize(Object value, Set<Object> serializedObjects, NodeMapper ma
// multiple times (like in a List<T>).
serializedObjects.remove(value);

return new ObjectNode(mappings, SourceLocation.NONE);
// Pass on the source location if it is present.
SourceLocation sourceLocation = SourceLocation.NONE;
if (value instanceof FromSourceLocation) {
sourceLocation = ((FromSourceLocation) value).getSourceLocation();
}

return new ObjectNode(mappings, sourceLocation);
}

private boolean canSerialize(NodeMapper mapper, Node value) {
Expand Down
83 changes: 80 additions & 3 deletions smithy-model/src/test/java/software/amazon/smithy/model/node/NodeMapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import java.net.URI;
import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
Expand All @@ -34,9 +33,14 @@
import software.amazon.smithy.model.FromSourceLocation;
import software.amazon.smithy.model.SourceLocation;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.AbstractTrait;
import software.amazon.smithy.model.traits.AbstractTrait.Provider;
import software.amazon.smithy.model.traits.AbstractTraitBuilder;
import software.amazon.smithy.model.traits.RangeTrait;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;

public class NodeMapperTest {
@Test
Expand Down Expand Up @@ -1198,15 +1202,44 @@ public void deserializesIntoValueWithSourceLocation() {
}

@Test
public void doesNotSerializeSourceLocation() {
public void deserializesIntoTraitWithSourceLocation() {
NodeMapper mapper = new NodeMapper();
Map<StringNode, Node> mappings = new HashMap<>();
mappings.put(StringNode.from("foo"), StringNode.from("foo"));
SourceLocation sourceLocation = new SourceLocation("/abc/def");
Node node = new ObjectNode(mappings, sourceLocation);
SourceLocationBearerTrait trait = mapper.deserialize(node, SourceLocationBearerTrait.class);

assertThat(trait.getSourceLocation(), equalTo(sourceLocation));
assertThat(trait.getFoo(), equalTo("foo"));
}

@Test
public void doesNotSerializeSourceLocationAsKey() {
JordonPhillips marked this conversation as resolved.
Show resolved Hide resolved
NodeMapper mapper = new NodeMapper();
HasSourceLocation hs = new HasSourceLocation();
hs.setSourceLocation(new SourceLocation("/foo/baz"));
SourceLocation sourceLocation = new SourceLocation("/foo/baz");
hs.setSourceLocation(sourceLocation);
hs.setFoo("hi");
Node result = mapper.serialize(hs);

assertThat(result.expectObjectNode().getStringMap(), hasKey("foo"));
assertThat(result.expectObjectNode().getStringMap(), not(hasKey("sourceLocation")));
assertThat(result.getSourceLocation(), equalTo(sourceLocation));
}

@Test
public void passesSourceLocationFromTrait() {
JordonPhillips marked this conversation as resolved.
Show resolved Hide resolved
SourceLocation sourceLocation = new SourceLocation("/foo/baz");
SourceLocationBearerTrait trait = SourceLocationBearerTrait.builder()
.sourceLocation(sourceLocation)
.foo("foo")
.build();
Node result = trait.createNode();

assertThat(result.expectObjectNode().getStringMap(), hasKey("foo"));
assertThat(result.expectObjectNode().getStringMap(), not(hasKey("sourceLocation")));
assertThat(result.getSourceLocation(), equalTo(sourceLocation));
}

private static class HasSourceLocation implements FromSourceLocation {
Expand All @@ -1231,6 +1264,50 @@ public String getFoo() {
}
}

private static class SourceLocationBearerTrait extends AbstractTrait implements ToSmithyBuilder<SourceLocationBearerTrait> {
public static final ShapeId ID = ShapeId.from("smithy.test#sourceLocationBearer");
private final String foo;

public SourceLocationBearerTrait(Builder builder) {
super(ID, builder.getSourceLocation());
this.foo = builder.foo;
}

public String getFoo() {
return foo;
}

@Override
protected Node createNode() {
NodeMapper mapper = new NodeMapper();
mapper.disableToNodeForClass(SourceLocationBearerTrait.class);
return mapper.serialize(this);
}

@Override
public SmithyBuilder<SourceLocationBearerTrait> toBuilder() {
return new Builder().sourceLocation(getSourceLocation());
}

public static Builder builder() {
return new Builder();
}

public static final class Builder extends AbstractTraitBuilder<SourceLocationBearerTrait, Builder> {
private String foo;

@Override
public SourceLocationBearerTrait build() {
return new SourceLocationBearerTrait(this);
}

public Builder foo(String foo) {
this.foo = foo;
return this;
}
}
}

@Test
public void deserializesEnums() {
NodeMapper mapper = new NodeMapper();
Expand Down