-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #164 from mindvalley/feat/display-upgrade-option
PXP-628: [CLI]: Display new release info banner
- Loading branch information
Showing
15 changed files
with
243 additions
and
20 deletions.
There are no files selected for viewing
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
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 |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ mod error; | |
| mod loader; | ||
| mod logger; | ||
| pub mod output; | ||
| mod update; | ||
| mod utils; | ||
| mod wukong_client; | ||
|
|
||
|
|
||
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,196 @@ | ||
| use crate::{ | ||
| config::{Config, UpdateCheck}, | ||
| utils::compare_with_current_time, | ||
| }; | ||
| use aion::*; | ||
| use chrono::Utc; | ||
| use clap::crate_version; | ||
| use log::debug; | ||
| use owo_colors::OwoColorize; | ||
| use reqwest::Client; | ||
| use semver::Version; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| const WUKONG_GITHUB_REPO: &str = "mindvalley/wukong-cli"; | ||
| const GITHUB_API_URL: &str = "https://api.github.com"; | ||
|
|
||
| #[derive(Debug, Serialize, Deserialize)] | ||
| pub struct GithubLatestReleaseInfo { | ||
| pub tag_name: String, | ||
| pub url: String, | ||
| pub published_at: String, | ||
| pub html_url: String, | ||
| } | ||
|
|
||
| // check_for_update checks whether this wukong has had a newer release on Github | ||
| pub async fn check_for_update() { | ||
| let last_updated_at = get_last_update_checked_at(); | ||
|
|
||
| if let Some(last_updated_at) = last_updated_at { | ||
| let last_update_checked_since = compare_with_current_time(&last_updated_at); | ||
|
|
||
| if last_update_checked_since >= -(72.hours()) { | ||
| debug!("No need to check for update"); | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| debug!("Checking for update"); | ||
|
|
||
| if let Some(latest_release_info) = get_latest_release_info(GITHUB_API_URL).await { | ||
| update_last_update_checked_at(); | ||
| print_update_message(latest_release_info); | ||
| } | ||
| } | ||
|
|
||
| fn print_update_message(latest_release_info: GithubLatestReleaseInfo) { | ||
| let current_version = crate_version!().to_string(); | ||
|
|
||
| let has_update = version_greater_than(&latest_release_info.tag_name, ¤t_version); | ||
|
|
||
| if has_update { | ||
| debug!("New release found"); | ||
| eprintln!( | ||
| "{} {} {} {}", | ||
| "A new release of wukong is available:".yellow(), | ||
| current_version.cyan(), | ||
| "→".cyan(), | ||
| latest_release_info.tag_name.cyan(), | ||
| ); | ||
|
|
||
| eprintln!("To upgrade, run: brew update && brew upgrade wukong"); | ||
| eprintln!("{}", latest_release_info.url.yellow()); | ||
| } else { | ||
| debug!("No new release found"); | ||
| } | ||
| } | ||
|
|
||
| fn get_last_update_checked_at() -> Option<String> { | ||
| let config = Config::load_from_default_path().map_err(|e| { | ||
| debug!("Error: {:?}", e); | ||
| }); | ||
|
|
||
| if let Ok(config) = config { | ||
| if let Some(config) = config.update_check { | ||
| return Some(config.last_update_checked_at); | ||
| } | ||
| } | ||
|
|
||
| None | ||
| } | ||
|
|
||
| fn update_last_update_checked_at() { | ||
| let config = Config::load_from_default_path(); | ||
|
|
||
| match config { | ||
| Ok(mut config) => { | ||
| config.update_check = Some(UpdateCheck { | ||
| last_update_checked_at: Utc::now().to_rfc3339(), | ||
| }); | ||
|
|
||
| let _ = config.save_to_default_path().map_err(|e| { | ||
| debug!("Error: {:?}", e); | ||
| }); | ||
| } | ||
| Err(e) => { | ||
| debug!("Error: {:?}", e); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| fn version_greater_than(new_version: &str, current_version: &str) -> bool { | ||
| if let (Ok(new_version), Ok(current_version)) = | ||
| (Version::parse(new_version), Version::parse(current_version)) | ||
| { | ||
| new_version > current_version | ||
| } else { | ||
| false | ||
| } | ||
| } | ||
|
|
||
| async fn get_latest_release_info(github_api_url: &str) -> Option<GithubLatestReleaseInfo> { | ||
| let client = Client::new(); | ||
|
|
||
| let url = format!( | ||
| "{}/repos/{}/releases/latest", | ||
| github_api_url, WUKONG_GITHUB_REPO | ||
| ); | ||
|
|
||
| let response = client | ||
| .get(&url) | ||
| .header("user-agent", "wukong-cli") | ||
| .send() | ||
| .await | ||
| .map_err(|e| { | ||
| debug!("Error: {:?}", e); | ||
| }); | ||
|
|
||
| if let Ok(response) = response { | ||
| let github_release_info = response | ||
| .json::<GithubLatestReleaseInfo>() | ||
| .await | ||
| .map_err(|e| { | ||
| debug!("Error: {:?}", e); | ||
| }); | ||
|
|
||
| if let Ok(github_release_info) = github_release_info { | ||
| return Some(github_release_info); | ||
| } | ||
| } | ||
|
|
||
| None | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
| use httpmock::prelude::*; | ||
|
|
||
| #[test] | ||
| fn test_version_greater_than() { | ||
| // Test cases for version comparison. | ||
| assert!(version_greater_than("1.1.0", "1.0.0")); | ||
| assert!(!version_greater_than("1.0.0", "1.1.0")); | ||
| assert!(!version_greater_than("1.0.0", "1.0.0")); | ||
| assert!(!version_greater_than("invalid", "1.0.0")); | ||
| assert!(!version_greater_than("1.0.0", "invalid")); | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn test_get_latest_release_info() { | ||
| let server = MockServer::start(); | ||
|
|
||
| let api_resp = r#"{ | ||
| "url": "https://github.com/mindvalley/wukong-cli/releases/tag/1.2.0", | ||
| "html_url": "https://github.com/mindvalley/wukong-cli/releases/tag/1.2.0", | ||
| "id": 120063991, | ||
| "tag_name": "1.2.0", | ||
| "published_at": "2023-09-06T07:08:46Z", | ||
| "body": null | ||
| }"#; | ||
|
|
||
| let url = format!("/repos/{}/releases/latest", WUKONG_GITHUB_REPO); | ||
|
|
||
| let mock_server = server.mock(|when, then| { | ||
| when.method(GET) | ||
| .path(url) | ||
| .header("user-agent", "wukong-cli"); | ||
| then.status(200) | ||
| .header("content-type", "application/json; charset=UTF-8") | ||
| .body(api_resp); | ||
| }); | ||
| println!("{:?}", &server.base_url()); | ||
|
|
||
| let release_info = get_latest_release_info(&server.base_url()).await; | ||
|
|
||
| mock_server.assert(); | ||
|
|
||
| let release_info = release_info.unwrap(); | ||
| assert_eq!(release_info.tag_name, "1.2.0"); | ||
| assert_eq!(release_info.published_at, "2023-09-06T07:08:46Z"); | ||
| assert_eq!( | ||
| release_info.url, | ||
| "https://github.com/mindvalley/wukong-cli/releases/tag/1.2.0" | ||
| ); | ||
| } | ||
| } |
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
2 changes: 1 addition & 1 deletion
2
...ts/application_instances__wukong_application_instances_list_failed_if_not_authorized.snap
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
2 changes: 1 addition & 1 deletion
2
cli/tests/snapshots/config__wukong_config_list_should_failed_without_config_file.snap
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
Oops, something went wrong.