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

test: fixes e2e test failures due to increased timeout propose and timeout commit #3718

Merged
merged 28 commits into from
Aug 6, 2024

Conversation

staheri14
Copy link
Contributor

@staheri14 staheri14 commented Jul 22, 2024

The e2e tests started failing due to a recent change to the node configurations, which unintentionally increased the timeout propose and timeout commit of all validators in all e2e tests to 10 and 11 seconds (link). This caused the E2ESimple test to fail due to its short test duration 30 seconds and insufficient network progress due to the high block time (due to these, there were not enough txs at the end of the test). The MajorUpgradeToV2 also seemed to fail for similar reasons (related to timeouts).

The current PR addresses the problem by retracting the initial timeout propose and timeout commit i.e., 3 and 1 seconds, respectively. This will resolve the issue and make all the e2e tests pass.

@staheri14 staheri14 self-assigned this Jul 22, 2024
@staheri14 staheri14 added the testing items that are strictly related to adding or extending test coverage label Jul 22, 2024
@staheri14
Copy link
Contributor Author

Will open it for reviews once this PR gets merged.

@staheri14
Copy link
Contributor Author

staheri14 commented Aug 6, 2024

I can confirm that all the e2e tests (i.e., MajorUpgradeToV2, MinorVersionCompatibility, and E2ESimple) pass in this branch. Among the benchmark tests, I ran TwoNodeBigBlock64MB for sample, it also worked fine.

@staheri14 staheri14 marked this pull request as ready for review August 6, 2024 16:46
@staheri14 staheri14 requested a review from a team as a code owner August 6, 2024 16:46
@staheri14 staheri14 requested review from rach-id and evan-forbes and removed request for a team August 6, 2024 16:46
Copy link
Contributor

coderabbitai bot commented Aug 6, 2024

Walkthrough

Walkthrough

The recent changes enhance the configuration and performance of the BenchmarkTest class and the transaction setup in the testing framework. New parameters for transaction indexing and memory pool management have been introduced, allowing for improved performance during benchmark tests. The configurability of the MakeConfig function has also been increased by replacing hardcoded values with flexible options, supporting diverse operational contexts.

Changes

Files Change Summary
test/e2e/benchmark/benchmark.go Updated SetupNodes function to include new parameters for transaction indexing and mempool settings.
test/e2e/testnet/setup.go Added new functional options for transaction indexer and mempool configurations; replaced hardcoded timeout values.

Sequence Diagram(s)

sequenceDiagram
    participant B as BenchmarkTest
    participant C as Configuration
    participant T as Transaction Indexer
    participant M as Mempool

    B->>C: SetupNodes(WithTxIndexer, WithMempoolMaxTxsBytes, WithMempoolMaxTxBytes)
    C->>T: Configure Transaction Indexer
    C->>M: Configure Mempool Settings
    T->>B: Return Transaction Indexer Status
    M->>B: Return Mempool Configuration
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6fb8507 and 80e1eb8.

Files selected for processing (2)
  • test/e2e/benchmark/benchmark.go (1 hunks)
  • test/e2e/testnet/setup.go (2 hunks)
Additional comments not posted (5)
test/e2e/testnet/setup.go (4)

18-19: LGTM!

The changes align the timeout settings with the default consensus configuration, enhancing configurability and maintainability.


80-84: LGTM!

The new WithTxIndexer function correctly implements the customization of the transaction indexer.


86-90: LGTM!

The new WithMempoolMaxTxsBytes function correctly implements the customization of the maximum transaction bytes in the mempool.


92-96: LGTM!

The new WithMempoolMaxTxBytes function correctly implements the customization of the maximum transaction bytes in the mempool.

test/e2e/benchmark/benchmark.go (1)

73-75: LGTM!

The enhancements to the SetupNodes function improve performance and resource management during benchmark tests. The new parameters are correctly integrated.


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@staheri14 staheri14 enabled auto-merge (squash) August 6, 2024 16:49
@rootulp
Copy link
Collaborator

rootulp commented Aug 6, 2024

The e2e tests started failing due to a recent change to the node configurations, which unintentionally increased the timeout propose and timeout commit of all validators in all e2e tests to 10 and 11 seconds (link).

I'm confused because TimeoutPropose and TimeoutCommit hasn't been modified for a year (see git blame). That's the case on main, v1.x, and v2.x. What am I missing?

test/e2e/testnet/setup.go Show resolved Hide resolved
@staheri14 staheri14 merged commit 6b01740 into main Aug 6, 2024
32 of 34 checks passed
@staheri14 staheri14 deleted the sanaz/fix-failing-e2etests branch August 6, 2024 17:03
@staheri14
Copy link
Contributor Author

staheri14 commented Aug 6, 2024

I'm confused because TimeoutPropose and TimeoutCommit hasn't been modified for a year (see git blame). That's the case on main, v1.x, and v2.x. What am I missing?

I see where the confusion comes from, the issue resolved in this PR is not about the values of timeout_commit and timeout_propose in the app default configs (or the cometBFT default configs), rather which configs we use in the e2e tests.

ninabarbakadze pushed a commit that referenced this pull request Aug 7, 2024
…meout commit (#3718)

The e2e tests started failing due to a recent change to the node
configurations, which unintentionally increased the timeout propose and
timeout commit of all validators in all e2e tests to `10` and `11`
seconds
([link](https://github.com/celestiaorg/celestia-app/blob/9fa9fbf2fc347752dfe67aa3eca6dc157d3f3291/pkg/appconsts/consensus_consts.go#L6-L7)).
This caused the `E2ESimple` test to fail due to its short test duration
`30` seconds and insufficient network progress due to the high block
time (due to these, there were not enough txs at the end of the test).
The `MajorUpgradeToV2` also seemed to fail for similar reasons (related
to timeouts).

The current PR addresses the problem by retracting the initial timeout
propose and timeout commit i.e., `3` and `1` seconds, respectively. This
will resolve the issue and make all the e2e tests pass.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testing items that are strictly related to adding or extending test coverage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants