Skip to main content

aion/runtime/
outcome.rs

1//! Workflow process outcome conversion at the beamr boundary.
2
3use aion_core::{Payload, WorkflowError};
4use beamr::atom::{Atom, AtomTable};
5use beamr::process::ExitReason;
6use beamr::term::Term;
7use beamr::term::boxed::Tuple;
8
9use crate::{EngineError, Pid};
10
11use super::payload::term_to_payload;
12use super::process_exit::OwnedProcessExitOutcome;
13
14/// Runtime-converted terminal workflow process outcome.
15#[derive(Clone)]
16pub enum WorkflowProcessOutcome {
17    /// The workflow process returned normally with a payload result.
18    Completed(Payload),
19    /// The workflow process exited abnormally with a workflow error.
20    Failed(WorkflowError),
21}
22
23pub(super) fn workflow_outcome(
24    atoms: &AtomTable,
25    pid: Pid,
26    owned: &OwnedProcessExitOutcome,
27) -> Result<Result<Payload, WorkflowError>, EngineError> {
28    match workflow_outcome_from_owned_exit(atoms, pid, owned)? {
29        WorkflowProcessOutcome::Completed(payload) => Ok(Ok(payload)),
30        WorkflowProcessOutcome::Failed(error) => Ok(Err(error)),
31    }
32}
33
34pub(super) fn workflow_outcome_from_owned_exit(
35    atoms: &AtomTable,
36    pid: Pid,
37    owned: &OwnedProcessExitOutcome,
38) -> Result<WorkflowProcessOutcome, EngineError> {
39    let observed = match owned {
40        OwnedProcessExitOutcome::Observed(observed) => observed,
41        OwnedProcessExitOutcome::ObservationFailed {
42            process_id,
43            failure,
44        } => return Err(failure.into_engine_error(*process_id)),
45    };
46    if observed.reason != ExitReason::Normal {
47        // The VM execution error, when present, is the authoritative exit
48        // cause. A caught raise can leave a residual exception until try_end.
49        if let Some(error) = &observed.execution_error {
50            let formatted = error.format_with_atoms(atoms);
51            let residue = observed
52                .exception
53                .as_ref()
54                .map_or_else(String::new, |exception| {
55                    format!(
56                        " (residual exception: {})",
57                        exception.format_with_atoms(atoms)
58                    )
59                });
60            return Ok(WorkflowProcessOutcome::Failed(WorkflowError {
61                message: format!(
62                    "workflow process {pid} exited: {:?}: VM execution error: {formatted}{residue}",
63                    observed.reason
64                ),
65                details: None,
66            }));
67        }
68        if let Some(exception) = &observed.exception {
69            let formatted = exception.format_with_atoms(atoms);
70            let view = exception.view();
71            let details = term_to_payload(view.reason, atoms).ok();
72            return Ok(WorkflowProcessOutcome::Failed(WorkflowError {
73                message: format!("workflow process {pid} exited: {formatted}"),
74                details,
75            }));
76        }
77    }
78    convert_process_outcome(atoms, pid, observed.reason, observed.result.root())
79}
80
81pub(super) fn convert_process_outcome(
82    atoms: &AtomTable,
83    pid: Pid,
84    reason: ExitReason,
85    result: Term,
86) -> Result<WorkflowProcessOutcome, EngineError> {
87    if reason == ExitReason::Normal {
88        unwrap_gleam_result(result, atoms, pid)
89    } else {
90        let formatted = beamr::term::format::format_term(result, atoms);
91        let details = term_to_payload(result, atoms).ok();
92        Ok(WorkflowProcessOutcome::Failed(WorkflowError {
93            message: format!("workflow process {pid} exited: {reason:?}: {formatted}"),
94            details,
95        }))
96    }
97}
98
99fn unwrap_gleam_result(
100    result: Term,
101    atoms: &AtomTable,
102    pid: Pid,
103) -> Result<WorkflowProcessOutcome, EngineError> {
104    if let Some(tuple) = Tuple::new(result) {
105        if tuple.arity() == 2 {
106            if let (Some(tag), Some(value)) = (tuple.get(0), tuple.get(1)) {
107                if let Some(atom) = tag.as_atom() {
108                    if atom == Atom::OK {
109                        return Ok(WorkflowProcessOutcome::Completed(term_to_payload(
110                            value, atoms,
111                        )?));
112                    }
113                    if atom == Atom::ERROR {
114                        let details = term_to_payload(value, atoms).ok();
115                        return Ok(WorkflowProcessOutcome::Failed(WorkflowError {
116                            message: format!("workflow {pid} returned error"),
117                            details,
118                        }));
119                    }
120                }
121            }
122        }
123    }
124    Ok(WorkflowProcessOutcome::Completed(term_to_payload(
125        result, atoms,
126    )?))
127}