fix(core): allow hyphens and underscores on identifiers, closes #9707 (#10700)

lucasfernog · web-flow · commit 793ee0531730 · 2024-08-21T13:46:25.000-03:00
* fix(core): allow hyphens and underscores on identifiers, closes #9707 * fix build * fix build * lint * move replace * update tao * update tao-macros
diff --git a/.changes/mobile-identifier.md b/.changes/mobile-identifier.md
@@ -0,0 +1,8 @@
+---
+"tauri-cli": patch:bug
+"tauri-build": patch:bug
+"@tauri-apps/cli": patch:bug
+"tauri-runtime-wry": patch:bug
+---
+
+Allow hyphens and underscores on app identifiers.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/core/tauri-build/src/lib.rs b/core/tauri-build/src/lib.rs
@@ -476,9 +476,12 @@ pub fn try_build(attributes: Attributes) -> Result<()> {
   let mut android_package_prefix = String::new();
   for (i, w) in s.enumerate() {
     if i == last {
-      println!("cargo:rustc-env=TAURI_ANDROID_PACKAGE_NAME_APP_NAME={w}");
+      println!(
+        "cargo:rustc-env=TAURI_ANDROID_PACKAGE_NAME_APP_NAME={}",
+        w.replace('-', "_")
+      );
     } else {
-      android_package_prefix.push_str(w);
+      android_package_prefix.push_str(&w.replace(['_', '-'], "_1"));
       android_package_prefix.push('_');
     }
   }
diff --git a/core/tauri-macros/src/mobile.rs b/core/tauri-macros/src/mobile.rs
@@ -8,15 +8,10 @@ use quote::{format_ident, quote};
 use std::env::var;
 use syn::{parse_macro_input, spanned::Spanned, ItemFn};
 
-fn get_env_var<R: FnOnce(String) -> String>(
-  name: &str,
-  replacer: R,
-  error: &mut Option<TokenStream2>,
-  function: &ItemFn,
-) -> TokenStream2 {
+fn get_env_var(name: &str, error: &mut Option<TokenStream2>, function: &ItemFn) -> TokenStream2 {
   match var(name) {
     Ok(value) => {
-      let ident = format_ident!("{}", replacer(value));
+      let ident = format_ident!("{value}");
       quote!(#ident)
     }
     Err(_) => {
@@ -37,18 +32,8 @@ pub fn entry_point(_attributes: TokenStream, item: TokenStream) -> TokenStream {
   let function_name = &function.sig.ident;
 
   let mut error = None;
-  let domain = get_env_var(
-    "TAURI_ANDROID_PACKAGE_NAME_PREFIX",
-    |r| r,
-    &mut error,
-    &function,
-  );
-  let app_name = get_env_var(
-    "TAURI_ANDROID_PACKAGE_NAME_APP_NAME",
-    |r| r.replace('-', "_"),
-    &mut error,
-    &function,
-  );
+  let domain = get_env_var("TAURI_ANDROID_PACKAGE_NAME_PREFIX", &mut error, &function);
+  let app_name = get_env_var("TAURI_ANDROID_PACKAGE_NAME_APP_NAME", &mut error, &function);
 
   if let Some(e) = error {
     quote!(#e).into()
diff --git a/core/tauri-runtime-wry/Cargo.toml b/core/tauri-runtime-wry/Cargo.toml
@@ -18,7 +18,7 @@ rustdoc-args = [ "--cfg", "docsrs" ]
 
 [dependencies]
 wry = { version = "0.42", default-features = false, features = [ "drag-drop", "protocol", "os-webview" ] }
-tao = { version = "0.29", default-features = false, features = [ "rwh_06" ] }
+tao = { version = "0.29.1", default-features = false, features = [ "rwh_06" ] }
 tauri-runtime = { version = "2.0.0-rc.5", path = "../tauri-runtime" }
 tauri-utils = { version = "2.0.0-rc.5", path = "../tauri-utils" }
 raw-window-handle = "0.6"
diff --git a/examples/api/src-tauri/Cargo.lock b/examples/api/src-tauri/Cargo.lock
diff --git a/tooling/cli/Cargo.lock b/tooling/cli/Cargo.lock
diff --git a/tooling/cli/Cargo.toml b/tooling/cli/Cargo.toml
@@ -39,7 +39,7 @@ name = "cargo-tauri"
 path = "src/main.rs"
 
 [dependencies]
-cargo-mobile2 = { version = "0.13.4", default-features = false }
+cargo-mobile2 = { version = "0.13.5", default-features = false }
 jsonrpsee = { version = "0.24", features = [ "server" ] }
 jsonrpsee-core = "0.24"
 jsonrpsee-client-transport = { version = "0.24", features = [ "ws" ] }
diff --git a/tooling/cli/src/mobile/android/android_studio_script.rs b/tooling/cli/src/mobile/android/android_studio_script.rs
@@ -52,7 +52,11 @@ pub fn command(options: Options) -> Result<()> {
     let tauri_config_ = tauri_config_guard.as_ref().unwrap();
     let cli_options = read_options(&tauri_config_.identifier);
     let (config, metadata) = get_config(
-      &get_app(tauri_config_, &AppInterface::new(tauri_config_, None)?),
+      &get_app(
+        MobileTarget::Android,
+        tauri_config_,
+        &AppInterface::new(tauri_config_, None)?,
+      ),
       tauri_config_,
       None,
       &cli_options,
diff --git a/tooling/cli/src/mobile/android/build.rs b/tooling/cli/src/mobile/android/build.rs
@@ -114,7 +114,7 @@ pub fn command(options: Options, noise_level: NoiseLevel) -> Result<()> {
     let interface = AppInterface::new(tauri_config_, build_options.target.clone())?;
     interface.build_options(&mut Vec::new(), &mut build_options.features, true);
 
-    let app = get_app(tauri_config_, &interface);
+    let app = get_app(MobileTarget::Android, tauri_config_, &interface);
     let (config, metadata) = get_config(
       &app,
       tauri_config_,
diff --git a/tooling/cli/src/mobile/android/dev.rs b/tooling/cli/src/mobile/android/dev.rs
@@ -134,7 +134,7 @@ fn run_command(options: Options, noise_level: NoiseLevel) -> Result<()> {
 
     let interface = AppInterface::new(tauri_config_, dev_options.target.clone())?;
 
-    let app = get_app(tauri_config_, &interface);
+    let app = get_app(MobileTarget::Android, tauri_config_, &interface);
     let (config, metadata) = get_config(
       &app,
       tauri_config_,
diff --git a/tooling/cli/src/mobile/init.rs b/tooling/cli/src/mobile/init.rs
@@ -89,7 +89,11 @@ pub fn exec(
   let tauri_config_guard = tauri_config.lock().unwrap();
   let tauri_config_ = tauri_config_guard.as_ref().unwrap();
 
-  let app = get_app(tauri_config_, &AppInterface::new(tauri_config_, None)?);
+  let app = get_app(
+    target,
+    tauri_config_,
+    &AppInterface::new(tauri_config_, None)?,
+  );
 
   let (handlebars, mut map) = handlebars(&app);
 
diff --git a/tooling/cli/src/mobile/ios/build.rs b/tooling/cli/src/mobile/ios/build.rs
@@ -146,7 +146,7 @@ pub fn command(options: Options, noise_level: NoiseLevel) -> Result<()> {
     let interface = AppInterface::new(tauri_config_, build_options.target.clone())?;
     interface.build_options(&mut Vec::new(), &mut build_options.features, true);
 
-    let app = get_app(tauri_config_, &interface);
+    let app = get_app(MobileTarget::Ios, tauri_config_, &interface);
     let (config, _metadata) = get_config(
       &app,
       tauri_config_,
diff --git a/tooling/cli/src/mobile/ios/dev.rs b/tooling/cli/src/mobile/ios/dev.rs
@@ -159,7 +159,7 @@ fn run_command(options: Options, noise_level: NoiseLevel) -> Result<()> {
 
     let interface = AppInterface::new(tauri_config_, Some(target_triple))?;
 
-    let app = get_app(tauri_config_, &interface);
+    let app = get_app(MobileTarget::Ios, tauri_config_, &interface);
     let (config, _metadata) = get_config(
       &app,
       tauri_config_,
diff --git a/tooling/cli/src/mobile/ios/xcode_script.rs b/tooling/cli/src/mobile/ios/xcode_script.rs
@@ -81,7 +81,11 @@ pub fn command(options: Options) -> Result<()> {
     let tauri_config_ = tauri_config_guard.as_ref().unwrap();
     let cli_options = read_options(&tauri_config_.identifier);
     let (config, metadata) = get_config(
-      &get_app(tauri_config_, &AppInterface::new(tauri_config_, None)?),
+      &get_app(
+        MobileTarget::Ios,
+        tauri_config_,
+        &AppInterface::new(tauri_config_, None)?,
+      ),
       tauri_config_,
       None,
       &cli_options,
diff --git a/tooling/cli/src/mobile/mod.rs b/tooling/cli/src/mobile/mod.rs
@@ -248,13 +248,19 @@ fn read_options(identifier: &str) -> CliOptions {
   options
 }
 
-pub fn get_app(config: &TauriConfig, interface: &AppInterface) -> App {
+pub fn get_app(target: Target, config: &TauriConfig, interface: &AppInterface) -> App {
   let identifier = config
     .identifier
     .rsplit('.')
     .collect::<Vec<&str>>()
     .join(".");
 
+  let identifier = match target {
+    Target::Android => identifier.replace('-', "_"),
+    #[cfg(target_os = "macos")]
+    Target::Ios => identifier.replace('_', "-"),
+  };
+
   if identifier.is_empty() {
     log::error!("Bundle identifier set in `tauri.conf.json > identifier` cannot be empty");
     exit(1);
@@ -318,7 +324,7 @@ fn ensure_init(
     Target::Android => {
       let java_folder = project_dir
         .join("app/src/main/java")
-        .join(tauri_config_.identifier.replace('.', "/"));
+        .join(tauri_config_.identifier.replace('.', "/").replace('-', "_"));
       if !java_folder.exists() {
         project_outdated_reasons
           .push("you have modified your \"identifier\" in the Tauri configuration");
@@ -330,7 +336,7 @@ fn ensure_init(
         .context("missing project.yml file in the Xcode project directory")?;
       if !project_yml.contains(&format!(
         "PRODUCT_BUNDLE_IDENTIFIER: {}",
-        tauri_config_.identifier
+        tauri_config_.identifier.replace('_', "-")
       )) {
         project_outdated_reasons
           .push("you have modified your \"identifier\" in the Tauri configuration");
