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: in-place-testnet edgecases #19516

Merged
merged 3 commits into from
Feb 22, 2024
Merged

Conversation

czarcas7ic
Copy link
Contributor

@czarcas7ic czarcas7ic commented Feb 21, 2024

Description

Closes: #XXXX

Killing a node, setting a halt height, and gracefully shutting down cause varying states of the block height across app/blockStore/state. This PR handles these states properly.

Additionally, there was an edge case where if prometheus was enabled, it would panic due to setting it a second time in testnetify. We don't actually need the metrics provider to match what the user wants in testnetify since this is just used temporarily while setting up the application, so we use the default config of instrumentation to prevent this panic from happening.


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

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

  • Refactor
    • Updated metrics provider configuration for better performance and reliability.
    • Improved handling of block and state heights to enhance node robustness under various conditions.

Copy link
Contributor

coderabbitai bot commented Feb 21, 2024

Walkthrough

Walkthrough

This update focuses on enhancing the metrics collection by adopting a default configuration for instrumentation and refining the logic related to block and state heights. It addresses scenarios such as node stoppages and discrepancies in blockstore heights, ensuring more accurate and reliable metrics and state management within the system.

Changes

Files Change Summary
server/start.go - Updated metrics provider to use cmtcfg.DefaultConfig().Instrumentation.
- Modified logic for handling block and state heights in special conditions.

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.

server/start.go Fixed Show fixed Hide fixed
@czarcas7ic czarcas7ic marked this pull request as ready for review February 22, 2024 00:23
@czarcas7ic czarcas7ic requested a review from a team as a code owner February 22, 2024 00:23
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.yml

Commits Files that changed from the base of the PR and between 541df89 and a4f070a.
Files selected for processing (1)
  • server/start.go (2 hunks)
Additional comments: 6
server/start.go (6)
  • 783-783: The code initializes default metrics for the node, which is a good practice for monitoring and debugging. However, it's important to ensure that the metrics being collected are relevant and useful for the application's performance and health monitoring.
  • 804-815: The logic here handles the case where the state's last blockstore height does not match the app and blockstore height, likely due to stopping with the halt height flag. This is a critical piece of logic for ensuring data consistency. However, it's essential to ensure that this logic is thoroughly tested, especially for edge cases where the application might not shut down gracefully.
  • 817-817: This section handles the case where the blockStore height is greater than the state's last block height, typically occurring when the node is gracefully stopped. Deleting the latest block to align the heights is a crucial operation for maintaining state consistency. It's important to ensure that this operation does not inadvertently remove necessary data and that there are safeguards against data corruption.
  • 783-783: The use of node.DefaultMetricsProvider to initialize metrics with default configuration is a good practice for ensuring that the application has the necessary instrumentation for monitoring and observability. This aligns with the PR's objective to handle the Prometheus metrics provider configuration more gracefully.
  • 804-815: The handling of the state's last block height and app hash in the case of a mismatch between the application and blockstore heights is crucial for ensuring the consistency of the blockchain state. This logic appears to be well-thought-out, but it's essential to ensure that it is covered by unit tests, especially since it deals with critical state management.
  • 817-817: Deleting the latest block when the blockstore height is greater than the state's last block height is a sensitive operation that must be handled with care to avoid data loss. It's important to ensure that there are adequate checks and balances in place to prevent accidental deletion of critical data.

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Feb 22, 2024
@facundomedica facundomedica added this pull request to the merge queue Feb 22, 2024
Merged via the queue into main with commit 35fe6c4 Feb 22, 2024
60 of 61 checks passed
@facundomedica facundomedica deleted the adam/in-place-testnet-edgecases branch February 22, 2024 13:23
mergify bot pushed a commit that referenced this pull request Feb 22, 2024
julienrbrt pushed a commit that referenced this pull request Feb 23, 2024
Co-authored-by: Adam Tucker <adam@osmosis.team>
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Mar 27, 2024
…0.50.5

* fix: in-place-testnet edgecases (backport cosmos#19516) (cosmos#19526)

Co-authored-by: Adam Tucker <adam@osmosis.team>

* fix(simapp): typo in GetStoreKeys (cosmos#19544)

* build(deps): Bump cosmossdk.io/math from 1.2.0 to 1.3.0 (cosmos#19562)

* fix(depinject): Authtx was not accepting custom signers (backport cosmos#19549) (cosmos#19551)

Co-authored-by: Devon Bear <itsdevbear@berachain.com>
Co-authored-by: Qt <golang.chen@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): Bump github.com/cosmos/cosmos-db from 1.0.0 to 1.0.2 (cosmos#19566)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* Merge pull request from GHSA-86h5-xcpx-cfqc

* fix slashing hole with test

* release notes + changelog

* word

* date

* updates

---------

Co-authored-by: Julien Robert <julien@rbrt.fr>

* ci: run test pipeline on merge v0.50 branch (cosmos#19582)

* fix(staking): fix impossible conditions (cosmos#19621)

* docs: add section on creating a testnets from mainnet exports (backport cosmos#19475) (cosmos#19648)

Co-authored-by: Marko <marbar3778@yahoo.com>

* build(deps): Bump cosmossdk.io/x/tx from 0.13.0 to 0.13.1 (cosmos#19665)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* feat(client/v2): marshal enum as string (cosmos#19653)

* refactor(x/auth): allow empty public keys for GetSignBytesAdapter (backport cosmos#19651) (cosmos#19675)

Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(types): check for HasABCIGenesis in CoreAppModuleBasicAdaptor (cosmos#19709)

* build(deps): Bump deps (backport cosmos#19655) (cosmos#19711)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* Merge pull request from GHSA-95rx-m9m5-m94v

* validate ExtendedCommit against LastCommit

test cases

* account for core.comet types

* logging

* linting

* cherry-pick staking fix

* nits

* linting fix

* run tests

---------

Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Marko Baricevic <markobaricevic3778@gmail.com>

* feat(baseapp): add option to disable block gas meter (cosmos#19626)

* feat(x/distribution): add rewards-by-validator autocli config (backport cosmos#19707) (cosmos#19714)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(x/gov): grpc query tally for failed proposal (backport cosmos#19725) (cosmos#19727)

Co-authored-by: David Tumcharoen <david@alleslabs.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* chore: prepare v0.50.5 (cosmos#19715)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Adam Tucker <adam@osmosis.team>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Devon Bear <itsdevbear@berachain.com>
Co-authored-by: Qt <golang.chen@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: khanh <50263489+catShaark@users.noreply.github.com>
Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Nikhil Vasan <97126437+nivasan1@users.noreply.github.com>
Co-authored-by: Marko Baricevic <markobaricevic3778@gmail.com>
Co-authored-by: David Tumcharoen <david@alleslabs.com>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants