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

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports

// Third Party Imports

// Local Imports
use super::*;

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

/* === Enums === */

/* === Traits === */

/* === Implementations === */

impl<A, H> Exchange<'_, A, H>
where
    A: Application,
    H: Fn(&Service<A>, Notice) + Send + Sync,
{
    pub(super) async fn open(&mut self, within: Duration) -> Result<(), Fault<String>> {
        let encoded = self.open_call(Frame::REGISTER, Vec::new(), within).await?;
        let catalog = serde_json::from_slice::<harmos_sidecar::PluginCatalog>(&encoded)
            .map_err(|error| Fault::Application(format!("the sidecar returned an invalid plugin catalog: {error}")))?;
        harmos_sidecar::inventory::observers::validate(&catalog.observers, self.publications)
            .map_err(|error| Fault::Application(error.to_string()))?;
        if normalized_observers(catalog.observers) != normalized_observers(self.observers.to_vec()) {
            return Err(Fault::Application("the sidecar observers differ from the admitted catalog".to_owned()));
        }
        harmos_sidecar::inventory::operations::validate_match(self.operations, &catalog.operations)
            .map_err(|error| Fault::Application(format!("the sidecar operations differ from the admitted catalog: {error}")))?;
        let mut registrations = catalog.registrations;
        if let Some(expected) = self.expected {
            registrations.sort_by(|left, right| left.namespace.cmp(&right.namespace));
            if registrations.windows(2).any(|pair| pair[0].namespace == pair[1].namespace) || registrations != expected {
                return Err(Fault::Application("the sidecar registrations differ from the expected catalog".to_owned()));
            }
        }
        self.registrations.send_replace(Some(registrations));
        Ok(())
    }

    pub(super) async fn open_call(&mut self, method: &str, params: Vec<u8>, within: Duration) -> Result<Vec<u8>, Fault<String>> {
        let id = self.mint();
        if let Err(error) = self.send(Frame::Call { id, method: method.to_owned(), params }).await {
            return Err(Fault::Environmental(format!("the sidecar could not answer `{method}`: {error}")));
        }

        let opened = executor::timeout(within, async {
            loop {
                let Some(arrival) = self.arrival().await else {
                    return Err(Fault::Environmental("the sidecar stopped speaking while opening".to_owned()));
                };
                let frame = match &arrival {
                    Arrival::Frame(frame) => Some(frame),
                    Arrival::Binary(received) => Some(&received.frame),
                    _ => None,
                };
                let answered = match frame {
                    Some(Frame::Answer { id: at, result }) if *at == id => Some(result.clone()),
                    _ => None,
                };
                let refused = match frame {
                    Some(Frame::Refusal { id: at, refusal }) if *at == id => Some(refusal.message().to_owned()),
                    _ => None,
                };
                match self.absorb(arrival).await {
                    Absorbed::Ended => {
                        return Err(Fault::Environmental("the sidecar exited while opening".to_owned()));
                    }
                    Absorbed::Malformed(error) => return Err(Fault::Environmental(error)),
                    Absorbed::Carried => {}
                }
                if let Some(message) = refused {
                    return Err(Fault::Application(format!("the sidecar refused `{method}`: {message}")));
                }
                if let Some(result) = answered {
                    return Ok(result);
                }
            }
        })
        .await;

        opened.unwrap_or_else(|_| Err(Fault::Environmental("the sidecar did not open inside its handshake".to_owned())))
    }
}

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

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

/* === Tests === */