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

Jump to bottom

Fix JSON Schema pointer conflicts with trait definitions #2412

Merged
merged 1 commit into from
Oct 2, 2024
Merged

Fix JSON Schema pointer conflicts with trait definitions #2412

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
11 changes: 9 additions & 2 deletions smithy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/DeconflictingStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import software.amazon.smithy.model.shapes.SimpleShape;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.PrivateTrait;
import software.amazon.smithy.model.transform.ModelTransformer;
import software.amazon.smithy.utils.FunctionalUtils;
import software.amazon.smithy.utils.StringUtils;

Expand Down Expand Up @@ -56,8 +57,14 @@ final class DeconflictingStrategy implements RefStrategy {
this.delegate = delegate;

// Pre-compute a map of all converted shape refs. Sort the shapes
// to make the result deterministic.
model.shapes().filter(shapePredicate.and(FunctionalUtils.not(this::isIgnoredShape))).sorted().forEach(shape -> {
// to make the result deterministic. Eliminate trait definitions
// ahead of that computation to eliminate potential conflicts with
// shapes that won't go into JSON Schema anyway.
Model scrubbedModel = ModelTransformer.create().scrubTraitDefinitions(model);
scrubbedModel.shapes()
.filter(shapePredicate.and(FunctionalUtils.not(this::isIgnoredShape)))
.sorted()
.forEach(shape -> {
String pointer = delegate.toPointer(shape.getId());
if (!reversePointers.containsKey(pointer)) {
pointers.put(shape.getId(), pointer);
Expand Down
25 changes: 25 additions & 0 deletions ...jsonschema/src/test/java/software/amazon/smithy/jsonschema/DeconflictingStrategyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.shapes.StringShape;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.traits.PrivateTrait;
import software.amazon.smithy.model.traits.TraitDefinition;

public class DeconflictingStrategyTest {
@Test
Expand Down Expand Up @@ -97,4 +99,27 @@ public void excludesPrivatePreludeShapes() {
.createDefaultStrategy(model, new JsonSchemaConfig(), propertyNamingStrategy, alwaysTrue());
assertThat(strategy.toPointer(a.getId()), equalTo("#/definitions/Severity"));
}

@Test
public void excludesTraitDefinitions() {
StringShape member = StringShape.builder().id("com.foo#String").build();
StructureShape matcher = StructureShape.builder()
.id("com.foo#Matcher")
.addMember("member", member.getId())
.build();
StructureShape matcherForTrait = StructureShape.builder()
.id("com.bar#Matcher")
.addTrait(new PrivateTrait())
.build();
StructureShape trait = StructureShape.builder()
.id("com.bar#Trait")
.addTrait(TraitDefinition.builder().build())
.addMember("matcher", matcherForTrait.toShapeId())
.build();
Model model = Model.assembler().addShapes(trait, matcherForTrait, matcher, member).assemble().unwrap();
PropertyNamingStrategy propertyNamingStrategy = PropertyNamingStrategy.createDefaultStrategy();
RefStrategy strategy = RefStrategy
.createDefaultStrategy(model, new JsonSchemaConfig(), propertyNamingStrategy, alwaysTrue());
assertThat(strategy.toPointer(matcher.getId()), equalTo("#/definitions/Matcher"));
}
}
Loading