refactor(core): resolve resource_dir using the package info (#1762)

Author: lucasfernog

.changes/app-dir-refactor.md

@@ -2,5 +2,5 @@
 "tauri": patch
 ---
 
-**Breaking:** `api::path::resolve_path()` and `api::path::app_dir()` now takes the config as first argument.
+**Breaking:** `api::path::resolve_path()` and `api::path::app_dir()` now takes the config as first argument and the `PackageInfo` as second argument.
 **Breaking:** `api::path::app_dir()` now resolves to `${configDir}/${config.tauri.bundle.identifier}`.

.changes/resources-dir-refactor.md

@@ -0,0 +1,5 @@
+---
+"tauri-utils": patch
+---
+
+The `platform::resource_dir` API now takes the `PackageInfo`.

core/tauri-codegen/src/context.rs

@@ -62,6 +62,23 @@ pub fn context_codegen(data: ContextData) -> Result<TokenStream, EmbeddedAssetsE
     quote!(None)
   };
 
+  let package_name = if let Some(product_name) = &config.package.product_name {
+    quote!(#product_name.to_string())
+  } else {
+    quote!(env!("CARGO_PKG_NAME").to_string())
+  };
+  let package_version = if let Some(version) = &config.package.version {
+    quote!(#version.to_string())
+  } else {
+    quote!(env!("CARGO_PKG_VERSION").to_string())
+  };
+  let package_info = quote!(
+    #root::api::PackageInfo {
+      name: #package_name,
+      version: #package_version,
+    }
+  );
+
   #[cfg(target_os = "linux")]
   let system_tray_icon = if let Some(tray) = &config.tauri.system_tray {
     let mut system_tray_icon_path = tray.icon_path.clone();
@@ -73,7 +90,7 @@ pub fn context_codegen(data: ContextData) -> Result<TokenStream, EmbeddedAssetsE
         .to_string_lossy()
         .to_string();
       quote!(Some(
-        ::tauri::platform::resource_dir()
+        ::tauri::platform::resource_dir(&#package_info)
           .expect("failed to read resource dir")
           .join(
             #system_tray_icon_file_name
@@ -103,26 +120,12 @@ pub fn context_codegen(data: ContextData) -> Result<TokenStream, EmbeddedAssetsE
     quote!(None)
   };
 
-  let package_name = if let Some(product_name) = &config.package.product_name {
-    quote!(#product_name.to_string())
-  } else {
-    quote!(env!("CARGO_PKG_NAME").to_string())
-  };
-  let package_version = if let Some(version) = &config.package.version {
-    quote!(#version.to_string())
-  } else {
-    quote!(env!("CARGO_PKG_VERSION").to_string())
-  };
-
   // double braces are purposeful to force the code into a block expression
   Ok(quote!(#root::Context {
     config: #config,
     assets: ::std::sync::Arc::new(#assets),
     default_window_icon: #default_window_icon,
     system_tray_icon: #system_tray_icon,
-    package_info: #root::api::PackageInfo {
-      name: #package_name,
-      version: #package_version,
-    },
+    package_info: #package_info,
   }))
 }

core/tauri-utils/Cargo.toml

@@ -20,5 +20,8 @@ html5ever = "0.25"
 proc-macro2 = { version = "1.0", optional = true }
 quote = { version = "1.0", optional = true }
 
+[target."cfg(target_os = \"linux\")".dependencies]
+heck = "0.3"
+
 [features]
 build = [ "proc-macro2", "quote" ]

core/tauri-utils/src/lib.rs

@@ -14,6 +14,29 @@ pub mod html;
 /// Platform helpers
 pub mod platform;
 
+/// `App` package information.
+#[derive(Debug, Clone)]
+pub struct PackageInfo {
+  /// App name.
+  pub name: String,
+  /// App version.
+  pub version: String,
+}
+
+impl PackageInfo {
+  /// Returns the application package name.
+  /// On macOS and Windows it's the `name` field, and on Linux it's the `name` in `kebab-case`.
+  pub fn package_name(&self) -> String {
+    #[cfg(target_os = "linux")]
+    {
+      use heck::KebabCase;
+      self.name.to_kebab_case()
+    }
+    #[cfg(not(target_os = "linux"))]
+    return self.name.clone();
+  }
+}
+
 /// Result type alias using the crate's error type.
 pub type Result<T> = std::result::Result<T, Error>;
 

core/tauri-utils/src/platform.rs

@@ -7,6 +7,8 @@ use std::{
   path::{PathBuf, MAIN_SEPARATOR},
 };
 
+use crate::PackageInfo;
+
 /// Try to determine the current target triple.
 ///
 /// Returns a target triple (e.g. `x86_64-unknown-linux-gnu` or `i686-pc-windows-msvc`) or an
@@ -70,13 +72,9 @@ pub fn target_triple() -> crate::Result<String> {
 /// `${exe_dir}/../lib/${exe_name}`.
 ///
 /// On MacOS, it's `${exe_dir}../Resources` (inside .app).
-pub fn resource_dir() -> crate::Result<PathBuf> {
+pub fn resource_dir(package_info: &PackageInfo) -> crate::Result<PathBuf> {
   let exe = std::env::current_exe()?;
   let exe_dir = exe.parent().expect("failed to get exe directory");
-  let app_name = exe
-    .file_name()
-    .expect("failed to get exe filename")
-    .to_string_lossy();
   let curr_dir = exe_dir.display().to_string();
 
   if curr_dir.ends_with(format!("{S}target{S}debug", S = MAIN_SEPARATOR).as_str())
@@ -90,12 +88,19 @@ pub fn resource_dir() -> crate::Result<PathBuf> {
   if cfg!(target_os = "linux") {
     if curr_dir.ends_with("/data/usr/bin") {
       // running from the deb bundle dir
-      Ok(exe_dir.join(format!("../lib/{}", app_name)))
+      Ok(exe_dir.join(format!("../lib/{}", package_info.package_name())))
     } else if let Ok(appdir) = env::var("APPDIR") {
-      Ok(PathBuf::from(format!("{}/usr/lib/{}", appdir, app_name)))
+      Ok(PathBuf::from(format!(
+        "{}/usr/lib/{}",
+        appdir,
+        package_info.package_name()
+      )))
     } else {
       // running bundle
-      Ok(PathBuf::from(format!("/usr/lib/{}", app_name)))
+      Ok(PathBuf::from(format!(
+        "/usr/lib/{}",
+        package_info.package_name()
+      )))
     }
   } else if cfg!(target_os = "macos") {
     Ok(exe_dir.join("../Resources"))

core/tauri/src/api/mod.rs

@@ -52,15 +52,6 @@ pub use error::Error;
 /// Tauri API result type.
 pub type Result<T> = std::result::Result<T, Error>;
 
-/// `App` package information.
-#[derive(Debug, Clone)]
-pub struct PackageInfo {
-  /// App name.
-  pub name: String,
-  /// App version.
-  pub version: String,
-}
-
 // Not public API
 #[doc(hidden)]
 pub mod private {

core/tauri/src/api/path.rs

@@ -7,7 +7,7 @@ use std::{
   path::{Path, PathBuf},
 };
 
-use crate::Config;
+use crate::{Config, PackageInfo};
 
 use serde_repr::{Deserialize_repr, Serialize_repr};
 
@@ -65,14 +65,22 @@ pub enum BaseDirectory {
 ///
 /// # Example
 /// ```
-/// use tauri::api::path::{resolve_path, BaseDirectory};
-/// // we use the default config, but in an actual app you should get the Config created from tauri.conf.json
-/// let path = resolve_path(&Default::default(), "path/to/something", Some(BaseDirectory::Config))
-///   .expect("failed to resolve path");
+/// use tauri::api::{path::{resolve_path, BaseDirectory}, PackageInfo};
+/// // we use the default config and a mock PackageInfo, but in an actual app you should get the Config created from tauri.conf.json and the app's PackageInfo instance
+/// let path = resolve_path(
+///   &Default::default(),
+///   &PackageInfo {
+///     name: "app".into(),
+///     version: "1.0.0".into(),
+///   },
+///   "path/to/something",
+///   Some(BaseDirectory::Config)
+///  ).expect("failed to resolve path");
 /// // path is equal to "/home/${whoami}/.config/path/to/something" on Linux
 /// ```
 pub fn resolve_path<P: AsRef<Path>>(
   config: &Config,
+  package_info: &PackageInfo,
   path: P,
   dir: Option<BaseDirectory>,
 ) -> crate::api::Result<PathBuf> {
@@ -94,7 +102,7 @@ pub fn resolve_path<P: AsRef<Path>>(
       BaseDirectory::Runtime => runtime_dir(),
       BaseDirectory::Template => template_dir(),
       BaseDirectory::Video => video_dir(),
-      BaseDirectory::Resource => resource_dir(),
+      BaseDirectory::Resource => resource_dir(package_info),
       BaseDirectory::App => app_dir(config),
       BaseDirectory::Current => Some(env::current_dir()?),
     };
@@ -194,8 +202,8 @@ pub fn video_dir() -> Option<PathBuf> {
 }
 
 /// Returns the path to the resource directory of this app.
-pub fn resource_dir() -> Option<PathBuf> {
-  crate::api::platform::resource_dir().ok()
+pub fn resource_dir(package_info: &PackageInfo) -> Option<PathBuf> {
+  crate::api::platform::resource_dir(package_info).ok()
 }
 
 /// Returns the path to the suggested directory for your app config files.

core/tauri/src/endpoints.rs

@@ -75,7 +75,7 @@ impl Module {
         .respond_async(async move { cmd.run().and_then(|r| r.json).map_err(InvokeError::from) }),
       Self::Fs(cmd) => resolver.respond_async(async move {
         cmd
-          .run(config)
+          .run(config, &package_info)
           .and_then(|r| r.json)
           .map_err(InvokeError::from)
       }),
@@ -122,7 +122,7 @@ impl Module {
       }
       Self::Notification(cmd) => resolver.respond_closure(move || {
         cmd
-          .run(config)
+          .run(config, &package_info)
           .and_then(|r| r.json)
           .map_err(InvokeError::from)
       }),