Add application log viewer

2026-06-07 15:09:59 +02:00
parent d63d4b9c2f
commit 20404d0145
10 changed files with 1090 additions and 328 deletions
@@ -1,8 +1,10 @@
 use std::{
    collections::{HashMap, HashSet},
+    fs::{self, OpenOptions},
+    io::{Read as _, Seek as _, SeekFrom, Write as _},
    net::SocketAddr,
    path::{Component, Path, PathBuf},
-    sync::{Arc, OnceLock},
+    sync::{Arc, Mutex, OnceLock},
    time::{Duration, SystemTime, UNIX_EPOCH},
 };

@@ -28,6 +30,12 @@ use tokio::sync::{
    RwLock,
    mpsc::{UnboundedReceiver, UnboundedSender},
 };
+use tracing::{Event, Level, Metadata, Subscriber, field::Visit};
+use tracing_subscriber::{
+    layer::{Context, Layer},
+    prelude::*,
+    registry::LookupSpan,
+};

 // Learn more about Tauri commands at https://tauri.app/develop/calling-rust/

@@ -132,12 +140,21 @@ struct UnpackLogEntry {
    success: bool,
 }

+#[derive(Clone, Debug, serde::Serialize)]
+struct MainLogLinePayload {
+    line: String,
+    level: String,
+}
+
 struct SidecarUnpacker {
    app_handle: AppHandle,
 }

 const MAX_UNPACK_LOGS: usize = 20;
 const UNPACK_LOGS_FILE_NAME: &str = "unpack-logs.json";
+const MAIN_LOG_FILE_NAME: &str = "lanspread.log";
+const MAX_MAIN_LOG_BYTES: u64 = 2 * 1024 * 1024;
+const MAIN_LOG_TRIM_SLACK_BYTES: u64 = 64 * 1024;

 impl Unpacker for SidecarUnpacker {
    fn unpack<'a>(&'a self, archive: &'a Path, dest: &'a Path) -> UnpackFuture<'a> {
@@ -156,6 +173,20 @@ async fn get_unpack_logs(
    Ok(state.inner().unpack_logs.read().await.clone())
 }

+#[tauri::command]
+async fn get_main_logs(app_handle: tauri::AppHandle) -> tauri::Result<String> {
+    let state_dir = app_handle.path().app_data_dir()?;
+    fs::create_dir_all(&state_dir)?;
+    let path = main_log_path(&state_dir);
+    trim_main_log_file(&path)?;
+
+    match fs::read_to_string(&path) {
+        Ok(contents) => Ok(contents),
+        Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(String::new()),
+        Err(err) => Err(err.into()),
+    }
+}
+
 #[cfg_attr(not(target_os = "windows"), allow(dead_code))]
 const GAME_SETUP_SCRIPT: &str = "game_setup.cmd";
 #[cfg_attr(not(target_os = "windows"), allow(dead_code))]
@@ -1349,6 +1380,280 @@ fn unpack_logs_path(state_dir: &Path) -> PathBuf {
    state_dir.join(UNPACK_LOGS_FILE_NAME)
 }

+fn main_log_path(state_dir: &Path) -> PathBuf {
+    state_dir.join(MAIN_LOG_FILE_NAME)
+}
+
+fn trim_main_log_file(path: &Path) -> std::io::Result<()> {
+    trim_main_log_file_to_limit(path, MAX_MAIN_LOG_BYTES)
+}
+
+fn trim_main_log_file_to_limit(path: &Path, max_bytes: u64) -> std::io::Result<()> {
+    let metadata = match fs::metadata(path) {
+        Ok(metadata) => metadata,
+        Err(err) if err.kind() == std::io::ErrorKind::NotFound => return Ok(()),
+        Err(err) => return Err(err),
+    };
+
+    if metadata.len() <= max_bytes {
+        return Ok(());
+    }
+
+    if max_bytes == 0 {
+        fs::write(path, [])?;
+        return Ok(());
+    }
+
+    let mut file = fs::File::open(path)?;
+    file.seek(SeekFrom::Start(metadata.len() - max_bytes))?;
+
+    let mut bytes = Vec::with_capacity(usize::try_from(max_bytes).unwrap_or(usize::MAX));
+    file.read_to_end(&mut bytes)?;
+    let tail = valid_utf8_tail(bytes);
+    fs::write(path, tail.as_bytes())
+}
+
+fn valid_utf8_tail(bytes: Vec<u8>) -> String {
+    for offset in 0..bytes.len().min(4) {
+        if let Ok(tail) = std::str::from_utf8(&bytes[offset..]) {
+            return tail.to_string();
+        }
+    }
+
+    String::from_utf8_lossy(&bytes).into_owned()
+}
+
+#[derive(Clone)]
+struct MainLogSink {
+    app_handle: AppHandle,
+    path: PathBuf,
+    file_lock: Arc<Mutex<()>>,
+}
+
+impl MainLogSink {
+    fn new(app_handle: AppHandle, path: PathBuf) -> Self {
+        Self {
+            app_handle,
+            path,
+            file_lock: Arc::new(Mutex::new(())),
+        }
+    }
+
+    fn write_line(&self, line: String, level: Level) {
+        write_main_log_stdout(&line);
+        self.append_file_line(&line);
+
+        let _ = self.app_handle.emit(
+            "main-log-line",
+            MainLogLinePayload {
+                line,
+                level: level.as_str().to_string(),
+            },
+        );
+    }
+
+    fn append_file_line(&self, line: &str) {
+        let Ok(_guard) = self.file_lock.lock() else {
+            return;
+        };
+
+        if let Some(parent) = self.path.parent() {
+            let _ = fs::create_dir_all(parent);
+        }
+
+        let Ok(mut file) = OpenOptions::new()
+            .create(true)
+            .append(true)
+            .open(&self.path)
+        else {
+            return;
+        };
+
+        if writeln!(file, "{line}").is_err() {
+            return;
+        }
+
+        let should_trim = file
+            .metadata()
+            .is_ok_and(|metadata| {
+                metadata.len() > MAX_MAIN_LOG_BYTES.saturating_add(MAIN_LOG_TRIM_SLACK_BYTES)
+            });
+
+        if should_trim {
+            let _ = trim_main_log_file(&self.path);
+        }
+    }
+}
+
+struct MainLogLayer {
+    sink: MainLogSink,
+}
+
+impl MainLogLayer {
+    fn new(sink: MainLogSink) -> Self {
+        Self { sink }
+    }
+}
+
+impl<S> Layer<S> for MainLogLayer
+where
+    S: Subscriber + for<'span> LookupSpan<'span>,
+{
+    fn enabled(&self, metadata: &Metadata<'_>, _ctx: Context<'_, S>) -> bool {
+        should_capture_main_log_metadata(metadata)
+    }
+
+    fn on_event(&self, event: &Event<'_>, _ctx: Context<'_, S>) {
+        let metadata = event.metadata();
+        if !should_capture_main_log_metadata(metadata) {
+            return;
+        }
+
+        let mut visitor = MainLogFieldVisitor::default();
+        event.record(&mut visitor);
+        let target = visitor
+            .log_target
+            .clone()
+            .unwrap_or_else(|| metadata.target().to_string());
+        let message = visitor.into_message();
+        let (date, time) = current_main_log_timestamp();
+        let line = format_main_log_line_parts(
+            &date,
+            &time,
+            &target,
+            metadata.level().as_str(),
+            &message,
+        );
+
+        self.sink.write_line(line, *metadata.level());
+    }
+}
+
+#[derive(Default)]
+struct MainLogFieldVisitor {
+    message: Option<String>,
+    log_target: Option<String>,
+    fields: Vec<String>,
+}
+
+impl MainLogFieldVisitor {
+    fn record_value(&mut self, field_name: &str, value: String) {
+        match field_name {
+            "message" => self.message = Some(value),
+            "log.target" => self.log_target = Some(value),
+            "log.module_path" | "log.file" | "log.line" => {}
+            _ => self.fields.push(format!("{field_name}={value}")),
+        }
+    }
+
+    fn into_message(self) -> String {
+        let mut parts = Vec::new();
+        if let Some(message) = self.message
+            && !message.is_empty()
+        {
+            parts.push(message);
+        }
+        parts.extend(self.fields);
+
+        if parts.is_empty() {
+            String::from("(no message)")
+        } else {
+            normalize_main_log_message(&parts.join(" "))
+        }
+    }
+}
+
+impl Visit for MainLogFieldVisitor {
+    fn record_bool(&mut self, field: &tracing::field::Field, value: bool) {
+        self.record_value(field.name(), value.to_string());
+    }
+
+    fn record_i64(&mut self, field: &tracing::field::Field, value: i64) {
+        self.record_value(field.name(), value.to_string());
+    }
+
+    fn record_u64(&mut self, field: &tracing::field::Field, value: u64) {
+        self.record_value(field.name(), value.to_string());
+    }
+
+    fn record_str(&mut self, field: &tracing::field::Field, value: &str) {
+        self.record_value(field.name(), value.to_string());
+    }
+
+    fn record_debug(&mut self, field: &tracing::field::Field, value: &dyn std::fmt::Debug) {
+        self.record_value(field.name(), format!("{value:?}"));
+    }
+}
+
+fn should_capture_main_log_metadata(metadata: &Metadata<'_>) -> bool {
+    if metadata.target().starts_with("mdns_sd::service_daemon") {
+        return false;
+    }
+
+    matches!(*metadata.level(), Level::ERROR | Level::WARN | Level::INFO)
+}
+
+fn current_main_log_timestamp() -> (String, String) {
+    let now = time::OffsetDateTime::now_local().unwrap_or_else(|_| time::OffsetDateTime::now_utc());
+    let date = now.date();
+    let clock = now.time();
+
+    (
+        format!(
+            "{:04}-{:02}-{:02}",
+            date.year(),
+            u8::from(date.month()),
+            date.day()
+        ),
+        format!(
+            "{:02}:{:02}:{:02}",
+            clock.hour(),
+            clock.minute(),
+            clock.second()
+        ),
+    )
+}
+
+fn format_main_log_line_parts(
+    date: &str,
+    time: &str,
+    target: &str,
+    level: &str,
+    message: &str,
+) -> String {
+    format!(
+        "[{date}][{time}][{}][{level}] {message}",
+        normalize_main_log_target(target)
+    )
+}
+
+fn normalize_main_log_target(target: &str) -> String {
+    target.replace(['\r', '\n'], " ")
+}
+
+fn normalize_main_log_message(message: &str) -> String {
+    message.replace('\r', "\\r").replace('\n', "\\n")
+}
+
+fn write_main_log_stdout(line: &str) {
+    let stdout = std::io::stdout();
+    let mut stdout = stdout.lock();
+    let _ = writeln!(stdout, "{line}");
+}
+
+fn init_main_logging(
+    app_handle: AppHandle,
+    path: PathBuf,
+) -> Result<(), Box<dyn std::error::Error>> {
+    let subscriber =
+        tracing_subscriber::registry().with(MainLogLayer::new(MainLogSink::new(app_handle, path)));
+    tracing::subscriber::set_global_default(subscriber)?;
+    tracing_log::LogTracer::builder()
+        .with_max_level(log::LevelFilter::Info)
+        .init()?;
+    Ok(())
+}
+
 fn load_unpack_logs(state_dir: &Path) -> Vec<UnpackLogEntry> {
    let path = unpack_logs_path(state_dir);
    let contents = match std::fs::read_to_string(&path) {
@@ -1918,6 +2223,46 @@ mod tests {
        let _ = std::fs::remove_dir_all(root);
    }

+    #[test]
+    fn main_log_line_format_is_stable_and_single_line() {
+        let line = format_main_log_line_parts(
+            "2026-06-07",
+            "12:34:56",
+            "lanspread\napp",
+            "WARN",
+            "first line\nsecond line",
+        );
+
+        assert_eq!(
+            line,
+            "[2026-06-07][12:34:56][lanspread app][WARN] first line\\nsecond line"
+        );
+    }
+
+    #[test]
+    fn main_log_trim_keeps_utf8_tail_at_char_boundary() {
+        let root = std::env::temp_dir().join(format!(
+            "lanspread-main-log-test-{}",
+            SystemTime::now()
+                .duration_since(UNIX_EPOCH)
+                .expect("clock should be after epoch")
+                .as_nanos()
+        ));
+        std::fs::create_dir_all(&root).expect("test state dir should be created");
+        let path = main_log_path(&root);
+        std::fs::write(&path, format!("{}{}", "a".repeat(11), "é".repeat(20)))
+            .expect("main log should be written");
+
+        trim_main_log_file_to_limit(&path, 21).expect("main log should trim");
+
+        let trimmed = std::fs::read_to_string(&path).expect("trimmed log should remain utf-8");
+        assert!(trimmed.as_bytes().len() <= 21);
+        assert!(trimmed.starts_with('é'));
+        assert!(trimmed.ends_with('é'));
+
+        let _ = std::fs::remove_dir_all(root);
+    }
+
    #[test]
    fn active_operation_reconciliation_replaces_stale_ui_history() {
        let mut active_operations = HashMap::from([
@@ -2220,21 +2565,12 @@ mod tests {
 #[allow(clippy::missing_panics_doc)]
 #[cfg_attr(mobile, tauri::mobile_entry_point)]
 pub fn run() {
-    let tauri_logger_builder = tauri_plugin_log::Builder::new()
-        .clear_targets()
-        .target(tauri_plugin_log::Target::new(
-            tauri_plugin_log::TargetKind::Stdout,
-        ))
-        .level(log::LevelFilter::Info)
-        .level_for("mdns_sd::service_daemon", log::LevelFilter::Off);
-
    // channel to receive events from the peer
    let (tx_peer_event, rx_peer_event) = tokio::sync::mpsc::unbounded_channel::<PeerEvent>();

    tauri::Builder::default()
        .plugin(tauri_plugin_store::Builder::new().build())
        .plugin(tauri_plugin_dialog::init())
-        .plugin(tauri_logger_builder.build())
        .plugin(tauri_plugin_shell::init())
        .invoke_handler(tauri::generate_handler![
            request_games,
@@ -2250,13 +2586,15 @@ pub fn run() {
            open_game_files,
            get_peer_count,
            get_game_thumbnail,
-            get_unpack_logs
+            get_unpack_logs,
+            get_main_logs
        ])
        .manage(LanSpreadState::default())
        .manage(PeerEventTx(tx_peer_event))
        .setup(move |app| {
            let state_dir = app.path().app_data_dir()?;
            std::fs::create_dir_all(&state_dir)?;
+            init_main_logging(app.handle().clone(), main_log_path(&state_dir))?;
            let state = app.state::<LanSpreadState>();
            let unpack_logs = load_unpack_logs(&state_dir);
            tauri::async_runtime::block_on(async {