fp-runtime 0.5.0

Runtime policies, evidence ledgers, and asupersync interop for the frankenpandas execution layer.
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
156
157
158
159
160
161
162
163
164
165
166
167
168

use std::{
    collections::BTreeMap,
    sync::{Arc, Mutex},
};

use serde::{Deserialize, Serialize};

use crate::asupersync::{
    codec::EncodedArtifact,
    config::{AsupersyncConfig, CapabilitySet, CxCapability},
    error::AsupersyncError,
    validate_capability_gate,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TransferStatus {
    Completed,
    RetryableFailure,
    PermanentFailure,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct TransferReport {
    pub artifact_id: String,
    pub bytes_transferred: usize,
    pub status: TransferStatus,
    pub detail: String,
}

pub trait TransportLayer {
    fn send(
        &self,
        artifact: EncodedArtifact,
        config: &AsupersyncConfig,
    ) -> Result<TransferReport, AsupersyncError>;

    fn receive(
        &self,
        artifact_id: &str,
        config: &AsupersyncConfig,
    ) -> Result<EncodedArtifact, AsupersyncError>;

    fn required_capabilities(&self) -> CapabilitySet {
        CapabilitySet::for_capability(CxCapability::Io)
            .union(CapabilitySet::for_capability(CxCapability::Remote))
    }
}

#[derive(Debug, Clone, Default)]
pub struct InMemoryTransport {
    storage: Arc<Mutex<BTreeMap<String, Arc<EncodedArtifact>>>>,
}

impl InMemoryTransport {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }
}

impl TransportLayer for InMemoryTransport {
    fn send(
        &self,
        artifact: EncodedArtifact,
        config: &AsupersyncConfig,
    ) -> Result<TransferReport, AsupersyncError> {
        validate_capability_gate(config, self.required_capabilities())?;

        let mut guard = self.storage.lock().map_err(|_| {
            AsupersyncError::Transport("in-memory transport lock poisoned".to_string())
        })?;
        let bytes_transferred = artifact.encoded_bytes.len();
        let artifact_id = artifact.artifact_id.clone();
        guard.insert(artifact_id.clone(), Arc::new(artifact));

        Ok(TransferReport {
            artifact_id,
            bytes_transferred,
            status: TransferStatus::Completed,
            detail: "stored in in-memory transport".to_string(),
        })
    }

    fn receive(
        &self,
        artifact_id: &str,
        config: &AsupersyncConfig,
    ) -> Result<EncodedArtifact, AsupersyncError> {
        validate_capability_gate(config, self.required_capabilities())?;

        let artifact = {
            let guard = self.storage.lock().map_err(|_| {
                AsupersyncError::Transport("in-memory transport lock poisoned".to_string())
            })?;
            guard
                .get(artifact_id)
                .cloned()
                .ok_or_else(|| AsupersyncError::ArtifactNotFound(artifact_id.to_string()))?
        };

        match std::panic::catch_unwind(|| (*artifact).clone()) {
            Ok(artifact) => Ok(artifact),
            Err(payload) => {
                let _guard = self.storage.lock().map_err(|_| {
                    AsupersyncError::Transport("in-memory transport lock poisoned".to_string())
                })?;
                std::panic::resume_unwind(payload);
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::panic::{AssertUnwindSafe, catch_unwind};

    use super::{InMemoryTransport, TransportLayer};
    use crate::asupersync::{
        codec::EncodedArtifact, config::AsupersyncConfig, error::AsupersyncError,
    };

    fn artifact() -> EncodedArtifact {
        EncodedArtifact {
            artifact_id: "transport-artifact-3nzz3".to_string(),
            source_len: 7,
            encoded_bytes: b"payload".to_vec(),
            repair_symbols: 1,
        }
    }

    #[test]
    fn receive_returns_a_deep_copy_after_storing_an_arc_3nzz3() -> Result<(), AsupersyncError> {
        let transport = InMemoryTransport::new();
        let config = AsupersyncConfig::default();
        transport.send(artifact(), &config)?;

        let mut received = transport.receive("transport-artifact-3nzz3", &config)?;
        received.encoded_bytes = b"changed".to_vec();

        assert_eq!(
            transport
                .receive("transport-artifact-3nzz3", &config)?
                .encoded_bytes,
            b"payload"
        );
        Ok(())
    }

    #[test]
    fn receive_preserves_lock_poisoning_failure_3nzz3() {
        let transport = InMemoryTransport::new();
        let storage = transport.storage.clone();
        let _ = catch_unwind(AssertUnwindSafe(|| {
            let Ok(_guard) = storage.lock() else {
                return;
            };
            std::panic::resume_unwind(Box::new("poison in-memory transport lock"));
        }));

        let error = transport
            .receive("transport-artifact-3nzz3", &AsupersyncConfig::default())
            .expect_err("poisoned storage must be rejected");
        assert!(
            matches!(error, AsupersyncError::Transport(message) if message.contains("poisoned"))
        );
    }
}