soil-client 0.2.0

// This file is part of Soil.

// Copyright (C) Soil contributors.
// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

use clap::Args;
use std::{
	io,
	path::{Path, PathBuf},
	time::Duration,
};
use subsoil::core::traits::SpawnEssentialNamed;

const LOG_TARGET: &str = "storage-monitor";

/// Result type used in this crate.
pub type Result<T> = std::result::Result<T, Error>;

/// Error type used in this crate.
#[derive(Debug, thiserror::Error)]
pub enum Error {
	#[error("IO Error")]
	IOError(#[from] io::Error),
	#[error("Out of storage space: available {0}MiB, required {1}MiB")]
	StorageOutOfSpace(u64, u64),
}

/// Parameters used to create the storage monitor.
#[derive(Default, Debug, Clone, Args)]
pub struct StorageMonitorParams {
	/// Required available space on database storage.
	///
	/// If available space for DB storage drops below the given threshold, node will
	/// be gracefully terminated.
	///
	/// If `0` is given monitoring will be disabled.
	#[arg(long = "db-storage-threshold", value_name = "MiB", default_value_t = 1024)]
	pub threshold: u64,

	/// How often available space is polled.
	#[arg(long = "db-storage-polling-period", value_name = "SECONDS", default_value_t = 5, value_parser = clap::value_parser!(u32).range(1..))]
	pub polling_period: u32,
}

/// Storage monitor service: checks the available space for the filesystem for given path.
pub struct StorageMonitorService {
	/// watched path
	path: PathBuf,
	/// number of megabytes that shall be free on the filesystem for watched path
	threshold: u64,
	/// storage space polling period
	polling_period: Duration,
}

impl StorageMonitorService {
	/// Creates new StorageMonitorService for given client config
	pub fn try_spawn(
		parameters: StorageMonitorParams,
		path: PathBuf,
		spawner: &impl SpawnEssentialNamed,
	) -> Result<()> {
		if parameters.threshold == 0 {
			log::info!(
				target: LOG_TARGET,
				"StorageMonitorService: threshold `0` given, storage monitoring disabled",
			);
		} else {
			log::debug!(
				target: LOG_TARGET,
				"Initializing StorageMonitorService for db path: {}",
				path.display()
			);

			Self::check_free_space(&path, parameters.threshold)?;

			let storage_monitor_service = StorageMonitorService {
				path,
				threshold: parameters.threshold,
				polling_period: Duration::from_secs(parameters.polling_period.into()),
			};

			spawner.spawn_essential(
				"storage-monitor",
				None,
				Box::pin(storage_monitor_service.run()),
			);
		}

		Ok(())
	}

	/// Main monitoring loop, intended to be spawned as essential task. Quits if free space drop
	/// below threshold.
	async fn run(self) {
		loop {
			tokio::time::sleep(self.polling_period).await;
			if Self::check_free_space(&self.path, self.threshold).is_err() {
				break;
			};
		}
	}

	/// Returns free space in MiB, or error if statvfs failed.
	fn free_space(path: &Path) -> Result<u64> {
		Ok(fs4::available_space(path).map(|s| s / 1024 / 1024)?)
	}

	/// Checks if the amount of free space for given `path` is above given `threshold` in MiB.
	/// If it dropped below, error is returned.
	/// System errors are silently ignored.
	fn check_free_space(path: &Path, threshold: u64) -> Result<()> {
		match StorageMonitorService::free_space(path) {
			Ok(available_space) => {
				log::trace!(
					target: LOG_TARGET,
					"free: {available_space} , threshold: {threshold}.",
				);

				if available_space < threshold {
					log::error!(target: LOG_TARGET, "Available space {available_space}MiB for path `{}` dropped below threshold: {threshold}MiB , terminating...", path.display());
					Err(Error::StorageOutOfSpace(available_space, threshold))
				} else {
					Ok(())
				}
			},
			Err(e) => {
				log::error!(target: LOG_TARGET, "Could not read available space: {e:?}.");
				Err(e)
			},
		}
	}
}