aion-rs 0.29.0

Transport-agnostic Aion workflow engine with durability, replay, timers, and supervision.
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

//! Process materialization and recovered-await readiness gates.

use crate::EngineError;

use super::delivery::{
    next_signal_delivery_backoff, sleep_signal_delivery_backoff, yield_signal_delivery_backoff,
};
use super::{Pid, RuntimeHandle, runtime_error};

impl RuntimeHandle {
    pub(crate) fn wait_for_process_ready(&self, pid: Pid) -> Result<(), EngineError> {
        let deadline = std::time::Instant::now() + self.signal_delivery.ready_timeout;
        while std::time::Instant::now() < deadline {
            if self.scheduler.trap_exit(pid).is_some() {
                return Ok(());
            }
            sleep_signal_delivery_backoff(self.signal_delivery.initial_backoff);
        }
        self.scheduler
            .trap_exit(pid)
            .map(|_| ())
            .ok_or_else(|| runtime_error(format!("process {pid} is not ready")))
    }

    /// Async twin of [`Self::wait_for_process_ready`]: identical readiness
    /// semantics, but waits yield to the executor so unrelated deliveries run.
    pub(crate) async fn wait_for_process_ready_async(&self, pid: Pid) -> Result<(), EngineError> {
        let deadline = std::time::Instant::now() + self.signal_delivery.ready_timeout;
        while std::time::Instant::now() < deadline {
            if self.scheduler.trap_exit(pid).is_some() {
                return Ok(());
            }
            yield_signal_delivery_backoff(self.signal_delivery.initial_backoff).await;
        }
        self.scheduler
            .trap_exit(pid)
            .map(|_| ())
            .ok_or_else(|| runtime_error(format!("process {pid} is not ready")))
    }

    /// Wait until a recovered workflow has committed a suspending-await park.
    ///
    /// Recovered readiness is a state transition, not a bounded operation. A
    /// fixed deadline can expire after durable resume and resident registration
    /// have succeeded. Wait until the live process parks or actually exits.
    pub(crate) async fn wait_for_pending_await(&self, pid: Pid) -> Result<(), EngineError> {
        let mut backoff = self.signal_delivery.initial_backoff;
        loop {
            if self.nif_state.has_pending_await(pid) {
                return Ok(());
            }
            if !self.is_live(pid) {
                return Err(runtime_error(format!(
                    "recovered workflow process {pid} exited before reaching its pending await"
                )));
            }
            yield_signal_delivery_backoff(backoff).await;
            backoff = next_signal_delivery_backoff(backoff, self.signal_delivery.max_backoff);
        }
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use crate::runtime::RuntimeConfig;
    use crate::runtime::nif_state::PendingAwait;

    use super::RuntimeHandle;

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn a_live_recovered_process_may_reach_its_await_after_the_old_deadline()
    -> Result<(), Box<dyn std::error::Error>> {
        let runtime = Arc::new(RuntimeHandle::new(RuntimeConfig::new(
            None,
            crate::runtime::config::TEST_STOP_DRAIN_TIMEOUT,
        ))?);
        let pid = runtime.spawn_test_process()?;
        let old_budget = runtime
            .signal_delivery
            .ready_timeout
            .saturating_mul(runtime.signal_delivery.max_enqueue_attempts.max(1));

        let waiting_runtime = Arc::clone(&runtime);
        let waiter = tokio::spawn(async move { waiting_runtime.wait_for_pending_await(pid).await });
        tokio::time::sleep(old_budget + std::time::Duration::from_millis(50)).await;
        assert!(
            runtime.is_live(pid),
            "fixture control: the recovered process must still be alive after the prior deadline"
        );
        runtime
            .nif_state
            .pending_awaits
            .insert(pid, PendingAwait::Signal { index: 0 });

        let readiness = waiter.await?;
        runtime.terminate_test_process_with_error(pid)?;
        runtime.shutdown()?;
        readiness.map_err(Into::into)
    }
}