kaspa-utils 0.15.0

Kaspa utilities
Documentation
use crate::fd_budget;
use crate::git;
use crate::hex::ToHex;
use sha2::{Digest, Sha256};
use std::fs::{read_to_string, File};
use std::io::Read;
use std::path::PathBuf;
// use std::fs::read_to_string;
use std::sync::OnceLock;

static SYSTEM_INFO: OnceLock<SystemInfo> = OnceLock::new();

#[derive(Clone)]
pub struct SystemInfo {
    /// unique system (machine) identifier
    pub system_id: Option<Vec<u8>>,
    /// full git commit hash
    pub git_hash: Option<Vec<u8>>,
    /// short git commit hash
    pub git_short_hash: Option<Vec<u8>>,
    /// crate (workspace) version
    pub version: String,
    /// number of physical CPU cores
    pub cpu_physical_cores: u16,
    /// total system memory in bytes
    pub total_memory: u64,
    /// file descriptor limit of the current process
    pub fd_limit: u32,
    /// maximum number of sockets per CPU core
    pub proxy_socket_limit_per_cpu_core: Option<u32>,
}

// provide hex encoding for system_id, git_hash, and git_short_hash
impl std::fmt::Debug for SystemInfo {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("SystemInfo")
            .field("system_id", &self.system_id.as_ref().map(|id| id.to_hex()))
            .field("git_hash", &self.git_hash.as_ref().map(|hash| hash.to_hex()))
            .field("git_short_hash", &self.git_short_hash.as_ref().map(|hash| hash.to_hex()))
            .field("version", &self.version)
            .field("cpu_physical_cores", &self.cpu_physical_cores)
            .field("total_memory", &self.total_memory)
            .field("fd_limit", &self.fd_limit)
            .field("proxy_socket_limit_per_cpu_core", &self.proxy_socket_limit_per_cpu_core)
            .finish()
    }
}

impl Default for SystemInfo {
    fn default() -> Self {
        let system_info = SYSTEM_INFO.get_or_init(|| {
            let mut system = sysinfo::System::new();
            system.refresh_memory();
            let cpu_physical_cores = num_cpus::get() as u16;
            let total_memory = system.total_memory();
            let fd_limit = fd_budget::limit() as u32;
            let system_id = Self::try_system_id();
            let git_hash = git::hash();
            let git_short_hash = git::short_hash();
            let version = git::version();
            let proxy_socket_limit_per_cpu_core = Self::try_proxy_socket_limit_per_cpu_core();

            SystemInfo {
                system_id,
                git_hash,
                git_short_hash,
                version,
                cpu_physical_cores,
                total_memory,
                fd_limit,
                proxy_socket_limit_per_cpu_core,
            }
        });
        (*system_info).clone()
    }
}

impl SystemInfo {
    /// Obtain a unique system (machine) identifier.
    fn try_system_id() -> Option<Vec<u8>> {
        let some_id = if let Ok(mut file) = File::open("/etc/machine-id") {
            // fetch the system id from /etc/machine-id
            let mut machine_id = String::new();
            file.read_to_string(&mut machine_id).ok();
            machine_id.trim().to_string()
        } else if let Ok(Some(mac)) = mac_address::get_mac_address() {
            // fallback on the mac address
            mac.to_string().trim().to_string()
        } else {
            // 🤷
            return None;
        };
        let mut sha256 = Sha256::default();
        sha256.update(some_id.as_bytes());
        Some(sha256.finalize().to_vec())
    }

    fn try_proxy_socket_limit_per_cpu_core() -> Option<u32> {
        let nginx_config_path = PathBuf::from("/etc/nginx/nginx.conf");
        if nginx_config_path.exists() {
            read_to_string(nginx_config_path)
                .ok()
                .and_then(|content| content.lines().find(|line| line.trim().starts_with("worker_connections")).map(String::from))
                .and_then(|line| line.split_whitespace().nth(1).map(|v| v.replace(";", "")))
                .and_then(|value| value.parse::<u32>().ok())
        } else {
            None
        }
    }
}

impl AsRef<SystemInfo> for SystemInfo {
    fn as_ref(&self) -> &SystemInfo {
        self
    }
}

// #[cfg(test)]
// mod tests {
//     use super::*;

//     #[test]
//     fn test_system_info() {
//         let system_info = SystemInfo::default();
//         println!("{:#?}", system_info);
//     }
// }