Skip to main content

a3s_box_runtime/network/
store.rs

1//! Persistent storage for network configurations.
2//!
3//! Networks are stored as JSON in `~/.a3s/networks.json` with atomic writes
4//! (write to tmp file, then rename) to prevent corruption.
5
6use a3s_box_core::error::{BoxError, Result};
7use a3s_box_core::network::NetworkConfig;
8use std::collections::HashMap;
9use std::path::{Path, PathBuf};
10
11/// Persistent store for network configurations.
12#[derive(Debug)]
13pub struct NetworkStore {
14    /// Path to the JSON file.
15    path: PathBuf,
16}
17
18/// Serializable wrapper for the networks file.
19#[derive(Debug, serde::Serialize, serde::Deserialize, Default)]
20struct NetworksFile {
21    networks: HashMap<String, NetworkConfig>,
22}
23
24impl NetworkStore {
25    /// Create a new store at the given path.
26    pub fn new(path: impl Into<PathBuf>) -> Self {
27        Self { path: path.into() }
28    }
29
30    /// Create a store at the default location (`~/.a3s/networks.json`).
31    pub fn default_path() -> Result<Self> {
32        let home = a3s_box_core::dirs_home();
33        Ok(Self::new(home.join("networks.json")))
34    }
35
36    /// Load all networks from disk.
37    pub fn load(&self) -> Result<HashMap<String, NetworkConfig>> {
38        if !self.path.exists() {
39            return Ok(HashMap::new());
40        }
41
42        let data = std::fs::read_to_string(&self.path).map_err(|e| {
43            BoxError::NetworkError(format!(
44                "failed to read networks file {}: {}",
45                self.path.display(),
46                e
47            ))
48        })?;
49
50        // A corrupt/old-schema networks file must not brick the runtime: quarantine
51        // it and start from an empty set (create repopulates) rather than failing
52        // every network operation. Mirrors the boxes.json hardening.
53        let file: NetworksFile = match serde_json::from_str(&data) {
54            Ok(f) => f,
55            Err(e) => {
56                let preserved = crate::store_io::quarantine_label(&self.path);
57                tracing::warn!(
58                    "networks file {} is corrupt ({e}); preserved a copy at {preserved} \
59                     and started from an empty network set",
60                    self.path.display(),
61                );
62                return Ok(HashMap::new());
63            }
64        };
65
66        Ok(file.networks)
67    }
68
69    /// Save all networks to disk (atomic write).
70    pub fn save(&self, networks: &HashMap<String, NetworkConfig>) -> Result<()> {
71        // Ensure parent directory exists
72        if let Some(parent) = self.path.parent() {
73            std::fs::create_dir_all(parent).map_err(|e| {
74                BoxError::NetworkError(format!(
75                    "failed to create directory {}: {}",
76                    parent.display(),
77                    e
78                ))
79            })?;
80        }
81
82        let file = NetworksFile {
83            networks: networks.clone(),
84        };
85
86        let json = serde_json::to_string_pretty(&file)
87            .map_err(|e| BoxError::NetworkError(format!("failed to serialize networks: {}", e)))?;
88
89        // Atomic write: write to tmp, then rename
90        let tmp_path = self.path.with_extension("json.tmp");
91        std::fs::write(&tmp_path, &json).map_err(|e| {
92            BoxError::NetworkError(format!(
93                "failed to write tmp file {}: {}",
94                tmp_path.display(),
95                e
96            ))
97        })?;
98
99        std::fs::rename(&tmp_path, &self.path).map_err(|e| {
100            BoxError::NetworkError(format!(
101                "failed to rename {} → {}: {}",
102                tmp_path.display(),
103                self.path.display(),
104                e
105            ))
106        })?;
107
108        Ok(())
109    }
110
111    /// Get a single network by name.
112    pub fn get(&self, name: &str) -> Result<Option<NetworkConfig>> {
113        let networks = self.load()?;
114        Ok(networks.get(name).cloned())
115    }
116
117    /// Run `f` against the full networks map under the **cross-process write
118    /// lock** (load-fresh → mutate → save). Use this to make a
119    /// get-modify-update sequence atomic — e.g. allocate-an-IP-then-connect —
120    /// so concurrent boots cannot assign duplicate IPs/MACs or silently lose
121    /// each other's endpoints. The map is saved only if `f` returns `Ok`.
122    ///
123    /// The lock is held across the whole load/mutate/save; `save` is itself
124    /// lock-free, so there is no re-entrant `flock` (which would self-deadlock).
125    pub fn with_write_lock<F, R, E>(&self, f: F) -> std::result::Result<R, E>
126    where
127        F: FnOnce(&mut HashMap<String, NetworkConfig>) -> std::result::Result<R, E>,
128        E: From<BoxError>,
129    {
130        let _lock = crate::file_lock::FileLock::acquire(&self.path).map_err(|e| {
131            E::from(BoxError::NetworkError(format!(
132                "failed to lock networks file {}: {e}",
133                self.path.display()
134            )))
135        })?;
136        let mut networks = self.load().map_err(E::from)?;
137        let r = f(&mut networks)?;
138        self.save(&networks).map_err(E::from)?;
139        Ok(r)
140    }
141
142    /// Create a new network. Returns error if name already exists.
143    pub fn create(&self, config: NetworkConfig) -> Result<()> {
144        self.with_write_lock(|networks| {
145            if networks.contains_key(&config.name) {
146                return Err(BoxError::NetworkError(format!(
147                    "network '{}' already exists",
148                    config.name
149                )));
150            }
151            networks.insert(config.name.clone(), config);
152            Ok(())
153        })
154    }
155
156    /// Remove a network by name. Returns the removed config or error if not found.
157    pub fn remove(&self, name: &str) -> Result<NetworkConfig> {
158        self.with_write_lock(|networks| {
159            let config = networks
160                .remove(name)
161                .ok_or_else(|| BoxError::NetworkError(format!("network '{}' not found", name)))?;
162
163            if !config.endpoints.is_empty() {
164                // Returning Err skips the save, so the in-memory removal is not
165                // persisted — the network stays intact.
166                return Err(BoxError::NetworkError(format!(
167                    "network '{}' has {} connected endpoint(s); disconnect them first or use --force",
168                    name,
169                    config.endpoints.len()
170                )));
171            }
172            Ok(config)
173        })
174    }
175
176    /// List all network names.
177    pub fn list(&self) -> Result<Vec<NetworkConfig>> {
178        let networks = self.load()?;
179        Ok(networks.into_values().collect())
180    }
181
182    /// Update a network in-place (used for connect/disconnect).
183    ///
184    /// Prefer [`with_write_lock`](Self::with_write_lock) for a
185    /// get-modify-update sequence: `update` re-loads under the lock, but a
186    /// caller that read the network *before* calling `update` decided its
187    /// mutation on a possibly-stale snapshot.
188    pub fn update(&self, config: &NetworkConfig) -> Result<()> {
189        self.with_write_lock(|networks| {
190            if !networks.contains_key(&config.name) {
191                return Err(BoxError::NetworkError(format!(
192                    "network '{}' not found",
193                    config.name
194                )));
195            }
196            networks.insert(config.name.clone(), config.clone());
197            Ok(())
198        })
199    }
200
201    /// Get the store file path.
202    pub fn path(&self) -> &Path {
203        &self.path
204    }
205}
206
207impl a3s_box_core::traits::NetworkStoreBackend for NetworkStore {
208    fn get(&self, name: &str) -> Result<Option<NetworkConfig>> {
209        self.get(name)
210    }
211
212    fn create(&self, config: NetworkConfig) -> Result<()> {
213        self.create(config)
214    }
215
216    fn remove(&self, name: &str) -> Result<NetworkConfig> {
217        self.remove(name)
218    }
219
220    fn list(&self) -> Result<Vec<NetworkConfig>> {
221        self.list()
222    }
223
224    fn update(&self, config: &NetworkConfig) -> Result<()> {
225        self.update(config)
226    }
227}
228
229#[cfg(test)]
230mod tests {
231    use super::*;
232
233    fn temp_store() -> (tempfile::TempDir, NetworkStore) {
234        let dir = tempfile::tempdir().unwrap();
235        let store = NetworkStore::new(dir.path().join("networks.json"));
236        (dir, store)
237    }
238
239    #[test]
240    fn test_load_empty() {
241        let (_dir, store) = temp_store();
242        let networks = store.load().unwrap();
243        assert!(networks.is_empty());
244    }
245
246    #[test]
247    fn test_create_and_load() {
248        let (_dir, store) = temp_store();
249        let net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
250        store.create(net).unwrap();
251
252        let networks = store.load().unwrap();
253        assert_eq!(networks.len(), 1);
254        assert!(networks.contains_key("mynet"));
255    }
256
257    #[test]
258    fn test_create_duplicate() {
259        let (_dir, store) = temp_store();
260        let net1 = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
261        let net2 = NetworkConfig::new("mynet", "10.89.0.0/24").unwrap();
262
263        store.create(net1).unwrap();
264        assert!(store.create(net2).is_err());
265    }
266
267    #[test]
268    fn test_get_existing() {
269        let (_dir, store) = temp_store();
270        let net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
271        store.create(net).unwrap();
272
273        let found = store.get("mynet").unwrap();
274        assert!(found.is_some());
275        assert_eq!(found.unwrap().name, "mynet");
276    }
277
278    #[test]
279    fn test_get_nonexistent() {
280        let (_dir, store) = temp_store();
281        let found = store.get("nope").unwrap();
282        assert!(found.is_none());
283    }
284
285    #[test]
286    fn test_remove() {
287        let (_dir, store) = temp_store();
288        let net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
289        store.create(net).unwrap();
290
291        let removed = store.remove("mynet").unwrap();
292        assert_eq!(removed.name, "mynet");
293
294        let networks = store.load().unwrap();
295        assert!(networks.is_empty());
296    }
297
298    #[test]
299    fn test_remove_nonexistent() {
300        let (_dir, store) = temp_store();
301        assert!(store.remove("nope").is_err());
302    }
303
304    #[test]
305    fn test_remove_with_endpoints() {
306        let (_dir, store) = temp_store();
307        let mut net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
308        net.connect("box-1", "web").unwrap();
309        store.create(net).unwrap();
310
311        // Should fail because endpoints are connected
312        assert!(store.remove("mynet").is_err());
313    }
314
315    #[test]
316    fn test_list() {
317        let (_dir, store) = temp_store();
318        store
319            .create(NetworkConfig::new("net1", "10.88.0.0/24").unwrap())
320            .unwrap();
321        store
322            .create(NetworkConfig::new("net2", "10.89.0.0/24").unwrap())
323            .unwrap();
324
325        let list = store.list().unwrap();
326        assert_eq!(list.len(), 2);
327    }
328
329    #[test]
330    fn test_update() {
331        let (_dir, store) = temp_store();
332        let net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
333        store.create(net).unwrap();
334
335        // Connect a box
336        let mut net = store.get("mynet").unwrap().unwrap();
337        net.connect("box-1", "web").unwrap();
338        store.update(&net).unwrap();
339
340        // Verify persistence
341        let loaded = store.get("mynet").unwrap().unwrap();
342        assert_eq!(loaded.endpoints.len(), 1);
343    }
344
345    #[test]
346    fn test_update_nonexistent() {
347        let (_dir, store) = temp_store();
348        let net = NetworkConfig::new("nope", "10.88.0.0/24").unwrap();
349        assert!(store.update(&net).is_err());
350    }
351
352    #[test]
353    fn test_atomic_write() {
354        let (_dir, store) = temp_store();
355        let net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
356        store.create(net).unwrap();
357
358        // Verify the file exists and is valid JSON
359        let data = std::fs::read_to_string(store.path()).unwrap();
360        let _: serde_json::Value = serde_json::from_str(&data).unwrap();
361
362        // Verify no tmp file left behind
363        let tmp = store.path().with_extension("json.tmp");
364        assert!(!tmp.exists());
365    }
366
367    #[test]
368    fn test_creates_parent_directory() {
369        let dir = tempfile::tempdir().unwrap();
370        let store = NetworkStore::new(dir.path().join("subdir").join("networks.json"));
371
372        let net = NetworkConfig::new("mynet", "10.88.0.0/24").unwrap();
373        store.create(net).unwrap();
374
375        assert!(store.path().exists());
376    }
377
378    #[test]
379    fn concurrent_connects_allocate_distinct_ips() {
380        use std::collections::HashSet;
381        use std::sync::Arc;
382
383        let dir = tempfile::tempdir().unwrap();
384        let store = Arc::new(NetworkStore::new(dir.path().join("networks.json")));
385        store
386            .create(NetworkConfig::new("dev", "10.88.0.0/24").unwrap())
387            .unwrap();
388
389        // Many threads connect concurrently. with_write_lock must serialize the
390        // load → allocate → save so every box gets a distinct IP and no endpoint
391        // is lost — the bug allocated duplicate IPs and dropped endpoints.
392        let handles: Vec<_> = (0..16)
393            .map(|i| {
394                let store = Arc::clone(&store);
395                std::thread::spawn(move || {
396                    store
397                        .with_write_lock(|nets| {
398                            nets.get_mut("dev")
399                                .unwrap()
400                                .connect(&format!("box-{i}"), &format!("name-{i}"))
401                                .map_err(BoxError::NetworkError)
402                        })
403                        .unwrap()
404                        .ip_address
405                })
406            })
407            .collect();
408
409        let ips: Vec<_> = handles.into_iter().map(|h| h.join().unwrap()).collect();
410        let unique: HashSet<_> = ips.iter().collect();
411        assert_eq!(
412            unique.len(),
413            ips.len(),
414            "concurrent connects must allocate distinct IPs (got {ips:?})"
415        );
416        assert_eq!(
417            store.get("dev").unwrap().unwrap().endpoints.len(),
418            16,
419            "every concurrent endpoint must be persisted (no lost writes)"
420        );
421    }
422
423    #[test]
424    fn corrupt_networks_file_is_quarantined_not_fatal() {
425        let dir = tempfile::tempdir().unwrap();
426        let path = dir.path().join("networks.json");
427        std::fs::write(&path, "{ not valid json").unwrap();
428        let store = NetworkStore::new(path.clone());
429
430        // load() must succeed (empty) instead of erroring every network op.
431        assert!(store.load().unwrap().is_empty());
432        // The corrupt file is preserved as a timestamped sibling, not lost.
433        let quarantined = std::fs::read_dir(dir.path())
434            .unwrap()
435            .filter_map(|e| e.ok())
436            .any(|e| {
437                e.file_name()
438                    .to_string_lossy()
439                    .contains("networks.json.corrupt-")
440            });
441        assert!(quarantined, "corrupt networks.json must be quarantined");
442    }
443}