rustvello 0.8.0

Distributed task queue and workflow runtime for Rust and Python: typed tasks, retries, priorities, triggers and pluggable backends
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
//! Final assembly: `build()` and backend resolution.

use std::sync::Arc;

use cistell_core::Resolver;
use rustvello_core::broker::Broker;
use rustvello_core::broker::{validate_routing, DEFAULT_QUEUE};
use rustvello_core::client_data_store::{ClientDataStore, ClientDataStoreManager};
use rustvello_core::error::{RustvelloError, RustvelloResult};
use rustvello_core::orchestrator::InvocationControlBackend;
use rustvello_core::state_backend::StateBackend;
use rustvello_core::trigger::{TriggerManager, TriggerStore};
use rustvello_proto::config::AppConfig;

use crate::app::{RustvelloApp, TaskEntry};

use super::RustvelloBuilder;

/// All five backend trait objects created from a preset.
struct ResolvedBackends {
    broker: Arc<dyn Broker>,
    orchestrator: Arc<dyn InvocationControlBackend>,
    state_backend: Arc<dyn StateBackend>,
    client_data_store: Arc<dyn ClientDataStore>,
    trigger_store: Arc<dyn TriggerStore>,
}

impl RustvelloBuilder {
    /// Consume the builder and produce a [`RustvelloApp`].
    ///
    /// Establishes all backend connections (database, Redis, etc.) that were
    /// configured via preset methods like [`.sqlite()`](Self::sqlite),
    /// [`.redis()`](Self::redis), or [`.postgres()`](Self::postgres).
    ///
    /// If no backends were explicitly provided, falls back to:
    /// - In-memory backends (when the `mem` feature is enabled)
    /// - Error otherwise
    ///
    /// If `auto_discover_tasks()` was called, all tasks registered via
    /// `#[rustvello::task]` are automatically added to the registry.
    /// Additionally, any task modules added via `task_module()` are
    /// registered.
    pub async fn build(mut self) -> RustvelloResult<RustvelloApp> {
        // -----------------------------------------------------------------------
        // Resolve AppConfig via cistell (programmatic > [env >] file > pyproject > defaults)
        // -----------------------------------------------------------------------
        let mut config: AppConfig = {
            let mut builder = Resolver::builder().add_source(self.programmatic.clone());

            if self.use_env {
                builder = builder.env();
            }

            for path in &self.file_paths {
                builder = builder
                    .file(path)
                    .map_err(|e| RustvelloError::Configuration {
                        message: e.to_string(),
                    })?;
            }

            builder = builder.pyproject_toml("rustvello", "app").map_err(|e| {
                RustvelloError::Configuration {
                    message: e.to_string(),
                }
            })?;

            let resolved = builder.build().resolve::<AppConfig>().map_err(|e| {
                RustvelloError::Configuration {
                    message: e.to_string(),
                }
            })?;

            tracing::info!("Configuration loaded:\n{}", resolved.explain());
            resolved.value
        };

        if !config
            .broker_queues
            .iter()
            .any(|queue| queue == DEFAULT_QUEUE)
        {
            config.broker_queues.insert(0, DEFAULT_QUEUE.to_owned());
        }
        validate_queue_config(&config)?;

        // Validate timing configuration
        if config.heartbeat_interval_seconds == 0 {
            return Err(RustvelloError::Configuration {
                message: "heartbeat_interval_seconds must be > 0".into(),
            });
        }
        if config.recovery_check_interval_seconds == 0 {
            return Err(RustvelloError::Configuration {
                message: "recovery_check_interval_seconds must be > 0".into(),
            });
        }

        // Materialise the preset (if any) into concrete backend objects.
        let preset_backends = self.resolve_preset().await?;

        // Apply preset backends — individual `.broker()` / `.state_backend()`
        // etc. take precedence over the preset.
        if let Some(pb) = preset_backends {
            if self.broker.is_none() {
                self.broker = Some(pb.broker);
            }
            if self.orchestrator.is_none() {
                self.orchestrator = Some(pb.orchestrator);
            }
            if self.state_backend.is_none() {
                self.state_backend = Some(pb.state_backend);
            }
            if self.client_data_store.is_none() {
                self.client_data_store = Some(pb.client_data_store);
            }
            if self.trigger_store.is_none() {
                self.trigger_store = Some(pb.trigger_store);
            }
        }

        // RabbitMQ overrides only the broker (if configured).
        #[cfg(feature = "rabbitmq")]
        if let Some(ref rmq) = self.rabbitmq_config {
            self.broker = Some(Arc::new(rustvello_rabbitmq::prelude::RabbitMqBroker::new(
                &rmq.uri,
                &rmq.prefix,
            )));
        }

        let broker = self.resolve_broker()?;
        let orchestrator = self.resolve_orchestrator()?;
        let state_backend = self.resolve_state_backend()?;
        let cds_backend = self.resolve_client_data_store()?;
        let cds_manager = Arc::new(ClientDataStoreManager::new(
            cds_backend,
            self.client_data_store_config,
        ));

        let mut app =
            RustvelloApp::with_backends(config, broker, orchestrator, state_backend, cds_manager);
        app.set_task_config_overrides(self.task_config_overrides, self.task_defaults_override);

        // Auto-discover tasks from inventory (compile-time registration)
        if self.auto_discover {
            let mut discovered = 0u32;
            for entry in inventory::iter::<TaskEntry> {
                (entry.register_fn)(app.task_registry_mut())?;
                discovered += 1;
            }
            tracing::info!("Auto-discovered {} tasks via inventory", discovered);
        }

        // Register task modules
        for module in &self.task_modules {
            tracing::info!("Registering task module: {}", module.name());
            module.register(app.task_registry_mut())?;
        }

        // Configure trigger manager if a trigger store was provided
        if let Some(trigger_store) = self.trigger_store {
            app.set_trigger_manager(TriggerManager::new(trigger_store));
        }

        Ok(app)
    }

    // ------------------------------------------------------------------
    // Preset materialisation
    // ------------------------------------------------------------------

    async fn resolve_preset(&self) -> RustvelloResult<Option<ResolvedBackends>> {
        let preset = match self.backend_preset {
            Some(ref p) => p,
            None => return Ok(None),
        };
        match preset {
            #[cfg(feature = "mem")]
            super::BackendPreset::Memory => Ok(Some(ResolvedBackends {
                broker: Arc::new(rustvello_mem::broker::MemBroker::new()),
                orchestrator: Arc::new(rustvello_mem::orchestrator::MemOrchestrator::new()),
                state_backend: Arc::new(rustvello_mem::state_backend::MemStateBackend::new()),
                client_data_store: Arc::new(
                    rustvello_mem::client_data_store::MemClientDataStore::new(),
                ),
                trigger_store: Arc::new(rustvello_mem::trigger::MemTriggerStore::new()),
            })),
            #[cfg(feature = "sqlite")]
            super::BackendPreset::Sqlite {
                path,
                app_id,
                options,
            } => {
                let db = Arc::new(rustvello_sqlite::db::Database::open_with_options(
                    path,
                    app_id,
                    options.clone(),
                )?);
                Ok(Some(ResolvedBackends {
                    broker: Arc::new(rustvello_sqlite::broker::SqliteBroker::new(Arc::clone(&db))),
                    orchestrator: Arc::new(
                        rustvello_sqlite::orchestrator::SqliteOrchestrator::new(Arc::clone(&db)),
                    ),
                    state_backend: Arc::new(
                        rustvello_sqlite::state_backend::SqliteStateBackend::new(Arc::clone(&db)),
                    ),
                    client_data_store: Arc::new(
                        rustvello_sqlite::client_data_store::SqliteClientDataStore::new(
                            Arc::clone(&db),
                        ),
                    ),
                    trigger_store: Arc::new(rustvello_sqlite::trigger::SqliteTriggerStore::new(db)),
                }))
            }
            #[cfg(feature = "redis")]
            super::BackendPreset::Redis {
                uri,
                app_id,
                options,
                tls,
            } => {
                let pool = Arc::new(match tls {
                    Some(tls) => rustvello_redis::prelude::RedisPool::new_tls_with_options(
                        uri,
                        app_id,
                        options.clone(),
                        tls.clone(),
                    )?,
                    None => rustvello_redis::prelude::RedisPool::new_with_options(
                        uri,
                        app_id,
                        options.clone(),
                    )?,
                });
                if options.require_durable_server {
                    pool.verify_server_policy().await?;
                }
                Ok(Some(ResolvedBackends {
                    broker: Arc::new(rustvello_redis::prelude::RedisBroker::new(Arc::clone(
                        &pool,
                    ))),
                    orchestrator: Arc::new(rustvello_redis::prelude::RedisOrchestrator::new(
                        Arc::clone(&pool),
                    )),
                    state_backend: Arc::new(rustvello_redis::prelude::RedisStateBackend::new(
                        Arc::clone(&pool),
                    )),
                    client_data_store: Arc::new(
                        rustvello_redis::prelude::RedisClientDataStore::new(Arc::clone(&pool)),
                    ),
                    trigger_store: Arc::new(rustvello_redis::prelude::RedisTriggerStore::new(pool)),
                }))
            }
            #[cfg(feature = "postgres")]
            super::BackendPreset::Postgres {
                connection_string,
                app_id,
                options,
            } => {
                let db = Arc::new(
                    rustvello_postgres::prelude::Database::connect_with_options(
                        connection_string,
                        app_id,
                        options.clone(),
                    )
                    .await?,
                );
                Ok(Some(ResolvedBackends {
                    broker: Arc::new(rustvello_postgres::prelude::PostgresBroker::new(
                        Arc::clone(&db),
                    )),
                    orchestrator: Arc::new(rustvello_postgres::prelude::PostgresOrchestrator::new(
                        Arc::clone(&db),
                    )),
                    state_backend: Arc::new(
                        rustvello_postgres::prelude::PostgresStateBackend::new(Arc::clone(&db)),
                    ),
                    client_data_store: Arc::new(
                        rustvello_postgres::prelude::PostgresClientDataStore::new(Arc::clone(&db)),
                    ),
                    trigger_store: Arc::new(
                        rustvello_postgres::prelude::PostgresTriggerStore::new(db),
                    ),
                }))
            }
            #[cfg(all(feature = "postgres", feature = "tls"))]
            super::BackendPreset::PostgresTls {
                connection_string,
                app_id,
                options,
                tls,
            } => {
                let database = match tls {
                    Some(tls) => {
                        rustvello_postgres::prelude::Database::connect_tls_with_options(
                            connection_string,
                            app_id,
                            options.clone(),
                            tls.clone(),
                        )
                        .await?
                    }
                    None => {
                        rustvello_postgres::prelude::Database::connect_tls_with_pool_size(
                            connection_string,
                            app_id,
                            Some(options.max_pool_size),
                        )
                        .await?
                    }
                };
                let db = Arc::new(database);
                Ok(Some(ResolvedBackends {
                    broker: Arc::new(rustvello_postgres::prelude::PostgresBroker::new(
                        Arc::clone(&db),
                    )),
                    orchestrator: Arc::new(rustvello_postgres::prelude::PostgresOrchestrator::new(
                        Arc::clone(&db),
                    )),
                    state_backend: Arc::new(
                        rustvello_postgres::prelude::PostgresStateBackend::new(Arc::clone(&db)),
                    ),
                    client_data_store: Arc::new(
                        rustvello_postgres::prelude::PostgresClientDataStore::new(Arc::clone(&db)),
                    ),
                    trigger_store: Arc::new(
                        rustvello_postgres::prelude::PostgresTriggerStore::new(db),
                    ),
                }))
            }
            #[cfg(feature = "mongodb")]
            super::BackendPreset::MongoDB {
                uri,
                db_name,
                app_id,
            } => {
                let pool = Arc::new(rustvello_mongo::prelude::MongoPool::new(
                    uri, db_name, app_id,
                ));
                Ok(Some(ResolvedBackends {
                    broker: Arc::new(rustvello_mongo::prelude::MongoBroker::new(Arc::clone(
                        &pool,
                    ))),
                    orchestrator: Arc::new(rustvello_mongo::prelude::MongoOrchestrator::new(
                        Arc::clone(&pool),
                    )),
                    state_backend: Arc::new(rustvello_mongo::prelude::MongoStateBackend::new(
                        Arc::clone(&pool),
                    )),
                    client_data_store: Arc::new(
                        rustvello_mongo::prelude::MongoClientDataStore::new(Arc::clone(&pool)),
                    ),
                    trigger_store: Arc::new(rustvello_mongo::prelude::MongoTriggerStore::new(pool)),
                }))
            }
            #[cfg(feature = "mongodb3")]
            super::BackendPreset::Mongo3 {
                uri,
                db_name,
                app_id,
            } => {
                let pool = Arc::new(rustvello_mongo3::prelude::MongoPool::new(
                    uri, db_name, app_id,
                ));
                Ok(Some(ResolvedBackends {
                    broker: Arc::new(rustvello_mongo3::prelude::Mongo3Broker::new(Arc::clone(
                        &pool,
                    ))),
                    orchestrator: Arc::new(rustvello_mongo3::prelude::Mongo3Orchestrator::new(
                        Arc::clone(&pool),
                    )),
                    state_backend: Arc::new(rustvello_mongo3::prelude::Mongo3StateBackend::new(
                        Arc::clone(&pool),
                    )),
                    client_data_store: Arc::new(
                        rustvello_mongo3::prelude::Mongo3ClientDataStore::new(Arc::clone(&pool)),
                    ),
                    trigger_store: Arc::new(rustvello_mongo3::prelude::Mongo3TriggerStore::new(
                        pool,
                    )),
                }))
            }
        }
    }

    // ------------------------------------------------------------------
    // Fallback resolution (explicit backend or mem default)
    // ------------------------------------------------------------------

    fn resolve_broker(&self) -> RustvelloResult<Arc<dyn Broker>> {
        if let Some(ref b) = self.broker {
            return Ok(Arc::clone(b));
        }
        #[cfg(feature = "mem")]
        {
            return Ok(Arc::new(rustvello_mem::broker::MemBroker::new()));
        }
        #[allow(unreachable_code)]
        Err(RustvelloError::Configuration {
            message: "no broker configured and no default backend feature enabled".into(),
        })
    }

    fn resolve_orchestrator(&self) -> RustvelloResult<Arc<dyn InvocationControlBackend>> {
        if let Some(ref o) = self.orchestrator {
            return Ok(Arc::clone(o));
        }
        #[cfg(feature = "mem")]
        {
            return Ok(Arc::new(rustvello_mem::orchestrator::MemOrchestrator::new()));
        }
        #[allow(unreachable_code)]
        Err(RustvelloError::Configuration {
            message: "no orchestrator configured and no default backend feature enabled".into(),
        })
    }

    fn resolve_state_backend(&self) -> RustvelloResult<Arc<dyn StateBackend>> {
        if let Some(ref sb) = self.state_backend {
            return Ok(Arc::clone(sb));
        }
        #[cfg(feature = "mem")]
        {
            return Ok(Arc::new(
                rustvello_mem::state_backend::MemStateBackend::new(),
            ));
        }
        #[allow(unreachable_code)]
        Err(RustvelloError::Configuration {
            message: "no state backend configured and no default backend feature enabled".into(),
        })
    }

    fn resolve_client_data_store(&self) -> RustvelloResult<Arc<dyn ClientDataStore>> {
        if let Some(ref cds) = self.client_data_store {
            return Ok(Arc::clone(cds));
        }
        #[cfg(feature = "mem")]
        {
            return Ok(Arc::new(
                rustvello_mem::client_data_store::MemClientDataStore::new(),
            ));
        }
        #[allow(unreachable_code)]
        Err(RustvelloError::Configuration {
            message: "no client data store configured and no default backend feature enabled"
                .into(),
        })
    }
}

fn validate_queue_config(config: &AppConfig) -> RustvelloResult<()> {
    if config.broker_queues.is_empty() {
        return Err(RustvelloError::Configuration {
            message: "broker_queues cannot be empty".to_owned(),
        });
    }
    for queue in config
        .broker_queues
        .iter()
        .chain(config.runner_queues.iter())
    {
        validate_routing(queue, 0.0)?;
    }
    for queues in [&config.broker_queues, &config.runner_queues] {
        let mut unique = std::collections::HashSet::new();
        if queues.iter().any(|queue| !unique.insert(queue)) {
            return Err(RustvelloError::Configuration {
                message: "queue lists cannot contain duplicate names".to_owned(),
            });
        }
    }
    for rule in &config.priority_rules {
        validate_routing(DEFAULT_QUEUE, rule.priority)?;
        if rule.task_id.is_empty() {
            return Err(RustvelloError::Configuration {
                message: "priority rule task_id cannot be empty".to_owned(),
            });
        }
        glob::Pattern::new(&rule.task_id).map_err(|error| RustvelloError::Configuration {
            message: format!("invalid priority rule pattern {:?}: {error}", rule.task_id),
        })?;
    }
    Ok(())
}