use std::path::Path;
use std::time::Duration;
use console::style;
use eyre::Result;
use std::sync::LazyLock as Lazy;
use versions::Versioning;
use crate::build_time::BUILD_TIME;
use crate::cli::self_update::{SelfUpdate, upgrade_instructions_or_hint};
use crate::config::Settings;
use crate::file::modified_duration;
use crate::ui::style;
use crate::{dirs, duration, env, file};
#[derive(Debug, usage_rs::Args)]
#[usage(verbatim_doc_comment, visible_alias = "v", after_long_help = AFTER_LONG_HELP)]
pub(crate) struct Version {
#[usage(short = 'J', long)]
json: bool,
}
impl Version {
pub(crate) async fn run(self) -> Result<()> {
if self.json {
self.json().await?
} else {
show_version()?;
show_latest().await;
show_version_hint();
}
Ok(())
}
async fn json(&self) -> Result<()> {
let json = serde_json::json!({
"version": *VERSION,
"latest": get_latest_version(duration::DAILY).await,
"os": *OS,
"arch": *ARCH,
"build_time": BUILD_TIME.to_string(),
});
println!("{}", serde_json::to_string_pretty(&json)?);
Ok(())
}
}
pub(crate) static OS: Lazy<String> = Lazy::new(|| env::consts::OS.into());
pub(crate) static ARCH: Lazy<String> = Lazy::new(|| {
match env::consts::ARCH {
"x86_64" => "x64",
"aarch64" => "arm64",
_ => env::consts::ARCH,
}
.to_string()
});
pub(crate) fn normalize_os(os: &str) -> &str {
match os {
"darwin" | "macos" => "macos",
"windows" | "win" => "windows",
other => other,
}
}
pub(crate) fn normalize_arch(arch: &str) -> &str {
match arch {
"x86_64" | "amd64" | "x64" => "x64",
"aarch64" | "arm64" => "arm64",
other => other,
}
}
pub(crate) fn os_selector_matches(entry: &str) -> bool {
if let Some((os, arch)) = entry.split_once('/') {
normalize_os(os) == OS.as_str() && normalize_arch(arch) == ARCH.as_str()
} else {
normalize_os(entry) == OS.as_str()
}
}
pub(crate) static VERSION_PLAIN: Lazy<String> = Lazy::new(|| {
let mut v = V.to_string();
if cfg!(debug_assertions) {
v.push_str("-DEBUG");
};
v
});
pub(crate) static VERSION: Lazy<String> = Lazy::new(|| {
let build_time = BUILD_TIME.format("%Y-%m-%d");
let v = &*VERSION_PLAIN;
format!("{v} {os}-{arch} ({build_time})", os = *OS, arch = *ARCH)
});
static AFTER_LONG_HELP: &str = color_print::cstr!(
r#"<bold><underline>Examples:</underline></bold>
$ <bold>mise version</bold>
$ <bold>mise --version</bold>
$ <bold>mise -v</bold>
$ <bold>mise -V</bold>
"#
);
pub(crate) static V: Lazy<Versioning> =
Lazy::new(|| Versioning::new(env!("CARGO_PKG_VERSION")).unwrap());
pub(crate) fn print_version_if_requested(args: &[String]) -> std::io::Result<bool> {
if args.len() == 2 && !*crate::env::IS_RUNNING_AS_SHIM {
let cmd = &args[1].to_lowercase();
if cmd == "version" || cmd == "-v" || cmd == "--version" || cmd == "v" {
show_version()?;
return Ok(true);
}
}
debug!("Version: {}", *VERSION);
Ok(false)
}
fn show_version() -> std::io::Result<()> {
if console::user_attended() {
let banner = style::nred(
r#"
_ __
____ ___ (_)_______ ___ ____ ____ / /___ _________
/ __ `__ \/ / ___/ _ \______/ _ \/ __ \______/ __ \/ / __ `/ ___/ _ \
/ / / / / / (__ ) __/_____/ __/ / / /_____/ /_/ / / /_/ / /__/ __/
/_/ /_/ /_/_/____/\___/ \___/_/ /_/ / .___/_/\__,_/\___/\___/
/_/"#
.trim_start_matches("\n"),
);
let jdx = style::nbright("by @jdx");
miseprintln!("{banner} {jdx}");
}
miseprintln!("{}", *VERSION);
Ok(())
}
pub(crate) async fn show_latest() {
if ci_info::is_ci() && !cfg!(test) {
return;
}
if let Some(latest) = check_for_new_version(duration::DAILY).await {
warn!("mise version {} available", latest);
if SelfUpdate::is_available() {
let cmd = style("mise self-update").bright().yellow().for_stderr();
warn!("To update, run {}", cmd);
} else {
warn!("{}", upgrade_instructions_or_hint());
}
}
}
#[derive(Debug, PartialEq)]
enum VersionHint {
AutoUpdate,
Homebrew,
OptimizedBinary,
OptimizedBinaryWindows,
}
fn select_version_hint(
self_update_available: bool,
auto_update: bool,
homebrew: bool,
windows: bool,
) -> Option<VersionHint> {
if self_update_available {
(!auto_update).then_some(VersionHint::AutoUpdate)
} else if homebrew {
Some(VersionHint::Homebrew)
} else if windows {
Some(VersionHint::OptimizedBinaryWindows)
} else {
Some(VersionHint::OptimizedBinary)
}
}
pub(crate) fn show_auto_update_hint() {
let Ok(settings) = Settings::try_get() else {
return;
};
if select_version_hint(
SelfUpdate::is_available(),
settings.auto_update,
false,
cfg!(windows),
) == Some(VersionHint::AutoUpdate)
{
hint!(
"auto_update",
"keep mise updated automatically with",
"mise settings set auto_update true"
);
}
}
pub(crate) fn show_version_hint() {
let Ok(settings) = Settings::try_get() else {
return;
};
match select_version_hint(
SelfUpdate::is_available(),
settings.auto_update,
is_homebrew_install(),
cfg!(windows),
) {
Some(VersionHint::AutoUpdate) => show_auto_update_hint(),
Some(VersionHint::Homebrew) => hint!(
"optimized_mise_homebrew",
"Homebrew's mise formula can be substantially slower and larger than the optimized mise.run binary; replace it with",
"brew uninstall mise && curl https://mise.run | sh"
),
Some(VersionHint::OptimizedBinary) => hint!(
"optimized_mise_binary",
"third-party package builds may be slower and larger than mise's optimized binary; install the official build with",
"curl https://mise.run | sh"
),
Some(VersionHint::OptimizedBinaryWindows) => hint!(
"optimized_mise_binary",
"third-party package builds may be slower and larger than mise's optimized binary; download the official build from",
"https://github.com/jdx/mise/releases/latest"
),
None => {}
}
}
fn is_homebrew_install() -> bool {
std::fs::canonicalize(&*env::MISE_BIN)
.ok()
.is_some_and(|path| path.components().any(|part| part.as_os_str() == "Cellar"))
}
pub(crate) async fn check_for_new_version(cache_duration: Duration) -> Option<String> {
if let Some(latest) = get_latest_version(cache_duration)
.await
.and_then(Versioning::new)
&& *V < latest
{
return Some(latest.to_string());
}
None
}
#[derive(Debug, PartialEq)]
enum Cached {
Fresh(Option<String>),
Stale,
}
fn cached_latest_version(path: &Path, duration: Duration) -> Cached {
match modified_duration(path) {
Ok(age) if age < duration => match file::read_to_string(path) {
Ok(body) => Cached::Fresh(Versioning::new(body.trim()).map(|v| v.to_string())),
Err(_) => Cached::Stale,
},
_ => Cached::Stale,
}
}
async fn get_latest_version(duration: Duration) -> Option<String> {
let version_file_path = dirs::CACHE.join("latest-version");
if let Cached::Fresh(version) = cached_latest_version(&version_file_path, duration) {
return version;
}
let _ = file::create_dir_all(*dirs::CACHE);
let version = get_latest_version_call().await;
let _ = file::write(version_file_path, version.clone().unwrap_or_default());
version
}
#[cfg(test)]
async fn get_latest_version_call() -> Option<String> {
Some("0.0.0".to_string())
}
#[cfg(not(test))]
async fn get_latest_version_call() -> Option<String> {
fetch_latest_version(&crate::http::HTTP).await
}
async fn fetch_latest_version(client: &crate::http::Client) -> Option<String> {
let url = "https://mise.jdx.dev/VERSION";
debug!("checking mise version from {}", url);
match client.get_text(url).await {
Ok(text) => {
debug!("got version {text}");
Some(text.trim().to_string())
}
Err(err) => {
debug!("failed to check for version: {:#?}", err);
None
}
}
}
#[cfg(test)]
mod tests {
use super::*;
const HOUR: Duration = Duration::from_secs(3600);
fn write(dir: &Path, body: &str) -> std::path::PathBuf {
let p = dir.join("latest-version");
std::fs::write(&p, body).unwrap();
p
}
#[test]
fn test_normalize_os() {
assert_eq!(normalize_os("macos"), "macos");
assert_eq!(normalize_os("darwin"), "macos");
assert_eq!(normalize_os("linux"), "linux");
assert_eq!(normalize_os("windows"), "windows");
assert_eq!(normalize_os("win"), "windows");
assert_eq!(normalize_os("freebsd"), "freebsd");
}
#[test]
fn test_normalize_arch() {
assert_eq!(normalize_arch("arm64"), "arm64");
assert_eq!(normalize_arch("aarch64"), "arm64");
assert_eq!(normalize_arch("x64"), "x64");
assert_eq!(normalize_arch("x86_64"), "x64");
assert_eq!(normalize_arch("amd64"), "x64");
assert_eq!(normalize_arch("riscv64"), "riscv64");
}
#[test]
fn missing_file_is_stale() {
let dir = tempfile::tempdir().unwrap();
let p = dir.path().join("latest-version");
assert_eq!(cached_latest_version(&p, HOUR), Cached::Stale);
}
#[test]
fn fresh_file_returns_its_version() {
let dir = tempfile::tempdir().unwrap();
let p = write(dir.path(), "2030.1.2\n");
assert_eq!(
cached_latest_version(&p, HOUR),
Cached::Fresh(Some("2030.1.2".to_string()))
);
}
#[test]
fn fresh_but_empty_file_is_a_negative_cache_not_stale() {
let dir = tempfile::tempdir().unwrap();
let p = write(dir.path(), "");
assert_eq!(cached_latest_version(&p, HOUR), Cached::Fresh(None));
}
#[test]
fn fresh_but_unreadable_file_is_stale_not_a_negative_cache() {
let dir = tempfile::tempdir().unwrap();
let p = dir.path().join("latest-version");
std::fs::create_dir(&p).unwrap();
assert_eq!(cached_latest_version(&p, HOUR), Cached::Stale);
}
#[test]
fn versioning_is_permissive_so_garbage_is_not_a_negative_cache() {
let dir = tempfile::tempdir().unwrap();
let p = write(dir.path(), "not-a-version\n");
assert_eq!(
cached_latest_version(&p, HOUR),
Cached::Fresh(Some("not-a-version".to_string()))
);
}
#[test]
fn expired_file_is_stale() {
let dir = tempfile::tempdir().unwrap();
let p = write(dir.path(), "2030.1.2\n");
assert_eq!(cached_latest_version(&p, Duration::ZERO), Cached::Stale);
}
#[tokio::test]
async fn latest_version_ignores_http_client_initialization_errors() {
let client = crate::http::Client::with_init_error("builder error: OpenSSL error");
assert_eq!(fetch_latest_version(&client).await, None);
}
#[test]
fn cache_is_honoured_even_when_it_is_older_than_us() {
let dir = tempfile::tempdir().unwrap();
let p = write(dir.path(), "0.0.1\n");
assert_eq!(
cached_latest_version(&p, HOUR),
Cached::Fresh(Some("0.0.1".to_string()))
);
}
#[test]
fn version_hint_promotes_auto_update_for_official_binaries() {
assert_eq!(
select_version_hint(true, false, false, false),
Some(VersionHint::AutoUpdate)
);
assert_eq!(select_version_hint(true, true, false, false), None);
}
#[test]
fn version_hint_promotes_optimized_binaries_for_package_installs() {
assert_eq!(
select_version_hint(false, false, true, false),
Some(VersionHint::Homebrew)
);
assert_eq!(
select_version_hint(false, false, false, false),
Some(VersionHint::OptimizedBinary)
);
assert_eq!(
select_version_hint(false, false, false, true),
Some(VersionHint::OptimizedBinaryWindows)
);
}
}