-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve member trait querys and fix JSON bug
This commit fixes a bug in the JSON schema converter where a member was not being excluded if the shape targeted by the member is marked as private. To address this in a way that helps other write similar code, I made an abstractions for querying the effective traits of a member based on a query object that can be extended in the future. I also moved the getMemberTrait and findMemberTrait methods to Shape itself rather than just on MemberShape to make them easier to use in situations where you want to get traits from a shape in a normalized way across regular shapes and member shapes.
- Loading branch information
Showing
8 changed files
with
295 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletions
134
smithy-model/src/main/java/software/amazon/smithy/model/traits/EffectiveTraitQuery.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package software.amazon.smithy.model.traits; | ||
|
|
||
| import software.amazon.smithy.model.shapes.MemberShape; | ||
| import software.amazon.smithy.model.shapes.Shape; | ||
| import software.amazon.smithy.model.shapes.ShapeIndex; | ||
| import software.amazon.smithy.model.shapes.ToShapeId; | ||
| import software.amazon.smithy.utils.SmithyBuilder; | ||
| import software.amazon.smithy.utils.ToSmithyBuilder; | ||
|
|
||
| /** | ||
| * Queries a shape index for effective traits bound to shapes and members. | ||
| */ | ||
| public final class EffectiveTraitQuery implements ToSmithyBuilder<EffectiveTraitQuery> { | ||
|
|
||
| private final ShapeIndex shapeIndex; | ||
| private final Class<? extends Trait> traitClass; | ||
| private final boolean inheritFromContainer; | ||
|
|
||
| private EffectiveTraitQuery(Builder builder) { | ||
| this.shapeIndex = SmithyBuilder.requiredState("shapeIndex", builder.shapeIndex); | ||
| this.traitClass = SmithyBuilder.requiredState("traitClass", builder.traitClass); | ||
| this.inheritFromContainer = builder.inheritFromContainer; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the trait is effectively applied to a shape. | ||
| * | ||
| * @param shapeId Shape to test. | ||
| * @return Returns true if the trait is effectively applied to the shape. | ||
| */ | ||
| public boolean isTraitApplied(ToShapeId shapeId) { | ||
| Shape shape = shapeIndex.getShape(shapeId.toShapeId()).orElse(null); | ||
|
|
||
| if (shape == null) { | ||
| return false; | ||
| } | ||
|
|
||
| if (shape.getMemberTrait(shapeIndex, traitClass).isPresent()) { | ||
| return true; | ||
| } | ||
|
|
||
| if (!inheritFromContainer || !shape.asMemberShape().isPresent()) { | ||
| return false; | ||
| } | ||
|
|
||
| // Check if the parent of the member is marked with the trait. | ||
| MemberShape memberShape = shape.asMemberShape().get(); | ||
| Shape parent = shapeIndex.getShape(memberShape.getContainer()).orElse(null); | ||
| return parent != null && parent.hasTrait(traitClass); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new query builder. | ||
| * | ||
| * @return Returns the created builder. | ||
| */ | ||
| public static Builder builder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| @Override | ||
| public Builder toBuilder() { | ||
| return builder() | ||
| .shapeIndex(shapeIndex) | ||
| .traitClass(traitClass) | ||
| .inheritFromContainer(inheritFromContainer); | ||
| } | ||
|
|
||
| /** | ||
| * Builds a reusable EffectiveTraitQuery. | ||
| */ | ||
| public static final class Builder implements SmithyBuilder<EffectiveTraitQuery> { | ||
|
|
||
| private ShapeIndex shapeIndex; | ||
| private Class<? extends Trait> traitClass; | ||
| private boolean inheritFromContainer; | ||
|
|
||
| @Override | ||
| public EffectiveTraitQuery build() { | ||
| return new EffectiveTraitQuery(this); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the required shape index to query. | ||
| * | ||
| * @param shapeIndex Shape index to query. | ||
| * @return Returns the query object builder. | ||
| */ | ||
| public Builder shapeIndex(ShapeIndex shapeIndex) { | ||
| this.shapeIndex = shapeIndex; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the required trait being queried. | ||
| * | ||
| * @param traitClass Trait to detect on shapes. | ||
| * @return Returns the query object builder. | ||
| */ | ||
| public Builder traitClass(Class<? extends Trait> traitClass) { | ||
| this.traitClass = traitClass; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * When testing member shapes, also checks the container of the member for | ||
| * the presence of a trait. | ||
| * | ||
| * <p>By default, traits are not inherited from a member's parent container. | ||
| * | ||
| * @param inheritFromContainer Set to true to inherit traits from member containers. | ||
| * @return Returns the query object builder. | ||
| */ | ||
| public Builder inheritFromContainer(boolean inheritFromContainer) { | ||
| this.inheritFromContainer = inheritFromContainer; | ||
| return this; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
99 changes: 99 additions & 0 deletions
99
smithy-model/src/test/java/software/amazon/smithy/model/traits/EffectiveTraitQueryTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| package software.amazon.smithy.model.traits; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import software.amazon.smithy.model.shapes.ListShape; | ||
| import software.amazon.smithy.model.shapes.MemberShape; | ||
| import software.amazon.smithy.model.shapes.Shape; | ||
| import software.amazon.smithy.model.shapes.ShapeIndex; | ||
| import software.amazon.smithy.model.shapes.StringShape; | ||
|
|
||
| public class EffectiveTraitQueryTest { | ||
| @Test | ||
| public void detectsTraitOnShape() { | ||
| Shape stringShape = StringShape.builder().id("foo.bar#Baz") | ||
| .addTrait(new SensitiveTrait()) | ||
| .build(); | ||
| ShapeIndex index = ShapeIndex.builder() | ||
| .addShapes(stringShape) | ||
| .build(); | ||
| EffectiveTraitQuery query = EffectiveTraitQuery.builder() | ||
| .shapeIndex(index) | ||
| .traitClass(SensitiveTrait.class) | ||
| .build(); | ||
|
|
||
| assertTrue(query.isTraitApplied(stringShape)); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsTraitOnMemberTarget() { | ||
| Shape stringShape = StringShape.builder().id("foo.bar#Baz") | ||
| .addTrait(new SensitiveTrait()) | ||
| .build(); | ||
| MemberShape member = MemberShape.builder() | ||
| .id("foo.baz#Container$member") | ||
| .target(stringShape) | ||
| .build(); | ||
| ShapeIndex index = ShapeIndex.builder() | ||
| .addShapes(stringShape, member) | ||
| .build(); | ||
| EffectiveTraitQuery query = EffectiveTraitQuery.builder() | ||
| .shapeIndex(index) | ||
| .traitClass(SensitiveTrait.class) | ||
| .build(); | ||
|
|
||
| assertTrue(query.isTraitApplied(member)); | ||
| } | ||
|
|
||
| @Test | ||
| public void ignoresTraitOnMemberContainerByDefault() { | ||
| Shape stringShape = StringShape.builder().id("foo.bar#Baz").build(); | ||
| MemberShape member = MemberShape.builder() | ||
| .id("foo.baz#Container$member") | ||
| .target(stringShape) | ||
| .build(); | ||
| ListShape list = ListShape.builder() | ||
| .id("foo.baz#Container") | ||
| .member(member) | ||
| .addTrait(new SensitiveTrait()) | ||
| .build(); | ||
| ShapeIndex index = ShapeIndex.builder() | ||
| .addShapes(stringShape, member, list) | ||
| .build(); | ||
| EffectiveTraitQuery query = EffectiveTraitQuery.builder() | ||
| .shapeIndex(index) | ||
| .traitClass(SensitiveTrait.class) | ||
| .build(); | ||
|
|
||
| assertFalse(query.isTraitApplied(member)); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsTraitOnMemberContainer() { | ||
| Shape stringShape = StringShape.builder().id("foo.bar#Baz").build(); | ||
| MemberShape member = MemberShape.builder() | ||
| .id("foo.baz#Container$member") | ||
| .target(stringShape) | ||
| .build(); | ||
| ListShape list = ListShape.builder() | ||
| .id("foo.baz#Container") | ||
| .member(member) | ||
| .addTrait(new SensitiveTrait()) | ||
| .build(); | ||
| ShapeIndex index = ShapeIndex.builder() | ||
| .addShapes(stringShape, member, list) | ||
| .build(); | ||
| EffectiveTraitQuery query = EffectiveTraitQuery.builder() | ||
| .shapeIndex(index) | ||
| .traitClass(SensitiveTrait.class) | ||
| .inheritFromContainer(true) | ||
| .build(); | ||
|
|
||
| assertTrue(query.isTraitApplied(member)); | ||
|
|
||
| // Converts to a builder... | ||
| assertTrue(query.toBuilder().build().isTraitApplied(member)); | ||
| } | ||
| } |