fix: update `voting_end_time` to `next_emergency_tally_time` at tally #388

beer-1 · 2025-04-07T10:01:09Z

Description

To properly show the voting end time, we need to update voting end time to next emergency tally time at tally handler.

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
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
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

coderabbitai · 2025-04-07T10:01:16Z

📝 Walkthrough

Walkthrough

This change refines the emergency proposal handling by updating the handleTallyResult function. For emergency proposals, after they are removed from the emergency queue and list, the code now sets the proposal’s VotingEndTime to match its EmergencyNextTallyTime. An additional test assertion in the endblocker confirms that the voting end time is correctly updated, ensuring consistent timing logic during emergency proposal processing.

Changes

File	Change Summary
`x/gov/abci.go`	Modified `handleTallyResult` to set `VotingEndTime` equal to `EmergencyNextTallyTime` for emergency proposals after removing them from queues.
`x/gov/abci_test.go`	Added an assertion in `TestEmergencyProposalPassedEndblocker` to verify that `VotingEndTime` matches `EmergencyNextTallyTime` in emergency cases.

Sequence Diagram(s)

sequenceDiagram
    participant P as Proposal
    participant H as handleTallyResult
    participant EQ as EmergencyQueue
    participant TS as TallyScheduler

    P->>H: Process emergency proposal
    H->>EQ: Remove proposal from emergency list & queue
    H->>H: Update VotingEndTime = EmergencyNextTallyTime
    H->>TS: Schedule next tally step

Possibly related PRs

fix: emergency poll should be finished if voting period is over #302: Involves similar modifications in the handleTallyResult function, enhancing emergency proposal timing and queue management.

Suggested reviewers

sh-cha

Poem

In fields of code I twirl and hop,
Syncing times till errors stop,
Emergency cues now dance in line,
With each update, everything's fine,
A rabbit's cheer in every tick—hop, hop! 🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2913dcb and a3c8ebc.

📒 Files selected for processing (2)

x/gov/abci.go (1 hunks)
x/gov/abci_test.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: golangci-lint
GitHub Check: Run test and upload codecov
GitHub Check: Analyze (go)

🔇 Additional comments (2)

x/gov/abci.go (1)

260-262: Good addition for accurate timeline tracking.

The change correctly updates the proposal's VotingEndTime to match its EmergencyNextTallyTime for emergency proposals after they've been tallied and removed from the emergency queues. This ensures that the voting end time reflected in the proposal accurately represents when the final emergency tally occurred.

This is important for maintaining a consistent and accurate historical record of when emergency proposals were actually decided.

x/gov/abci_test.go (1)

137-139: Good test coverage for the new behavior.

This assertion correctly validates that the voting end time is updated to match the emergency next tally time after an emergency proposal has passed. The test ensures that the change in the handleTallyResult function is working as expected.

The clear comment also helps explain the purpose of the assertion.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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 generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

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

github-actions · 2025-04-07T10:01:23Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Files

codecov · 2025-04-07T10:15:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.03%. Comparing base (2913dcb) to head (a3c8ebc).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #388   +/-   ##
=======================================
  Coverage   40.03%   40.03%           
=======================================
  Files         294      294           
  Lines       27508    27509    +1     
=======================================
+ Hits        11012    11013    +1     
  Misses      14796    14796           
  Partials     1700     1700

Files with missing lines	Coverage Δ
x/gov/abci.go	`28.17% <100.00%> (+0.22%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sh-cha

LGTM

fix to update voting_end_time to next_emergency_tally_time

a3c8ebc

beer-1 requested a review from a team as a code owner April 7, 2025 10:01

beer-1 self-assigned this Apr 7, 2025

beer-1 requested a review from sh-cha April 7, 2025 10:01

sh-cha approved these changes Apr 9, 2025

View reviewed changes

beer-1 added consensus-breaking v1.1 Release v1.1 v1 Release v1 and removed v1.1 Release v1.1 labels Apr 17, 2025

beer-1 merged commit 84b6bf0 into main Apr 17, 2025
10 checks passed

beer-1 deleted the fix/update-proposal-end-time branch April 17, 2025 05:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: update `voting_end_time` to `next_emergency_tally_time` at tally #388

fix: update `voting_end_time` to `next_emergency_tally_time` at tally #388

Uh oh!

beer-1 commented Apr 7, 2025

Uh oh!

coderabbitai bot commented Apr 7, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Apr 7, 2025

Uh oh!

codecov bot commented Apr 7, 2025 •

edited

Loading

Uh oh!

sh-cha left a comment

Uh oh!

Uh oh!

Uh oh!

fix: update voting_end_time to next_emergency_tally_time at tally #388

fix: update voting_end_time to next_emergency_tally_time at tally #388

Uh oh!

Conversation

beer-1 commented Apr 7, 2025

Description

Author Checklist

Reviewers Checklist

Uh oh!

coderabbitai bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Apr 7, 2025

Dependency Review

OpenSSF Scorecard

Scanned Files

Uh oh!

codecov bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sh-cha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fix: update `voting_end_time` to `next_emergency_tally_time` at tally #388

fix: update `voting_end_time` to `next_emergency_tally_time` at tally #388

coderabbitai bot commented Apr 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Apr 7, 2025 •

edited

Loading