acts 0.21.1

a fast, lightweight, extensiable workflow engine
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
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
use super::{ActTask, Process, Sign, Task, TaskState};
use crate::{
    ActError, Action, Config, Error, Package, Result, ShareLock, Vars, Workflow,
    cache::Cache,
    config::ConfigResolver,
    data,
    env::Enviroment,
    event::{Emitter, EventAction},
    scheduler::queue::{Queue, QueueData},
    store::Store,
    utils::{self, consts},
};
use std::{
    collections::HashMap,
    sync::{Arc, RwLock},
    time::Duration,
};
use tokio::{runtime::Handle, time};
use tokio_util::sync::CancellationToken;
use tracing::{debug, error, info, instrument};

#[derive(Clone)]
pub struct Runtime {
    config: Arc<Config>,
    queue: Arc<Queue>,
    env: Arc<Enviroment>,
    cache: Arc<Cache>,
    emitter: Arc<Emitter>,
    package: Arc<Package>,
    shutdown: CancellationToken,
    pub(crate) resolvers: ShareLock<HashMap<String, Arc<dyn ConfigResolver>>>,
}

impl std::fmt::Debug for Runtime {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Runtime")
            .field("config", &self.config)
            .field("queue", &self.queue)
            .field("env", &self.env)
            .field("cache", &self.cache)
            .field("emitter", &self.emitter)
            .field("package", &self.package)
            .field(
                "resolvers",
                &format_args!(
                    "<{} entries>",
                    self.resolvers.read().map(|r| r.len()).unwrap_or(0)
                ),
            )
            .finish()
    }
}

impl Runtime {
    pub fn new(config: &Config) -> crate::Result<Arc<Self>> {
        let runtime = Self::create(config)?;
        Ok(runtime)
    }

    #[allow(unused)]
    pub fn cache(&self) -> &Arc<Cache> {
        &self.cache
    }

    #[allow(unused)]
    pub fn queue(&self) -> &Arc<Queue> {
        &self.queue
    }

    #[allow(unused)]
    pub fn env(&self) -> &Arc<Enviroment> {
        &self.env
    }

    pub fn emitter(&self) -> &Arc<Emitter> {
        &self.emitter
    }

    pub fn package(&self) -> &Arc<Package> {
        &self.package
    }

    pub fn store(&self) -> Arc<Store> {
        self.cache.store().clone()
    }

    #[allow(unused)]
    pub fn config(&self) -> &Arc<Config> {
        &self.config
    }
    pub fn register_resolver(&self, name: &str, resolver: Arc<dyn ConfigResolver>) {
        let mut resolvers = self.resolvers.write().unwrap();
        resolvers.insert(name.to_string(), resolver);
    }

    pub fn close(&self) {
        self.shutdown.cancel();
        self.queue.abort();
        self.cache.close();
        self.emitter.close();
    }

    pub(crate) fn shutdown_token(&self) -> CancellationToken {
        self.shutdown.clone()
    }

    #[instrument(skip(self, model, options), fields(mid = %model.id, name = %model.name))]
    pub fn start(self: &Arc<Self>, model: &Workflow, options: Vars) -> Result<Arc<Process>> {
        debug!("process starting");

        let mut proc_id = utils::longid();
        if let Some(pid) = &options.get::<String>(consts::PROCESS_ID) {
            // the pid will use as the proc_id
            proc_id = pid.to_string();
        }
        let proc = self.cache.proc(&proc_id, self)?;
        if proc.is_some() {
            return Err(ActError::Action(format!(
                "proc_id({proc_id}) is duplicated in running process list"
            )));
        }

        // validate the options
        if !model.inputs.is_empty() {
            model
                .inputs
                .validate(&(options.to_value()))
                .map_err(|err| {
                    ActError::Model(format!(
                        "model({}) inputs validation error: {}",
                        model.id, err
                    ))
                })?;
        }

        let mut model = model.clone();
        model.set_vars(&options);

        let proc = Process::new(&proc_id, self);
        proc.load(&model)?;

        self.launch(&proc)?;

        info!(pid = %proc_id, mid = %model.id, name = %model.name, "process started");
        Ok(proc)
    }

    pub fn proc(self: &Arc<Self>, pid: &str) -> Result<Option<Arc<Process>>> {
        self.cache.proc(pid, self)
    }

    #[instrument(skip(self, proc), fields(pid = %proc.id()))]
    pub fn launch(self: &Arc<Self>, proc: &Arc<Process>) -> Result<()> {
        debug!("process launched");
        let proc = proc.clone();
        proc.start()?;
        Ok(())
    }

    #[allow(unused)]
    pub(crate) fn create_proc(self: &Arc<Self>, pid: &str, model: &Workflow) -> Arc<Process> {
        let proc = Process::new(pid, self);
        proc.load(model);
        proc
    }

    #[instrument(skip(self, task), fields(pid = %task.pid, tid = %task.id))]
    pub fn push(&self, task: &Arc<Task>) -> Result<()> {
        debug!("task pushed");
        let cache = self.cache.clone();
        let task_clone = task.clone();
        cache.upsert_async(&task_clone)?;
        self.queue.send(&task_clone)?;
        Ok(())
    }

    #[instrument(skip(self, action), fields(pid = %action.pid, tid = %action.tid, event = ?action.event))]
    pub fn do_action(self: &Arc<Self>, action: &Action) -> Result<()> {
        debug!("action received");
        let proc = self.cache.proc(&action.pid, self)?;
        match proc {
            Some(proc) => proc.do_action(action),
            None => Err(ActError::Runtime(format!(
                "cannot find process '{}' when do_action({:?})",
                action.pid, action
            ))),
        }
    }

    /// Replay tasks whose `next` propagation was enqueued (`Sign::NEXT_PENDING`)
    /// but never executed (e.g. the engine crashed before the queued `next`
    /// ran). Re-enqueueing is idempotent: `next` clears the marker once run.
    pub fn recover_actions(self: &Arc<Self>) -> Result<()> {
        let pending = self.cache.store().load_pending_next_tasks()?;
        for (pid, tid) in pending {
            if let Some(proc) = self.cache.proc(&pid, self)?
                && let Some(task) = proc.task(&tid)
                && task.is_sign(Sign::NEXT_PENDING)
            {
                self.queue.send_next(&task)?;
            }
        }
        Ok(())
    }

    #[cfg(test)]
    pub fn do_action2(
        self: &Arc<Self>,
        pid: &str,
        tid: &str,
        action: EventAction,
        options: crate::Vars,
    ) -> Result<()> {
        self.do_action(&Action::new(pid, tid, action, options))
    }

    pub fn ack(&self, id: &str) -> Result<()> {
        self.cache
            .store()
            .set_message(id, data::MessageStatus::Acked)
    }

    pub fn event_loop(self: &Arc<Self>) {
        let queue = self.queue.clone();
        let shutdown = self.shutdown.clone();
        tokio::spawn(async move {
            loop {
                let next = tokio::select! {
                    _ = shutdown.cancelled() => break,
                    next = queue.next() => next,
                };
                match next {
                    Ok(data) => match data {
                        QueueData::Task(task) => {
                            let ctx = &task.create_context();
                            if let Err(err) = task.exec(ctx).await {
                                error!(error = %err, "task.exec failed");
                                task.set_err(&err.clone().into());
                                ctx.set_task(&task);
                                ctx.emit_error().ok();
                            }
                        }
                        QueueData::Next(task) => {
                            let ctx = &task.create_context();
                            let result = task.next(ctx).await;
                            if let Err(err) = result {
                                error!(error = %err, "task.next failed");
                                task.set_err(&err.clone().into());
                                ctx.set_task(&task);
                                ctx.emit_error().ok();
                            }
                        }
                        QueueData::Abort => {
                            break;
                        }
                    },
                    Err(err) => {
                        error!(error = %err, "queue.next failed");
                        break;
                    }
                }
            }
        });
    }

    fn create(config: &Config) -> crate::Result<Arc<Runtime>> {
        // let scher = Scheduler::new();
        let env = Arc::new(Enviroment::new());
        let cache = Arc::new(Cache::new(config)?);
        let emitter = Arc::new(Emitter::new());
        let package = Arc::new(Package::new());
        let queue = Queue::new();
        let shutdown = CancellationToken::new();
        let resolvers = Arc::new(RwLock::new(HashMap::new()));
        let runtime = Arc::new(Runtime {
            config: Arc::new(config.clone()),
            emitter,
            // scher,
            queue,
            env,
            cache,
            package,
            shutdown,
            resolvers,
        });

        runtime.initialize(config)?;
        Ok(runtime)
    }

    fn initialize(self: &Arc<Self>, options: &Config) -> crate::Result<()> {
        {
            let cache = self.cache.clone();
            let rt = self.clone();
            self.emitter.on_proc(move |proc| {
                debug!(pid = %proc.id(), "proc event");
                if let Some(root) = proc.root() {
                    let state = proc.state();
                    let mut message = root.create_message();
                    if state.is_running() || state.is_pending() {
                        let emitter = rt.emitter().clone();
                        emitter.emit_start_event(&message);
                    } else {
                        if state.is_error() {
                            let emitter = rt.emitter().clone();
                            let message = message.clone();
                            emitter.emit_error(&message);
                        } else if state.is_completed() {
                            let mut is_validation_err = false;
                            let exposes = &proc.model().exposes;
                            if !exposes.is_empty() {
                                // validate the process outputs
                                let schema = crate::ActSchema::Multiple(exposes.clone());
                                if let Err(e) = schema
                                    .validate(&(message.outputs.to_value()))
                                    .map_err(|err| {
                                        ActError::Model(format!(
                                            "model({}) outputs validation error: {}",
                                            proc.model().id,
                                            err
                                        ))
                                    })
                                {
                                    is_validation_err = true;
                                    let error = e.to_string();
                                    message.set_err("", &error);
                                    proc.set_err(&Error::new(&error, ""));
                                    let emitter = rt.emitter().clone();
                                    emitter.emit_error(&message);
                                }
                            }

                            if !is_validation_err {
                                let emitter = rt.emitter().clone();
                                emitter.emit_complete_event(&message);
                            }
                        }
                        let final_state = proc.state();
                        if final_state.is_error() {
                            info!(pid = %proc.id(), state = %final_state, cost_ms = proc.cost(), "process errored");
                        } else if final_state.is_completed() {
                            info!(pid = %proc.id(), state = %final_state, cost_ms = proc.cost(), "process completed");
                        }

                        // if the process is a sub process
                        // call the parent act
                        if let Some((ppid, ptid)) = proc.parent() {
                            rt.return_to_act(&ppid, &ptid, proc);
                        }

                        if !rt.config.keep_processes() {
                            debug!(pid = %proc.id(), "remove process");
                            let cache = cache.clone();
                            let pid = proc.id().to_string();
                            cache.remove(&pid).unwrap_or_else(|err| {
                                error!(error = %err, "process remove failed");
                                false
                            });
                        }

                        let cache = cache.clone();
                        let rt = rt.clone();
                        cache
                            .restore(&rt)
                            .unwrap_or_else(|err| error!(error = %err, "process restore failed"));
                    }
                } else {
                    error!(pid = %proc.id(), "cannot find root task");
                }
            });
        }
        {
            let cache = self.cache.clone();
            let rt = self.clone();
            self.emitter.on_task(move |e| {
                debug!(pid = %e.inner().pid, tid = %e.inner().id, "task event");
                let cache = cache.clone();
                let e_clone = e.clone();
                cache
                    .upsert_async(&e_clone)
                    .unwrap_or_else(|err| error!(error = %err, "task upsert failed"));

                // check task is allowed to emit message to client
                if !e.state().is_pending() && !e.state().is_running() && e.is_emit() {
                    let msg = e.create_message();
                    debug!(pid = %msg.pid, tid = %msg.tid, name = %msg.name, "emit message");
                    let emitter = rt.emitter().clone();
                    emitter.emit_message(&msg);
                }
            });
        }
        {
            // Message retry timer — periodically re-send unacknowledged messages
            let max_message_retry_times = options.max_message_retry_times();
            #[cfg(not(test))]
            let interval_ms = {
                let secs = if options.tick_interval_secs() > 0 {
                    options.tick_interval_secs()
                } else {
                    15
                };
                (secs * 1000) as u64
            };
            #[cfg(test)]
            let interval_ms = 800u64;

            let evt = self.emitter().clone();
            let cache = self.cache.clone();
            let shutdown = self.shutdown.clone();
            Handle::current().spawn(async move {
                let mut intv = time::interval(Duration::from_millis(interval_ms));
                loop {
                    tokio::select! {
                        _= shutdown.cancelled() => break,
                        _ = intv.tick() => {}
                    }
                    let _ = cache.store().with_no_response_messages(
                        interval_ms as i64,
                        max_message_retry_times,
                        |m| {
                            let emitter = evt.clone();
                            let m = m.clone();
                            emitter.emit_message(&m);
                        },
                    );
                }
            });
        }

        // recover durable actions that were not yet fully processed (crash replay)
        self.recover_actions()?;

        Ok(())
    }

    fn return_to_act(self: &Arc<Self>, pid: &str, tid: &str, proc: &Process) {
        debug!(pid = %pid, tid = %tid, "return to act");
        let state = proc.state();
        // process.print();
        let mut vars = proc.outputs();
        debug!(pid = %pid, tid = %tid, outputs = %vars, "sub outputs");

        let event = match state {
            TaskState::Aborted => EventAction::Abort,
            TaskState::Skipped => EventAction::Skip,
            TaskState::Error => {
                if let Some(err) = proc.err() {
                    vars.set(consts::ACT_ERR_CODE, err.ecode);
                    vars.set(consts::ACT_ERR_MESSAGE, err.message);
                }

                EventAction::Error
            }
            _ => EventAction::Next,
        };

        let action = Action::new(pid, tid, event, vars);
        let scher = self.clone();
        let _ = scher
            .do_action(&action)
            .map_err(|err| error!(error = %err, "return to act failed"));
    }
}