chore: Rework Denoms.Sort() to sort by base denom and then trace

[neitdung]

Description

• Change compare method of Denoms.Less() to sort by base denom and then trace
• Add tests for Denoms.Sort()
• Fix the tests have used Denoms.Sort()

closes: #6451

Commit Message / Changelog Entry

chore: rework Denoms.Sort() to sort by base denom and then trace

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against the correct branch (see CONTRIBUTING.md).
• Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
• Code follows the module structure standards and Go style guide.
• Wrote unit and integration tests.
• Updated relevant documentation (docs/).
• Added relevant godoc comments.
• Provide a conventional commit message to follow the repository standards.
• Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
• Re-reviewed Files changed in the GitHub PR explorer.
• Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

• Bug Fixes

  • Corrected the order of entries in the migration tests to ensure proper sequence during migrations.

• Refactor

  • Enhanced sorting logic for denoms to consider base and trace fields for more accurate comparisons.

• Tests

  • Added new test cases to verify the sorting functionality of denoms based on base denom, traces, and their combinations.

[coderabbitai]

Walkthrough

The changes primarily focus on modifying the sorting mechanism for Denoms in the denom.go file. The Less method has been updated to first sort by the base denomination, then by the length of the trace, and finally by the path. Corresponding test cases have been added to ensure the correctness of this new sorting logic. Additionally, the order of entries in the TestMigratorMigrateDenomTraceToDenom function has been adjusted.

Changes

File Path	Change Summary
modules/.../transfer/keeper/migrations_test.go	Reordered NewDenom entries in TestMigratorMigrateDenomTraceToDenom function and updated entries in KeeperTestSuite.
modules/.../transfer/types/denom.go	Modified Less method in Denoms type to sort by base denom, trace length, and path.
modules/.../transfer/types/denom_test.go	Added new test functions TestPath(), TestDenomChainSource(), and TestSort() in TypesTestSuite.

Sequence Diagram(s) (Beta)

Changes are too simple and varied for a meaningful sequence diagram.

Assessment against linked issues

Objective	Addressed	Explanation
Rework Denoms.Sort() to sort by base denom and then trace (#6451)	✅

---

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
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 01eb3cb and b62750a.

Files selected for processing (3)

• modules/apps/transfer/keeper/migrations_test.go (1 hunks)
• modules/apps/transfer/types/denom.go (1 hunks)
• modules/apps/transfer/types/denom_test.go (1 hunks)

Additional context used

Path-based instructions (3)

modules/apps/transfer/types/denom.go (1)

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

modules/apps/transfer/types/denom_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"

modules/apps/transfer/keeper/migrations_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"

golangci-lint

modules/apps/transfer/types/denom.go

100-100: undefined: Denom (typecheck)

---

15-15: undefined: Trace (typecheck)

---

23-23: undefined: Denom (typecheck)

---

42-42: undefined: Denom (typecheck)

---

49-49: undefined: Denom (typecheck)

---

60-60: undefined: Denom (typecheck)

---

75-75: undefined: Denom (typecheck)

---

81-81: undefined: Denom (typecheck)

---

88-88: undefined: Denom (typecheck)

---

16-16: undefined: Denom (typecheck)

---

27-27: undefined: ErrInvalidDenomForTransfer (typecheck)

---

54-54: undefined: DenomPrefix (typecheck)

Additional comments not posted (2)

modules/apps/transfer/types/denom_test.go (1)

122-261: The TestSort method provides comprehensive coverage for the new sorting logic.

Ensure that all edge cases are considered, especially with complex trace structures.

modules/apps/transfer/keeper/migrations_test.go (1)

123-123: The order of NewDenom entries in TestMigratorMigrateDenomTraceToDenom has been adjusted to reflect the new sorting logic.

This change aligns with the PR's objective to sort denoms by base denom first and then by trace.

[coderabbitai]

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 b62750a and ac1f498.

Files selected for processing (1)

• modules/apps/transfer/types/denom.go (1 hunks)

Additional context used

Path-based instructions (1)

modules/apps/transfer/types/denom.go (1)

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

golangci-lint

modules/apps/transfer/types/denom.go

100-100: undefined: Denom (typecheck)

---

15-15: undefined: Trace (typecheck)

---

23-23: undefined: Denom (typecheck)

---

42-42: undefined: Denom (typecheck)

---

49-49: undefined: Denom (typecheck)

---

60-60: undefined: Denom (typecheck)

---

75-75: undefined: Denom (typecheck)

---

81-81: undefined: Denom (typecheck)

---

88-88: undefined: Denom (typecheck)

---

16-16: undefined: Denom (typecheck)

---

27-27: undefined: ErrInvalidDenomForTransfer (typecheck)

---

54-54: undefined: DenomPrefix (typecheck)

Additional comments not posted (1)

modules/apps/transfer/types/denom.go (1)

125-135: The updated sorting logic in Denoms.Less method looks correct and aligns with the PR objectives.

[DimitrisJim]

beautiful, thanks so much @neitdung!

[crodriguezvega]

Thanks, @neitdung. Nice work with the tests!

[damiannolan]

Excellent! Thank you @neitdung 🙏