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: TestAccountsMigration systemtest with simdv2 #22673

Merged
merged 3 commits into from
Nov 28, 2024

Conversation

hieuvubk
Copy link
Contributor

@hieuvubk hieuvubk commented Nov 28, 2024

Description

Closes: #22651

  • Regist x/accounts msg server & queries for appmodule v2

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, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Enhanced account management with new query and message handling functionalities.
    • Improved integration with the latest app module framework for better data processing.

Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve the addition of two new methods to the AppModule struct in the x/accounts/module.go file. These methods, RegisterQueryHandlers and RegisterMsgHandlers, facilitate the registration of query and message handlers using the appmodulev2 package. This update aims to improve the handling of queries and messages within the application module framework.

Changes

File Change Summary
x/accounts/module.go Added methods: RegisterQueryHandlers(router appmodulev2.QueryRouter) and RegisterMsgHandlers(router appmodulev2.MsgRouter) for query and message handler registration.

Assessment against linked issues

Objective Addressed Explanation
Complete service registration for x/accounts query (22651)

Possibly related PRs

Suggested labels

C:CLI, backport/v0.52.x

Suggested reviewers

  • sontrinh16
  • tac0turtle
  • julienrbrt
  • akhilkumarpilli

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@hieuvubk hieuvubk changed the title fix: TestAccountsMigration systemtest when run with simdv2 fix: TestAccountsMigration systemtest with simdv2 Nov 28, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a267da6 and f24e040.

📒 Files selected for processing (1)
  • x/accounts/module.go (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
x/accounts/module.go (1)

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

🔇 Additional comments (3)
x/accounts/module.go (3)

11-11: LGTM: Import statement is correctly aliased

The import statement for appmodulev2 is properly aliased and follows the Uber Go style guide.


75-82: LGTM: Message handlers are correctly registered

The implementation properly registers all necessary message handlers using the correct registration method.


65-82: Verify complete handler registration

Let's ensure all query and message handlers from the server interfaces are registered.

✅ Verification successful

All handlers are correctly registered

The code correctly registers all query and message handlers from the accounts module:

Query handlers registered:

  • AccountQuery
  • Schema
  • AccountType
  • AccountNumber

Message handlers registered:

  • Init
  • Execute
  • ExecuteBundle

The implementation matches the interfaces defined in the protobuf files, with all methods properly registered in the RegisterQueryHandlers and RegisterMsgHandlers functions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any unregistered handlers from the query and message servers

# Find all methods in the query and message server interfaces
echo "Checking for query and message handlers..."
ast-grep --pattern 'type QueryServer interface {
  $$$
}'

ast-grep --pattern 'type MsgServer interface {
  $$$
}'

Length of output: 100524


Script:

#!/bin/bash
# Let's search for the QueryServer and MsgServer interfaces specifically in the accounts module
echo "Searching for QueryServer interface in accounts module..."
rg -A 10 "type QueryServer interface" x/accounts/v1/query.pb.go

echo "Searching for MsgServer interface in accounts module..."
rg -A 10 "type MsgServer interface" x/accounts/v1/tx.pb.go

Length of output: 1515

Comment on lines +65 to +73
// RegisterQueryHandlers registers the query handlers for the accounts module.
func (am AppModule) RegisterQueryHandlers(router appmodulev2.QueryRouter) {
queryServer := NewQueryServer(am.k)

appmodulev2.RegisterMsgHandler(router, queryServer.AccountNumber)
appmodulev2.RegisterMsgHandler(router, queryServer.AccountQuery)
appmodulev2.RegisterMsgHandler(router, queryServer.AccountType)
appmodulev2.RegisterMsgHandler(router, queryServer.Schema)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Critical: Incorrect handler registration for queries

The implementation is using RegisterMsgHandler for registering query handlers, which is incorrect. This explains the system test failures mentioned in issue #22651 where query handlers couldn't be found.

Apply this fix:

func (am AppModule) RegisterQueryHandlers(router appmodulev2.QueryRouter) {
    queryServer := NewQueryServer(am.k)

-   appmodulev2.RegisterMsgHandler(router, queryServer.AccountNumber)
-   appmodulev2.RegisterMsgHandler(router, queryServer.AccountQuery)
-   appmodulev2.RegisterMsgHandler(router, queryServer.AccountType)
-   appmodulev2.RegisterMsgHandler(router, queryServer.Schema)
+   appmodulev2.RegisterQueryHandler(router, queryServer.AccountNumber)
+   appmodulev2.RegisterQueryHandler(router, queryServer.AccountQuery)
+   appmodulev2.RegisterQueryHandler(router, queryServer.AccountType)
+   appmodulev2.RegisterQueryHandler(router, queryServer.Schema)
}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// RegisterQueryHandlers registers the query handlers for the accounts module.
func (am AppModule) RegisterQueryHandlers(router appmodulev2.QueryRouter) {
queryServer := NewQueryServer(am.k)
appmodulev2.RegisterMsgHandler(router, queryServer.AccountNumber)
appmodulev2.RegisterMsgHandler(router, queryServer.AccountQuery)
appmodulev2.RegisterMsgHandler(router, queryServer.AccountType)
appmodulev2.RegisterMsgHandler(router, queryServer.Schema)
}
// RegisterQueryHandlers registers the query handlers for the accounts module.
func (am AppModule) RegisterQueryHandlers(router appmodulev2.QueryRouter) {
queryServer := NewQueryServer(am.k)
appmodulev2.RegisterQueryHandler(router, queryServer.AccountNumber)
appmodulev2.RegisterQueryHandler(router, queryServer.AccountQuery)
appmodulev2.RegisterQueryHandler(router, queryServer.AccountType)
appmodulev2.RegisterQueryHandler(router, queryServer.Schema)
}

Copy link
Contributor

@alpe alpe left a comment

Choose a reason for hiding this comment

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

This fixes the TestAccountsMigration 👍

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Looks like what looked like a double registration RegisterServices + RegisterMsg/QueryHandler can work together. In v2 it looks like RegisterMsg/QueryHandler will override RegisterServices, which is good

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 28, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Nov 28, 2024
Merged via the queue into main with commit 18dcdb8 Nov 28, 2024
75 of 76 checks passed
@julienrbrt julienrbrt deleted the hieu/systemtest-xaccount branch November 28, 2024 09:23
mergify bot pushed a commit that referenced this pull request Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/accounts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: v2: system-tests are failing on xaccounts query
5 participants