harmos-runtime 0.1.2

Harmos runtime: managed state, undo, recovery, background work and typed streams.
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

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

/* === Modules === */

/* === Re-Exports === */

pub use harmos_storage::ErasedCatalog;
pub(crate) use harmos_storage::encoded_size;

/* === Imports === */

// Standard Library Imports
use std::sync::{Arc, Mutex};

// Third Party Imports

// Local Imports
use super::{StorageBackends, StorageSettings};
use crate::operations::{OperationManager, resident::Lease};
use crate::services::{Fault, Once, Resident, Service, ServiceDefinition};
use crate::supervision::executor;
use crate::{Application, Error, Result};

/* === Constants === */

/* === Macros === */

/* === Type Aliases === */

/* === Structs === */

pub struct StorageManager<C = ()> {
    engine: harmos_storage::StorageManager<C>,
}

struct Worker(harmos_storage::Worker);

struct Owner {
    leases: Mutex<Vec<Lease>>,
}

/* === Enums === */

/* === Traits === */

/* === Implementations === */

impl<C> Clone for StorageManager<C> {
    fn clone(&self) -> Self {
        Self { engine: self.engine.clone() }
    }
}

impl<C> std::ops::Deref for StorageManager<C> {
    type Target = harmos_storage::StorageManager<C>;
    fn deref(&self) -> &Self::Target {
        &self.engine
    }
}

impl<C: super::ObjectCatalog> StorageManager<C> {
    pub fn new(backends: StorageBackends, settings: StorageSettings) -> Result<Self> {
        let execution = harmos_storage::execution::Execution::new(executor::now, |duration| Box::pin(executor::sleep(duration)));
        Ok(Self { engine: harmos_storage::StorageManager::with_execution(backends, settings, execution)? })
    }
}

impl<C> StorageManager<C> {
    pub(crate) fn claim_owner(&self, owner: Arc<()>) -> Result<()> {
        self.engine.claim_owner(owner).map_err(Into::into)
    }
    pub(crate) async fn acquire(&self) -> Result<()> {
        self.engine.acquire().await.map_err(Into::into)
    }
    pub async fn close(&self) -> Result<()> {
        self.engine.close().await.map_err(Into::into)
    }

    pub(crate) fn erased(&self) -> StorageManager<ErasedCatalog> {
        StorageManager { engine: self.engine.erased() }
    }
    pub(crate) fn same_instance<D>(&self, other: &StorageManager<D>) -> bool {
        self.engine.same_instance(&other.engine)
    }
    pub async fn start<A: Application>(&self, runtime: &crate::Runtime<A>) -> Result<()> {
        self.start_on::<A>(&runtime.operations).await
    }
    pub(crate) async fn start_on<A: Application>(&self, operations: &OperationManager) -> Result<()> {
        self.engine
            .start_with(operations.resident_identity(), |worker| {
                let lease = operations
                    .start_service::<A>(Once::new(ServiceDefinition::new("harmos-storage"), Worker(worker)), true, false)
                    .map_err(|error| {
                        harmos_storage::Error::backend("start storage worker", harmos_storage::BackendFailure::Permanent, error)
                    })?;
                Ok(Box::new(Owner { leases: Mutex::new(vec![lease]) }))
            })
            .await
            .map_err(Into::into)
    }
}

impl<A: Application> Resident<A> for Worker {
    type Error = Error;
    async fn cleanup(&mut self) -> Result<()> {
        self.0.cleanup().await.map_err(Into::into)
    }
    async fn run(&mut self, mut context: Service<A>) -> std::result::Result<(), Fault<Error>> {
        context.ready();
        context.until_stopping(self.0.run()).await.unwrap_or(Ok(())).map_err(|error| Fault::Environmental(error.into()))
    }
}

impl harmos_storage::WorkerOwner for Owner {
    fn stop(&self) -> harmos_storage::StorageFuture<'_, ()> {
        Box::pin(async move {
            let receipts: Vec<_> = self.leases.lock().unwrap().iter_mut().map(Lease::retire).collect();
            let mut failure = None;
            for receipt in receipts {
                if let Err(error) = receipt.await {
                    failure.get_or_insert_with(|| {
                        harmos_storage::Error::backend("stop storage worker", harmos_storage::BackendFailure::Permanent, error)
                    });
                }
            }
            failure.map_or(Ok(()), Err)
        })
    }
}

/* === Public Functions === */

/* === Private Functions === */

/* === Tests === */