ecdysis 1.1.1

A library for graceful restarts in Rust.
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

use std::{
    io,
    path::PathBuf,
    pin::Pin,
    task::{Context, Poll},
};

use futures::{ready, Stream, StreamExt};
use tokio::{net::UnixStream, signal::unix::SignalKind};
use tokio_stream::wrappers::{SignalStream, UnixListenerStream};

use crate::tokio_ecdysis::StoppableStream;

/// A Trigger is anything that can trigger a reload or shutdown in TokioEcdysis
pub(crate) enum Trigger {
    Signal(SignalKind, SignalStream),
    Uds(PathBuf, StoppableStream<UnixListenerStream>),
}

/// Holds something to identify the trigger that was triggered as well as state that should be
/// maintained between upgrader state transitions.
#[derive(Debug)]
pub(crate) enum TriggerReason {
    Signal(SignalKind),
    UnixStream(PathBuf, UnixStream),
}

impl Trigger {
    pub(crate) async fn cleanup(self) -> Result<(), String> {
        // explicit match since we might add more Triggers in the future
        match self {
            Trigger::Signal(_kind, _stream) => Ok(()),
            Trigger::Uds(path, _listener_stream) => {
                // cleanup path
                // this branch also takes ownership of the listener stream, which is then dropped
                // at the end of the scope. neat!

                log::debug!("Removing {path:?}");
                tokio::fs::remove_file(path.clone())
                    .await
                    .map_err(|e| e.to_string())
            }
        }
    }
}

impl Stream for Trigger {
    type Item = io::Result<TriggerReason>;

    /// TODO: Document that this never returns None
    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        match self.get_mut() {
            Self::Signal(kind, signal_stream) => match ready!(signal_stream.poll_next_unpin(cx)) {
                None => unreachable!(), // SignalStream is documented to be infinite.
                Some(()) => Poll::Ready(Some(Ok(TriggerReason::Signal(*kind)))),
            },
            Self::Uds(path, listener_stream) => match ready!(listener_stream.poll_next_unpin(cx)) {
                None => Poll::Ready(Some(Err(io::Error::other(
                    "Socket shut down unexpectedly.",
                )))),
                Some(Err(e)) => Poll::Ready(Some(Err(io::Error::other(format!(
                    "Unexpected error accepting connection on socket: {e}"
                ))))),
                Some(Ok(stream)) => {
                    Poll::Ready(Some(Ok(TriggerReason::UnixStream(path.clone(), stream))))
                }
            },
        }
    }
}