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

Problem: sdk v0.47.x is outdated #1329

Merged
merged 7 commits into from
Feb 28, 2024
Merged

Conversation

mmsqe
Copy link
Collaborator

@mmsqe mmsqe commented Feb 27, 2024

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features

    • Integration testing configurations now support RocksDB as a database backend.
    • Added a new chain ID cronos_777-1 for app configurations in integration tests.
  • Refactor

    • Improved chain ID assertion in integration tests with timeout handling for better consensus failure checks.

Copy link
Contributor

coderabbitai bot commented Feb 27, 2024

Walkthrough

The recent updates involve enhancing a JSON configuration file and refining a test script. The configuration now supports RocksDB as its database backend and specifies a unique chain_id for better network identification. Additionally, improvements in a test function include timeout handling for block waiting and checks for consensus failure, ensuring robustness in test execution and reliability in network operations.

Changes

File Path Change Summary
.../configs/default.jsonnet Added db_backend: 'rocksdb' and chain_id: 'cronos_777-1' to the configuration.
.../test_client_id.py Modified assert_chain_id to include a timeout parameter and added logic for consensus failure.
.../test_chain_id.py Updated assert_chain_id with timeout handling using pytest.raises for block waiting.
CHANGELOG.md Introduces a bug fix by updating cosmos-sdk to version v0.47.10 in an unreleased version.

Poem

🐰💻
In the land of code and byte,
A rabbit hopped, by day and night.
"Add RocksDB, chain_id too,
Make our tests robust, through and through."
With a hop and a skip, the changes were made,
In the realm of blockchain, our marks were laid.
🌟📚

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.

@yihuang yihuang changed the title Problem: different db are not tested when change client id Problem: different db are not tested when change chain id Feb 28, 2024
@mmsqe mmsqe changed the title Problem: different db are not tested when change chain id Problem: sdk v0.47.x is outdated Feb 28, 2024
@mmsqe mmsqe marked this pull request as ready for review February 28, 2024 01:34
@mmsqe mmsqe requested a review from a team as a code owner February 28, 2024 01:34
@mmsqe mmsqe requested review from yihuang and JayT106 and removed request for a team February 28, 2024 01:34
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: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 76a35e8 and f31dc65.
Files ignored due to path filters (3)
  • go.mod is excluded by: !**/*.mod
  • go.sum is excluded by: !**/*.sum
  • gomod2nix.toml is excluded by: !**/*.toml
Files selected for processing (2)
  • integration_tests/configs/default.jsonnet (1 hunks)
  • integration_tests/test_client_id.py (2 hunks)
Additional comments: 3
integration_tests/test_client_id.py (1)
  • 36-36: The call to assert_chain_id(776, 5) correctly uses the newly introduced timeout parameter. This demonstrates an understanding of the function's enhanced capabilities. However, ensure that the integration tests cover scenarios where the timeout is not triggered to validate the function's behavior in both timeout and non-timeout scenarios.

This usage of the assert_chain_id function with a timeout parameter is a good example of leveraging the new functionality for more robust testing.

integration_tests/configs/default.jsonnet (2)
  • 7-7: The addition of db_backend: 'rocksdb' to the configuration is a significant change, as it switches the database backend from the default (likely LevelDB) to RocksDB. This change can have implications for performance, storage efficiency, and operational characteristics. It's important to ensure that:
  1. Compatibility: All parts of the application that interact with the database are compatible with RocksDB.
  2. Migration: If the application is transitioning from another database backend, a migration strategy is in place for existing data.
  3. Performance Testing: Performance characteristics are tested and validated, as RocksDB may perform differently under various workloads compared to the previous backend.

Consider verifying the compatibility of RocksDB with the application, outlining a migration strategy for existing data if necessary, and conducting performance testing to ensure that the new backend meets the application's requirements.

  • 13-13: Specifying the chain ID as 'cronos_777-1' in the app-config section is crucial for network identification and interaction. This change ensures that the application is correctly configured for the specified blockchain network. It's important to verify that this chain ID aligns with the network's expected configuration and that all network participants are aware of and using the correct chain ID.

The explicit setting of the chain ID is a positive step towards ensuring consistency and clarity in network configuration.

integration_tests/test_client_id.py Outdated Show resolved Hide resolved
go.mod Show resolved Hide resolved
@mmsqe mmsqe enabled auto-merge February 28, 2024 01:49
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: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f31dc65 and 9fd2170.
Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • integration_tests/test_chain_id.py (2 hunks)
Additional comments: 1
CHANGELOG.md (1)
  • 7-7: The entry for the bug fix related to updating the cosmos-sdk to version v0.47.10 is correctly formatted and follows the standard convention used in the rest of the CHANGELOG.md file. It provides a direct link to the pull request, which is helpful for users or developers looking for more details about the change. This entry is clear and concise, effectively communicating the change made.

integration_tests/test_chain_id.py Show resolved Hide resolved
integration_tests/test_chain_id.py Show resolved Hide resolved
@mmsqe mmsqe added this pull request to the merge queue Feb 28, 2024
Merged via the queue into crypto-org-chain:main with commit 01d9dc6 Feb 28, 2024
43 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Mar 5, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants