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

Enforce private on traits #1406

Merged
merged 2 commits into from
Sep 20, 2022
Merged

Enforce private on traits #1406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
973134d
Fix bug where `private` would be applied to every shape that mixes in…
milesziemer Sep 14, 2022
7708abc
Fix bug where private access wasn't enforced on trait applications
milesziemer Sep 14, 2022
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
2 changes: 1 addition & 1 deletion smithy-aws-traits/src/main/resources/META-INF/smithy/aws.protocols.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ structure awsJson1_1 with [HttpConfiguration] {}

/// Contains HTTP protocol configuration for HTTP-based protocols.
@private
@mixin
@mixin(localTraits: [private])
structure HttpConfiguration {
/// The priority ordered list of supported HTTP protocol versions.
http: StringList
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/software/amazon/smithy/model/validation/validators/PrivateAccessValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public final class PrivateAccessValidator extends AbstractValidator {

@Override
public List<ValidationEvent> validate(Model model) {
NeighborProvider provider = NeighborProviderIndex.of(model).getReverseProvider();
NeighborProvider provider = NeighborProviderIndex.of(model).getReverseProviderWithTraitRelationships();

List<ValidationEvent> events = new ArrayList<>();
for (Shape privateShape : model.getShapesWithTrait(PrivateTrait.class)) {
Expand Down
1 change: 1 addition & 0 deletions ...c/test/resources/software/amazon/smithy/model/errorfiles/validators/private-access.errors
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
[ERROR] smithy.example#InvalidOperation: This shape has an invalid output relationship that targets a private shape, `smithy.private#InvalidOperationOutput`, in another namespace. | PrivateAccess
[ERROR] smithy.example#InvalidService: This shape has an invalid operation relationship that targets a private shape, `smithy.private#PrivateOperation`, in another namespace. | PrivateAccess
[ERROR] smithy.example#InvalidStructure$invalid: This shape has an invalid member_target relationship that targets a private shape, `smithy.private#PrivateString`, in another namespace. | PrivateAccess
[ERROR] smithy.example#InvalidTraitApplication: This shape has an invalid trait relationship that targets a private shape, `smithy.private#privateTrait`, in another namespace. | PrivateAccess
20 changes: 20 additions & 0 deletions ...src/test/resources/software/amazon/smithy/model/errorfiles/validators/private-access.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,20 @@
}
]
},
"smithy.example#InvalidTraitApplication": {
"type": "structure",
"members": {},
"traits": {
"smithy.private#privateTrait": {}
}
},
"smithy.private#privateTrait": {
"type": "structure",
"traits": {
"smithy.api#trait": {},
"smithy.api#private": {}
}
},
"smithy.private#InvalidOperationInput": {
"type": "structure",
"members": {
Expand All @@ -64,6 +78,9 @@
},
"map": {
"target": "smithy.example#InvalidMap"
},
"traitApplication": {
"target": "smithy.example#InvalidTraitApplication"
}
},
"traits": {
Expand All @@ -85,6 +102,9 @@
},
"map": {
"target": "smithy.example#InvalidMap"
},
"traitApplication": {
"target": "smithy.example#InvalidTraitApplication"
}
},
"traits": {
Expand Down