test: fix flaky Snapshotter test

[alpe]

Description

Part of #21804

Sometimes the pruning job started by the test is not completed before the test reaches the checkpoint (L55 before).
By refactoring this part to the await pattern and increasing the max timeout to 6s, the test should become stable and faster in the optimal scenario.

require.Eventually(t, func() bool { return txm2.Size() == 0 }, 6*time.Second, 500*time.Millisecond)

---

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

• Tests
  • Improved the responsiveness of the transaction manager's testing by replacing fixed sleep calls with a dynamic wait mechanism.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve updates to the test function TestSnapshotter in the snapshotter_test.go file. The modifications focus on improving the timing and synchronization logic associated with the transaction manager's background purge loop. The previous implementation relied on fixed sleep intervals, which have been replaced with a more dynamic approach using require.Eventually to verify the transaction manager's size within a specified timeout.

Changes

File Path	Change Summary
x/auth/ante/unorderedtx/snapshotter_test.go	Removed fixed time.Sleep calls and introduced require.Eventually to check transaction manager size.

Possibly related PRs

• test(server/v2): Add system-test for store's command #21357: Introduces system tests for snapshot management, closely related to the transaction manager's background purge logic.
• refactor(systemtest): Add cli.RunAndWait for common operations #21689: Adds cli.RunAndWait to improve transaction execution handling, aligning with the focus on test responsiveness.
• fix(systemtest): upgrade test #21877: Adjusts the upgrade test's halt height, relating to timing and synchronization aspects in the blockchain context.

Suggested labels

Type: CI

Suggested reviewers

• kocubinski
• sontrinh16
• tac0turtle

---

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

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (2)

x/auth/ante/unorderedtx/snapshotter_test.go (2)

52-54: Approve changes with a minor suggestion

The replacement of time.Sleep calls with require.Eventually is a significant improvement that addresses the flaky test issue. This change makes the test more robust and less dependent on fixed timing.

Consider updating the comment on line 53 to better reflect the new waiting mechanism:

- // the loop runs every 5 seconds, so we need to wait for that
+ // Wait for the background purge loop to complete (runs every 5 seconds)

This change would make the comment more accurate and informative in the context of the new implementation.

---

Additional Instances of time.Sleep Found in Test Files

The search revealed several instances of time.Sleep in the following test files:

• store/rootmulti/store_test.go
• store/snapshots/helpers_test.go
• store/v2/snapshots/store_test.go
• store/v2/root/migrate_test.go
• baseapp/baseapp_test.go

Refactoring these tests to replace fixed sleep durations with adaptive waiting mechanisms can further improve the reliability and stability of the test suite.

Analysis chain

Line range hint 1-70: Overall improvement with potential for further enhancement

The changes successfully address the flaky test issue by replacing fixed sleep durations with a more adaptive waiting mechanism. This improvement aligns well with the PR objectives and enhances the test's reliability.

Consider extending this improvement to other parts of the test suite where similar timing-dependent assertions are made. This could further enhance the overall stability of the test suite.

To identify other potential candidates for similar improvements, we can search for other uses of time.Sleep in test files:

This will help identify other test files that might benefit from a similar refactoring approach.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for time.Sleep usage in test files
rg --type go -g '*_test.go' 'time\.Sleep' -C 3

Length of output: 3445

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5590c16 and 5eb4e16.

Files selected for processing (1)

• x/auth/ante/unorderedtx/snapshotter_test.go (1 hunks)

Additional context used

Path-based instructions (1)

x/auth/ante/unorderedtx/snapshotter_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"