Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions crates/stackable-operator/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.

## [Unreleased]

### Added

- Add `SignalWatcher` which can be used to watch signals and multiply them to gracefully shutdown
multiple concurrent tasks/futures ([#1147]).

[#1147]: https://github.com/stackabletech/operator-rs/pull/1147

## [0.104.0] - 2026-01-26

### Added
Expand Down
2 changes: 2 additions & 0 deletions crates/stackable-operator/src/utils/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ pub mod cluster_info;
pub mod crds;
pub mod kubelet;
pub mod logging;
pub mod signal;

mod option;
mod url;

Expand Down
73 changes: 73 additions & 0 deletions crates/stackable-operator/src/utils/signal.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
use snafu::{ResultExt, Snafu};
use tokio::{
signal::unix::{SignalKind, signal},
sync::watch,
};

#[derive(Debug, Snafu)]
#[snafu(display("failed to construct signal watcher"))]
pub struct SignalError {
source: std::io::Error,
}

/// Watches for the incoming signal and multiplies it by sending it to all acquired handles.
pub struct SignalWatcher<T>
where
T: Send + Sync + 'static,
{
watch_rx: watch::Receiver<T>,
}

impl<T> SignalWatcher<T>
where
T: Default + Send + Sync + 'static,
{
/// Watches the provided `signal` and multiplies the signal by sending it to all acquired handles
/// constructed through [`SignalWatcher::handle`].
pub fn new<F>(signal: F) -> Self
where
F: Future<Output = T> + Send + Sync + 'static,
{
let (watch_tx, watch_rx) = watch::channel(T::default());

tokio::spawn(async move {
let value = signal.await;
watch_tx.send(value)
});

Self { watch_rx }
}

/// Acquire a new handle which will complete once a `SIGTERM` signal is received.
///
/// This handle can be cheaply cloned to be able to gracefully shutdown multiple concurrent
/// tasks.
pub fn handle(&self) -> impl Future<Output = ()> + use<T> {
let mut watch_rx = self.watch_rx.clone();

async move {
watch_rx.changed().await.ok();
}
}
}

impl SignalWatcher<()> {
/// Watches the `SIGTERM` signal and multiplies the signal by sending it to all acquired handlers
/// constructed through [`SignalWatcher::handle`].
//
// NOTE (@Techassi): Note Accepting a generic Future<Output = ()> here is possible, but
// `Signal::recv` borrows instead of consuming which clashes with the 'static lifetime
// requirement of `tokio::spawn`. That's why I opted for watching for a particular signal
// internally instead of requiring users to pass the signal to this function.
pub fn sigterm() -> Result<Self, SignalError> {
let mut sigterm = signal(SignalKind::terminate()).context(SignalSnafu)?;
let (watch_tx, watch_rx) = watch::channel(());

tokio::spawn(async move {
sigterm.recv().await;
watch_tx.send(())
});

Ok(Self { watch_rx })
}
}
Loading