fix(x/gov): grpc query tally for failed proposal

[traviolus]

Description

Closes: #XXXX

The query for a failed proposal tally should fetch from proposal.FinalTallyResult rather than tallying from votes again, as they are all removed after the proposal has failed.

---

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

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

• Bug Fixes

  • Fixed a bug in the x/gov module related to fetching failed proposal tallies.

• New Features

  • Enhanced the proposal system to handle and display results for proposals with a 'Failed' status.

[coderabbitai]

Walkthrough

Walkthrough

The modification introduces a new status condition, StatusFailed, into the TallyResult function's logic. This addition allows for the handling of proposals that have failed, alongside the already managed statuses of passed and rejected proposals. This change enriches the decision-making process by accommodating a broader range of proposal outcomes.

Changes

File	Change Summary
x/gov/keeper/grpc_query.go	Added handling for StatusFailed in TallyResult, alongside StatusPassed and StatusRejected.
x/gov/keeper/grpc_query_test.go	Modified grpc_query_test.go to include a test case for a proposal with a failed status and updated the TallyResult structure.

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between fea88d1 and 3eccfb4.

Files selected for processing (1)

• x/gov/keeper/grpc_query.go (1 hunks)

Additional comments: 1

x/gov/keeper/grpc_query.go (1)

• 322-322: The addition of proposal.Status == v1.StatusFailed to the switch case in the TallyResult function correctly addresses the issue of tallying votes for failed proposals. By fetching the final tally result directly from proposal.FinalTallyResult, this change ensures that the tally accurately reflects the final outcome without attempting to recount votes, which aligns with the intended behavior and the PR objectives.

[julienrbrt]

Thank you!
Can you add a changelog and add a test?

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 3eccfb4 and a155748.

Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• x/gov/keeper/grpc_query_test.go (2 hunks)

Additional comments: 4

x/gov/keeper/grpc_query_test.go (3)

• 1643-1684: The test case "proposal status failed" in TestGRPCQueryTallyResult method correctly sets up a failed proposal and queries its tally result. This test is crucial for ensuring that the tally results of failed proposals are accurately fetched from FinalTallyResult. The setup, execution, and assertion are correctly implemented, ensuring the functionality works as expected.
• 1826-1858: The test case "proposal status failed" in TestLegacyGRPCQueryTallyResult method is well-constructed for verifying the legacy gRPC query functionality for failed proposals. It ensures backward compatibility and correctness of the tally result fetching in the legacy system. The use of v1beta1 types and the alignment with the expected behavior are correctly handled.
• 1823-1861: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1859-1899]

The test case "multiple choice proposal" in TestProposalVoteOptions method effectively verifies the retrieval of vote options for a multiple choice proposal. It demonstrates the system's ability to handle proposals with multiple voting options and ensures that the query returns the correct set of options. The setup, query execution, and result validation are properly implemented, showcasing the functionality's correctness.

CHANGELOG.md (1)

• 88-88: The changelog entry for the bug fix in the x/gov module is clear, concise, and correctly formatted. It accurately describes the change made and provides a link to the PR for more details.

[julienrbrt]

Thank you!!