Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: mock CheckTx call for mempool recheck #1559

Merged
merged 1 commit into from
Feb 23, 2024
Merged

Conversation

tzdybal
Copy link
Member

@tzdybal tzdybal commented Feb 22, 2024

Overview

Closes: #1558

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Tests
    • Enhanced the TestMempool2Nodes function to include a new expectation for transaction checks, ensuring more robust testing of transaction handling.

@tzdybal tzdybal added the T:testing Related to testing label Feb 22, 2024
@tzdybal tzdybal self-assigned this Feb 22, 2024
Copy link
Contributor

coderabbitai bot commented Feb 22, 2024

Walkthrough

The recent update primarily focuses on enhancing the stability and correctness of the TestMempool2Nodes function. By introducing a new expectation for the CheckTx method to handle a specific Type parameter and ensuring it returns a Code: 0 response, the changes aim at reducing test flakiness and aligning method call expectations with actual behavior, addressing key issues related to mempool and block synchronization.

Changes

Files Change Summary
node/full_client_test.go Added expectation for CheckTx with specific Type, returning Code: 0.

Assessment against linked issues

Objective Addressed Explanation
Objective 1-5, 7-10 (#1558) The summary mentions addressing a specific issue in CheckTx, which could impact these areas, but without details on how each objective is specifically addressed, it's unclear.
Objective 6 (#1558): Review CheckTxAsync and recheckTxs methods. No mention of modifications to CheckTxAsync and recheckTxs methods in the summary.

Poem

In the land of code, where the bugs do roam,
A rabbit hopped in, making it home.
With a flick of its ear, a twist of its tail,
The flakiness gone, the rabbit prevails.
🌟 In tests and in mempool, it danced with glee,
For stability's sake, a victory spree.
"Hop, hop, hooray!" it cheerfully sings,
As into the sunset, it softly springs. 🐇💻✨

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>.
    • Generate unit-tests for this file.
  • 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 from git 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.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8736541 and a88640e.
Files selected for processing (1)
  • node/full_client_test.go (1 hunks)
Additional comments: 1
node/full_client_test.go (1)
  • 837-837: The addition of a .Maybe() expectation for the CheckTx method with a Type parameter set to abci.CheckTxType_Recheck and a Code of 0 is a targeted fix to address the test flakiness by ensuring that rechecks of transactions in the mempool are handled correctly. This change aligns with the PR objectives to stabilize the TestMempool2Nodes test by ensuring the CheckTx method behaves as expected during the recheck process in the mempool. It's a good practice to explicitly set expectations for mock method calls, especially in tests that involve conditional logic or state changes, such as rechecking transactions in a mempool. This ensures that the test accurately reflects the intended behavior of the system under test and can help prevent flakiness by making the test's assumptions and requirements clear.

@tzdybal tzdybal added this pull request to the merge queue Feb 23, 2024
Merged via the queue into main with commit 47be8c6 Feb 23, 2024
26 checks passed
@tzdybal tzdybal deleted the tzdybal/fix/mempool2nodes branch February 23, 2024 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:testing Related to testing
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

TestMempool2Nodes is flaky
3 participants