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

Extend event ids for Added/RemovedOperationError events #1803

Merged
merged 2 commits into from
Jun 8, 2023
Merged

Extend event ids for Added/RemovedOperationError events #1803

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
9d68b5c
Extend event ids for Added/RemovedOperationError events
rchache Jun 2, 2023
1e1e912
Remove namespace from event id
rchache Jun 8, 2023
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
26 changes: 17 additions & 9 deletions smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/AddedOperationError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import software.amazon.smithy.diff.Differences;
import software.amazon.smithy.model.shapes.OperationShape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.validation.Severity;
import software.amazon.smithy.model.validation.ValidationEvent;

/**
Expand All @@ -42,15 +43,22 @@ private List<ValidationEvent> createErrorViolations(ChangedShape<OperationShape>
}

List<ValidationEvent> events = new ArrayList<>();
for (ShapeId id : change.getNewShape().getErrors()) {
if (!change.getOldShape().getErrors().contains(id)) {
events.add(warning(change.getNewShape(), String.format(
"The `%s` error was added to the `%s` operation. This "
+ "is backward-compatible if the error is only "
+ "encountered as a result of a change in behavior of "
+ "the client (for example, the client sends a new "
+ "parameter to an operation).",
id, change.getShapeId())));
for (ShapeId error : change.getNewShape().getErrors()) {
if (!change.getOldShape().getErrors().contains(error)) {
events.add(
ValidationEvent.builder()
.id(getEventId() + "." + error.getName())
.severity(Severity.WARNING)
.message(String.format(
"The `%s` error was added to the `%s` operation. This "
+ "is backward-compatible if the error is only "
+ "encountered as a result of a change in behavior of "
+ "the client (for example, the client sends a new "
+ "parameter to an operation).",
error, change.getShapeId()))
.shape(change.getNewShape())
.build()
);
}
}

Expand Down
18 changes: 13 additions & 5 deletions smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/RemovedOperationError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import software.amazon.smithy.diff.Differences;
import software.amazon.smithy.model.shapes.OperationShape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.validation.Severity;
import software.amazon.smithy.model.validation.ValidationEvent;

/**
Expand All @@ -42,11 +43,18 @@ private List<ValidationEvent> createErrorViolations(ChangedShape<OperationShape>
}

List<ValidationEvent> events = new ArrayList<>();
for (ShapeId id : change.getOldShape().getErrors()) {
if (!change.getNewShape().getErrors().contains(id)) {
events.add(warning(change.getNewShape(), String.format(
"The `%s` error was removed from the `%s` operation.",
id, change.getShapeId())));
for (ShapeId error : change.getOldShape().getErrors()) {
if (!change.getNewShape().getErrors().contains(error)) {
events.add(
ValidationEvent.builder()
.id(getEventId() + "." + error.getName())
.severity(Severity.WARNING)
.message(String.format(
"The `%s` error was removed from the `%s` operation.",
error, change.getShapeId()))
.shape(change.getNewShape())
.build()
);
}
}

Expand Down
2 changes: 2 additions & 0 deletions ...hy-diff/src/test/java/software/amazon/smithy/diff/evaluators/AddedOperationErrorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,7 @@ public void detectsAddedErrors() {
List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);

assertThat(TestHelper.findEvents(events, "AddedOperationError").size(), equalTo(2));
assertThat(TestHelper.findEvents(events, "AddedOperationError.E1").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "AddedOperationError.E2").size(), equalTo(1));
}
}
2 changes: 2 additions & 0 deletions ...-diff/src/test/java/software/amazon/smithy/diff/evaluators/RemovedOperationErrorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ public void detectsRemovedErrors() {

// Emits an event for each removal.
assertThat(TestHelper.findEvents(events, "RemovedOperationError").size(), equalTo(2));
assertThat(TestHelper.findEvents(events, "RemovedOperationError.E1").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "RemovedOperationError.E2").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "RemovedOperationError").get(0).toString(),
startsWith("[WARNING] foo.baz#Operation: The `foo.baz#E1` error was removed " +
"from the `foo.baz#Operation` operation. | RemovedOperationError"));
Expand Down