// Copyright 2019-2024 Tauri Programme within The Commons Conservancy // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT use crate::{ error::{Context, ErrorExt}, helpers::{ app_paths::{frontend_dir, tauri_dir}, command_env, config::{ get as get_config, reload as reload_config, BeforeDevCommand, ConfigHandle, FrontendDist, }, }, info::plugins::check_mismatched_packages, interface::{AppInterface, ExitReason, Interface}, CommandExt, ConfigValue, Error, Result, }; use clap::{ArgAction, Parser}; use shared_child::SharedChild; use tauri_utils::{config::RunnerConfig, platform::Target}; use std::{ env::set_current_dir, net::{IpAddr, Ipv4Addr}, path::PathBuf, process::{exit, Command, Stdio}, sync::{ atomic::{AtomicBool, Ordering}, Arc, Mutex, OnceLock, }, }; mod builtin_dev_server; static BEFORE_DEV: OnceLock>> = OnceLock::new(); static KILL_BEFORE_DEV_FLAG: AtomicBool = AtomicBool::new(false); #[cfg(unix)] const KILL_CHILDREN_SCRIPT: &[u8] = include_bytes!("../scripts/kill-children.sh"); pub const TAURI_CLI_BUILTIN_WATCHER_IGNORE_FILE: &[u8] = include_bytes!("../tauri-dev-watcher.gitignore"); #[derive(Debug, Clone, Parser)] #[clap( about = "Run your app in development mode", long_about = "Run your app in development mode with hot-reloading for the Rust code. It makes use of the `build.devUrl` property from your `tauri.conf.json` file. It also runs your `build.beforeDevCommand` which usually starts your frontend devServer.", trailing_var_arg(true) )] pub struct Options { /// Binary to use to run the application #[clap(short, long)] pub runner: Option, /// Target triple to build against #[clap(short, long)] pub target: Option, /// List of cargo features to activate #[clap(short, long, action = ArgAction::Append, num_args(0..))] pub features: Vec, /// Exit on panic #[clap(short, long)] pub exit_on_panic: bool, /// JSON strings or paths to JSON, JSON5 or TOML files to merge with the default configuration file /// /// Configurations are merged in the order they are provided, which means a particular value overwrites previous values when a config key-value pair conflicts. /// /// Note that a platform-specific file is looked up and merged with the default file by default /// (tauri.macos.conf.json, tauri.linux.conf.json, tauri.windows.conf.json, tauri.android.conf.json and tauri.ios.conf.json) /// but you can use this for more specific use cases such as different build flavors. #[clap(short, long)] pub config: Vec, /// Run the code in release mode #[clap(long = "release")] pub release_mode: bool, /// Command line arguments passed to the runner. /// Use `--` to explicitly mark the start of the arguments. Arguments after a second `--` are passed to the application /// e.g. `tauri dev -- [runnerArgs] -- [appArgs]`. pub args: Vec, /// Skip waiting for the frontend dev server to start before building the tauri application. #[clap(long, env = "TAURI_CLI_NO_DEV_SERVER_WAIT")] pub no_dev_server_wait: bool, /// Disable the file watcher. #[clap(long)] pub no_watch: bool, /// Additional paths to watch for changes. #[clap(long)] pub additional_watch_folders: Vec, /// Disable the built-in dev server for static files. #[clap(long)] pub no_dev_server: bool, /// Specify port for the built-in dev server for static files. Defaults to 1430. #[clap(long, env = "TAURI_CLI_PORT")] pub port: Option, #[clap(skip)] pub host: Option, } pub fn command(options: Options) -> Result<()> { crate::helpers::app_paths::resolve(); let r = command_internal(options); if r.is_err() { kill_before_dev_process(); } r } fn command_internal(mut options: Options) -> Result<()> { let target = options .target .as_deref() .map(Target::from_triple) .unwrap_or_else(Target::current); let config = get_config( target, &options.config.iter().map(|c| &c.0).collect::>(), )?; let mut interface = AppInterface::new( config.lock().unwrap().as_ref().unwrap(), options.target.clone(), )?; setup(&interface, &mut options, config)?; let exit_on_panic = options.exit_on_panic; let no_watch = options.no_watch; interface.dev(options.into(), move |status, reason| { on_app_exit(status, reason, exit_on_panic, no_watch) }) } pub fn setup(interface: &AppInterface, options: &mut Options, config: ConfigHandle) -> Result<()> { let tauri_path = tauri_dir(); std::thread::spawn(|| { if let Err(error) = check_mismatched_packages(frontend_dir(), tauri_path) { log::error!("{error}"); } }); set_current_dir(tauri_path).context("failed to set current directory")?; if let Some(before_dev) = config .lock() .unwrap() .as_ref() .unwrap() .build .before_dev_command .clone() { let (script, script_cwd, wait) = match before_dev { BeforeDevCommand::Script(s) if s.is_empty() => (None, None, false), BeforeDevCommand::Script(s) => (Some(s), None, false), BeforeDevCommand::ScriptWithOptions { script, cwd, wait } => { (Some(script), cwd.map(Into::into), wait) } }; let cwd = script_cwd.unwrap_or_else(|| frontend_dir().clone()); if let Some(before_dev) = script { log::info!(action = "Running"; "BeforeDevCommand (`{}`)", before_dev); let mut env = command_env(true); env.extend(interface.env()); #[cfg(windows)] let mut command = { let mut command = Command::new("cmd"); command .arg("/S") .arg("/C") .arg(&before_dev) .current_dir(cwd) .envs(env); command }; #[cfg(not(windows))] let mut command = { let mut command = Command::new("sh"); command .arg("-c") .arg(&before_dev) .current_dir(cwd) .envs(env); command }; if wait { let status = command.piped().map_err(|error| Error::CommandFailed { command: format!( "`{before_dev}` with `{}`", if cfg!(windows) { "cmd /S /C" } else { "sh -c" } ), error, })?; if !status.success() { crate::error::bail!( "beforeDevCommand `{}` failed with exit code {}", before_dev, status.code().unwrap_or_default() ); } } else { command.stdin(Stdio::piped()); command.stdout(os_pipe::dup_stdout().unwrap()); command.stderr(os_pipe::dup_stderr().unwrap()); let child = SharedChild::spawn(&mut command) .unwrap_or_else(|_| panic!("failed to run `{before_dev}`")); let child = Arc::new(child); let child_ = child.clone(); std::thread::spawn(move || { let status = child_ .wait() .expect("failed to wait on \"beforeDevCommand\""); if !(status.success() || KILL_BEFORE_DEV_FLAG.load(Ordering::Relaxed)) { log::error!("The \"beforeDevCommand\" terminated with a non-zero status code."); exit(status.code().unwrap_or(1)); } }); BEFORE_DEV.set(Mutex::new(child)).unwrap(); let _ = ctrlc::set_handler(move || { kill_before_dev_process(); exit(130); }); } } } if options.runner.is_none() { options.runner = config .lock() .unwrap() .as_ref() .unwrap() .build .runner .clone(); } let mut cargo_features = config .lock() .unwrap() .as_ref() .unwrap() .build .features .clone() .unwrap_or_default(); cargo_features.extend(options.features.clone()); let mut dev_url = config .lock() .unwrap() .as_ref() .unwrap() .build .dev_url .clone(); let frontend_dist = config .lock() .unwrap() .as_ref() .unwrap() .build .frontend_dist .clone(); if !options.no_dev_server && dev_url.is_none() { if let Some(FrontendDist::Directory(path)) = &frontend_dist { if path.exists() { let path = path .canonicalize() .fs_context("failed to canonicalize path", path.to_path_buf())?; let ip = options .host .unwrap_or_else(|| Ipv4Addr::new(127, 0, 0, 1).into()); let server_url = builtin_dev_server::start(path, ip, options.port) .context("failed to start builtin dev server")?; let server_url = format!("http://{server_url}"); dev_url = Some(server_url.parse().unwrap()); options.config.push(crate::ConfigValue(serde_json::json!({ "build": { "devUrl": server_url } }))); reload_config(&options.config.iter().map(|c| &c.0).collect::>())?; } } } if !options.no_dev_server_wait { if let Some(url) = dev_url { let host = url.host().expect("No host name in the URL"); let port = url .port_or_known_default() .expect("No port number in the URL"); let addrs; let addr; let addrs = match host { url::Host::Domain(domain) => { use std::net::ToSocketAddrs; addrs = (domain, port).to_socket_addrs().unwrap(); addrs.as_slice() } url::Host::Ipv4(ip) => { addr = (ip, port).into(); std::slice::from_ref(&addr) } url::Host::Ipv6(ip) => { addr = (ip, port).into(); std::slice::from_ref(&addr) } }; let mut i = 0; let sleep_interval = std::time::Duration::from_secs(2); let timeout_duration = std::time::Duration::from_secs(1); let max_attempts = 90; 'waiting: loop { for addr in addrs.iter() { if std::net::TcpStream::connect_timeout(addr, timeout_duration).is_ok() { break 'waiting; } } if i % 3 == 1 { log::warn!("Waiting for your frontend dev server to start on {url}...",); } i += 1; if i == max_attempts { log::error!("Could not connect to `{url}` after {}s. Please make sure that is the URL to your dev server.", i * sleep_interval.as_secs()); exit(1); } std::thread::sleep(sleep_interval); } } } if options.additional_watch_folders.is_empty() { options.additional_watch_folders.extend( config .lock() .unwrap() .as_ref() .unwrap() .build .additional_watch_folders .clone(), ); } Ok(()) } pub fn on_app_exit(code: Option, reason: ExitReason, exit_on_panic: bool, no_watch: bool) { if no_watch || (!matches!(reason, ExitReason::TriggeredKill) && (exit_on_panic || matches!(reason, ExitReason::NormalExit))) { kill_before_dev_process(); exit(code.unwrap_or(0)); } } pub fn kill_before_dev_process() { if let Some(child) = BEFORE_DEV.get() { let child = child.lock().unwrap(); if KILL_BEFORE_DEV_FLAG.load(Ordering::Relaxed) { return; } KILL_BEFORE_DEV_FLAG.store(true, Ordering::Relaxed); #[cfg(windows)] { let powershell_path = std::env::var("SYSTEMROOT").map_or_else( |_| "powershell.exe".to_string(), |p| format!("{p}\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"), ); let _ = Command::new(powershell_path) .arg("-NoProfile") .arg("-Command") .arg(format!("function Kill-Tree {{ Param([int]$ppid); Get-CimInstance Win32_Process | Where-Object {{ $_.ParentProcessId -eq $ppid }} | ForEach-Object {{ Kill-Tree $_.ProcessId }}; Stop-Process -Id $ppid -ErrorAction SilentlyContinue }}; Kill-Tree {}", child.id())) .status(); } #[cfg(unix)] { use std::io::Write; let mut kill_children_script_path = std::env::temp_dir(); kill_children_script_path.push("tauri-stop-dev-processes.sh"); if !kill_children_script_path.exists() { if let Ok(mut file) = std::fs::File::create(&kill_children_script_path) { use std::os::unix::fs::PermissionsExt; let _ = file.write_all(KILL_CHILDREN_SCRIPT); let mut permissions = file.metadata().unwrap().permissions(); permissions.set_mode(0o770); let _ = file.set_permissions(permissions); } } let _ = Command::new(&kill_children_script_path) .arg(child.id().to_string()) .output(); } let _ = child.kill(); } }