OneLauncher-Cracked/packages/core/src/logger.rs

//! **OneLauncher Logger**
//!
//! Public utilities for [`tracing`] logging in OneLauncher.
//!
//! - `RUST_LOG=xxx` is a variable which defines tracing configuration (`ERROR > WARN > INFO > DEBUG > TRACE`)
//! - `RUST_LOG="onelauncher=trace"` will show **all** mesages from OneLauncher and not other dependencies.
//! - `RUST_LOG="info"` will show info, warn, and error logs.
//!
//! Errors returned to [`tauri`] are displayed as tracing error logs.
//! These errors also include an attached span trace if the error is from a [`tracing_error`] and the level is info, debug, or trace.
//! Tracing errors also provide Sentry metadata to be handled.
//! To set the environment variable on `unix` you can use the following command: `RUST_LOG="xxx" {your command}`
//!
//! The default `RUST_LOG` is `onelauncher=show`, meaning only logs from OneLauncher will be displayed at the info, warn, and error levels.

use tracing_appender::non_blocking::WorkerGuard;

// TODO: refactor logging and add more env filters.

/// Initialize the global [`tracing`] logger in development.
#[cfg(debug_assertions)]
pub fn start_logger() -> Option<WorkerGuard> {
	use tracing_subscriber::prelude::*;

	let filter = tracing_subscriber::EnvFilter::try_from_default_env().unwrap_or_else(|_| {
		tracing_subscriber::EnvFilter::new("onelauncher=info,onelauncher_gui=info")
	});

	let subscriber = tracing_subscriber::registry()
		.with(tracing_subscriber::fmt::layer())
		.with(filter)
		.with(tracing_error::ErrorLayer::default());

	tracing::subscriber::set_global_default(subscriber).expect("setting default subscriber failed");

	None
}

/// Initialize the global [`tracing`] logger in production.
#[cfg(not(debug_assertions))]
pub fn start_logger() -> Option<WorkerGuard> {
	use crate::store::Directories;
	use tracing_appender::rolling::{RollingFileAppender, Rotation};
	use tracing_subscriber::fmt::time::ChronoLocal;
	use tracing_subscriber::prelude::*;

	let logs_dir = if let Some(directory) = Directories::logs_dir() {
		directory
	} else {
		eprintln!("failed to start logger");
		return None;
	};

	let filter = tracing_subscriber::EnvFilter::try_from_default_env()
		.unwrap_or_else(|_| tracing_subscriber::EnvFilter::new("onelauncher=info"));

	let file_appender = RollingFileAppender::new(Rotation::DAILY, logs_dir, "onelauncher.log");
	let (non_blocking, guard) = tracing_appender::non_blocking(file_appender);

	let subscriber = tracing_subscriber::registry()
		.with(
			tracing_subscriber::fmt::layer()
				.with_writer(non_blocking)
				.with_ansi(false)
				.with_timer(ChronoLocal::rfc_3339()),
		)
		.with(filter)
		.with(tracing_error::ErrorLayer::default());

	tracing::subscriber::set_global_default(subscriber).expect("setting default subscriber failed");

	Some(guard)
}