plane 0.5.5

Session backend orchestrator for ambitious browser-based apps.
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

use super::executor::Executor;
use crate::util::GuardHandle;
use chrono::Utc;
use plane_common::{
    log_types::LoggableTime,
    names::BackendName,
    protocol::{AcquiredKey, BackendAction, KeyDeadlines, RenewKeyRequest},
    typed_socket::TypedSocketSender,
    types::{backend_state::TerminationReason, TerminationKind},
};
use std::{collections::HashMap, sync::Arc, time::Duration};
use tokio::time::sleep;
use valuable::Valuable;

pub struct KeyManager {
    executor: Arc<Executor>,

    /// Map from a backend to the most recently acquired key for that backend,
    /// along with the handle for the task that is responsible for renewing the key
    /// and terminating the backend if the key cannot be renewed.
    handles: HashMap<BackendName, (AcquiredKey, GuardHandle)>,

    sender: Option<TypedSocketSender<RenewKeyRequest>>,
}

async fn renew_key_loop(
    key: AcquiredKey,
    backend: BackendName,
    sender: Option<TypedSocketSender<RenewKeyRequest>>,
    executor: Arc<Executor>,
) {
    loop {
        let now = Utc::now();
        let deadlines = &key.deadlines;
        if now >= deadlines.hard_terminate_at.0 {
            tracing::warn!("Key {:?} has expired, hard-terminating.", key.key);
            if let Err(err) = executor
                .apply_action(
                    &backend,
                    &BackendAction::Terminate {
                        kind: TerminationKind::Hard,
                        reason: TerminationReason::KeyExpired,
                    },
                )
                .await
            {
                tracing::error!(%err, "Error hard-terminating backend.");
                sleep(Duration::from_secs(1)).await;
                continue;
            }
            break;
        }

        if now >= deadlines.soft_terminate_at.0 {
            tracing::warn!("Key {:?} has expired, soft-terminating.", key.key);
            if let Err(err) = executor
                .apply_action(
                    &backend,
                    &BackendAction::Terminate {
                        kind: TerminationKind::Soft,
                        reason: TerminationReason::KeyExpired,
                    },
                )
                .await
            {
                tracing::error!(%err, "Error soft-terminating backend.");
                sleep(Duration::from_secs(1)).await;
                continue;
            }

            if let Ok(time_to_sleep) = deadlines
                .hard_terminate_at
                .0
                .signed_duration_since(now)
                .to_std()
            {
                sleep(time_to_sleep).await;
            }

            continue;
        }

        if now >= deadlines.renew_at.0 {
            tracing::info!(key = key.key.as_value(), "Renewing key.");

            if let Some(ref sender) = sender {
                let request = RenewKeyRequest {
                    backend: backend.clone(),
                    local_time: LoggableTime(Utc::now()),
                };

                if let Err(err) = sender.send(request) {
                    tracing::error!(%err, "Error sending renew key request.");
                }
            }

            if let Ok(time_to_sleep) = deadlines
                .soft_terminate_at
                .0
                .signed_duration_since(now)
                .to_std()
            {
                sleep(time_to_sleep).await;
            }
            continue;
        }

        if let Ok(time_to_sleep) = deadlines.renew_at.0.signed_duration_since(now).to_std() {
            sleep(time_to_sleep).await;
        }
    }
}

impl KeyManager {
    pub fn new(executor: Arc<Executor>) -> Self {
        Self {
            executor,
            handles: HashMap::new(),
            sender: None,
        }
    }

    pub fn set_sender(&mut self, sender: TypedSocketSender<RenewKeyRequest>) {
        self.sender.replace(sender);

        for (backend, (acquired_key, handle)) in self.handles.iter_mut() {
            let new_handle = GuardHandle::new(renew_key_loop(
                acquired_key.clone(),
                backend.clone(),
                self.sender.clone(),
                self.executor.clone(),
            ));

            *handle = new_handle;
        }
    }

    /// Register a key with the key manager, ensuring that it will be renewed.
    /// Returns true if the key was registered, and false if it was already registered (this
    /// should be considered an error.)
    pub fn register_key(&mut self, backend: BackendName, key: AcquiredKey) -> bool {
        if self.handles.contains_key(&backend) {
            return false;
        }

        let handle = GuardHandle::new(renew_key_loop(
            key.clone(),
            backend.clone(),
            self.sender.clone(),
            self.executor.clone(),
        ));

        self.handles.insert(backend, (key, handle));

        true
    }

    pub fn update_deadlines(&mut self, backend: &BackendName, deadlines: KeyDeadlines) {
        if let Some((key, handle)) = self.handles.get_mut(backend) {
            key.deadlines = deadlines;

            *handle = GuardHandle::new(renew_key_loop(
                key.clone(),
                backend.clone(),
                self.sender.clone(),
                self.executor.clone(),
            ));
        }
    }

    pub fn unregister_key(&mut self, backend: &BackendName) {
        self.handles.remove(backend);
    }
}