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.

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

Add breakingChanges for httpChecksum trait #2398

Merged
merged 1 commit into from
Sep 17, 2024

Conversation

gosar
Copy link
Contributor

@gosar gosar commented Sep 17, 2024

Background

The aws.protocols#httpChecksum trait was missing any rules for detecting backwards incompatible changes to the applied trait. This PR adds breakingChanges to the trait definition.

Testing

Added tests to assert the events for diff.

Links


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@gosar gosar requested a review from a team as a code owner September 17, 2024 19:22
@gosar gosar requested a review from yefrig September 17, 2024 19:22
breakingChanges: [
{
change: "remove",
severity: "ERROR",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include a message when the entire trait is removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh I wanted to add message later after adding test, but forgot. thanks for catching.

breakingChanges: [
{
change: "remove",
severity: "ERROR",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error is the default severity for breaking changes, so we can probably remove that here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that the request compression rules use DANGER see. These seem like they would have the same severity.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I debated it and felt removal of compression being less severe than removal of checksums was reasonable. But don't feel strongly about it, so changing to DANGER.

path: "/requestValidationModeMember",
severity: "ERROR",
message: """
`requestValidationModeMember` was removed so newly generated clients will no longer validate response \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`requestValidationModeMember` was removed so newly generated clients will no longer validate response \
`requestValidationModeMember` was removed, so newly generated clients will no longer validate response \

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same above.

@gosar gosar force-pushed the httpChecksum-breakingChanges branch from e1bf982 to e4001f9 Compare September 17, 2024 20:37
@gosar gosar merged commit 75d5a75 into smithy-lang:main Sep 17, 2024
13 checks passed
@gosar gosar deleted the httpChecksum-breakingChanges branch September 17, 2024 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants