zinit 0.3.9

Process supervisor with dependency management
Documentation
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
//! Event handlers for the supervisor.

use crate::sdk::{FailureReason, ServiceState};
use nix::sys::signal::Signal;

use crate::server::graph::ServiceId;
use crate::server::process::send_signal_to_group;

use super::Supervisor;
use super::events::{ReevaluateAction, SupervisorEvent, TimeoutKind};

impl Supervisor {
    /// Handle a supervisor event.
    pub(crate) async fn handle_event(&mut self, event: SupervisorEvent) {
        // Log the event at debug level with service name resolution
        let event_desc = match &event {
            SupervisorEvent::ProcessExited {
                service_id,
                exit_code,
                signal,
            } => {
                let name = self
                    .service_name(*service_id)
                    .await
                    .unwrap_or_else(|| "?".to_string());
                format!(
                    "ProcessExited {{ service={}, exit_code={:?}, signal={:?} }}",
                    name, exit_code, signal
                )
            }
            SupervisorEvent::HealthCheckResult {
                service_id, passed, ..
            } => {
                let name = self
                    .service_name(*service_id)
                    .await
                    .unwrap_or_else(|| "?".to_string());
                format!(
                    "HealthCheckResult {{ service={}, passed={} }}",
                    name, passed
                )
            }
            SupervisorEvent::Timeout { service_id, kind } => {
                let name = self
                    .service_name(*service_id)
                    .await
                    .unwrap_or_else(|| "?".to_string());
                format!("Timeout {{ service={}, kind={:?} }}", name, kind)
            }
            SupervisorEvent::Reevaluate { service_id } => {
                let name = self
                    .service_name(*service_id)
                    .await
                    .unwrap_or_else(|| "?".to_string());
                format!("Reevaluate {{ service={} }}", name)
            }
            SupervisorEvent::BuiltinCompleted {
                service_id,
                success,
                ..
            } => {
                let name = self
                    .service_name(*service_id)
                    .await
                    .unwrap_or_else(|| "?".to_string());
                format!(
                    "BuiltinCompleted {{ service={}, success={} }}",
                    name, success
                )
            }
            _ => format!("{}", event),
        };
        tracing::debug!(event = %event_desc, "handling event");

        match event {
            SupervisorEvent::ProcessExited {
                service_id,
                exit_code,
                signal,
            } => {
                self.handle_process_exit(service_id, exit_code, signal)
                    .await;
            }
            SupervisorEvent::HealthCheckResult {
                service_id,
                passed,
                error,
            } => {
                self.handle_health_check_result(service_id, passed, error)
                    .await;
            }
            SupervisorEvent::Timeout { service_id, kind } => {
                self.handle_timeout(service_id, kind).await;
            }
            SupervisorEvent::Reevaluate { service_id } => {
                self.handle_reevaluate(service_id).await;
            }
            SupervisorEvent::StartService { name, response_tx } => {
                let result = self.start_service(&name).await;
                if let Err(ref e) = result {
                    tracing::error!(service = %name, error = %e, "failed to start service");
                }
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::StopService { name, response_tx } => {
                let result = self.stop_service(&name).await;
                if let Err(ref e) = result {
                    tracing::error!(service = %name, error = %e, "failed to stop service");
                }
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::RestartService { name, response_tx } => {
                // Check current state to decide if we need to stop first or can start directly
                let (id, is_running) = {
                    let graph = self.graph.read().await;
                    if let Some(id) = graph.get_by_name(&name) {
                        let service = graph.get(id).unwrap();
                        let is_running = service.state.is_active();
                        (Some(id), is_running)
                    } else {
                        (None, false)
                    }
                };

                let result = if let Some(id) = id {
                    if is_running {
                        // Service is running - stop it and start when it exits
                        self.pending_restarts.insert(id);
                        tracing::info!(service = %name, "restart requested, stopping service");
                        match self.stop_service(&name).await {
                            Ok(()) => Ok(()),
                            Err(e) => {
                                self.pending_restarts.remove(&id);
                                tracing::error!(service = %name, error = %e, "failed to stop service for restart");
                                Err(e)
                            }
                        }
                    } else {
                        // Service is already stopped - start it directly
                        tracing::info!(service = %name, "restart requested, service not running, starting");
                        {
                            let mut graph = self.graph.write().await;
                            if let Some(service) = graph.get_mut(id) {
                                service.reset_backoff();
                            }
                        }
                        self.try_start_service(id).await;
                        Ok(())
                    }
                } else {
                    tracing::error!(service = %name, "service not found for restart");
                    Err(crate::server::error::SupervisorError::ServiceNotFound(
                        name.clone(),
                    ))
                };
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::KillService {
                name,
                signal,
                response_tx,
            } => {
                let result = self.kill_service(&name, signal.as_deref()).await;
                if let Err(ref e) = result {
                    tracing::error!(service = %name, error = %e, "failed to kill service");
                }
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::AddService {
                config,
                response_tx,
            } => {
                let name = config.service.name.clone();
                let result = self.add_service(config).await;
                match &result {
                    Ok(()) => tracing::info!(service = %name, "service added"),
                    Err(e) => tracing::error!(service = %name, error = %e, "failed to add service"),
                }
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::RemoveService { name, response_tx } => {
                let result = self.remove_service(&name).await;
                match &result {
                    Ok(()) => {
                        tracing::info!(service = %name, "service removed");
                    }
                    Err(e) => {
                        tracing::error!(service = %name, error = %e, "failed to remove service");
                    }
                }
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::Reload { response_tx } => {
                let result = self.reload().await;
                match &result {
                    Ok(r) => {
                        tracing::info!(
                            added = r.added.len(),
                            removed = r.removed.len(),
                            changed = r.changed.len(),
                            "configuration reloaded"
                        );
                    }
                    Err(e) => {
                        tracing::error!(error = %e, "failed to reload configuration");
                    }
                }
                let _ = response_tx.send(result.map_err(|e| e.to_string()));
            }
            SupervisorEvent::PrepareRestart { response_tx } => {
                tracing::info!("preparing for restart");
                let result = self.prepare_restart().await;
                let _ = response_tx.send(result);
            }
            SupervisorEvent::BuiltinCompleted {
                service_id,
                success,
                error,
            } => {
                self.handle_builtin_completed(service_id, success, error)
                    .await;
            }
        }
    }

    /// Handle a service re-evaluation request.
    pub(crate) async fn handle_reevaluate(&mut self, id: ServiceId) {
        let action = {
            let graph = self.graph.read().await;
            let service = match graph.get(id) {
                Some(s) => s,
                None => return,
            };

            match &service.state {
                ServiceState::Blocked { .. } | ServiceState::Inactive => {
                    // Try to start blocked/inactive services
                    ReevaluateAction::TryStart
                }
                ServiceState::Running { .. } if service.is_target() => {
                    // Check if target's dependencies are still satisfied
                    // If not, downgrade the target
                    match graph.can_start(id) {
                        Ok(()) => ReevaluateAction::None,
                        Err(reason) => ReevaluateAction::DowngradeTarget {
                            name: service.name.clone(),
                            waiting_on: reason.waiting_on(),
                        },
                    }
                }
                _ => ReevaluateAction::None,
            }
        };

        match action {
            ReevaluateAction::TryStart => {
                self.try_start_service(id).await;
            }
            ReevaluateAction::DowngradeTarget { name, waiting_on } => {
                // Target's dependencies are no longer satisfied - downgrade it
                tracing::warn!(
                    target = %name,
                    waiting_on = ?waiting_on,
                    "target dependencies no longer satisfied, downgrading to blocked"
                );
                let dependents = {
                    let mut graph = self.graph.write().await;
                    graph.set_state(id, ServiceState::Blocked { waiting_on });
                    graph.dependents(id)
                };
                // Re-evaluate services that depended on this target
                self.queue_reevaluate(dependents).await;
            }
            ReevaluateAction::None => {}
        }
    }

    /// Handle a process exit event.
    pub(crate) async fn handle_process_exit(
        &mut self,
        id: ServiceId,
        exit_code: Option<i32>,
        signal: Option<i32>,
    ) {
        // Cancel any pending timers
        self.cancel_timeout(id, TimeoutKind::Start);
        self.cancel_timeout(id, TimeoutKind::Stop);
        self.cancel_timeout(id, TimeoutKind::HealthCheck);
        self.process_tasks.remove(&id);
        self.health_attempts.remove(&id);

        let (name, restart_delay, dependents, critical_failure) = {
            let mut graph = self.graph.write().await;
            let service = match graph.get_mut(id) {
                Some(s) => s,
                None => return,
            };

            let name = service.name.clone();
            let was_stopping = matches!(service.state, ServiceState::Stopping { .. });
            let is_oneshot = service
                .service_config()
                .map(|c| c.service.oneshot)
                .unwrap_or(false);
            let is_critical = service.is_critical();

            // Determine new state
            let new_state = if was_stopping {
                ServiceState::Exited { exit_code }
            } else if let Some(sig) = signal {
                ServiceState::Failed {
                    reason: FailureReason::Signal { signal: sig },
                }
            } else if exit_code == Some(0) || is_oneshot {
                ServiceState::Exited { exit_code }
            } else {
                ServiceState::Failed {
                    reason: FailureReason::ExitCode {
                        code: exit_code.unwrap_or(-1),
                    },
                }
            };

            service.state = new_state.clone();

            tracing::info!(
                service = %name,
                exit_code = ?exit_code,
                signal = ?signal,
                state = %new_state.name(),
                "process exited"
            );

            // Check for critical failure
            let critical_failure = if is_critical {
                if let ServiceState::Failed { ref reason } = new_state {
                    Some(reason.clone())
                } else {
                    None
                }
            } else {
                None
            };

            // Try to reset backoff if service was stable (ran long enough)
            // This must happen BEFORE next_restart_delay() to properly reset on stability
            service.try_reset_backoff();

            // Get restart delay with exponential backoff (if applicable)
            let restart_delay = if !was_stopping && !is_oneshot {
                match service.next_restart_delay(exit_code) {
                    Some(delay) => Some(delay),
                    None => {
                        if service.restart_count > 0 {
                            tracing::warn!(
                                service = %name,
                                restart_count = service.restart_count,
                                "max restarts exceeded, giving up"
                            );
                        }
                        None
                    }
                }
            } else {
                None
            };

            let dependents = graph.dependents(id);
            (name, restart_delay, dependents, critical_failure)
        };

        // Handle critical failure if this was a critical service
        if let Some(reason) = critical_failure {
            self.handle_critical_failure(&name, &reason).await;
        }

        // Notify dependents
        self.queue_reevaluate(dependents).await;

        // Check if this was an explicit restart request
        if self.pending_restarts.remove(&id) {
            tracing::info!(service = %name, "restarting service (explicit restart)");
            // Reset backoff since this was an explicit restart
            {
                let mut graph = self.graph.write().await;
                if let Some(service) = graph.get_mut(id) {
                    service.reset_backoff();
                }
            }
            self.try_start_service(id).await;
        } else if let Some(delay) = restart_delay {
            // Schedule restart if needed (with exponential backoff)
            // Get restart count for logging
            let restart_count = {
                let graph = self.graph.read().await;
                graph.get(id).map(|s| s.restart_count).unwrap_or(0)
            };
            tracing::info!(
                service = %name,
                delay_ms = delay,
                restart_count = restart_count,
                "scheduling restart with exponential backoff"
            );
            self.schedule_timeout(id, TimeoutKind::RestartDelay, delay);
        }
    }

    /// Handle critical service failure in PID1 mode.
    /// Logs an error message for manual recovery.
    pub(crate) async fn handle_critical_failure(
        &mut self,
        failed_service: &str,
        reason: &FailureReason,
    ) {
        if !self.pid1_mode {
            return;
        }

        tracing::error!("==================== CRITICAL FAILURE ====================");
        tracing::error!("Service '{}' failed: {}", failed_service, reason);
        tracing::error!("Manual intervention may be required.");
        tracing::error!("==========================================================");

        // Check if network target is reached (sshd available for remote recovery)
        let network_up = {
            let graph = self.graph.read().await;
            graph
                .get_by_name("network")
                .and_then(|id| graph.get(id))
                .is_some_and(|s| matches!(s.state, ServiceState::Running { .. }))
        };

        if network_up {
            tracing::error!("Network is up - connect via SSH to recover:");
            tracing::error!("  zinit status        # view service states");
            tracing::error!("  zinit start <name>  # retry failed service");
        } else {
            tracing::error!("Network not available. Use serial console if configured.");
        }
    }

    /// Handle a health check result.
    pub(crate) async fn handle_health_check_result(
        &mut self,
        id: ServiceId,
        passed: bool,
        error: Option<String>,
    ) {
        if passed {
            // Health check passed
            let dependents = {
                let mut graph = self.graph.write().await;
                let service = match graph.get_mut(id) {
                    Some(s) => s,
                    None => return,
                };

                let name = service.name.clone();

                if let ServiceState::Starting { pid } = service.state {
                    service.state = ServiceState::Running { pid };
                    // Note: Don't reset backoff here - it will be reset when the
                    // service has been running long enough (stability period).
                    tracing::info!(service = %name, "health check passed, service running");
                    graph.dependents(id)
                } else {
                    return;
                }
            };

            self.cancel_timeout(id, TimeoutKind::Start);
            self.health_attempts.remove(&id);
            self.queue_reevaluate(dependents).await;
        } else {
            // Health check failed
            let attempts = self.health_attempts.entry(id).or_insert(0);
            *attempts += 1;
            let current_attempts = *attempts;

            let (name, max_retries, interval, pid) = {
                let graph = self.graph.read().await;
                let service = match graph.get(id) {
                    Some(s) => s,
                    None => return,
                };

                let name = service.name.clone();
                let pid = service.state.pid();

                let (max_retries, interval) = service
                    .service_config()
                    .and_then(|c| c.health.as_ref())
                    .map(|h| match h {
                        crate::sdk::HealthDef::Tcp { common, .. }
                        | crate::sdk::HealthDef::Http { common, .. }
                        | crate::sdk::HealthDef::Exec { common, .. } => {
                            (common.retries, common.interval_ms)
                        }
                    })
                    .unwrap_or((3, 10000));

                (name, max_retries, interval, pid)
            };

            tracing::warn!(
                service = %name,
                attempt = current_attempts,
                max_retries = max_retries,
                error = ?error,
                "health check failed"
            );

            if current_attempts >= max_retries {
                // Too many failures - mark service as failed
                if let Some(p) = pid {
                    if let Err(e) = send_signal_to_group(p, Signal::SIGKILL) {
                        tracing::warn!(service = %name, pid = p, error = %e, "failed to send SIGKILL to process group");
                    }
                }

                let mut graph = self.graph.write().await;
                graph.set_state(
                    id,
                    ServiceState::Failed {
                        reason: FailureReason::HealthCheckFailed {
                            attempts: current_attempts,
                        },
                    },
                );
            } else {
                // Schedule another health check
                self.schedule_timeout(id, TimeoutKind::HealthCheck, interval);
            }
        }
    }

    /// Handle a timeout event.
    pub(crate) async fn handle_timeout(&mut self, id: ServiceId, kind: TimeoutKind) {
        self.timers.remove(&(id, kind));

        match kind {
            TimeoutKind::Start => {
                let mut graph = self.graph.write().await;
                let service = match graph.get(id) {
                    Some(s) => s,
                    None => return,
                };

                if let ServiceState::Starting { pid } = service.state {
                    tracing::error!(service = %service.name, pgid = pid, "start timeout, killing process group");
                    if let Err(e) = send_signal_to_group(pid, Signal::SIGKILL) {
                        tracing::warn!(service = %service.name, pgid = pid, error = %e, "failed to send SIGKILL to process group");
                    }
                    graph.set_state(
                        id,
                        ServiceState::Failed {
                            reason: FailureReason::StartTimeout,
                        },
                    );
                }
            }
            TimeoutKind::Stop => {
                let graph = self.graph.read().await;
                let service = match graph.get(id) {
                    Some(s) => s,
                    None => return,
                };

                if let ServiceState::Stopping { pid } = service.state {
                    tracing::warn!(service = %service.name, pgid = pid, "stop timeout, sending SIGKILL to process group");
                    if let Err(e) = send_signal_to_group(pid, Signal::SIGKILL) {
                        tracing::warn!(service = %service.name, pgid = pid, error = %e, "failed to send SIGKILL to process group");
                    }
                }
            }
            TimeoutKind::HealthCheck => {
                let health = {
                    let graph = self.graph.read().await;
                    graph
                        .get(id)
                        .and_then(|s| s.service_config())
                        .and_then(|c| c.health.clone())
                };

                if let Some(health) = health {
                    self.run_health_check(id, health);
                }
            }
            TimeoutKind::RestartDelay => {
                self.try_start_service(id).await;
            }
        }
    }
}