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
//! # Script Task flow node
use crate::activity::{Activity, InputSet, OutputSet};
use crate::bpmn::schema::{FlowNodeType, ScriptTask as Element};

use crate::data_object::{self, DataObject};
use crate::flow_node::{self, Action, FlowNode};
use crate::language::{
    Engine as _, EngineContext, EngineContextProvider, EvaluationError, MultiLanguageEngine,
};
use crate::process::Log;
use crate::sys::task;
use futures::stream::Stream;
use serde::{Deserialize, Serialize};
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll, Waker};
use tokio::sync::broadcast;

/// Script Task flow node
pub struct Task {
    element: Arc<Element>,
    state: State,
    engine: Arc<MultiLanguageEngine>,
    waker: Option<Waker>,
    notifier: broadcast::Sender<Completion>,
    notifier_receiver: broadcast::Receiver<Completion>,
    log_broadcast: Option<broadcast::Sender<Log>>,
    input_sets: Vec<InputSet>,
    output_sets: Option<Vec<OutputSet>>,
}

#[derive(Clone)]
enum Completion {
    Success(Option<Vec<OutputSet>>),
    Error,
}

impl Task {
    /// Creates new Script Task flow node
    pub fn new(element: Element) -> Self {
        let (notifier, notifier_receiver) = broadcast::channel(1);
        Self {
            element: Arc::new(element),
            state: State::Initialized,
            engine: Arc::new(Default::default()),
            waker: None,
            notifier,
            notifier_receiver,
            log_broadcast: None,
            input_sets: vec![],
            output_sets: None,
        }
    }

    fn wake(&mut self) {
        if let Some(waker) = self.waker.take() {
            waker.wake();
        }
    }
}

/// Node state
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum State {
    Initialized,
    Ready,
    Execute,
    Executing,
    Errored,
    Done,
}

impl FlowNode for Task {
    fn set_state(&mut self, state: flow_node::State) -> Result<(), flow_node::StateError> {
        match state {
            flow_node::State::ScriptTask(state) => {
                self.state = state;
                Ok(())
            }
            _ => Err(flow_node::StateError::InvalidVariant),
        }
    }

    fn get_state(&mut self) -> flow_node::State {
        flow_node::State::ScriptTask(self.state.clone())
    }

    fn element(&self) -> Box<dyn FlowNodeType> {
        Box::new(self.element.as_ref().clone())
    }

    fn set_process(&mut self, process: crate::process::Handle) {
        if let State::Initialized = self.state {
            self.state = State::Ready;
            self.log_broadcast.replace(process.log_broadcast());
            self.engine = Arc::new(process.model().script_engine_factory().create());
            self.wake();
        }
    }
}

impl Activity for Task {
    fn execute(&mut self) {
        self.state = State::Execute;
        self.wake();
    }

    fn input_sets(&mut self, input_sets: Vec<InputSet>) {
        self.input_sets = input_sets;
    }

    fn take_output_sets(&mut self) -> Option<Vec<OutputSet>> {
        self.output_sets.take()
    }
}

impl From<Element> for Task {
    fn from(element: Element) -> Self {
        Self::new(element)
    }
}

impl Stream for Task {
    type Item = Action;
    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        match self.state {
            State::Initialized => {
                self.waker.replace(cx.waker().clone());
                Poll::Pending
            }
            State::Ready => {
                self.waker.replace(cx.waker().clone());
                Poll::Pending
            }
            State::Execute => {
                self.state = State::Executing;
                let waker = cx.waker().clone();
                let engine = self.engine.clone();
                let element = self.element.as_ref().clone();
                let notifier = self.notifier.clone();
                let log_broadcast = self.log_broadcast.clone();
                let mut context = engine.new_context();
                // We only need input once, we can drain it
                for (name, input_set) in
                    std::mem::replace(&mut self.input_sets, Vec::new()).drain(..)
                {
                    if let Some(name) = name {
                        context.set(&name, Box::new(data_object::Collection(input_set)));
                    } else {
                        context.set("input", Box::new(data_object::Collection(input_set)));
                    }
                }

                task::spawn(async move {
                    match engine
                        .eval::<Vec<Box<dyn DataObject>>>(&element, &mut context)
                        .await
                    {
                        Ok(data_objects) => {
                            let _ = notifier
                                .send(Completion::Success(Some(vec![(None, data_objects)])));
                        }
                        Err(EvaluationError::ResultTypeError { got, .. }) if got == "()" => {
                            let _ = notifier.send(Completion::Success(None));
                        }
                        Err(err) => {
                            let _ = notifier.send(Completion::Error);
                            if let Some(log_broadcast) = log_broadcast {
                                let _ = log_broadcast.send(Log::ScriptError {
                                    error: format!("{:?}", err),
                                });
                            }
                        }
                    }
                    waker.wake();
                });
                Poll::Pending
            }
            State::Executing => match self.notifier_receiver.try_recv() {
                Ok(Completion::Success(data_objects)) => {
                    self.output_sets = data_objects;
                    self.waker.replace(cx.waker().clone());
                    self.state = State::Done;
                    Poll::Ready(Some(Action::Flow(
                        (0..self.element.outgoings().len()).collect(),
                    )))
                }
                Ok(Completion::Error) => {
                    self.state = State::Errored;
                    Poll::Ready(Some(Action::Complete))
                }
                Err(broadcast::error::TryRecvError::Empty) => {
                    self.waker.replace(cx.waker().clone());
                    Poll::Pending
                }
                Err(broadcast::error::TryRecvError::Lagged(_)) => {
                    self.waker.replace(cx.waker().clone());
                    Poll::Pending
                }
                Err(broadcast::error::TryRecvError::Closed) => Poll::Ready(None),
            },
            State::Errored => {
                self.waker.replace(cx.waker().clone());
                Poll::Pending
            }
            State::Done => {
                self.state = State::Ready;
                Poll::Ready(Some(Action::Complete))
            }
        }
    }
}

#[cfg(test)]
#[allow(unused_imports)]
mod tests {
    use crate::bpmn::parse;
    use crate::language::*;
    use crate::model;
    use crate::test::*;
    use bpxe_internal_macros as bpxe_im;
    use tokio::sync::mpsc;

    #[cfg(feature = "rhai")]
    #[bpxe_im::test]
    async fn runs() {
        let definitions = parse(include_str!("test_models/task_script.bpmn")).unwrap();
        let (sender, mut receiver) = mpsc::channel(10);
        let sender_clone = sender.clone();
        let model =
            model::Model::new(definitions).with_script_engine_factory(
                model::FnLanguageEngineFactory(move || {
                    use ::rhai::RegisterFn;
                    let mut engine = MultiLanguageEngine::new();
                    let rhai_engine = engine.rhai.engine_mut().unwrap();
                    let sender_clone = sender_clone.clone();
                    rhai_engine.register_fn("notify", move || {
                        while let Err(_) = sender_clone.try_send(()) {}
                    });
                    engine
                }),
            );

        let model = model.spawn().await;

        let handle = model.processes().await.unwrap().pop().unwrap();
        assert!(handle.start().await.is_ok());

        assert_eq!(receiver.recv().await, Some(()));

        model.terminate().await;
    }
}