fix!: change UX in key assignment

[insumity]

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...

• [x] Included the correct type prefix in the PR title
• [x] 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
• [x] Targeted the correct branch (see PR Targeting)
• [x] Provided a link to the relevant issue or specification
• [ ] Followed the guidelines for building SDK modules
• [x] Included the necessary unit and integration tests
• [x] 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

• Bug Fixes

  • Updated key assignment process to return an error if a validator attempts to reuse the same consumer key.

• Tests

  • Adjusted error expectations and state representations in several test scenarios to reflect the new key assignment behavior.

• Documentation

  • Added changelog entries describing the new UX changes for key assignment, emphasizing the error returned on key reuse attempts.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The update introduces a significant change to the key assignment user experience (UX) by enforcing strict error handling when a validator attempts to reuse the same consumer key. The modifications include various updates to error messaging, test cases, and key assignment logic to prevent key reuse by validators. These changes affect multiple files spanning changelogs, tests, and core implementation, improving the overall robustness and accuracy of key assignments. ## Changes | File(s) | Change Summary | |-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | `.changelog/unreleased/api-breaking/provider/1964-1998-change-ux-in-key-assignment.md`
`.changelog/unreleased/state-breaking/provider/1964-1998-change-ux-in-key-assignment.md`
`.changelog/unreleased/api-breaking/provider/1998-change-ux-in-key-assignment.md`
`.changelog/unreleased/state-breaking/provider/1998-change-ux-in-key-assignment.md` | Introduced changes in the key assignment UX to return errors when a validator reuses the same consumer key. | | `tests/e2e/steps_compatibility.go`
`tests/e2e/steps_start_chains.go` | Added and modified logic to handle key reuse errors. | | `tests/e2e/tracehandler_testdata/*.json` | Updated `ExpectError` fields to `true` and modified `ExpectedError` messages. Significant removals in the `State` objects. | | `tests/integration/key_assignment.go` | Altered test case scenario descriptions and parameter values in anonymous functions. | | `x/ccv/provider/handler_test.go` | Updated test case names, expectations, comments, and mock calls to reflect new key assignment behavior. | | `x/ccv/provider/keeper/key_assignment.go` | Revised key assignment logic to add additional checks preventing key reuse by validators. No public entity changes. | | `x/ccv/provider/keeper/msg_server.go` | Modified logging and event attribute creation to use `msg.ConsumerKey` instead of `consumerTMPublicKey`. | ## Sequence Diagram(s) The changes introduced in this update are varied and dispersed across multiple files, focusing primarily on error handling, test modifications, and internal logic adjustments. No new features or significant control flow changes were introduced that would benefit from a sequence diagram.

---

Recent review details

**Configuration used: .coderabbit.yml** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 9228132a8d388771e983b44fabc26434d2d19f7c and a15827c051f82ce66a7f3bf4114e2e598f43c4cb.

Files selected for processing (3)

* .changelog/unreleased/api-breaking/provider/1998-change-ux-in-key-assignment.md (1 hunks) * .changelog/unreleased/state-breaking/provider/1998-change-ux-in-key-assignment.md (1 hunks) * x/ccv/provider/keeper/msg_server.go (1 hunks)

Additional context used

Path-based instructions (1)

x/ccv/provider/keeper/msg_server.go (1)

Pattern `**/*.go`: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (3)

.changelog/unreleased/api-breaking/provider/1998-change-ux-in-key-assignment.md (1)

`1-3`: **Changelog entry is clear and concise.** The changelog entry effectively summarizes the changes made in PR #1998, specifically the change in UX for key assignment.

.changelog/unreleased/state-breaking/provider/1998-change-ux-in-key-assignment.md (1)

`1-3`: **Changelog entry is clear and concise.** The changelog entry effectively summarizes the state-breaking changes made in PR #1998, specifically the change in UX for key assignment.

x/ccv/provider/keeper/msg_server.go (1)

`57-64`: **Update in logging and event attributes is appropriate.** The change from logging the `consumerTMPublicKey` to `msg.ConsumerKey` aligns with the PR's objective to enhance clarity in log entries. The event attributes have also been updated accordingly.

--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.