Add option to improve Wayland compatiblity (using xwayland)

Author: martpie

package-lock.json

@@ -56,6 +56,7 @@
     "@tauri-apps/plugin-notification": "2.3.0",
     "@tauri-apps/plugin-opener": "2.4.0",
     "@tauri-apps/plugin-os": "2.3.0",
+    "@tauri-apps/plugin-process": "2.3.0",
     "browserslist": "4.25.1",
     "classnames": "2.5.1",
     "lodash-es": "4.17.21",

package.json

@@ -26,6 +26,7 @@ tauri-plugin-notification = "2.3.0"
 tauri-plugin-opener = "2.4.0"
 tauri-plugin-os = "2.3.0"
 tauri-plugin-prevent-default = "3.0.0"
+tauri-plugin-process = "2.3.0"
 tauri-plugin-shell = "2.3.0"
 tauri-plugin-single-instance = "2.3.2"
 tauri-plugin-window-state = "2.4.0"

src-tauri/Cargo.lock

@@ -24,6 +24,7 @@
     "opener:allow-default-urls",
     "opener:allow-reveal-item-in-dir",
     "os:allow-os-type",
+    "process:allow-restart",
     "log:allow-log",
     "notification:default",
     "app-menu:allow-toggle",

src-tauri/Cargo.toml

@@ -1,28 +1,50 @@
-use std::fs;
+use std::{env, fs};
 
-use crate::libs::error::AnyResult;
+use home_config::HomeConfig;
 
-pub fn init() -> AnyResult<()> {
-    let config_dir_check = ensure_new_config_dir()?;
+use crate::plugins::config::Config;
+use crate::{
+    libs::error::AnyResult,
+    plugins::config::{ConfigManager, get_storage_dir},
+};
 
-    match config_dir_check {
-        Some(message) => println!("[init] {}", message),
-        None => println!("[init] No actions needed"),
-    }
-
-    Ok(())
-}
-
-fn ensure_new_config_dir() -> AnyResult<Option<String>> {
+pub fn init() -> AnyResult<ConfigManager> {
+    // 1. Ensure Config dir is "museeks" and not Museeks
     let config_dir = dirs::config_dir().expect("Could not find config directory");
 
     let old_path = config_dir.join("./Museeks");
     let new_path = config_dir.join("./museeks");
 
     if old_path.exists() && !new_path.exists() {
         fs::rename(&old_path, &new_path)?;
-        return Ok(Some("Renamed config folder from Museeks to museeks".into()));
+        println!("Renamed config folder from Museeks to museeks");
+    }
+
+    // 2. Ensure Config is created and return it
+    let conf_path = get_storage_dir();
+    let manager = HomeConfig::with_file(conf_path.join("config.toml"));
+    let existing_config = manager.toml::<Config>();
+
+    let config = match existing_config {
+        Ok(config) => ConfigManager::new(manager, config),
+        Err(_) => {
+            // The config does not exist, so let's instantiate it with defaults
+            // Potential issue: if the config is extended, the defaults will be
+            // reloaded
+            let default_config = Config::default();
+            manager.save_toml(&default_config).unwrap();
+
+            ConfigManager::new(manager, default_config)
+        }
+    };
+
+    // 3. Ensure Wayland compatibility fixes if the user requests them
+    if config.get()?.wayland_compat {
+        unsafe {
+            env::set_var("GDK_BACKEND", "x11");
+            env::set_var("WEBKIT_DISABLE_COMPOSITING_MODE", "1");
+        }
     }
 
-    Ok(None)
+    Ok(config)
 }

src-tauri/capabilities/main.json

@@ -8,6 +8,7 @@ use libs::init::init;
 use libs::utils::get_theme_from_name;
 use log::{LevelFilter, info};
 use plugins::config::{ConfigManager, get_storage_dir};
+use std::env;
 use tauri::{Manager, WebviewUrl, WebviewWindowBuilder};
 use tauri_plugin_log::fern::colors::ColoredLevelConfig;
 use tauri_plugin_log::{Target, TargetKind};
@@ -17,17 +18,19 @@ use tauri_plugin_window_state::StateFlags;
  * The beast
  */
 fn main() {
-    match init() {
-        Ok(_) => {
+    let config = match init() {
+        Ok(config) => {
             println!("[init] Initialization successful");
+            config
         }
         Err(e) => {
             println!("[init] Error during initialization: {}", e);
             std::process::exit(1);
         }
-    }
+    };
 
     tauri::Builder::default()
+        .plugin(tauri_plugin_process::init())
         // Logging must be setup first, otherwise the logs won't be captured
         // while setting up the other plugins.
         .plugin(
@@ -58,7 +61,7 @@ fn main() {
         // Custom integrations
         .plugin(plugins::app_close::init())
         .plugin(plugins::app_menu::init())
-        .plugin(plugins::config::init())
+        .plugin(plugins::config::init(config))
         .plugin(plugins::cover::init())
         .plugin(plugins::db::init())
         .plugin(plugins::debug::init())

src-tauri/src/libs/init.rs

@@ -1,5 +1,5 @@
-use tauri::plugin::{Builder, TauriPlugin};
 use tauri::Runtime;
+use tauri::plugin::{Builder, TauriPlugin};
 
 /**
  * Plugin in charge on making sure closing the app does not stop the audio

src-tauri/src/main.rs

@@ -73,6 +73,7 @@ pub struct Config {
     pub auto_update_checker: bool,
     pub notifications: bool,
     pub track_view_density: TrackViewDensity,
+    pub wayland_compat: bool,
 }
 
 pub const SYSTEM_THEME: &str = "__system";
@@ -98,6 +99,7 @@ impl Config {
             auto_update_checker: true,
             notifications: false,
             track_view_density: TrackViewDensity::Normal,
+            wayland_compat: false,
         }
     }
 }
@@ -108,6 +110,15 @@ pub struct ConfigManager {
     pub data: RwLock<Config>,
 }
 
+impl ConfigManager {
+    pub fn new(manager: HomeConfig, config: Config) -> Self {
+        Self {
+            manager,
+            data: RwLock::new(config),
+        }
+    }
+}
+
 fn config_err<T: Display>(err: T) -> MuseeksError {
     MuseeksError::Config(format!("{}", err))
 }
@@ -167,30 +178,7 @@ pub fn set_config(config_manager: State<ConfigManager>, config: Config) -> AnyRe
     config_manager.update(config)
 }
 
-pub fn init<R: Runtime>() -> TauriPlugin<R> {
-    let conf_path = get_storage_dir();
-    let manager = HomeConfig::with_file(conf_path.join("config.toml"));
-    let existing_config = manager.toml::<Config>();
-
-    let config = match existing_config {
-        Ok(config) => ConfigManager {
-            manager,
-            data: RwLock::new(config),
-        },
-        Err(_) => {
-            // The config does not exist, so let's instantiate it with defaults
-            // Potential issue: if the config is extended, the defaults will be
-            // reloaded
-            let default_config = Config::default();
-            manager.save_toml(&default_config).unwrap();
-
-            ConfigManager {
-                manager,
-                data: RwLock::new(default_config),
-            }
-        }
-    };
-
+pub fn init<R: Runtime>(config: ConfigManager) -> TauriPlugin<R> {
     // We need to inject the initial state of the config to the window object of
     // our webview, because some of our front-end modules are instantiated at
     // parsing time and require data that would otherwise only load-able asynchronously

src-tauri/src/plugins/app_close.rs

@@ -1,11 +1,11 @@
 use std::path::PathBuf;
 use std::str::FromStr;
 
-use base64::prelude::{Engine as _, BASE64_STANDARD};
+use base64::prelude::{BASE64_STANDARD, Engine as _};
 use lofty::file::TaggedFileExt;
 use lofty::picture::{MimeType, PictureType};
-use tauri::plugin::{Builder, TauriPlugin};
 use tauri::Runtime;
+use tauri::plugin::{Builder, TauriPlugin};
 
 use crate::libs::error::AnyResult;
 use crate::libs::utils::scan_dir;