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

[0.10] Support Smithy IDL Serialization #284

Merged
merged 16 commits into from
Feb 27, 2020
Merged

[0.10] Support Smithy IDL Serialization #284

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
543857c
Add writeInline method to CodeWriter
JordonPhillips Feb 21, 2020
c0b8ce5
Support Smithy IDL serialization
JordonPhillips Feb 21, 2020
e809796
Add filtering predicates to idl serializer
JordonPhillips Feb 24, 2020
675b7d1
Don't filter metadata case-insensitively
JordonPhillips Feb 24, 2020
0f8205a
Serialize metadata-only models
JordonPhillips Feb 24, 2020
6fca073
Clarify documentation on IDL serializer outputs
JordonPhillips Feb 24, 2020
5555a4e
Make IDL shape comparator private
JordonPhillips Feb 24, 2020
9397ca4
Sort structures before unions in serialized IDL
JordonPhillips Feb 24, 2020
496f43a
touch up docs
JordonPhillips Feb 24, 2020
a96403a
Make shapeplacer public
JordonPhillips Feb 24, 2020
9ef38f4
Privatize everything that can be
JordonPhillips Feb 24, 2020
dd4396b
Use string array for writeInline
JordonPhillips Feb 24, 2020
b57193f
remove unused import
JordonPhillips Feb 25, 2020
8ea2e2f
Simplify IDL serializer
JordonPhillips Feb 27, 2020
92a4eaa
Add a base path to the idl serializer
JordonPhillips Feb 27, 2020
1811d0a
Compare ShapeId's case-insensitively
JordonPhillips Feb 27, 2020
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
Prev Previous commit
Next Next commit
Simplify IDL serializer 
This simplifies various bits of the internals, for instance by
discarding much manual tinkering of sorting.
  • Loading branch information
@JordonPhillips
JordonPhillips committed Feb 27, 2020
commit 8ea2e2f6476a052f9e8d9af455eaf36ba24576fb
102 changes: 33 additions & 69 deletions smithy-model/src/main/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.io.Serializable;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
Expand Down Expand Up @@ -46,6 +47,7 @@
import software.amazon.smithy.utils.CodeWriter;
import software.amazon.smithy.utils.FunctionalUtils;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.MapUtils;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.StringUtils;

Expand Down Expand Up @@ -81,16 +83,15 @@ private SmithyIdlModelSerializer(Builder builder) {
* @return A map of (possibly relative) file paths to Smithy IDL strings.
*/
public Map<Path, String> serialize(Model model) {
List<Shape> shapes = model.shapes()
Map<Path, String> result = model.shapes()
.filter(FunctionalUtils.not(Shape::isMemberShape))
.filter(shapeFilter)
.collect(Collectors.toList());
if (shapes.isEmpty()) {
return Collections.singletonMap(Paths.get("metadata.smithy"), serializeHeader(model, null));
}
return shapes.stream()
.collect(Collectors.groupingBy(shapePlacer)).entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, entry -> serialize(model, entry.getValue())));
if (result.isEmpty()) {
return Collections.singletonMap(Paths.get("metadata.smithy"), serializeHeader(model, null));
}
return result;
}

private String serialize(Model fullModel, Collection<Shape> shapes) {
Expand Down Expand Up @@ -124,8 +125,8 @@ private String serializeHeader(Model fullModel, String namespace) {
// Write the full metadata into every output. When loaded back together the conflicts will be ignored,
// but if they're separated out then each file will still have all the context.
fullModel.getMetadata().entrySet().stream()
.sorted(Map.Entry.comparingByKey())
.filter(entry -> metadataFilter.test(entry.getKey()))
JordonPhillips marked this conversation as resolved.
Show resolved Hide resolved
.sorted(Map.Entry.comparingByKey())
.forEach(entry -> {
codeWriter.trimTrailingSpaces(false)
.writeInline("metadata $M = ", entry.getKey())
Expand Down Expand Up @@ -166,17 +167,18 @@ public static Path placeShapesByNamespace(Shape shape) {
* Comparator used to sort shapes.
*/
private static final class ShapeComparator implements Comparator<Shape>, Serializable {
private static final List<ShapeType> PRIORITY = ListUtils.of(
ShapeType.SERVICE,
ShapeType.RESOURCE,
ShapeType.OPERATION,
ShapeType.STRUCTURE,
ShapeType.UNION,
ShapeType.LIST,
ShapeType.SET,
ShapeType.MAP
private static final Map<ShapeType, Integer> PRIORITY = MapUtils.of(
ShapeType.SERVICE, 0,
ShapeType.RESOURCE, 1,
ShapeType.OPERATION, 2,
ShapeType.STRUCTURE, 3,
ShapeType.UNION, 4,
ShapeType.LIST, 5,
ShapeType.SET, 6,
ShapeType.MAP, 7
);


@Override
public int compare(Shape s1, Shape s2) {
// Traits go first
Expand All @@ -188,31 +190,24 @@ public int compare(Shape s1, Shape s2) {
return -1;
}
// The other sorting rules don't matter for traits.
return compareCaseInsensitive(s1, s2);
return s1.compareTo(s2);
}
// If the shapes are the same type, just compare their shape ids.
if (s1.getType().equals(s2.getType())) {
return compareCaseInsensitive(s1, s2);
return s1.compareTo(s2);
}
// If one shape is prioritized, compare by priority.
if (PRIORITY.contains(s1.getType()) || PRIORITY.contains(s2.getType())) {
if (PRIORITY.containsKey(s1.getType()) || PRIORITY.containsKey(s2.getType())) {
// If only one shape is prioritized, that shape is "greater".
if (!PRIORITY.contains(s1.getType())) {
if (!PRIORITY.containsKey(s1.getType())) {
return 1;
}
if (!PRIORITY.contains(s2.getType())) {
if (!PRIORITY.containsKey(s2.getType())) {
return -1;
}
return PRIORITY.indexOf(s1.getType()) - PRIORITY.indexOf(s2.getType());
return PRIORITY.get(s1.getType()) - PRIORITY.get(s2.getType());
}
return compareCaseInsensitive(s1, s2);
}

/**
* Compare two shapes by id case-insensitively.
*/
private int compareCaseInsensitive(Shape s1, Shape s2) {
return s1.toShapeId().toString().toLowerCase().compareTo(s2.toShapeId().toString().toLowerCase());
return s1.compareTo(s2);
}
}

Expand Down Expand Up @@ -335,7 +330,7 @@ private void serializeTraits(Shape shape) {
shape.getAllTraits().values().stream()
.filter(trait -> !(trait instanceof DocumentationTrait))
.filter(traitFilter)
.sorted(Comparator.comparing(trait -> trait.toShapeId().toString(), String.CASE_INSENSITIVE_ORDER))
.sorted(Comparator.comparing(Trait::toShapeId))
.forEach(this::serializeTrait);
}

Expand Down Expand Up @@ -390,22 +385,16 @@ public Void mapShape(MapShape shape) {

@Override
public Void structureShape(StructureShape shape) {
shapeWithMembers(shape, sortMembers(shape.getAllMembers().values()));
shapeWithMembers(shape, new ArrayList<>(shape.getAllMembers().values()));
return null;
}

@Override
public Void unionShape(UnionShape shape) {
shapeWithMembers(shape, sortMembers(shape.getAllMembers().values()));
shapeWithMembers(shape, new ArrayList<>(shape.getAllMembers().values()));
return null;
}

private List<MemberShape> sortMembers(Collection<MemberShape> members) {
return members.stream()
.sorted(Comparator.comparing(MemberShape::getMemberName, String.CASE_INSENSITIVE_ORDER))
.collect(Collectors.toList());
}

@Override
public Void serviceShape(ServiceShape shape) {
serializeTraits(shape);
Expand All @@ -420,16 +409,11 @@ public Void serviceShape(ServiceShape shape) {
@Override
public Void resourceShape(ResourceShape shape) {
serializeTraits(shape);
if (isEmptyResource(shape)) {
codeWriter.write("resource $L {}", shape.getId().getName()).write("");
return null;
}

codeWriter.openBlock("resource $L {", shape.getId().getName());
if (!shape.getIdentifiers().isEmpty()) {
codeWriter.openBlock("identifiers: {");
shape.getIdentifiers().entrySet().stream()
.sorted(Map.Entry.comparingByKey(String.CASE_INSENSITIVE_ORDER))
.sorted(Map.Entry.comparingByKey())
.forEach(entry -> codeWriter.write(
"$L: $I,", entry.getKey(), entry.getValue()));
codeWriter.closeBlock("},");
Expand All @@ -450,19 +434,6 @@ public Void resourceShape(ResourceShape shape) {
return null;
}

private boolean isEmptyResource(ResourceShape shape) {
return !(!shape.getIdentifiers().isEmpty()
|| !shape.getOperations().isEmpty()
|| !shape.getCollectionOperations().isEmpty()
|| !shape.getResources().isEmpty()
|| shape.getPut().isPresent()
|| shape.getCreate().isPresent()
|| shape.getRead().isPresent()
|| shape.getUpdate().isPresent()
|| shape.getDelete().isPresent()
|| shape.getList().isPresent());
}

@Override
public Void operationShape(OperationShape shape) {
serializeTraits(shape);
Expand Down Expand Up @@ -546,11 +517,7 @@ private boolean isShapeId(Shape shape) {
if (shape == null) {
return false;
}
if (shape.isMemberShape()) {
return shape.asMemberShape()
.flatMap(member -> member.getMemberTrait(model, IdRefTrait.class)).isPresent();
}
return shape.hasTrait(IdRefTrait.class);
return shape.getMemberTrait(model, IdRefTrait.class).isPresent();
}

private void serializeString(StringNode node) {
Expand Down Expand Up @@ -632,7 +599,7 @@ private void serializeKeyValuePairs(ObjectNode node, Shape shape) {
if (shape == null) {
members = Collections.emptyMap();
} else {
members = shape.members().stream().distinct()
members = shape.members().stream()
.collect(Collectors.toMap(MemberShape::getMemberName, Function.identity()));
}

Expand Down Expand Up @@ -769,9 +736,7 @@ private SmithyCodeWriter writeOptionalIdList(String textBeforeList, Collection<S
}

openBlock("$L: [", textBeforeList);
shapeIds.stream()
.sorted(Comparator.comparing(ShapeId::toString, String.CASE_INSENSITIVE_ORDER))
.forEach(shapeId -> write("$I,", shapeId));
shapeIds.stream().sorted().forEach(shapeId -> write("$I,", shapeId));
closeBlock("],");

return this;
Expand All @@ -794,8 +759,7 @@ public String toString() {
if (imports.isEmpty()) {
return contents;
}
String importString = imports.stream()
.sorted(Comparator.comparing(ShapeId::toString, String.CASE_INSENSITIVE_ORDER))
String importString = imports.stream().sorted()
.map(shapeId -> String.format("use %s", shapeId.toString()))
.collect(Collectors.joining("\n"));
return importString + "\n\n" + contents;
Expand Down
3 changes: 2 additions & 1 deletion ...sources/software/amazon/smithy/model/shapes/idl-serialization/cases/service-shapes.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ service MyService {
],
}

resource EmptyResource {}
resource EmptyResource {
}

resource MyResource {
identifiers: {
Expand Down