a3s-boot 0.1.4

Adapter-first modular Rust web framework for A3S inspired by Nest.js
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
#![cfg(feature = "queue-postgres")]

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::Duration;
use std::{process::Command, process::Stdio};

use a3s_boot::{
    ModuleRef, PostgresQueueBackend, Queue, QueueContext, QueueJob, QueueJobOptions, QueueOptions,
    QueueRetryPolicy,
};
use serde_json::json;
use tokio::sync::Notify;
use uuid::Uuid;

fn postgres_url() -> Option<String> {
    std::env::var("A3S_BOOT_POSTGRES_URL")
        .ok()
        .filter(|value| !value.trim().is_empty())
}

fn queue_name(label: &str) -> String {
    format!("boot-{label}-{}", Uuid::new_v4())
}

async fn wait_until(mut predicate: impl FnMut() -> bool) {
    tokio::time::timeout(Duration::from_secs(5), async {
        loop {
            if predicate() {
                return;
            }
            tokio::time::sleep(Duration::from_millis(10)).await;
        }
    })
    .await
    .expect("PostgreSQL queue condition should become true");
}

#[tokio::test]
async fn queued_job_survives_backend_reconstruction() {
    let Some(url) = postgres_url() else {
        eprintln!("skipping PostgreSQL queue test; set A3S_BOOT_POSTGRES_URL");
        return;
    };
    let name = queue_name("restart");
    let options = QueueOptions::new()
        .with_poll_interval(Duration::from_millis(5))
        .with_lease_duration(Duration::from_millis(200));
    let first = PostgresQueueBackend::connect(&url, &name, options)
        .await
        .expect("connect first PostgreSQL queue backend");
    Queue::new(name.clone(), first)
        .enqueue("durable", &json!({"value": 42}))
        .await
        .expect("enqueue durable job");

    let calls = Arc::new(AtomicUsize::new(0));
    let second = PostgresQueueBackend::connect(&url, &name, options)
        .await
        .expect("reconnect PostgreSQL queue backend");
    let queue = Queue::new(name, second);
    let observed = Arc::clone(&calls);
    queue
        .process("durable", move |job: QueueJob, _context: QueueContext| {
            let observed = Arc::clone(&observed);
            async move {
                assert_eq!(job.data, json!({"value": 42}));
                observed.fetch_add(1, Ordering::SeqCst);
                Ok(())
            }
        })
        .expect("register durable processor");
    queue
        .start(ModuleRef::new())
        .await
        .expect("start reconstructed queue");
    wait_until(|| calls.load(Ordering::SeqCst) == 1).await;
    queue.shutdown().await.expect("shutdown queue");
    assert_eq!(queue.stats().expect("queue stats").completed, 1);
}

#[tokio::test]
async fn processor_failures_follow_the_typed_retry_policy() {
    let Some(url) = postgres_url() else {
        eprintln!("skipping PostgreSQL queue test; set A3S_BOOT_POSTGRES_URL");
        return;
    };
    let name = queue_name("retry");
    let backend = PostgresQueueBackend::connect(
        &url,
        &name,
        QueueOptions::new().with_poll_interval(Duration::from_millis(5)),
    )
    .await
    .expect("connect PostgreSQL queue backend");
    let queue = Queue::new(name, backend);
    let calls = Arc::new(AtomicUsize::new(0));
    let observed = Arc::clone(&calls);
    queue
        .process("retry", move |_job: QueueJob, _context: QueueContext| {
            let observed = Arc::clone(&observed);
            async move {
                if observed.fetch_add(1, Ordering::SeqCst) == 0 {
                    return Err(a3s_boot::BootError::Internal("first attempt".into()));
                }
                Ok(())
            }
        })
        .expect("register retry processor");
    queue
        .enqueue_with_options(
            "retry",
            &json!({}),
            QueueJobOptions::new()
                .with_retry_policy(QueueRetryPolicy::fixed(1, Duration::from_millis(5))),
        )
        .await
        .expect("enqueue retried job");
    queue.start(ModuleRef::new()).await.expect("start queue");
    wait_until(|| calls.load(Ordering::SeqCst) == 2).await;
    queue.shutdown().await.expect("shutdown queue");
    let stats = queue.stats().expect("queue stats");
    assert_eq!(stats.completed, 1);
    assert_eq!(stats.failed, 0);
}

#[tokio::test]
async fn active_deduplication_keeps_only_the_latest_successor() {
    let Some(url) = postgres_url() else {
        eprintln!("skipping PostgreSQL queue test; set A3S_BOOT_POSTGRES_URL");
        return;
    };
    let name = queue_name("dedup");
    let backend = PostgresQueueBackend::connect(
        &url,
        &name,
        QueueOptions::new().with_poll_interval(Duration::from_millis(5)),
    )
    .await
    .expect("connect PostgreSQL queue backend");
    let queue = Queue::new(name, backend);
    let started = Arc::new(Notify::new());
    let release = Arc::new(Notify::new());
    let values = Arc::new(std::sync::Mutex::new(Vec::new()));
    let processor_started = Arc::clone(&started);
    let processor_release = Arc::clone(&release);
    let observed = Arc::clone(&values);
    queue
        .process("dedup", move |job: QueueJob, _context: QueueContext| {
            let started = Arc::clone(&processor_started);
            let release = Arc::clone(&processor_release);
            let observed = Arc::clone(&observed);
            async move {
                let value = job.data["value"].as_u64().expect("numeric value");
                observed.lock().expect("values lock").push(value);
                if value == 1 {
                    started.notify_one();
                    release.notified().await;
                }
                Ok(())
            }
        })
        .expect("register deduplicated processor");
    let deduplicated = || {
        let mut options = QueueJobOptions::new().with_deduplication_id("same-target");
        options
            .deduplication
            .as_mut()
            .expect("deduplication options")
            .keep_last_if_active = true;
        options
    };
    queue
        .enqueue_with_options("dedup", &json!({"value": 1}), deduplicated())
        .await
        .expect("enqueue active owner");
    queue.start(ModuleRef::new()).await.expect("start queue");
    tokio::time::timeout(Duration::from_secs(5), started.notified())
        .await
        .expect("first job should become active");
    queue
        .enqueue_with_options("dedup", &json!({"value": 2}), deduplicated())
        .await
        .expect("enqueue first successor");
    queue
        .enqueue_with_options("dedup", &json!({"value": 3}), deduplicated())
        .await
        .expect("replace successor with latest payload");
    release.notify_one();
    wait_until(|| values.lock().expect("values lock").len() == 2).await;
    queue.shutdown().await.expect("shutdown queue");
    assert_eq!(*values.lock().expect("values lock"), vec![1, 3]);
}

#[tokio::test]
async fn processor_timeout_is_fenced_and_recorded() {
    let Some(url) = postgres_url() else {
        eprintln!("skipping PostgreSQL queue test; set A3S_BOOT_POSTGRES_URL");
        return;
    };
    let name = queue_name("timeout");
    let backend = PostgresQueueBackend::connect(
        &url,
        &name,
        QueueOptions::new().with_poll_interval(Duration::from_millis(5)),
    )
    .await
    .expect("connect timeout queue");
    let diagnostics = backend.clone();
    let queue = Queue::new(name, backend);
    queue
        .process(
            "timeout",
            |_job: QueueJob, _context: QueueContext| async move {
                std::future::pending::<a3s_boot::Result<()>>().await
            },
        )
        .expect("register timeout processor");
    queue
        .enqueue_with_options(
            "timeout",
            &json!({}),
            QueueJobOptions::new().with_timeout(Duration::from_millis(20)),
        )
        .await
        .expect("enqueue timeout job");
    queue.start(ModuleRef::new()).await.expect("start queue");
    let timeout_result = tokio::time::timeout(Duration::from_secs(5), async {
        loop {
            if diagnostics
                .stats_async()
                .await
                .expect("timeout stats")
                .failed
                == 1
            {
                break;
            }
            assert_eq!(diagnostics.last_worker_error().expect("worker error"), None);
            tokio::time::sleep(Duration::from_millis(10)).await;
        }
    })
    .await;
    if timeout_result.is_err() {
        let worker_error = diagnostics.last_worker_error().expect("worker error");
        let shutdown_error = queue.shutdown().await.err();
        panic!(
            "timeout job did not fail; worker_error={worker_error:?}, shutdown_error={shutdown_error:?}"
        );
    }
    queue.shutdown().await.expect("shutdown queue");
    let failures = diagnostics
        .failures_async()
        .await
        .expect("timeout failures");
    assert_eq!(failures.len(), 1);
    assert!(failures[0].message.contains("timed out"));
}

#[tokio::test]
async fn heartbeat_prevents_competing_workers_from_reclaiming_live_work() {
    let Some(url) = postgres_url() else {
        eprintln!("skipping PostgreSQL queue test; set A3S_BOOT_POSTGRES_URL");
        return;
    };
    let name = queue_name("heartbeat");
    let options = QueueOptions::new()
        .with_worker_count(2)
        .with_poll_interval(Duration::from_millis(5))
        .with_lease_duration(Duration::from_millis(60));
    let backend = PostgresQueueBackend::connect(&url, &name, options)
        .await
        .expect("connect heartbeat queue");
    let diagnostics = backend.clone();
    let queue = Queue::new(name, backend);
    let calls = Arc::new(AtomicUsize::new(0));
    let observed = Arc::clone(&calls);
    queue
        .process("slow", move |_job: QueueJob, _context: QueueContext| {
            let observed = Arc::clone(&observed);
            async move {
                observed.fetch_add(1, Ordering::SeqCst);
                tokio::time::sleep(Duration::from_millis(220)).await;
                Ok(())
            }
        })
        .expect("register slow processor");
    queue
        .enqueue("slow", &json!({}))
        .await
        .expect("enqueue slow job");
    queue.start(ModuleRef::new()).await.expect("start queue");
    tokio::time::timeout(Duration::from_secs(5), async {
        loop {
            if diagnostics
                .stats_async()
                .await
                .expect("heartbeat stats")
                .completed
                == 1
            {
                break;
            }
            assert_eq!(diagnostics.last_worker_error().expect("worker error"), None);
            tokio::time::sleep(Duration::from_millis(10)).await;
        }
    })
    .await
    .expect("heartbeat job should complete");
    queue.shutdown().await.expect("shutdown queue");
    assert_eq!(calls.load(Ordering::SeqCst), 1);
    assert_eq!(
        diagnostics
            .stats_async()
            .await
            .expect("heartbeat stats")
            .failed,
        0
    );
}

#[tokio::test]
async fn expired_lease_recovers_the_same_job_after_process_death() {
    let Some(url) = postgres_url() else {
        eprintln!("skipping PostgreSQL queue test; set A3S_BOOT_POSTGRES_URL");
        return;
    };
    let name = queue_name("process-death");
    let options = QueueOptions::new()
        .with_poll_interval(Duration::from_millis(5))
        .with_lease_duration(Duration::from_millis(150));
    let backend = PostgresQueueBackend::connect(&url, &name, options)
        .await
        .expect("connect process-death queue");
    let queue = Queue::new(name.clone(), backend);
    let receipt = queue
        .enqueue("block", &json!({"effectId": "stable-effect"}))
        .await
        .expect("enqueue process-death job");

    let executable = std::env::current_exe().expect("resolve PostgreSQL test executable");
    let child = Command::new(executable)
        .arg("--exact")
        .arg("postgres_queue_process_death_probe")
        .arg("--nocapture")
        .env("A3S_BOOT_POSTGRES_URL", &url)
        .env("A3S_BOOT_POSTGRES_CRASH_PROBE", "1")
        .env("A3S_BOOT_POSTGRES_CRASH_QUEUE", &name)
        .stdin(Stdio::null())
        .stdout(Stdio::null())
        .stderr(Stdio::null())
        .spawn()
        .expect("spawn PostgreSQL queue crash probe");
    let mut child = ChildGuard(Some(child));
    tokio::time::timeout(Duration::from_secs(5), async {
        loop {
            if queue.stats().expect("process-death stats").active == 1 {
                return;
            }
            if child
                .0
                .as_mut()
                .expect("crash probe child")
                .try_wait()
                .expect("poll crash probe")
                .is_some()
            {
                panic!("PostgreSQL queue crash probe exited before leasing work");
            }
            tokio::time::sleep(Duration::from_millis(10)).await;
        }
    })
    .await
    .expect("crash probe should lease the job");
    let mut killed = child.0.take().expect("take crash probe child");
    killed.kill().expect("kill PostgreSQL queue worker process");
    let killed_status = killed.wait().expect("wait for killed queue worker");
    assert!(!killed_status.success());

    tokio::time::sleep(Duration::from_millis(200)).await;
    let recovered = PostgresQueueBackend::connect(&url, &name, options)
        .await
        .expect("reconnect after process death");
    let recovered_queue = Queue::new(name, recovered);
    let recovered_job_id = receipt.id.clone();
    let completed = Arc::new(AtomicUsize::new(0));
    let observed = Arc::clone(&completed);
    recovered_queue
        .process("block", move |job: QueueJob, _context: QueueContext| {
            let observed = Arc::clone(&observed);
            let recovered_job_id = recovered_job_id.clone();
            async move {
                assert_eq!(job.id, recovered_job_id);
                assert_eq!(job.data["effectId"], "stable-effect");
                observed.fetch_add(1, Ordering::SeqCst);
                Ok(())
            }
        })
        .expect("register recovered processor");
    recovered_queue
        .start(ModuleRef::new())
        .await
        .expect("start recovered queue");
    wait_until(|| completed.load(Ordering::SeqCst) == 1).await;
    recovered_queue
        .shutdown()
        .await
        .expect("shutdown recovered queue");
    let stats = recovered_queue.stats().expect("recovered queue stats");
    assert_eq!(stats.active, 0);
    assert_eq!(stats.pending, 0);
    assert_eq!(stats.completed, 1);
    assert_eq!(stats.failed, 0);
}

#[tokio::test]
async fn postgres_queue_process_death_probe() {
    if std::env::var("A3S_BOOT_POSTGRES_CRASH_PROBE").as_deref() != Ok("1") {
        return;
    }
    let url = std::env::var("A3S_BOOT_POSTGRES_URL").expect("crash probe PostgreSQL URL");
    let name = std::env::var("A3S_BOOT_POSTGRES_CRASH_QUEUE").expect("crash probe queue name");
    let options = QueueOptions::new()
        .with_poll_interval(Duration::from_millis(5))
        .with_lease_duration(Duration::from_millis(150));
    let backend = PostgresQueueBackend::connect(&url, &name, options)
        .await
        .expect("connect crash probe queue");
    let queue = Queue::new(name, backend);
    queue
        .process(
            "block",
            |_job: QueueJob, _context: QueueContext| async move {
                std::future::pending::<a3s_boot::Result<()>>().await
            },
        )
        .expect("register blocking crash probe processor");
    queue
        .start(ModuleRef::new())
        .await
        .expect("start crash probe queue");
    std::future::pending::<()>().await;
}

struct ChildGuard(Option<std::process::Child>);

impl Drop for ChildGuard {
    fn drop(&mut self) {
        if let Some(child) = self.0.as_mut() {
            let _ = child.kill();
            let _ = child.wait();
        }
    }
}