chore: remove unstable log features & use qualified log::<macro> path (#9069)

* chore: remove unstable log features & use qualified `log::<macro>` path

* fmt

* fix build

Author: amrbashir

.changes/utils-debug-eprintln.md

@@ -0,0 +1,5 @@
+---
+'tauri-utils': 'major:breaking'
+---
+
+Removed `debug_eprintln!` and `consume_unused_variable` macros.

Cargo.lock

@@ -21,6 +21,7 @@ raw-window-handle = "0.6"
 http = "0.2"
 url = "2"
 tracing = { version = "0.1", optional = true }
+log = "0.4"
 
 [target."cfg(windows)".dependencies]
 webview2-com = "0.28"

core/tauri-runtime-wry/Cargo.toml

@@ -59,7 +59,7 @@ use tao::{
 };
 #[cfg(target_os = "macos")]
 use tauri_utils::TitleBarStyle;
-use tauri_utils::{config::WindowConfig, debug_eprintln, Theme};
+use tauri_utils::{config::WindowConfig, Theme};
 use url::Url;
 use wry::{
   FileDropEvent as WryFileDropEvent, ProxyConfig, ProxyEndpoint, WebContext, WebView,
@@ -2808,14 +2808,14 @@ fn handle_user_message<T: UserEvent>(
           WebviewMessage::EvaluateScript(script, tx, span) => {
             let _span = span.entered();
             if let Err(e) = webview.evaluate_script(&script) {
-              debug_eprintln!("{}", e);
+              log::error!("{}", e);
             }
             tx.send(()).unwrap();
           }
           #[cfg(not(all(feature = "tracing", not(target_os = "android"))))]
           WebviewMessage::EvaluateScript(script) => {
             if let Err(e) = webview.evaluate_script(&script) {
-              debug_eprintln!("{}", e);
+              log::error!("{}", e);
             }
           }
           WebviewMessage::Navigate(url) => webview.load_url(url.as_str()),
@@ -2964,7 +2964,7 @@ fn handle_user_message<T: UserEvent>(
             });
           }
           Err(e) => {
-            debug_eprintln!("{}", e);
+            log::error!("{}", e);
           }
         }
       }
@@ -2974,7 +2974,7 @@ fn handle_user_message<T: UserEvent>(
         windows.0.borrow_mut().insert(window_id, webview);
       }
       Err(e) => {
-        debug_eprintln!("{}", e);
+        log::error!("{}", e);
       }
     },
     Message::CreateRawWindow(window_id, handler, sender) => {

core/tauri-runtime-wry/src/lib.rs

@@ -22,8 +22,6 @@ use std::{
 use semver::Version;
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
-use log::warn;
-
 pub mod acl;
 pub mod assets;
 pub mod config;
@@ -320,7 +318,7 @@ impl Default for Env {
           .unwrap_or(true);
 
         if !is_temp {
-          warn!("`APPDIR` or `APPIMAGE` environment variable found but this application was not detected as an AppImage; this might be a security issue.");
+          log::warn!("`APPDIR` or `APPIMAGE` environment variable found but this application was not detected as an AppImage; this might be a security issue.");
         }
       }
       env
@@ -388,34 +386,6 @@ pub enum Error {
   NotAllowedToWalkDir(std::path::PathBuf),
 }
 
-/// Suppresses the unused-variable warnings of the given inputs.
-///
-/// This does not move any values. Instead, it just suppresses the warning by taking a
-/// reference to the value.
-#[macro_export]
-macro_rules! consume_unused_variable {
-  ($($arg:expr),*) => {
-    $(
-      let _ = &$arg;
-    )*
-    ()
-  };
-}
-
-/// Prints to the standard error, with a newline.
-///
-/// Equivalent to the [`eprintln!`] macro, except that it's only effective for debug builds.
-#[macro_export]
-macro_rules! debug_eprintln {
-  () => ($crate::debug_eprintln!(""));
-  ($($arg:tt)*) => {
-    #[cfg(debug_assertions)]
-    eprintln!($($arg)*);
-    #[cfg(not(debug_assertions))]
-    $crate::consume_unused_variable!($($arg)*);
-  };
-}
-
 /// Reconstructs a path from its components using the platform separator then converts it to String and removes UNC prefixes on Windows if it exists.
 pub fn display_path<P: AsRef<Path>>(p: P) -> String {
   dunce::simplified(&p.as_ref().components().collect::<PathBuf>())

core/tauri-utils/src/lib.rs

@@ -73,6 +73,7 @@ ico = { version = "0.3.0", optional = true }
 http-range = { version = "0.1.5", optional = true }
 tracing = { version = "0.1", optional = true }
 heck = "0.4"
+log = "0.4"
 
 [target."cfg(any(target_os = \"linux\", target_os = \"dragonfly\", target_os = \"freebsd\", target_os = \"openbsd\", target_os = \"netbsd\", target_os = \"windows\", target_os = \"macos\"))".dependencies]
 muda = { version = "0.11", default-features = false, features = [ "serde" ] }
@@ -96,9 +97,6 @@ window-vibrancy = "0.5"
   version = "0.52"
   features = [ "Win32_Foundation" ]
 
-[target."cfg(any(target_os = \"android\", target_os = \"ios\"))".dependencies]
-log = "0.4"
-
 [target."cfg(target_os = \"android\")".dependencies]
 jni = "0.21"
 

core/tauri/Cargo.toml

@@ -40,7 +40,7 @@ use tauri_runtime::{
   },
   RuntimeInitArgs,
 };
-use tauri_utils::{debug_eprintln, PackageInfo};
+use tauri_utils::PackageInfo;
 
 use std::{
   borrow::Cow,
@@ -402,7 +402,7 @@ impl<R: Runtime> AppHandle<R> {
   /// Exits the app by triggering [`RunEvent::ExitRequested`] and [`RunEvent::Exit`].
   pub fn exit(&self, exit_code: i32) {
     if let Err(e) = self.runtime_handle.request_exit(exit_code) {
-      debug_eprintln!("failed to exit: {}", e);
+      log::error!("failed to exit: {}", e);
       self.cleanup_before_exit();
       std::process::exit(exit_code);
     }

core/tauri/src/app.rs

@@ -13,7 +13,6 @@ use serde::Serialize;
 use url::Url;
 
 use tauri_macros::default_runtime;
-use tauri_utils::debug_eprintln;
 use tauri_utils::{
   assets::{AssetKey, CspHash},
   config::{Csp, CspDirectiveSources},
@@ -67,7 +66,7 @@ fn set_csp<R: Runtime>(
             acc.style.push(hash.into());
           }
           _csp_hash => {
-            debug_eprintln!("Unknown CspHash variant encountered: {:?}", _csp_hash);
+            log::debug!("Unknown CspHash variant encountered: {:?}", _csp_hash);
           }
         }
 
@@ -362,14 +361,14 @@ impl<R: Runtime> AppManager<R> {
     let asset_response = assets
       .get(&path.as_str().into())
       .or_else(|| {
-        debug_eprintln!("Asset `{path}` not found; fallback to {path}.html");
+        log::debug!("Asset `{path}` not found; fallback to {path}.html");
         let fallback = format!("{}.html", path.as_str()).into();
         let asset = assets.get(&fallback);
         asset_path = fallback;
         asset
       })
       .or_else(|| {
-        debug_eprintln!(
+        log::debug!(
           "Asset `{}` not found; fallback to {}/index.html",
           path,
           path
@@ -380,7 +379,7 @@ impl<R: Runtime> AppManager<R> {
         asset
       })
       .or_else(|| {
-        debug_eprintln!("Asset `{}` not found; fallback to index.html", path);
+        log::debug!("Asset `{}` not found; fallback to index.html", path);
         let fallback = AssetKey::from("index.html");
         let asset = assets.get(&fallback);
         asset_path = fallback;
@@ -412,7 +411,7 @@ impl<R: Runtime> AppManager<R> {
         })
       }
       Err(e) => {
-        debug_eprintln!("{:?}", e); // TODO log::error!
+        log::error!("{:?}", e);
         Err(Box::new(e))
       }
     }

core/tauri/src/manager/mod.rs

@@ -6,7 +6,6 @@ use crate::{path::SafePathBuf, scope, webview::UriSchemeProtocolHandler};
 use http::{header::*, status::StatusCode, Request, Response};
 use http_range::HttpRange;
 use std::{borrow::Cow, io::SeekFrom};
-use tauri_utils::debug_eprintln;
 use tauri_utils::mime_type::MimeType;
 use tokio::fs::File;
 use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};
@@ -40,12 +39,12 @@ fn get_response(
   let mut resp = Response::builder().header("Access-Control-Allow-Origin", window_origin);
 
   if let Err(e) = SafePathBuf::new(path.clone().into()) {
-    debug_eprintln!("asset protocol path \"{}\" is not valid: {}", path, e);
+    log::error!("asset protocol path \"{}\" is not valid: {}", path, e);
     return resp.status(403).body(Vec::new().into()).map_err(Into::into);
   }
 
   if !scope.is_allowed(&path) {
-    debug_eprintln!("asset protocol not configured to allow the path: {}", path);
+    log::error!("asset protocol not configured to allow the path: {}", path);
     return resp.status(403).body(Vec::new().into()).map_err(Into::into);
   }
 

core/tauri/src/protocol/asset.rs

@@ -146,7 +146,7 @@ fn get_response<R: Runtime>(
           .body(response.body.to_vec().into())?
       }
       Err(e) => {
-        tauri_utils::debug_eprintln!("Failed to request {}: {}", url.as_str(), e);
+        log::error!("Failed to request {}: {}", url.as_str(), e);
         return Err(Box::new(e));
       }
     }