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

fix!: change UX in key assignment (backport #1998) #2062

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jul 18, 2024

Description

Modifies the user experience (UX) of key assignment by reverting #1732. Note that this is not a full revert of #1732 because #1732 added tests that made sense to keep here as well.

Before, when a validator tried to re-use a previously assigned consumer key that they used, we would return success and the assignment would be a no-op. With this PR, we return an error instead.
The reason for this change was that we had a validator re-assigning an old consumer key they used but because the assignment was a no-op, the old consumer key was not set. As a result, the validator was confused on why the assignment was successful but the consumer key on the consumer chain remained unchanged.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • Included the correct type prefix in the PR title
  • Added ! to the type prefix if the change is state-machine breaking
  • Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
  • Targeted the correct branch (see PR Targeting)
  • Provided a link to the relevant issue or specification
  • Followed the guidelines for building SDK modules
  • Included the necessary unit and integration tests
  • Added a changelog entry to CHANGELOG.md
  • Included comments for documenting Go code
  • Updated the relevant documentation or specification
  • Reviewed "Files changed" and left comments if necessary
  • Confirmed all CI checks have passed
  • If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! the type prefix if the change is state-machine breaking
  • confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage

Summary by CodeRabbit

  • New Features

    • Improved key assignment security: Now triggers an error if a validator attempts to reuse the same consumer key, preventing key duplication.
  • Bug Fixes

    • Enhanced error handling for scenarios where a key is already assigned, ensuring accurate failure scenarios and messages.
  • Tests

    • Updated test cases and JSON structures to reflect new error handling logic for key assignments.
  • Documentation

    • Updated function descriptions in test cases to specify scenarios related to key assignment failures.

This is an automatic backport of pull request #1998 done by [Mergify](https://mergify.com).

* init

* added nit changes

* added CHANGELOGs

* fixed E2E tests error message

* brought one more test from #1732

* fixed logging

* fixed event key

* fixed CHANGELOGs

* rebase

(cherry picked from commit fde751e)
@mergify mergify bot requested a review from a team as a code owner July 18, 2024 18:13
@github-actions github-actions bot added C:Testing Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler labels Jul 18, 2024
@MSalopek MSalopek merged commit eb852ed into release/v5.1.x Jul 18, 2024
13 of 14 checks passed
@MSalopek MSalopek deleted the mergify/bp/release/v5.1.x/pr-1998 branch July 18, 2024 20:32
@insumity insumity mentioned this pull request Jul 19, 2024
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Testing Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants