etherbird 0.4.2

Stable async clients with connection recovery and session restoration
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
//! Lifecycle hook execution and replacement driver.
use super::*;

fn log_failure<L: Lifecycle>(lifecycle: &L, config: &Config, name: &str, error: &L::Error) {
    if lifecycle.is_expected(error) {
        tracing::warn!(resource = config.resource_name, hook = name, %error);
        tracing::debug!(resource = config.resource_name, hook = name, ?error);
    } else {
        tracing::error!(resource = config.resource_name, hook = name, %error);
    }
}
fn log_late_failure<L: Lifecycle>(lifecycle: &L, config: &Config, name: &str, error: &L::Error) {
    if classifiable_hook(name) && lifecycle.lifecycle_failure(error) == LifecycleFailurePolicy::Fail
    {
        if lifecycle.is_expected(error) {
            tracing::debug!(
                resource = config.resource_name,
                hook = name,
                "abandoned lifecycle hook failed (cause redacted)"
            );
        } else {
            tracing::error!(
                resource = config.resource_name,
                hook = name,
                "abandoned lifecycle hook failed (cause redacted)"
            );
        }
        return;
    }
    if lifecycle.is_expected(error) {
        tracing::debug!(
            resource = config.resource_name,
            hook = name,
            ?error,
            "abandoned hook failed"
        );
    } else {
        log_failure(lifecycle, config, name, error);
    }
}
fn classifiable_hook(name: &str) -> bool {
    matches!(
        name,
        "create"
            | "on_resource_created"
            | "connect"
            | "late connect"
            | "setup"
            | "watch_disconnect"
    )
}
struct HookFailure<E> {
    terminal: bool,
    cause: Option<Arc<E>>,
}
impl<E> HookFailure<E> {
    fn retry() -> Self {
        Self {
            terminal: false,
            cause: None,
        }
    }
}
fn hook_failure<L: Lifecycle>(
    lifecycle: &L,
    config: &Config,
    name: &str,
    error: L::Error,
) -> HookFailure<L::Error> {
    let terminal = lifecycle.is_terminal(&error);
    if classifiable_hook(name)
        && lifecycle.lifecycle_failure(&error) == LifecycleFailurePolicy::Fail
    {
        if lifecycle.is_expected(&error) {
            tracing::warn!(
                resource = config.resource_name,
                hook = name,
                "non-retryable lifecycle failure (cause redacted)"
            );
            tracing::debug!(
                resource = config.resource_name,
                hook = name,
                "non-retryable lifecycle failure (cause redacted)"
            );
        } else {
            tracing::error!(
                resource = config.resource_name,
                hook = name,
                "non-retryable lifecycle failure (cause redacted)"
            );
        }
        HookFailure {
            terminal,
            cause: Some(Arc::new(error)),
        }
    } else {
        log_failure(lifecycle, config, name, &error);
        HookFailure {
            terminal,
            cause: None,
        }
    }
}
async fn bounded<L: Lifecycle>(
    lifecycle: Arc<L>,
    config: Config,
    name: &'static str,
    duration: Option<Duration>,
    future: impl Future<Output = Result<(), L::Error>> + Send + 'static,
) -> Result<(), HookFailure<L::Error>> {
    let mut task = tokio::spawn(future);
    match deadline(duration, &mut task).await {
        Ok(Ok(Ok(()))) => Ok(()),
        Ok(Ok(Err(error))) => Err(hook_failure(lifecycle.as_ref(), &config, name, error)),
        Ok(Err(error)) => {
            tracing::error!(hook = name, %error, "hook task failed");
            Err(HookFailure::retry())
        }
        Err(_) => {
            tracing::warn!(
                resource = config.resource_name,
                hook = name,
                "hook abandoned after timeout"
            );
            tokio::spawn(async move {
                match task.await {
                    Ok(Err(error)) => log_late_failure(lifecycle.as_ref(), &config, name, &error),
                    Ok(Ok(())) => tracing::warn!(
                        resource = config.resource_name,
                        hook = name,
                        "abandoned hook completed after timeout"
                    ),
                    Err(error) => {
                        tracing::error!(hook = name, %error, "abandoned hook task failed")
                    }
                }
            });
            Err(HookFailure::retry())
        }
    }
}
async fn deadline<T>(
    duration: Option<Duration>,
    future: impl Future<Output = T>,
) -> Result<T, tokio::time::error::Elapsed> {
    match duration {
        Some(duration) => timeout(duration, future).await,
        None => Ok(future.await),
    }
}
async fn destroy<L: Lifecycle>(lifecycle: Arc<L>, config: Config, resource: Arc<L::Resource>) {
    let manager = lifecycle.clone();
    let _ = bounded(
        lifecycle,
        config.clone(),
        "destroy",
        config.destroy_timeout,
        async move { manager.destroy(&resource).await },
    )
    .await;
}
async fn close<L: Lifecycle>(
    lifecycle: Arc<L>,
    config: Config,
    resource: Arc<L::Resource>,
    terminal: bool,
) {
    let manager = lifecycle.clone();
    let value = resource.clone();
    let _ = bounded(
        lifecycle.clone(),
        config.clone(),
        "cleanup",
        Some(config.cleanup_timeout),
        async move { manager.cleanup(&value).await },
    )
    .await;
    if !terminal {
        let manager = lifecycle.clone();
        let value = resource.clone();
        let mut task = tokio::spawn(async move { manager.disconnect(&value).await });
        match timeout(config.disconnect_timeout, &mut task).await {
            Ok(Ok(Err(error))) => log_failure(lifecycle.as_ref(), &config, "disconnect", &error),
            Ok(Err(error)) => tracing::error!(%error, "disconnect task failed"),
            Ok(Ok(Ok(()))) => {}
            Err(_) => {
                tracing::warn!(
                    resource = config.resource_name,
                    "disconnect abandoned after timeout"
                );
                tokio::spawn(async move {
                    if let Ok(Err(error)) = task.await {
                        log_late_failure(lifecycle.as_ref(), &config, "disconnect", &error);
                    }
                    destroy(lifecycle, config, resource).await;
                });
                return;
            }
        }
    }
    destroy(lifecycle, config, resource).await;
}
async fn connect<L: Lifecycle>(
    lifecycle: Arc<L>,
    config: Config,
    resource: Arc<L::Resource>,
    stopping: &mut watch::Receiver<bool>,
) -> Result<(), HookFailure<L::Error>> {
    let manager = lifecycle.clone();
    let value = resource.clone();
    let mut task = tokio::spawn(async move { manager.connect(&value).await });
    tokio::select! {
        biased;
        _ = shutdown(stopping) => { task.abort(); let _ = task.await; Err(HookFailure::retry()) }
        result = timeout(config.connect_timeout, &mut task) => match result {
            Ok(Ok(Ok(()))) => Ok(()),
            Ok(Ok(Err(error))) => {
                Err(hook_failure(lifecycle.as_ref(), &config, "connect", error))
            }
            Ok(Err(error)) => { tracing::error!(%error, "connect task failed"); Err(HookFailure::retry()) }
            Err(_) => {
                tracing::warn!(resource = config.resource_name, "connect abandoned after timeout");
                tokio::spawn(async move {
                    match task.await {
                        Ok(Ok(())) => close(lifecycle, config, resource, false).await,
                        Ok(Err(error)) => log_late_failure(lifecycle.as_ref(), &config, "late connect", &error),
                        Err(error) => tracing::error!(%error, "late connect task failed"),
                    }
                });
                Err(HookFailure::retry())
            }
        }
    }
}
pub(super) struct WorkerStatus<L: Lifecycle> {
    pub(super) sender: watch::Sender<Snapshot<L::Resource>>,
    pub(super) failure: watch::Sender<Option<Arc<L::Error>>>,
}
fn latch_failure<L: Lifecycle>(status: &WorkerStatus<L>, cause: Arc<L::Error>) {
    status.failure.send_replace(Some(cause));
    publish(&status.sender, ResourceState::Failed, None);
}
async fn wait_for_reset<E>(
    failure: &watch::Sender<Option<Arc<E>>>,
    stopping: &mut watch::Receiver<bool>,
    requests: &mut mpsc::UnboundedReceiver<Recovery>,
) {
    let mut changes = failure.subscribe();
    loop {
        if changes.borrow_and_update().is_none() {
            return;
        }
        tokio::select! {
            biased;
            _ = shutdown(stopping) => return,
            _ = changes.changed() => {},
            request = requests.recv() => {
                match request {
                    Some(request) => {
                        if let Some(completed) = request.completed {
                            let _ = completed.send(());
                        }
                    }
                    None => return,
                }
            }
        }
    }
}
pub(super) async fn maintain<L: Lifecycle>(
    lifecycle: Arc<L>,
    config: Config,
    mut stopping: watch::Receiver<bool>,
    status: WorkerStatus<L>,
    mut requests: mpsc::UnboundedReceiver<Recovery>,
    attributes: Arc<Mutex<Attributes<L::Resource, L::Error>>>,
    generations: Arc<AtomicU64>,
) -> mpsc::UnboundedReceiver<Recovery> {
    let sender = &status.sender;
    let mut delay = config.retry_delay;
    loop {
        while let Ok(request) = requests.try_recv() {
            if let Some(completed) = request.completed {
                let _ = completed.send(());
            }
        }
        if *stopping.borrow() {
            break;
        }
        publish(sender, ResourceState::Connecting, None);
        let manager = lifecycle.clone();
        let mut creating = tokio::spawn(async move { manager.create().await });
        let created = tokio::select! {
            biased;
            _ = shutdown(&mut stopping) => { creating.abort(); let _ = creating.await; break },
            result = deadline(config.create_timeout, &mut creating) => result,
        };
        match created {
            Ok(Ok(Ok(resource))) => {
                let resource = Arc::new(resource);
                let (on_created, after_created) = {
                    let mut attributes = attributes.lock().unwrap();
                    attributes.last = Some(resource.clone());
                    (
                        attributes.on_created.clone(),
                        attributes.after_created.clone(),
                    )
                };
                let manager = lifecycle.clone();
                let value = resource.clone();
                let settings = attributes.clone();
                let created = bounded(
                    lifecycle.clone(),
                    config.clone(),
                    "on_resource_created",
                    config.created_timeout,
                    async move {
                        manager.on_resource_created(&value).await?;
                        if let Some(hook) = on_created {
                            hook(value.clone()).await?;
                        }
                        {
                            let settings = settings.lock().unwrap();
                            for setter in settings.setters.values() {
                                setter(&value);
                            }
                        }
                        if let Some(hook) = after_created {
                            hook(value).await?;
                        }
                        Ok(())
                    },
                );
                let created = tokio::select! { biased; _ = shutdown(&mut stopping) => Err(HookFailure::retry()), result = created => result };
                let connected = if created.is_ok() {
                    connect(
                        lifecycle.clone(),
                        config.clone(),
                        resource.clone(),
                        &mut stopping,
                    )
                    .await
                } else {
                    created
                };
                let manager = lifecycle.clone();
                let value = resource.clone();
                let setup = if connected.is_ok() {
                    tokio::select! {
                        biased;
                        _ = shutdown(&mut stopping) => Err(HookFailure::retry()),
                        ready = bounded(lifecycle.clone(), config.clone(), "setup", Some(config.setup_timeout),
                            async move { manager.setup(&value).await }) => ready,
                    }
                } else {
                    connected
                };
                if setup.is_ok() {
                    let generation = generations.fetch_add(1, Ordering::AcqRel) + 1;
                    delay = config.retry_delay;
                    tracing::info!(resource = config.resource_name, "connected");
                    publish(
                        sender,
                        ResourceState::Connected,
                        Some(ResourceHandle {
                            resource: resource.clone(),
                            generation,
                        }),
                    );
                    let mut watchdog = lifecycle
                        .watch_disconnect(resource.clone())
                        .map(tokio::spawn);
                    let mut watchdog_done = false;
                    let mut completed = None;
                    let terminal = loop {
                        tokio::select! {
                            biased;
                            _ = shutdown(&mut stopping) => break HookFailure::retry(),
                            request = requests.recv() => {
                                match request {
                                    Some(request) if request.generation == generation => { completed = request.completed; break HookFailure { terminal: request.terminal, cause: None } },
                                    Some(request) => { if let Some(completed) = request.completed { let _ = completed.send(()); } continue },
                                    None => break HookFailure::retry(),
                                }
                            }
                            result = async { match watchdog.as_mut() { Some(task) => task.await, None => std::future::pending().await } } => {
                                watchdog_done = true;
                                break match result { Ok(Err(error)) => hook_failure(lifecycle.as_ref(), &config, "watch_disconnect", error), _ => HookFailure::retry() };
                            }
                        }
                    };
                    if !watchdog_done && let Some(watchdog) = watchdog {
                        watchdog.abort();
                        let _ = watchdog.await;
                    }
                    let state = if *stopping.borrow() {
                        ResourceState::Stopping
                    } else {
                        ResourceState::Recovering
                    };
                    publish(sender, state, None);
                    let failed = terminal.cause.is_some();
                    if let Some(cause) = terminal.cause {
                        latch_failure(&status, cause);
                    }
                    close(
                        lifecycle.clone(),
                        config.clone(),
                        resource,
                        terminal.terminal,
                    )
                    .await;
                    if let Some(completed) = completed {
                        let _ = completed.send(());
                    }
                    if failed {
                        wait_for_reset(&status.failure, &mut stopping, &mut requests).await;
                    }
                    continue;
                }
                let failure = setup.expect_err("failed setup");
                let failed = failure.cause.is_some();
                if let Some(cause) = failure.cause {
                    latch_failure(&status, cause);
                } else {
                    publish(sender, ResourceState::Disconnected, None);
                }
                close(
                    lifecycle.clone(),
                    config.clone(),
                    resource,
                    failure.terminal,
                )
                .await;
                if failed {
                    wait_for_reset(&status.failure, &mut stopping, &mut requests).await;
                    continue;
                }
            }
            Ok(Ok(Err(error))) => {
                let failure = hook_failure(lifecycle.as_ref(), &config, "create", error);
                if let Some(cause) = failure.cause {
                    latch_failure(&status, cause);
                    wait_for_reset(&status.failure, &mut stopping, &mut requests).await;
                    continue;
                }
            }
            Ok(Err(error)) => tracing::error!(%error, "creation task failed"),
            Err(_) => {
                tracing::warn!("resource creation timed out");
                let manager = lifecycle.clone();
                let settings = config.clone();
                tokio::spawn(async move {
                    if let Ok(Ok(resource)) = creating.await {
                        close(manager, settings, Arc::new(resource), false).await;
                    }
                });
            }
        }
        publish(sender, ResourceState::Disconnected, None);
        tracing::info!(resource = config.resource_name, retry_delay = ?delay, "retrying connection");
        tokio::select! { biased; _ = shutdown(&mut stopping) => break, _ = sleep(delay) => {} }
        delay = delay.saturating_mul(2).min(config.max_retry_delay);
    }
    while let Ok(request) = requests.try_recv() {
        if let Some(completed) = request.completed {
            let _ = completed.send(());
        }
    }
    attributes.lock().unwrap().last = None;
    status.failure.send_replace(None);
    publish(sender, ResourceState::Stopped, None);
    requests
}