continuo 0.12.0

Runtime service composition for multi-service Rust applications: typed component resolution, dependency-ordered lifecycle, reload, runnable tasks, graceful drain, and finalization.
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
use super::*;
use crate::{Component, Runnable, RunnableInstance};
use crate::{
    ExecutionDomain, ExecutionDriver, ExecutionFuture, ExecutionOwner,
    ExecutionSpec, ExecutorKind, ExecutorSpec, PreparedExecution,
};
use async_trait::async_trait;
use std::sync::atomic::{AtomicBool, AtomicUsize};
use std::sync::{Mutex, RwLock, Weak};
use tokio::sync::Notify;

#[derive(Clone, Default)]
struct State(CancellationToken);
impl SharedState for State {
    fn shutdown_token(&self) -> CancellationToken {
        self.0.clone()
    }
}

#[derive(Default)]
struct Work {
    entered: Notify,
    draining: Notify,
    release: Option<Arc<Notify>>,
    contexts: Mutex<Vec<RunContext>>,
    execution: ExecutionSpec,
    own_reload: bool,
    reloads: AtomicUsize,
    reject_reload: AtomicBool,
}

#[async_trait]
impl Runnable<State> for Work {
    fn as_reloadable(&self) -> Option<&dyn crate::Reloadable<State>> {
        self.own_reload.then_some(self)
    }

    fn execution_spec(
        &self,
        _: &State,
    ) -> ExecutionSpec {
        self.execution.clone()
    }

    async fn run(
        self: Arc<Self>,
        _: (),
        _: State,
        context: RunContext,
    ) -> Result<()> {
        self.contexts.lock().unwrap().push(context.clone());
        self.entered.notify_one();
        context.cancelled().await;
        self.draining.notify_one();
        if let Some(release) = &self.release {
            release.notified().await;
        }
        Ok(())
    }
}

#[async_trait]
impl crate::Reloadable<State> for Work {
    async fn reload(
        &self,
        _: &State,
    ) -> Result<()> {
        if self.reject_reload.load(Ordering::Relaxed) {
            return Err(Error::msg("instance preparation rejected"));
        }
        self.reloads.fetch_add(1, Ordering::Relaxed);
        Ok(())
    }
}

#[derive(Default)]
struct Driver(Mutex<Vec<(ExecutionOwner, ExecutionSpec)>>);

impl Driver {
    fn specs(&self) -> Vec<ExecutionSpec> {
        self.0.lock().unwrap().iter().map(|(_, spec)| spec.clone()).collect()
    }

    fn owners(&self) -> Vec<ExecutionOwner> {
        self.0.lock().unwrap().iter().map(|(owner, _)| owner.clone()).collect()
    }
}

impl ExecutionDriver for Driver {
    fn prepare(
        &self,
        owner: &ExecutionOwner,
        spec: ExecutionSpec,
    ) -> Result<Arc<dyn PreparedExecution>> {
        self.0.lock().unwrap().push((owner.clone(), spec));
        Ok(Arc::new(Adapter))
    }
}

struct Adapter;

impl PreparedExecution for Adapter {
    fn execute(
        &self,
        task: ExecutionFuture,
        _: RunContext,
    ) -> ExecutionFuture {
        task
    }
}

#[tokio::test]
async fn each_instance_selects_its_own_execution_spec() {
    struct Domain;
    let (registry, factory, state, runtime) = setup();
    let first_spec =
        ExecutionSpec::default().with_executor(ExecutorSpec::Shared(
            ExecutionDomain::named::<Domain>(String::from("first")),
        ));
    let second_spec =
        ExecutionSpec::default().with_executor(ExecutorSpec::Shared(
            ExecutionDomain::named::<Domain>(String::from("second")),
        ));
    let first =
        Arc::new(Work { execution: first_spec.clone(), ..Default::default() });
    let second =
        Arc::new(Work { execution: second_spec.clone(), ..Default::default() });
    factory.set(vec![
        RunnableInstance::new("first", first.clone()),
        RunnableInstance::new("second", second.clone()),
    ]);
    let driver = Arc::new(Driver::default());
    let mut runtime = runtime.with_execution_driver(driver.clone()).unwrap();
    runtime.spawn_all(&registry, state).unwrap();
    first.entered.notified().await;
    second.entered.notified().await;
    assert_eq!(driver.specs(), vec![first_spec.clone(), second_spec.clone()]);
    assert_eq!(first.contexts.lock().unwrap()[0].execution_spec(), first_spec);
    assert_eq!(
        second.contexts.lock().unwrap()[0].execution_spec(),
        second_spec
    );
    runtime.begin_shutdown();
    runtime.drain().await.unwrap();
}

#[tokio::test]
async fn an_instance_is_prepared_with_the_same_owner_across_restart() {
    let (registry, factory, state, runtime) = setup();
    let dedicated = ExecutionSpec::default()
        .with_executor(ExecutorSpec::Dedicated(ExecutorKind::CurrentThread));
    let first =
        Arc::new(Work { execution: dedicated.clone(), ..Default::default() });
    let second =
        Arc::new(Work { execution: dedicated.clone(), ..Default::default() });
    factory.set(vec![
        RunnableInstance::new("first", first.clone()),
        RunnableInstance::new("second", second.clone()),
    ]);
    let driver = Arc::new(Driver::default());
    let mut runtime = runtime.with_execution_driver(driver.clone()).unwrap();
    runtime.spawn_all(&registry, state.clone()).unwrap();
    first.entered.notified().await;
    second.entered.notified().await;
    let manager = runtime.manager();
    let observing = state.clone();
    let running = tokio::spawn(async move {
        runtime.wait_until_shutdown(&observing).await.unwrap();
        runtime.drain().await.unwrap();
    });
    let restarted = manager.restart("first").await.unwrap();
    first.entered.notified().await;
    assert_eq!(restarted.generation(), 2);

    let owners = driver.owners();
    assert_eq!(owners.len(), 3);
    assert_eq!(owners[0], ExecutionOwner::of::<Factory>("first"));
    assert_eq!(owners[1], ExecutionOwner::of::<Factory>("second"));
    assert_eq!(owners[2], owners[0]);
    assert_ne!(owners[0], owners[1]);
    state.0.cancel();
    running.await.unwrap();
}

#[derive(Default)]
struct Factory {
    instances: RwLock<Vec<RunnableInstance<State>>>,
    reloads: AtomicUsize,
}
impl Factory {
    fn set(
        &self,
        instances: Vec<RunnableInstance<State>>,
    ) {
        *self.instances.write().unwrap() = instances;
    }
}
impl Component<State> for Factory {
    type Deps = ();
    fn name(&self) -> &str {
        "factory"
    }
    fn runnables(self: Arc<Self>) -> Vec<RunnableInstance<State>> {
        self.instances.read().unwrap().clone()
    }
    fn as_reloadable(&self) -> Option<&dyn crate::Reloadable<State>> {
        Some(self)
    }
}

#[async_trait]
impl crate::Reloadable<State> for Factory {
    async fn reload(
        &self,
        _: &State,
    ) -> Result<()> {
        self.reloads.fetch_add(1, Ordering::Relaxed);
        Ok(())
    }
}

fn setup() -> (Registry<State>, Arc<Factory>, State, Runtime<State>) {
    let registry = Registry::new();
    let factory = Arc::new(Factory::default());
    registry.register(factory.clone()).unwrap();
    (registry, factory, State::default(), Runtime::default())
}

#[tokio::test]
async fn targeted_instance_reload_retains_factory_fallback_and_isolates_failure()
 {
    let (registry, factory, state, mut runtime) = setup();
    let first = Arc::new(Work { own_reload: true, ..Default::default() });
    let second = Arc::new(Work::default());
    factory.set(vec![
        RunnableInstance::new("first", first.clone()),
        RunnableInstance::new("second", second.clone()),
    ]);
    runtime.spawn_all(&registry, state.clone()).unwrap();
    first.entered.notified().await;
    second.entered.notified().await;

    // A source notification remains a component-wide operation, even when
    // its selected management entry also has an instance reload capability.
    let (reply, result) = oneshot::channel();
    runtime
        .handle_prepared_command(
            ServiceCommand::Reload { name: "first".into(), reply },
            true,
        )
        .await;
    result.await.unwrap().unwrap();
    assert_eq!(factory.reloads.load(Ordering::Relaxed), 1);
    assert_eq!(first.reloads.load(Ordering::Relaxed), 0);

    let manager = runtime.manager();
    let observing = state.clone();
    let running = tokio::spawn(async move {
        runtime.wait_until_shutdown(&observing).await.unwrap();
        runtime.drain().await.unwrap();
    });
    let reloaded = manager.reload("first").await.unwrap();
    assert!(reloaded.is_reloadable());
    assert_eq!(reloaded.generation(), 1);
    assert_eq!(first.reloads.load(Ordering::Relaxed), 1);
    assert_eq!(factory.reloads.load(Ordering::Relaxed), 1);
    manager.reload("second").await.unwrap();
    assert_eq!(factory.reloads.load(Ordering::Relaxed), 2);
    assert_eq!(second.reloads.load(Ordering::Relaxed), 0);

    first.reject_reload.store(true, Ordering::Relaxed);
    assert!(matches!(
        manager.reload("first").await,
        Err(ServiceManagerError::OperationFailed { .. })
    ));
    assert_eq!(factory.reloads.load(Ordering::Relaxed), 2);
    assert_eq!(first.reloads.load(Ordering::Relaxed), 1);
    assert!(!first.contexts.lock().unwrap()[0].is_cancelled());
    assert!(!second.contexts.lock().unwrap()[0].is_cancelled());
    state.0.cancel();
    running.await.unwrap();
}

#[tokio::test]
async fn named_instances_share_a_type_but_own_independent_generations() {
    let (registry, factory, state, mut runtime) = setup();
    let first = Arc::new(Work::default());
    let second = Arc::new(Work::default());
    factory.set(vec![
        RunnableInstance::new(String::from("listener:first"), first.clone()),
        RunnableInstance::new(String::from("listener:second"), second.clone()),
    ]);
    runtime.spawn_all(&registry, state.clone()).unwrap();
    first.entered.notified().await;
    second.entered.notified().await;
    let first_identity =
        first.contexts.lock().unwrap()[0].identity().unwrap().clone();
    let second_identity =
        second.contexts.lock().unwrap()[0].identity().unwrap().clone();
    assert_eq!(first_identity.instance(), "listener:first");
    assert_eq!(first_identity.generation(), 1);
    assert_eq!(second_identity.instance(), "listener:second");
    assert_eq!(second_identity.generation(), 1);
    assert!(
        runtime
            .snapshots()
            .iter()
            .all(|snapshot| snapshot.component() == "factory")
    );
    let manager = runtime.manager();
    let observing = state.clone();
    let running = tokio::spawn(async move {
        runtime.wait_until_shutdown(&observing).await.unwrap();
        runtime.drain().await.unwrap();
        runtime
    });
    let stopped =
        manager.stop(Arc::<str>::from("listener:first")).await.unwrap();
    assert_eq!(stopped.status(), ServiceStatus::Stopped);
    assert!(!second.contexts.lock().unwrap()[0].is_cancelled());
    let restarted = manager.start("listener:first").await.unwrap();
    first.entered.notified().await;
    assert_eq!(restarted.generation(), 2);
    let next_identity =
        first.contexts.lock().unwrap()[1].identity().unwrap().clone();
    assert_eq!(next_identity.instance(), restarted.name());
    assert_eq!(next_identity.generation(), restarted.generation());
    assert_ne!(first_identity, next_identity);
    assert_eq!(first_identity.generation(), 1);
    assert_eq!(
        second.contexts.lock().unwrap()[0].identity(),
        Some(&second_identity)
    );
    let third = Arc::new(Work::default());
    factory.set(vec![
        RunnableInstance::new("listener:first", first.clone()),
        RunnableInstance::new("listener:second", second.clone()),
        RunnableInstance::new(String::from("listener:third"), third.clone()),
    ]);
    let refreshed = manager.reconcile().await.unwrap();
    third.entered.notified().await;
    assert_eq!(refreshed.len(), 3);
    assert_eq!(
        refreshed
            .iter()
            .find(|item| item.name() == "listener:second")
            .unwrap()
            .generation(),
        1
    );
    state.0.cancel();
    running.await.unwrap();
}

#[tokio::test]
async fn removed_instance_stays_owned_until_its_drain_finishes() {
    let (registry, factory, state, mut runtime) = setup();
    let release = Arc::new(Notify::new());
    let work =
        Arc::new(Work { release: Some(release.clone()), ..Default::default() });
    let weak: Weak<Work> = Arc::downgrade(&work);
    factory.set(vec![RunnableInstance::new(
        String::from("temporary"),
        work.clone(),
    )]);
    runtime.spawn_all(&registry, state).unwrap();
    work.entered.notified().await;
    factory.set(Vec::new());
    let snapshots = runtime.reconcile_instances().unwrap();
    work.draining.notified().await;
    assert_eq!(snapshots[0].status(), ServiceStatus::Stopping);
    assert!(runtime.start_generation("temporary", false).is_err());
    drop(work);
    assert!(weak.upgrade().is_some());
    release.notify_one();
    let exit = runtime.join_set.join_next_with_id().await.unwrap();
    runtime.complete_join(exit).unwrap();
    assert!(runtime.snapshots().is_empty());
    assert!(weak.upgrade().is_none());
    // Snapshots retain an owned label after the factory and task are gone.
    assert_eq!(snapshots[0].name(), "temporary");
}

#[tokio::test]
async fn restored_instance_restarts_only_after_the_retiring_generation_drains()
{
    let (registry, factory, state, mut runtime) = setup();
    let release = Arc::new(Notify::new());
    let work =
        Arc::new(Work { release: Some(release.clone()), ..Default::default() });
    factory.set(vec![RunnableInstance::new("restored", work.clone())]);
    runtime.spawn_all(&registry, state).unwrap();
    work.entered.notified().await;
    factory.set(Vec::new());
    runtime.reconcile_instances().unwrap();
    work.draining.notified().await;
    factory.set(vec![RunnableInstance::new("restored", work.clone())]);
    runtime.reconcile_instances().unwrap();
    assert_eq!(work.contexts.lock().unwrap().len(), 1);
    release.notify_one();
    let exit = runtime.join_set.join_next_with_id().await.unwrap();
    runtime.complete_join(exit).unwrap();
    work.entered.notified().await;
    assert_eq!(runtime.services["restored"].generation, 2);
    assert!(!work.contexts.lock().unwrap()[1].is_cancelled());
    runtime.begin_shutdown();
    release.notify_one();
    runtime.drain().await.unwrap();
}

#[tokio::test]
async fn retired_instance_is_released_after_an_aborted_future_is_joined() {
    let (registry, factory, state, mut runtime) = setup();
    let work = Arc::new(Work {
        release: Some(Arc::new(Notify::new())),
        ..Default::default()
    });
    let weak = Arc::downgrade(&work);
    factory.set(vec![RunnableInstance::new("retired", work.clone())]);
    runtime.spawn_all(&registry, state).unwrap();
    work.entered.notified().await;
    factory.set(Vec::new());
    runtime.reconcile_instances().unwrap();
    work.draining.notified().await;
    drop(work);
    runtime.join_set.abort_all();
    let exit = runtime.join_set.join_next_with_id().await.unwrap();
    assert!(runtime.complete_join(exit).is_err());
    assert!(runtime.snapshots().is_empty());
    assert!(weak.upgrade().is_none());
}

#[tokio::test]
async fn active_replacement_is_rejected_without_mutating_live_work() {
    let (registry, factory, state, mut runtime) = setup();
    let first = Arc::new(Work::default());
    let next = Arc::new(Work::default());
    factory.set(vec![RunnableInstance::new("same", first.clone())]);
    runtime.spawn_all(&registry, state).unwrap();
    first.entered.notified().await;
    factory.set(vec![RunnableInstance::new("same", next.clone())]);
    assert!(
        runtime
            .reconcile_instances()
            .unwrap_err()
            .to_string()
            .contains("stop runnable")
    );
    assert!(!first.contexts.lock().unwrap()[0].is_cancelled());
    assert!(next.contexts.lock().unwrap().is_empty());
    first.contexts.lock().unwrap()[0].cancellation_token().cancel();
    let exit = runtime.join_set.join_next_with_id().await.unwrap();
    runtime.complete_join(exit).unwrap();
    runtime.reconcile_instances().unwrap();
    assert_eq!(runtime.services["same"].status, ServiceStatus::Stopped);
    runtime.start_generation("same", false).unwrap();
    next.entered.notified().await;
    assert_eq!(runtime.services["same"].generation, 2);
    runtime.begin_shutdown();
    runtime.drain().await.unwrap();
}

#[tokio::test]
async fn duplicate_instance_names_reject_initial_admission() {
    let (registry, factory, state, mut runtime) = setup();
    let work = Arc::new(Work::default());
    factory.set(vec![
        RunnableInstance::new("duplicate", work.clone()),
        RunnableInstance::new("duplicate", work.clone()),
    ]);
    assert!(runtime.spawn_all(&registry, state).is_err());
    assert!(runtime.state.is_none());
    assert!(work.contexts.lock().unwrap().is_empty());
}

struct Missing;
struct NeedsMissing;
#[async_trait]
impl Runnable<State, (Arc<Missing>,)> for NeedsMissing {
    async fn run(
        self: Arc<Self>,
        _: (Arc<Missing>,),
        _: State,
        _: RunContext,
    ) -> Result<()> {
        panic!("a missing dependency must prevent execution")
    }
}

#[tokio::test]
async fn added_instances_are_all_admitted_before_any_existing_one_is_retired() {
    let (registry, factory, state, mut runtime) = setup();
    let current = Arc::new(Work::default());
    let added = Arc::new(Work::default());
    factory.set(vec![RunnableInstance::new("current", current.clone())]);
    runtime.spawn_all(&registry, state).unwrap();
    current.entered.notified().await;
    factory.set(vec![
        RunnableInstance::new("added", added.clone()),
        RunnableInstance::new("missing", Arc::new(NeedsMissing)),
    ]);
    assert!(runtime.reconcile_instances().is_err());
    assert_eq!(runtime.services.len(), 1);
    assert!(!current.contexts.lock().unwrap()[0].is_cancelled());
    assert!(added.contexts.lock().unwrap().is_empty());
    runtime.begin_shutdown();
    runtime.drain().await.unwrap();
}