harmos-runtime 0.1.5

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
143
144
145
146
147
148
149
150
151
152
153
154
155

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports
use std::borrow::Borrow;
use std::collections::{BTreeMap, BTreeSet};

// Third Party Imports
use petgraph::algo::toposort;
use petgraph::graph::DiGraph;

// Local Imports

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct Graph<K> {
    dependencies: BTreeMap<K, BTreeSet<K>>,
    dependents: BTreeMap<K, BTreeSet<K>>,
    ordered: Vec<K>,
}

pub(crate) struct Retirement<K> {
    dependencies: BTreeMap<K, BTreeSet<K>>,
    remaining: BTreeMap<K, usize>,
    ready: BTreeSet<K>,
    running: BTreeSet<K>,
}

/* === Enums === */

#[derive(Debug, PartialEq, Eq)]
pub(crate) enum Invalid<K> {
    Missing { owner: K, dependency: K },
    Cycle { owner: K },
}

/* === Traits === */

/* === Implementations === */

impl<K: Clone + Ord> Graph<K> {
    pub(crate) fn new(dependencies: BTreeMap<K, BTreeSet<K>>) -> Result<Self, Invalid<K>> {
        let mut graph = DiGraph::<K, ()>::new();
        let nodes: BTreeMap<_, _> = dependencies.keys().map(|id| (id.clone(), graph.add_node(id.clone()))).collect();
        let mut dependents = BTreeMap::<K, BTreeSet<K>>::new();
        for (owner, prerequisites) in &dependencies {
            for dependency in prerequisites {
                let Some(provider) = nodes.get(dependency) else {
                    return Err(Invalid::Missing { owner: owner.clone(), dependency: dependency.clone() });
                };
                graph.add_edge(*provider, nodes[owner], ());
                dependents.entry(dependency.clone()).or_default().insert(owner.clone());
            }
        }
        // Sorted Node And Edge Insertion Makes Independent Ordering Reproducible.
        let ordered = toposort(&graph, None)
            .map_err(|cycle| Invalid::Cycle { owner: graph[cycle.node_id()].clone() })?
            .into_iter()
            .map(|node| graph[node].clone())
            .collect();
        Ok(Self { dependencies, dependents, ordered })
    }

    pub(crate) fn retirement(&self, selected: BTreeSet<K>) -> Retirement<K> {
        let mut dependencies = BTreeMap::new();
        let mut remaining: BTreeMap<_, usize> = selected.iter().cloned().map(|id| (id, 0)).collect();
        for owner in &selected {
            let providers: BTreeSet<_> = self
                .dependencies
                .get(owner)
                .expect("retirement selects registered graph owners")
                .intersection(&selected)
                .cloned()
                .collect();
            for provider in &providers {
                *remaining.get_mut(provider).unwrap() += 1;
            }
            dependencies.insert(owner.clone(), providers);
        }
        let ready = remaining.iter().filter(|(_, count)| **count == 0).map(|(owner, _)| owner.clone()).collect();
        Retirement { dependencies, remaining, ready, running: BTreeSet::new() }
    }

    pub(crate) fn ordered(&self) -> &[K] {
        &self.ordered
    }

    pub(crate) fn dependencies<Q: Ord + ?Sized>(&self, owner: &Q) -> Option<&BTreeSet<K>>
    where
        K: Borrow<Q>,
    {
        self.dependencies.get(owner)
    }

    pub(crate) fn extend_dependents(&self, affected: &mut BTreeSet<K>) {
        let mut pending: Vec<_> = affected.iter().cloned().collect();
        while let Some(owner) = pending.pop() {
            if let Some(dependents) = self.dependents.get(&owner) {
                for dependent in dependents {
                    if affected.insert(dependent.clone()) {
                        pending.push(dependent.clone());
                    }
                }
            }
        }
    }
}

impl<K: Clone + Ord> Retirement<K> {
    pub(crate) fn take_ready(&mut self) -> BTreeSet<K> {
        let ready = std::mem::take(&mut self.ready);
        self.running.extend(ready.iter().cloned());
        ready
    }

    pub(crate) fn complete(&mut self, owner: &K, settled: bool) {
        assert!(self.running.remove(owner), "only dispatched cleanup can complete");
        self.remaining.remove(owner);
        if !settled {
            return;
        }
        for provider in &self.dependencies[owner] {
            let remaining = self.remaining.get_mut(provider).expect("a provider cannot retire before its dependents");
            *remaining -= 1;
            if *remaining == 0 {
                self.ready.insert(provider.clone());
            }
        }
    }
}

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

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

/* === Tests === */