feat: enhance desktop application startup diagnostics and logging

- Introduced a new `startup` module to capture and manage startup diagnostics.
- Implemented logging functionality with daily rotation and error reporting for application startup failures.
- Updated the main application run function to return an exit code based on startup success or failure.
- Added new dependencies for logging and diagnostics in `Cargo.toml`.
- Increased request timeout in the control service for improved stability.
- Expanded maximum search results in the federation module for better search capabilities.

apps/desktop/src-tauri/Cargo.toml

@@ -14,6 +14,7 @@ tauri-build = { version = "2", features = [] }
 [dependencies]
 axum = "0.8"
 cursor-server = { path = "../../../server" }
+rfd = "0.15"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 tauri = { version = "2", features = ["tray-icon"] }
@@ -26,5 +27,6 @@ tauri-plugin-updater = "2"
 tokio = { version = "1", features = ["time"] }
 tokio-util = "0.7"
 tracing = "0.1"
+tracing-appender = "0.2"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 url = "2"

apps/desktop/src-tauri/src/desktop.rs

@@ -1,5 +1,5 @@
 use std::{
-    process::Command,
+    process::{Command, ExitCode},
     sync::{
         atomic::{AtomicBool, Ordering},
         Mutex,
@@ -19,7 +19,6 @@ use tauri::{
 };
 use tauri_plugin_opener::OpenerExt;
 use tokio_util::sync::CancellationToken;
-use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
 
 #[cfg(dev)]
 use cursor_server::config::ConsoleSource;
@@ -27,6 +26,7 @@ use cursor_server::{App, Config, Result};
 
 #[cfg(not(dev))]
 use crate::frontend;
+use crate::startup::{self, StartupDiagnostics};
 use crate::tray;
 
 pub(crate) const MAIN_WINDOW_LABEL: &str = "main";
@@ -141,16 +141,23 @@ fn create_main_window(
     builder.build()
 }
 
-pub fn run() {
-    let started_by_autostart = std::env::args_os().any(|arg| arg == AUTOSTART_ARG);
+pub fn run() -> ExitCode {
+    let diagnostics = match StartupDiagnostics::initialize() {
+        Ok(diagnostics) => diagnostics,
+        Err(error) => {
+            startup::report_logging_failure(error.as_ref());
+            return ExitCode::FAILURE;
+        }
+    };
+    tracing::info!(
+        version = env!("CARGO_PKG_VERSION"),
+        os = std::env::consts::OS,
+        architecture = std::env::consts::ARCH,
+        log_directory = %diagnostics.log_directory().display(),
+        "desktop starting"
+    );
 
-    tracing_subscriber::registry()
-        .with(
-            tracing_subscriber::EnvFilter::try_from_default_env()
-                .unwrap_or_else(|_| "cursor_server=info".into()),
-        )
-        .with(tracing_subscriber::fmt::layer())
-        .init();
+    let started_by_autostart = std::env::args_os().any(|arg| arg == AUTOSTART_ARG);
 
     let app = tauri::Builder::default()
         .invoke_handler(tauri::generate_handler![open_terminal_with_command])
@@ -218,8 +225,14 @@ pub fn run() {
             tray::create(app)?;
             Ok(())
         })
-        .build(tauri::generate_context!())
-        .expect("failed to build Cursor BYOK desktop app");
+        .build(tauri::generate_context!());
+    let app = match app {
+        Ok(app) => app,
+        Err(error) => {
+            diagnostics.report_fatal(&error);
+            return ExitCode::FAILURE;
+        }
+    };
 
     app.run(|app, event| match event {
         RunEvent::WindowEvent {
@@ -264,4 +277,6 @@ pub fn run() {
         } => tray::show_main_window(app),
         _ => {}
     });
+
+    ExitCode::SUCCESS
 }

apps/desktop/src-tauri/src/lib.rs

@@ -1,6 +1,7 @@
 mod desktop;
 #[cfg(not(dev))]
 mod frontend;
+mod startup;
 mod tray;
 
 pub use desktop::run;

apps/desktop/src-tauri/src/main.rs

@@ -1,5 +1,5 @@
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
 
-fn main() {
-    cursor_byok_desktop::run();
+fn main() -> std::process::ExitCode {
+    cursor_byok_desktop::run()
 }

apps/desktop/src-tauri/src/startup.rs

@@ -0,0 +1,139 @@
+//! Captures startup diagnostics before the database and desktop runtime initialize.
+use std::{error::Error, path::PathBuf};
+
+use rfd::{MessageButtons, MessageDialog, MessageLevel};
+use tracing_appender::{
+    non_blocking::WorkerGuard,
+    rolling::{RollingFileAppender, Rotation},
+};
+use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
+
+const LOG_DIRECTORY_NAME: &str = "logs";
+const LOG_FILE_PREFIX: &str = "cursor-byok";
+const LOG_FILE_SUFFIX: &str = "log";
+const RETAINED_LOG_FILES: usize = 15;
+
+type BoxError = Box<dyn Error + Send + Sync>;
+
+pub(crate) struct StartupDiagnostics {
+    log_directory: PathBuf,
+    _writer_guard: WorkerGuard,
+}
+
+impl StartupDiagnostics {
+    pub(crate) fn initialize() -> Result<Self, BoxError> {
+        let log_directory = cursor_server::config::managed_data_dir()?.join(LOG_DIRECTORY_NAME);
+        std::fs::create_dir_all(&log_directory)?;
+
+        let file_appender = RollingFileAppender::builder()
+            .rotation(Rotation::DAILY)
+            .filename_prefix(LOG_FILE_PREFIX)
+            .filename_suffix(LOG_FILE_SUFFIX)
+            .max_log_files(RETAINED_LOG_FILES)
+            .build(&log_directory)?;
+        let (file_writer, writer_guard) = tracing_appender::non_blocking(file_appender);
+        let filter = tracing_subscriber::EnvFilter::try_from_default_env()
+            .unwrap_or_else(|_| "cursor_byok_desktop=info,cursor_server=info".into());
+
+        tracing_subscriber::registry()
+            .with(filter)
+            .with(tracing_subscriber::fmt::layer())
+            .with(
+                tracing_subscriber::fmt::layer()
+                    .with_ansi(false)
+                    .with_writer(file_writer),
+            )
+            .try_init()?;
+
+        Ok(Self {
+            log_directory,
+            _writer_guard: writer_guard,
+        })
+    }
+
+    pub(crate) fn log_directory(&self) -> &std::path::Path {
+        &self.log_directory
+    }
+
+    pub(crate) fn report_fatal(&self, error: &(dyn Error + 'static)) {
+        let details = error_chain(error);
+        tracing::error!(
+            error = %details,
+            log_directory = %self.log_directory.display(),
+            "desktop failed to start"
+        );
+        show_fatal_dialog(&details, Some(&self.log_directory));
+    }
+}
+
+pub(crate) fn report_logging_failure(error: &(dyn Error + 'static)) {
+    let details = error_chain(error);
+    eprintln!("Cursor BYOK failed to initialize logging: {details}");
+    show_fatal_dialog(&details, None);
+}
+
+fn show_fatal_dialog(details: &str, log_directory: Option<&std::path::Path>) {
+    let log_guidance = match log_directory {
+        Some(directory) => format!(
+            "日志目录 / Log directory:\n{}\n\n请将最新的日志文件发送给开发者。\nPlease send the latest log file to the developer.",
+            directory.display()
+        ),
+        None => "日志系统也未能启动，因此没有生成日志文件。\nLogging also failed to initialize, so no log file was created."
+            .to_owned(),
+    };
+    let description = format!(
+        "Cursor BYOK 无法启动 / failed to start.\n\n错误 / Error:\n{details}\n\n{log_guidance}"
+    );
+
+    let _ = MessageDialog::new()
+        .set_level(MessageLevel::Error)
+        .set_title("Cursor BYOK 启动失败 / Startup Error")
+        .set_description(description)
+        .set_buttons(MessageButtons::Ok)
+        .show();
+}
+
+fn error_chain(error: &(dyn Error + 'static)) -> String {
+    let mut details = error.to_string();
+    let mut source = error.source();
+    while let Some(cause) = source {
+        details.push_str("\nCaused by: ");
+        details.push_str(&cause.to_string());
+        source = cause.source();
+    }
+    details
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::fmt;
+
+    #[derive(Debug)]
+    struct OuterError(std::io::Error);
+
+    impl fmt::Display for OuterError {
+        fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
+            formatter.write_str("database initialization failed")
+        }
+    }
+
+    impl Error for OuterError {
+        fn source(&self) -> Option<&(dyn Error + 'static)> {
+            Some(&self.0)
+        }
+    }
+
+    #[test]
+    fn fatal_report_includes_the_complete_error_chain() {
+        let error = OuterError(std::io::Error::new(
+            std::io::ErrorKind::PermissionDenied,
+            "database file is read-only",
+        ));
+
+        assert_eq!(
+            error_chain(&error),
+            "database initialization failed\nCaused by: database file is read-only"
+        );
+    }
+}