refactor(core): use bundle identifier on app dir, closes #1693 (#1703)

* refactor(core): use bundle identifier on app dir, closes #1693

* fix: tests

* clippy

Author: lucasfernog

.changes/app-dir-refactor.md

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

core/tauri-utils/src/config.rs

@@ -397,7 +397,7 @@ pub struct PackageConfig {
 }
 
 /// The tauri.conf.json mapper.
-#[derive(Debug, PartialEq, Deserialize)]
+#[derive(Debug, Default, PartialEq, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Config {
   /// Package settings.

core/tauri/src/api/path.rs

@@ -7,6 +7,8 @@ use std::{
   path::{Path, PathBuf},
 };
 
+use crate::Config;
+
 use serde_repr::{Deserialize_repr, Serialize_repr};
 
 /// A Base Directory to use.
@@ -52,7 +54,7 @@ pub enum BaseDirectory {
   /// The Resource directory.
   Resource,
   /// The default App config directory.
-  /// Resolves to ${CONFIG_DIR}/${APP_NAME}
+  /// Resolves to ${BaseDirectory::Config}/${config.tauri.bundle.identifier}
   App,
   /// The current working directory.
   Current,
@@ -63,11 +65,13 @@ pub enum BaseDirectory {
 /// # Example
 /// ```
 /// use tauri::api::path::{resolve_path, BaseDirectory};
-/// let path = resolve_path("path/to/something", Some(BaseDirectory::Config))
+/// // 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");
 /// // path is equal to "/home/${whoami}/.config/path/to/something" on Linux
 /// ```
 pub fn resolve_path<P: AsRef<Path>>(
+  config: &Config,
   path: P,
   dir: Option<BaseDirectory>,
 ) -> crate::api::Result<PathBuf> {
@@ -90,7 +94,7 @@ pub fn resolve_path<P: AsRef<Path>>(
       BaseDirectory::Template => template_dir(),
       BaseDirectory::Video => video_dir(),
       BaseDirectory::Resource => resource_dir(),
-      BaseDirectory::App => app_dir(),
+      BaseDirectory::App => app_dir(config),
       BaseDirectory::Current => Some(env::current_dir()?),
     };
     if let Some(mut base_dir_path_value) = base_dir_path {
@@ -193,24 +197,7 @@ pub fn resource_dir() -> Option<PathBuf> {
   crate::api::platform::resource_dir().ok()
 }
 
-fn app_name() -> crate::api::Result<String> {
-  let exe = std::env::current_exe()?;
-  let app_name = exe
-    .file_stem()
-    .expect("failed to get exe filename")
-    .to_string_lossy();
-
-  Ok(app_name.to_string())
-}
-
 /// Returns the path to the suggested directory for your app config files.
-pub fn app_dir() -> Option<PathBuf> {
-  dirs_next::config_dir().and_then(|mut dir| {
-    if let Ok(app_name) = app_name() {
-      dir.push(app_name);
-      Some(dir)
-    } else {
-      None
-    }
-  })
+pub fn app_dir(config: &Config) -> Option<PathBuf> {
+  dirs_next::config_dir().map(|dir| dir.join(&config.tauri.bundle.identifier))
 }

core/tauri/src/endpoints.rs

@@ -9,6 +9,9 @@ use crate::{
 };
 use serde::{Deserialize, Serialize};
 use serde_json::Value as JsonValue;
+
+use std::sync::Arc;
+
 mod app;
 mod cli;
 mod dialog;
@@ -58,7 +61,7 @@ impl Module {
     self,
     window: Window<M>,
     resolver: InvokeResolver<M>,
-    config: &Config,
+    config: Arc<Config>,
     package_info: PackageInfo,
   ) {
     match self {
@@ -70,8 +73,12 @@ impl Module {
       }),
       Self::Process(cmd) => resolver
         .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().and_then(|r| r.json).map_err(InvokeError::from) }),
+      Self::Fs(cmd) => resolver.respond_async(async move {
+        cmd
+          .run(config)
+          .and_then(|r| r.json)
+          .map_err(InvokeError::from)
+      }),
       Self::Window(cmd) => resolver.respond_async(async move {
         cmd
           .run(window)
@@ -113,15 +120,12 @@ impl Module {
           })
         }
       }
-      Self::Notification(cmd) => {
-        let identifier = config.tauri.bundle.identifier.clone();
-        resolver.respond_async(async move {
-          cmd
-            .run(identifier)
-            .and_then(|r| r.json)
-            .map_err(InvokeError::from)
-        })
-      }
+      Self::Notification(cmd) => resolver.respond_closure(move || {
+        cmd
+          .run(config)
+          .and_then(|r| r.json)
+          .map_err(InvokeError::from)
+      }),
       Self::Http(cmd) => resolver.respond_async(async move {
         cmd
           .run()
@@ -142,7 +146,7 @@ impl Module {
 pub(crate) fn handle<P: Params>(
   module: String,
   invoke: Invoke<P>,
-  config: &Config,
+  config: Arc<Config>,
   package_info: &PackageInfo,
 ) {
   let Invoke { message, resolver } = invoke;