-
Notifications
You must be signed in to change notification settings - Fork 326
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add health checkup mechanism (#1145)
* Added health checkup mechanism for CosmosSDK * Added SDK compat diagnostic check * Added fix for leading v in semver * Lowered log to warn. Added early exit * Reverted the one-chain patch to enable indexing * changelog * Improve health_checkup async code flow * Tentative fix for tx_search parsing error bug which Soares found. * Update compatibility version bound to v0.42.6 to work with gaia v5.0.0 * Aesthetic & comments improvements. * Removed stale tracing import (became stale after rebasing onto master) Co-authored-by: Soares Chen <soares.chen@maybevoid.com>
- Loading branch information
1 parent
de62a4b
commit 3da7dc1
Showing
7 changed files
with
281 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| //! Cosmos-SDK compatibility constants and helper methods. | ||
|
|
||
| use thiserror::Error; | ||
|
|
||
| use ibc_proto::cosmos::base::tendermint::v1beta1::VersionInfo; | ||
|
|
||
| /// Specifies the SDK module path, as it is expected to appear | ||
| /// in the application version information. | ||
| /// | ||
| /// The module identification is captured in a [`Module`] | ||
| /// with the following structure as an example: | ||
| /// ```json,ignore | ||
| /// Module { | ||
| /// path: "github.com/cosmos/cosmos-sdk", | ||
| /// version: "v0.42.4", | ||
| /// sum: "h1:yaD4PyOx0LnyfiWasC5egg1U76lT83GRxjJjupPo7Gk=", | ||
| /// }, | ||
| /// ``` | ||
| const SDK_MODULE_NAME: &str = "cosmos/cosmos-sdk"; | ||
|
|
||
| /// Specifies the SDK module version requirement. | ||
| /// | ||
| /// # Note: Should be consistent with [features] guide page. | ||
| /// | ||
| /// [features]: https://hermes.informal.systems/features.html | ||
| const SDK_MODULE_VERSION_REQ: &str = ">=0.41.3, <=0.42.6"; | ||
|
|
||
| /// Helper struct to capture all the reported information of an | ||
| /// IBC application, e.g., `gaiad`. | ||
| #[derive(Clone, Debug)] | ||
| pub struct AppInfo { | ||
| app_name: String, | ||
| version: String, | ||
| git_commit: String, | ||
| } | ||
|
|
||
| impl std::fmt::Display for AppInfo { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| write!(f, "{}:{}-{}", self.app_name, self.version, self.git_commit) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Error, Debug)] | ||
| pub enum Diagnostic { | ||
| #[error("no SDK module '{pattern}' was found for application {app}")] | ||
| SdkModuleNotFound { pattern: String, app: AppInfo }, | ||
|
|
||
| #[error("failed parsing the SDK module ('{module_path}') version number '{raw_version}' into a semver for application {app}; cause: {cause}")] | ||
| VersionParsingFailed { | ||
| module_path: String, | ||
| raw_version: String, | ||
| cause: String, | ||
| app: AppInfo, | ||
| }, | ||
|
|
||
| #[error("SDK module at version '{found}' does not meet compatibility requirements {requirements} for application {app}")] | ||
| MismatchingSdkModuleVersion { | ||
| requirements: String, | ||
| found: String, | ||
| app: AppInfo, | ||
| }, | ||
| } | ||
|
|
||
| /// Runs a diagnostic check on the provided [`VersionInfo`] | ||
| /// to ensure that the Sdk module version matches the | ||
| /// predefined requirements. | ||
| /// | ||
| /// Returns `None` upon success, or a [`Diagnostic`] upon | ||
| /// an error. | ||
| /// | ||
| /// Relies on the constant [`SDK_MODULE_NAME`] to find the | ||
| /// Sdk module by name, as well as the constant | ||
| /// [`SDK_MODULE_VERSION_REQ`] for version compatibility | ||
| /// requirements. | ||
| pub(crate) fn run_diagnostic(v: VersionInfo) -> Option<Diagnostic> { | ||
| let app_info = AppInfo { | ||
| app_name: v.app_name, | ||
| version: v.version, | ||
| git_commit: v.git_commit, | ||
| }; | ||
|
|
||
| // Parse the requirements into a semver | ||
| let reqs = semver::VersionReq::parse(SDK_MODULE_VERSION_REQ) | ||
| .expect("parsing the SDK module requirements into semver"); | ||
|
|
||
| // Find the Cosmos SDK module | ||
| match v | ||
| .build_deps | ||
| .iter() | ||
| .find(|&m| m.path.contains(SDK_MODULE_NAME)) | ||
| { | ||
| None => Some(Diagnostic::SdkModuleNotFound { | ||
| pattern: SDK_MODULE_NAME.to_string(), | ||
| app: app_info, | ||
| }), | ||
| Some(sdk_module) => { | ||
| // The raw version number has a leading 'v', trim it out; | ||
| let plain_version = sdk_module.version.trim_start_matches('v'); | ||
|
|
||
| // Parse the module version | ||
| match semver::Version::parse(plain_version).map_err(|e| { | ||
| Diagnostic::VersionParsingFailed { | ||
| module_path: sdk_module.path.clone(), | ||
| raw_version: sdk_module.version.clone(), | ||
| cause: e.to_string(), | ||
| app: app_info.clone(), | ||
| } | ||
| }) { | ||
| // Finally, check the version requirements | ||
| Ok(v) => match reqs.matches(&v) { | ||
| true => None, | ||
| false => Some(Diagnostic::MismatchingSdkModuleVersion { | ||
| requirements: SDK_MODULE_VERSION_REQ.to_string(), | ||
| found: v.to_string(), | ||
| app: app_info, | ||
| }), | ||
| }, | ||
| Err(d) => Some(d), | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.