harmos-domain 0.1.5

Harmos domain model: identifiers, contracts, catalogs and storage identities.
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

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

/* === Modules === */

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

pub use crate::DefinitionId;

/* === Imports === */

// Standard Library Imports

// Third Party Imports
use serde::{Deserialize, Serialize};
// Local Imports
use super::entry::{Metadata, Position};

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct SystemFact {
    pub source: FactSource,
    pub name: String,
    pub version: u32,
    pub payload: Vec<u8>,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct Envelope<P> {
    pub position: Position,
    pub kind: Kind,
    pub id: DefinitionId,
    pub version: u32,
    pub metadata: Metadata,
    pub payload: P,
}

/* === Enums === */

#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub enum Kind {
    Transaction,
    Record,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub enum FactSource {
    Work(String),
    Guest(String),
    Sidecar(String),
}

/* === Traits === */

/* === Implementations === */

impl SystemFact {
    pub fn identify(&self) -> (DefinitionId, u32) {
        let id = match &self.source {
            FactSource::Work(service) => format!("harmos:work/{service}/{}", self.name),
            FactSource::Guest(guest) => format!("harmos:guest/{guest}/{}", self.name),
            FactSource::Sidecar(owner) => format!("harmos:sidecar/{owner}/{}", self.name),
        };

        (DefinitionId::new(id), self.version)
    }

    pub(crate) fn validate_admission(&self) -> bool {
        if !matches!(self.source, FactSource::Sidecar(_)) {
            return true;
        }
        system_identity(&self.identify().0).is_ok_and(|value| value == Some((self.source.clone(), self.name.clone())))
    }

    pub fn restore<'de, D>(id: &DefinitionId, version: u32, payload: D) -> Result<Option<Self>, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let Some((source, name)) = system_identity(id).map_err(serde::de::Error::custom)? else {
            return Ok(None);
        };
        let payload = Vec::<u8>::deserialize(payload)?;

        Ok(Some(Self { source, name, version, payload }))
    }
}

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

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

fn system_identity(id: &DefinitionId) -> Result<Option<(FactSource, String)>, &'static str> {
    if let Some(namespaced) = id.as_str().strip_prefix("harmos:work/") {
        let (service, name) = namespaced.split_once('/').ok_or("a work fact id must contain its local fact name")?;
        if service.is_empty() || name.is_empty() {
            return Err("a work fact id must name both service and fact");
        }
        return Ok(Some((FactSource::Work(service.to_owned()), name.to_owned())));
    }

    if let Some(namespaced) = id.as_str().strip_prefix("harmos:guest/") {
        let (guest, name) = namespaced.split_once('/').ok_or("a guest fact id must contain its local fact name")?;
        if guest.is_empty() || name.is_empty() {
            return Err("a guest fact id must name both guest and fact");
        }
        return Ok(Some((FactSource::Guest(guest.to_owned()), name.to_owned())));
    }

    if let Some(namespaced) = id.as_str().strip_prefix("harmos:sidecar/") {
        let (owner, name) = namespaced.split_once('/').ok_or("a sidecar fact id must contain its local fact name")?;
        if !owner.as_bytes().first().is_some_and(u8::is_ascii_lowercase)
            || !owner.bytes().all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || b == b'.' || b == b'-')
            || name.is_empty()
        {
            return Err("a sidecar fact must name a portable artifact owner and nonempty fact");
        }
        return Ok(Some((FactSource::Sidecar(owner.to_owned()), name.to_owned())));
    }
    Ok(None)
}

/* === Tests === */