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

refactor(baseapp): remove AccAddress.String() #21521

Merged
merged 2 commits into from
Sep 7, 2024

Conversation

JulianToledano
Copy link
Contributor

@JulianToledano JulianToledano commented Sep 3, 2024

Description

Ref:
#7448
#20955


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 address handling in transaction processing and tests, ensuring consistent formatting and improved robustness.
  • Bug Fixes

    • Improved error handling for address conversions in various test cases, enhancing test reliability.
  • Refactor

    • Updated function signatures to include address codec parameters for better address handling across the test suite.
  • Tests

    • Modified test cases to utilize the new address codec for improved clarity and correctness in address processing.

@JulianToledano JulianToledano added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 3, 2024
Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

Walkthrough

The changes involve significant updates to the handling of address encoding across various test files in the baseapp package. The modifications primarily focus on integrating an AddressCodec parameter into multiple functions, enhancing the consistency and robustness of address handling in transaction processing and message construction within the test suite.

Changes

Files Change Summary
baseapp/abci_test.go, baseapp/baseapp_test.go, baseapp/streaming_test.go, baseapp/utils_test.go Introduced AddressCodec as a parameter in various functions, enhancing address handling. Updated transaction counters to utilize the codec for address formatting.
baseapp/abci_utils.go, baseapp/abci_utils_test.go Modified signer key handling in PrepareProposalHandler and updated test cases to utilize AddressCodec for address conversions.
baseapp/msg_service_router_test.go Updated the Owner field in MsgCreateDog to use BytesToString for address conversion, improving address formatting.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite
    participant AddressCodec
    participant Transaction

    TestSuite->>AddressCodec: Initialize AddressCodec
    TestSuite->>Transaction: Call newTxCounter with AddressCodec
    Transaction->>AddressCodec: Convert address using BytesToString
    Transaction-->>TestSuite: Return formatted address
Loading

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.


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

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: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54b49d4 and c29108e.

Files selected for processing (7)
  • baseapp/abci_test.go (36 hunks)
  • baseapp/abci_utils.go (2 hunks)
  • baseapp/abci_utils_test.go (5 hunks)
  • baseapp/baseapp_test.go (14 hunks)
  • baseapp/msg_service_router_test.go (1 hunks)
  • baseapp/streaming_test.go (1 hunks)
  • baseapp/utils_test.go (2 hunks)
Additional context used
Path-based instructions (7)
baseapp/msg_service_router_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

baseapp/streaming_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

baseapp/utils_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

baseapp/abci_utils.go (1)

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

baseapp/abci_utils_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

baseapp/baseapp_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

baseapp/abci_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (31)
baseapp/msg_service_router_test.go (1)

158-162: LGTM!

The code changes are approved for the following reasons:

  • Using the BytesToString method from the AddressCodec of the signingCtx to convert the addr to a string ensures that the address is correctly formatted before being assigned to the Owner field.
  • Explicitly checking the error from the BytesToString method using require.NoError improves the robustness of the test by ensuring that any issues during the conversion are caught.
  • The changes align with the best practices of using the AddressCodec for address formatting and error handling.
baseapp/utils_test.go (4)

297-301: LGTM!

The changes to the newTxCounter function signature and the usage of the address.Codec for address conversion improve the clarity and correctness of address handling. The error handling ensures robustness.


304-304: LGTM!

Using the string representation of the address obtained from the codec for constructing the MsgCounter message ensures consistency with the rest of the code that uses the codec for address handling.


347-354: LGTM!

The changes to the setFailOnHandler function signature and the usage of the address.Codec for address conversion improve the flexibility of the function by allowing the address to be derived from the codec rather than being hardcoded. The error handling ensures robustness.


369-376: LGTM!

The changes to the wonkyMsg function signature and the usage of the address.Codec for deriving the address for the MsgCounter2 message improve flexibility by allowing the address to be derived from the codec rather than being hardcoded. The error handling ensures robustness.

baseapp/abci_utils.go (1)

303-304: LGTM!

The code changes enhance clarity by explicitly converting signer.Signer to a string before using it as the map key. This improves readability and maintainability while preserving the overall functionality.

Also applies to: 306-306, 317-317

baseapp/abci_utils_test.go (5)

Line range hint 724-753: LGTM!

The code changes to the buildMsg function are approved:

  • The function signature has been correctly updated to accept an address.Codec parameter.
  • The address.Codec is used to convert the public key bytes to a string address, improving the address encoding.

489-490: LGTM!

The code changes to the TestDefaultProposalHandler_NoOpMempoolTxSelection test are approved:

  • The test correctly uses the address.Codec from the signing context to convert the address bytes to a string.

Also applies to: 493-493


598-615: LGTM!

The code changes to the TestDefaultProposalHandler_PriorityNonceMempoolTxSelection test are approved:

  • The test correctly calls the buildMsg function with the address.Codec from the signing context, improving the address encoding.

5-5: LGTM!

The code change to the TestABCIUtilsTestSuite struct is approved:

  • The struct correctly imports the cosmossdk.io/core/address package, allowing the test suite to use the address package.

741-743: LGTM!

The code changes to the buildMsg function are approved:

  • The function correctly uses the address.Codec to convert the public key bytes to a string address, improving the address encoding.
baseapp/baseapp_test.go (12)

6-6: LGTM!

The import of cosmossdk.io/core/address package is approved.


54-54: LGTM!

The addition of the ac field to the BaseAppSuite struct is approved.


95-95: LGTM!

The initialization of the ac field with the address codec from the signing context is approved.


157-158: LGTM!

The usage of the ac field to convert address bytes to string is approved.


160-160: LGTM!

The usage of the converted address string to create a new message is approved.


234-234: LGTM!

The usage of the ac field to create a new transaction is approved.


516-516: LGTM!

The usage of the signingCtx.AddressCodec() to create a new transaction is approved.


560-560: LGTM!

The usage of the suite.ac field to create a new transaction is approved.


590-590: LGTM!

The usage of the suite.ac field to create a new transaction is approved.


607-608: LGTM!

The usage of the suite.ac field to create a new transaction and set it to fail on the handler is approved.


625-625: LGTM!

The usage of the suite.ac field to create a new transaction is approved.


665-665: LGTM!

The usage of the suite.ac field to create new transactions and set them to fail on the handler or use a wonky message is approved.

Also applies to: 679-679, 690-690, 911-911

baseapp/abci_test.go (8)

43-43: Looks good!

The new import statement for codectestutil is approved.


604-606: Approved.

Passing the suite.ac address codec to newTxCounter looks good.


659-661: LGTM.

The update to pass suite.ac to newTxCounter is approved.


707-709: Looks good to me.

Passing suite.ac to newTxCounter is approved.


728-736: Approved.

The code changes to construct a new transaction with additional MsgCounter2 messages look good. Using suite.ac.BytesToString to convert the address is the correct approach.


795-801: Looks good!

Initializing the address codec and converting test addresses from bytes to string using the codec's BytesToString method is the correct approach. The error handling for BytesToString calls is also done properly.


810-811: Approved.

Updating the test messages to use the string representation of addresses (addrStr and toAddrStr) instead of the byte representation looks good. The changes are consistent across all the test messages.

Also applies to: 818-819, 836-837, 845-846, 854-858, 867-871, 881-885


937-943: LGTM.

Initializing the address codec, converting test addresses to string, and using the string representation in the test messages is done correctly. The changes are consistent with the previous updates.

Also applies to: 954-955, 964-965

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: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c29108e and bb870cc.

Files selected for processing (2)
  • baseapp/abci_utils_test.go (5 hunks)
  • baseapp/baseapp_test.go (14 hunks)
Files skipped from review as they are similar to previous changes (2)
  • baseapp/abci_utils_test.go
  • baseapp/baseapp_test.go

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.

ACK

@julienrbrt julienrbrt added this pull request to the merge queue Sep 7, 2024
Merged via the queue into main with commit a48a75f Sep 7, 2024
76 checks passed
@julienrbrt julienrbrt deleted the julian/del-accString-baseapp branch September 7, 2024 07:49
mergify bot pushed a commit that referenced this pull request Sep 7, 2024
(cherry picked from commit a48a75f)

# Conflicts:
#	baseapp/abci_test.go
julienrbrt added a commit that referenced this pull request Sep 9, 2024
Co-authored-by: Julián Toledano <JulianToledano@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants