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.

Sign up for GitHub

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

Jump to bottom

feat(gRPC): Add halt-height to gRPC Node Config Query #19043

Merged
merged 2 commits into from
Jan 12, 2024
Merged

feat(gRPC): Add halt-height to gRPC Node Config Query #19043

merged 2 commits into from
Jan 12, 2024

Conversation

alexanderbez
Copy link
Contributor

Description

Closes: #19032

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

@alexanderbez alexanderbez marked this pull request as ready for review January 12, 2024 18:50
@alexanderbez alexanderbez requested a review from a team as a code owner January 12, 2024 18:50
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 12, 2024 •
edited
Loading

Walkthrough

The code changes introduce a new feature that enables users to fetch the halt_height from a node's configuration via the gRPC endpoint. This update allows external systems to monitor and alert on the approach of the halt height, a critical value indicating when a blockchain node will stop processing blocks, usually in preparation for an upgrade or maintenance.

Changes

File Path Change Summary
CHANGELOG.md Added entry for the addition of halt_height to the gRPC /cosmos/base/node/v1beta1/config request.
api/.../v1beta1/query.pulsar.go
client/grpc/node/service.go		 Added halt_height field to the ConfigResponse struct.
client/grpc/node/service_test.go Updated TestServiceServer_Config to include halt_height and added an assertion to check its value.
proto/cosmos/base/node/v1beta1/query.proto Added halt_height field of type uint64 to the ConfigResponse message and reformatted minimum_gas_price.

Assessment against linked issues

Objective Addressed Explanation
Enable fetching the halt-height of a specific node via the API it exposes (LCD or Tendermint/CometBFT API). [#19032] ✅ -
Support the retrieval of halt-height to facilitate building alerts for upcoming upgrades and chain halts. [#19032] ✅ -
Facilitate the calculation of time remaining before a halt-height is reached. [#19032] ✅ The addition of halt_height allows external systems to calculate the remaining time.
Expose the halt-height metric from the exporter for Prometheus scraping. [#19032] ❓ The changes do not directly indicate the exposure of halt_height for Prometheus scraping.
Provide an API method to retrieve the node's halt-height, considering potential limitations or security concerns. [#19032] ✅ The addition of halt_height to the gRPC endpoint is a secure method to expose this information.

The code changes appear to address most of the objectives outlined in the linked issue. However, it is not clear from the changes alone whether the halt_height metric has been made available for Prometheus scraping, which would require additional context or code outside the scope of the provided snippets.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments 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 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.

@alexanderbez alexanderbez changed the title feat: Add halt-height to gRPC Node Config Query feat(gRPC): Add halt-height to gRPC Node Config Query Jan 12, 2024
@alexanderbez alexanderbez added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Jan 12, 2024
coderabbitai[bot]
coderabbitai bot reviewed Jan 12, 2024
View reviewed changes
client/grpc/node/service_test.go
ctx := sdk.Context{}.WithMinGasPrices(sdk.NewDecCoins(sdk.NewInt64DecCoin("stake", 15)))

resp, err := svr.Config(ctx, &ConfigRequest{})
require.NoError(t, err)
require.NotNil(t, resp)
require.Equal(t, ctx.MinGasPrices().String(), resp.MinimumGasPrice)
require.Equal(t, defaultCfg.HaltHeight, resp.HaltHeight)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new assertion correctly checks if the HaltHeight in the response matches the defaultCfg. Consider adding a test case to cover scenarios where HaltHeight is set to a non-default value.

@alexanderbez alexanderbez added this pull request to the merge queue Jan 12, 2024
Merged via the queue into main with commit af41599 Jan 12, 2024
51 of 60 checks passed
@alexanderbez alexanderbez deleted the bez/19032 branch January 12, 2024 21:44
mergify bot pushed a commit that referenced this pull request Jan 12, 2024
@alexanderbez @mergify
feat(gRPC): Add halt-height to gRPC Node Config Query (#19043)
6ea1d83 
(cherry picked from commit af41599)

# Conflicts:
#	CHANGELOG.md
@mergify mergify bot mentioned this pull request Jan 12, 2024
Merged
julienrbrt added a commit that referenced this pull request Jan 13, 2024
@mergify @alexanderbez @julienrbrt
feat(gRPC): Add halt-height to gRPC Node Config Query (backport #19043)…
8ac0492 
… (#19044)

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
@alexanderbez @relyt29
feat(gRPC): Add halt-height to gRPC Node Config Query (cosmos#19043)
f4b0f12
@faddat faddat mentioned this pull request Nov 8, 2024
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@julienrbrt julienrbrt julienrbrt approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

@facundomedica facundomedica Awaiting requested review from facundomedica

@atheeshp atheeshp Awaiting requested review from atheeshp

Assignees
No one assigned
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature]: Have a way to fetch halt-height from the node API somehow
3 participants
@alexanderbez @tac0turtle @julienrbrt