1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
use std::{
collections::HashMap,
panic,
path::{Path, PathBuf},
thread::{self, JoinHandle},
time::Instant,
};
#[cfg(ipc)]
use std::time::Duration;
use zng_txt::Txt;
use crate::{ipc, AnyResult, Event, Request, Response, ViewConfig, ViewProcessGen, ViewProcessOffline, VpResult};
/// The listener returns the closure on join for reuse in respawn.
type EventListenerJoin = JoinHandle<Box<dyn FnMut(Event) + Send>>;
pub(crate) const VIEW_VERSION: &str = "ZNG_VIEW_VERSION";
pub(crate) const VIEW_SERVER: &str = "ZNG_VIEW_SERVER";
pub(crate) const VIEW_MODE: &str = "ZNG_VIEW_MODE";
#[derive(Clone, Copy)]
enum ViewState {
Offline,
Online,
Suspended,
}
/// View Process controller, used in the App Process.
///
/// # Exit
///
/// The View Process is [killed] when the controller is dropped, if the app is running in same process mode
/// then the current process [exits] with code 0 on drop.
///
/// [killed]: std::process::Child::kill
/// [exits]: std::process::exit
#[cfg_attr(not(ipc), allow(unused))]
pub struct Controller {
process: Option<std::process::Child>,
view_state: ViewState,
generation: ViewProcessGen,
is_respawn: bool,
view_process_exe: PathBuf,
view_process_env: HashMap<Txt, Txt>,
request_sender: ipc::RequestSender,
response_receiver: ipc::ResponseReceiver,
event_listener: Option<EventListenerJoin>,
headless: bool,
same_process: bool,
device_events: bool,
last_respawn: Option<Instant>,
fast_respawn_count: u8,
}
#[cfg(test)]
fn _assert_sync(x: Controller) -> impl Send + Sync {
x
}
impl Controller {
/// Start with a custom view process.
///
/// The `view_process_exe` must be an executable that starts a view server.
/// Note that the [`VERSION`] of this crate must match in both executables.
///
/// The `view_process_env` can be set to any env var needed to start the view-process. Note that if `view_process_exe`
/// is the current executable this most likely need set `zng_env::PROCESS_MAIN`.
///
/// The `on_event` closure is called in another thread every time the app receives an event.
///
/// # Tests
///
/// The [`current_exe`] cannot be used in tests, you should set an external view-process executable. Unfortunately there
/// is no way to check if `start` was called in a test so we cannot provide an error message for this.
/// If the test is hanging in debug builds or has a timeout error in release builds this is probably the reason.
///
/// [`current_exe`]: std::env::current_exe
/// [`VERSION`]: crate::VERSION
pub fn start<F>(
view_process_exe: PathBuf,
view_process_env: HashMap<Txt, Txt>,
device_events: bool,
headless: bool,
on_event: F,
) -> Self
where
F: FnMut(Event) + Send + 'static,
{
Self::start_impl(view_process_exe, view_process_env, device_events, headless, Box::new(on_event))
}
fn start_impl(
view_process_exe: PathBuf,
view_process_env: HashMap<Txt, Txt>,
device_events: bool,
headless: bool,
mut on_event: Box<dyn FnMut(Event) + Send>,
) -> Self {
if ViewConfig::from_env().is_some() {
panic!("cannot start Controller in process configured to be view-process");
}
let (process, request_sender, response_receiver, mut event_receiver) =
Self::spawn_view_process(&view_process_exe, &view_process_env, headless).expect("failed to spawn or connect to view-process");
let ev = thread::spawn(move || {
while let Ok(ev) = event_receiver.recv() {
on_event(ev);
}
on_event(Event::Disconnected(ViewProcessGen::first()));
// return to reuse in respawn.
on_event
});
let mut c = Controller {
same_process: process.is_none(),
view_state: ViewState::Offline,
process,
view_process_exe,
view_process_env,
request_sender,
response_receiver,
event_listener: Some(ev),
headless,
device_events,
generation: ViewProcessGen::first(),
is_respawn: false,
last_respawn: None,
fast_respawn_count: 0,
};
if let Err(ViewProcessOffline) = c.try_init() {
panic!("respawn on init");
}
c
}
fn try_init(&mut self) -> VpResult<()> {
self.init(self.generation, self.is_respawn, self.device_events, self.headless)?;
Ok(())
}
/// View-process is connected and ready to respond.
pub fn online(&self) -> bool {
matches!(self.view_state, ViewState::Online)
}
/// View-process generation.
pub fn generation(&self) -> ViewProcessGen {
self.generation
}
/// If is running in headless mode.
pub fn headless(&self) -> bool {
self.headless
}
/// If device events are enabled.
pub fn device_events(&self) -> bool {
self.device_events
}
/// If is running both view and app in the same process.
pub fn same_process(&self) -> bool {
self.same_process
}
fn offline_err(&self) -> Result<(), ViewProcessOffline> {
if self.online() {
Ok(())
} else {
Err(ViewProcessOffline)
}
}
fn try_talk(&mut self, req: Request) -> ipc::IpcResult<Response> {
self.request_sender.send(req)?;
self.response_receiver.recv()
}
pub(crate) fn talk(&mut self, req: Request) -> VpResult<Response> {
debug_assert!(req.expect_response());
if req.must_be_online() {
self.offline_err()?;
}
match self.try_talk(req) {
Ok(r) => Ok(r),
Err(ipc::Disconnected) => {
self.handle_disconnect(self.generation);
Err(ViewProcessOffline)
}
}
}
pub(crate) fn command(&mut self, req: Request) -> VpResult<()> {
debug_assert!(!req.expect_response());
if req.must_be_online() {
self.offline_err()?;
}
match self.request_sender.send(req) {
Ok(_) => Ok(()),
Err(ipc::Disconnected) => {
self.handle_disconnect(self.generation);
Err(ViewProcessOffline)
}
}
}
fn spawn_view_process(
view_process_exe: &Path,
view_process_env: &HashMap<Txt, Txt>,
headless: bool,
) -> AnyResult<(
Option<std::process::Child>,
ipc::RequestSender,
ipc::ResponseReceiver,
ipc::EventReceiver,
)> {
let _span = tracing::trace_span!("spawn_view_process").entered();
let init = ipc::AppInit::new();
// create process and spawn it, unless is running in same process mode.
let process = if ViewConfig::is_awaiting_same_process() {
ViewConfig::set_same_process(ViewConfig {
version: crate::VERSION.into(),
server_name: Txt::from_str(init.name()),
headless,
});
None
} else {
#[cfg(not(ipc))]
{
let _ = (view_process_exe, view_process_env);
panic!("expected only same_process mode with `ipc` feature disabled");
}
#[cfg(ipc)]
{
let mut process = std::process::Command::new(view_process_exe);
for (name, val) in view_process_env {
process.env(name, val);
}
let process = process
.env(VIEW_VERSION, crate::VERSION)
.env(VIEW_SERVER, init.name())
.env(VIEW_MODE, if headless { "headless" } else { "headed" })
.env("RUST_BACKTRACE", "full")
.spawn()?;
Some(process)
}
};
let (req, rsp, ev) = match init.connect() {
Ok(r) => r,
Err(e) => {
#[cfg(ipc)]
if let Some(mut p) = process {
if let Err(ke) = p.kill() {
tracing::error!(
"failed to kill new view-process after failing to connect to it\n connection error: {e:?}\n kill error: {ke:?}",
);
} else {
match p.wait() {
Ok(output) => {
let code = output.code();
if ViewConfig::is_version_err(code, None) {
let code = code.unwrap_or(1);
tracing::error!(
"view-process API version mismatch, the view-process build must use the same exact version as the app-process, \
will exit app-process with code 0x{code:x}"
);
zng_env::exit(code);
} else {
tracing::error!("view-process exit code: {}", output.code().unwrap_or(1));
}
}
Err(e) => {
tracing::error!("failed to read output status of killed view-process, {e}");
}
}
}
} else {
tracing::error!("failed to connect with same process");
}
return Err(e);
}
};
Ok((process, req, rsp, ev))
}
/// Handle an [`Event::Inited`].
///
/// Set the online flag to `true`.
pub fn handle_inited(&mut self, gen: ViewProcessGen) {
match self.view_state {
ViewState::Offline => {
if self.generation == gen {
// crash respawn already sets gen
self.view_state = ViewState::Online;
}
}
ViewState::Suspended => {
self.generation = gen;
self.view_state = ViewState::Online;
}
ViewState::Online => {}
}
}
/// Handle an [`Event::Suspended`].
///
/// Set the online flat to `false`.
pub fn handle_suspended(&mut self) {
self.view_state = ViewState::Suspended;
}
/// Handle an [`Event::Disconnected`].
///
/// The `gen` parameter is the generation provided by the event. It is used to determinate if the disconnect has
/// not been handled already.
///
/// Tries to cleanup the old view-process and start a new one, if all is successful an [`Event::Inited`] is send.
///
/// The old view-process exit code and std output is logged using the `vp_respawn` target.
///
/// Exits the current process with code `1` if the view-process was killed by the user. In Windows this is if
/// the view-process exit code is `1`. In Unix if it was killed by SIGKILL, SIGSTOP, SIGINT.
///
/// # Panics
///
/// If the last five respawns happened all within 500ms of the previous respawn.
///
/// If the an error happens three times when trying to spawn the new view-process.
///
/// If another disconnect happens during the view-process startup dialog.
pub fn handle_disconnect(&mut self, gen: ViewProcessGen) {
if gen == self.generation {
#[cfg(not(ipc))]
{
tracing::error!(target: "vp_respawn", "cannot recover in same_process mode (no ipc)");
}
#[cfg(ipc)]
{
self.respawn_impl(true)
}
}
}
/// Reopen the view-process, causing another [`Event::Inited`].
///
/// This is similar to [`handle_disconnect`] but the current process does not
/// exit depending on the view-process exit code.
///
/// [`handle_disconnect`]: Controller::handle_disconnect
pub fn respawn(&mut self) {
#[cfg(not(ipc))]
{
tracing::error!(target: "vp_respawn", "cannot recover in same_process mode (no ipc)");
}
#[cfg(ipc)]
self.respawn_impl(false);
}
#[cfg(ipc)]
fn respawn_impl(&mut self, is_crash: bool) {
use zng_unit::TimeUnits;
self.view_state = ViewState::Offline;
self.is_respawn = true;
let mut process = if let Some(p) = self.process.take() {
p
} else {
if self.same_process {
tracing::error!(target: "vp_respawn", "cannot recover in same_process mode");
}
return;
};
if is_crash {
tracing::error!(target: "vp_respawn", "channel disconnect, will try respawn");
}
if is_crash {
let t = Instant::now();
if let Some(last_respawn) = self.last_respawn {
if t - last_respawn < Duration::from_secs(60) {
self.fast_respawn_count += 1;
if self.fast_respawn_count == 2 {
panic!("disconnect respawn happened 2 times less than 1 minute apart");
}
} else {
self.fast_respawn_count = 0;
}
}
self.last_respawn = Some(t);
} else {
self.last_respawn = None;
}
// try exit
let mut killed_by_us = false;
if !is_crash {
let _ = process.kill();
killed_by_us = true;
} else if !matches!(process.try_wait(), Ok(Some(_))) {
// if not exited, give the process 300ms to close with the preferred exit code.
thread::sleep(300.ms());
if !matches!(process.try_wait(), Ok(Some(_))) {
// if still not exited, kill it.
killed_by_us = true;
let _ = process.kill();
}
}
let code_and_output = match process.wait() {
Ok(c) => Some(c),
Err(e) => {
tracing::error!(target: "vp_respawn", "view-process could not be killed, will abandon running, {e:?}");
None
}
};
// try print stdout/err and exit code.
if let Some(c) = code_and_output {
tracing::info!(target: "vp_respawn", "view-process killed");
let code = c.code();
#[allow(unused_mut)]
let mut signal = None::<i32>;
if !killed_by_us {
// check if user killed the view-process, in this case we exit too.
#[cfg(windows)]
if code == Some(1) {
tracing::warn!(target: "vp_respawn", "view-process exit code (1), probably killed by the system, \
will exit app-process with the same code");
zng_env::exit(1);
}
#[cfg(unix)]
if code.is_none() {
use std::os::unix::process::ExitStatusExt as _;
signal = c.signal();
if let Some(sig) = signal {
if [2, 9, 17, 19, 23].contains(&sig) {
tracing::warn!(target: "vp_respawn", "view-process exited by signal ({sig}), \
will exit app-process with code 1");
zng_env::exit(1);
}
}
}
}
if !killed_by_us {
let code = code.unwrap_or(0);
let signal = signal.unwrap_or(0);
tracing::error!(target: "vp_respawn", "view-process exit code: {code:#X}, signal: {signal}");
}
if ViewConfig::is_version_err(code, None) {
let code = code.unwrap_or(1);
tracing::error!(target: "vp_respawn", "view-process API version mismatch, the view-process build must use the same exact version as the app-process, \
will exit app-process with code 0x{code:x}");
zng_env::exit(code);
}
} else {
tracing::error!(target: "vp_respawn", "failed to kill view-process, will abandon it running and spawn a new one");
}
// recover event listener closure (in a box).
let mut on_event = match self.event_listener.take().unwrap().join() {
Ok(fn_) => fn_,
Err(p) => panic::resume_unwind(p),
};
// respawn
let mut retries = 3;
let (new_process, request, response, mut event) = loop {
match Self::spawn_view_process(&self.view_process_exe, &self.view_process_env, self.headless) {
Ok(r) => break r,
Err(e) => {
tracing::error!(target: "vp_respawn", "failed to respawn, {e:?}");
retries -= 1;
if retries == 0 {
panic!("failed to respawn `view-process` after 3 retries");
}
tracing::info!(target: "vp_respawn", "retrying respawn");
}
}
};
// update connections
self.process = new_process;
self.request_sender = request;
self.response_receiver = response;
let next_id = self.generation.next();
self.generation = next_id;
if let Err(ViewProcessOffline) = self.try_init() {
panic!("respawn on respawn startup");
}
let ev = thread::spawn(move || {
while let Ok(ev) = event.recv() {
on_event(ev);
}
on_event(Event::Disconnected(next_id));
on_event
});
self.event_listener = Some(ev);
}
}
impl Drop for Controller {
/// Kills the View Process, unless it is running in the same process.
fn drop(&mut self) {
let _ = self.exit();
#[cfg(ipc)]
if let Some(mut process) = self.process.take() {
if process.try_wait().is_err() {
std::thread::sleep(Duration::from_secs(1));
if process.try_wait().is_err() {
tracing::error!("view-process did not exit after 1s, killing");
let _ = process.kill();
let _ = process.wait();
}
}
}
}
}