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

use anyhow::Error;
use docker::{SpawnResult, TerminateEvent};
use futures_util::Stream;
use plane_common::{
    names::BackendName,
    protocol::{AcquiredKey, BackendMetricsMessage},
    types::{backend_state::BackendError, BearerToken},
};
use std::{net::SocketAddr, pin::Pin};

pub mod docker;
#[allow(unused)] // for now, to disable clippy noise
pub mod unix_socket;

#[async_trait::async_trait]
pub trait Runtime: Send + Sync + 'static {
    async fn prepare(&self, config: &serde_json::Value) -> Result<(), Error>;

    async fn spawn(
        &self,
        backend_id: &BackendName,
        executable: &serde_json::Value,
        acquired_key: Option<&AcquiredKey>,
        static_token: Option<&BearerToken>,
    ) -> Result<SpawnResult, Error>;

    /// Attempts to terminate the backend. If `hard` is true, the runtime should make every effort
    /// to forcibly terminate the backend immediately; otherwise it should invoke graceful shutdown.
    /// If the backend is already terminated or does not exist, this should return `Ok(false)`.
    async fn terminate(&self, backend_id: &BackendName, hard: bool) -> Result<bool, Error>;

    /// Provides a callback to be called when the executor has a new metrics message for
    /// any backend.
    fn metrics_callback(&self, sender: Box<dyn Fn(BackendMetricsMessage) + Send + Sync + 'static>);

    fn events(&self) -> Pin<Box<dyn Stream<Item = TerminateEvent> + Send>>;

    async fn wait_for_backend(
        &self,
        backend: &BackendName,
        address: SocketAddr,
    ) -> Result<(), BackendError>;
}