Skip to content

test: improve check for EnsureNoStaleBallots to ignore Pending Ballots#3627

Merged
kingpinXD merged 5 commits intodevelopfrom
fix-ballots-check
Mar 4, 2025
Merged

test: improve check for EnsureNoStaleBallots to ignore Pending Ballots#3627
kingpinXD merged 5 commits intodevelopfrom
fix-ballots-check

Conversation

@kingpinXD
Copy link
Member

@kingpinXD kingpinXD commented Mar 4, 2025

Description

After this PR
#3553 - pending ballots are not deleted at the maturity blocks of 100 .

However for e2e tests all ballots should be finalized , but for runs some garbage ballots get created which are triggereing this issue intermitently

closes : #3626

How Has This Been Tested?

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Summary by CodeRabbit

  • Bug Fixes
    • Improved ballot evaluation by considering only finalized ballots during system state checks. This update enhances reliability and ensures that only confirmed ballots affect outcome determinations, leading to a more consistent and predictable experience for users.

@kingpinXD kingpinXD requested a review from a team as a code owner March 4, 2025 16:51
@kingpinXD kingpinXD added the no-changelog Skip changelog CI check label Mar 4, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The change modifies the logic in the EnsureNoStaleBallots function in the E2ERunner struct. Instead of directly using the creation height of the first ballot, the function now iterates over all ballots, checking for finalized ballots via the IsFinalized() method. When a finalized ballot is found, its creation height is used to set the firstBallotCreationHeight. The error handling and overall control flow remain intact.

Changes

File Path Change Summary
e2e/runner/require.go Modified EnsureNoStaleBallots to iterate through all ballots and use the creation height of finalized ballots instead of taking the first ballot directly.

Sequence Diagram(s)

sequenceDiagram
  participant Runner as E2ERunner
  participant BallotList as Ballots
  Runner->>BallotList: Retrieve ballotsRes.Ballots
  loop For each ballot in BallotList
    BallotList->>BallotList: Check IsFinalized()
    alt Ballot is finalized
      Note right of Runner: Update firstBallotCreationHeight
    end
  end
  Runner->>Runner: Compare firstBallotCreationHeight with staleBlockStart
Loading

Possibly related PRs

Suggested labels

TSS_MIGRATION_TESTS

Suggested reviewers

  • ws4charlie
  • skosito
  • lumtis
  • fbac
  • gartnera

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 generate docstrings to generate docstrings for this 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.

@kingpinXD kingpinXD added the UPGRADE_TESTS Run make start-upgrade-tests label Mar 4, 2025
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.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f104014 and 2a44a8b.

📒 Files selected for processing (1)
  • e2e/runner/require.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.go`: Review the Go code, point out issues relative to ...

**/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

  • e2e/runner/require.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: start-upgrade-test / e2e
  • GitHub Check: start-e2e-test / e2e

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

🧹 Nitpick comments (1)
e2e/runner/require.go (1)

65-65: Update function comment to reflect new behavior

The function comment should be updated to clearly indicate that it now only checks for stale finalized ballots, ignoring pending ones.

-// EnsureNoStaleBallots ensures that there are no stale ballots left on the chain.
+// EnsureNoStaleBallots ensures that there are no stale finalized ballots left on the chain.
+// Pending ballots are ignored as they are not considered stale.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f104014 and 2a44a8b.

📒 Files selected for processing (1)
  • e2e/runner/require.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.go`: Review the Go code, point out issues relative to ...

**/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

  • e2e/runner/require.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: start-upgrade-test / e2e
  • GitHub Check: start-e2e-test / e2e

@kingpinXD kingpinXD added this pull request to the merge queue Mar 4, 2025
Merged via the queue into develop with commit 06e66fb Mar 4, 2025
47 checks passed
@kingpinXD kingpinXD deleted the fix-ballots-check branch March 4, 2025 19:02
@coderabbitai coderabbitai bot mentioned this pull request May 14, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Skip changelog CI check UPGRADE_TESTS Run make start-upgrade-tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CI sometimes fails with stale ballots check

3 participants