Skip to main content

flatland_client_lib/
content_pack.rs

1//! Sim content packs — versioned `assets/` trees published beside client gfx.
2
3use std::collections::BTreeMap;
4use std::path::{Path, PathBuf};
5
6use anyhow::Context;
7
8use crate::asset_backend::{mime_for_path, AssetBackendConfig, AssetStore};
9use crate::assets::{sha256_file, AssetBundleIndex, AssetFileEntry};
10
11/// Relative directories under `assets/` included in the sim pack (worker ContentBundle).
12pub const SIM_PACK_ASSET_DIRS: &[&str] = &[
13    "crafting",
14    "items",
15    "world",
16    "config",
17    "npcs",
18    "loot",
19    "combat",
20    "dialogue",
21    "quests",
22    "crops",
23    "gfx/sprites",
24    "paperdoll",
25];
26
27/// Build a file index for sim content under `repo_root/assets/…`.
28pub fn build_sim_pack_index(
29    repo_root: &Path,
30    publish_rev: u64,
31    published_at: &str,
32) -> anyhow::Result<AssetBundleIndex> {
33    let assets = repo_root.join("assets");
34    let mut files = BTreeMap::new();
35    for rel_dir in SIM_PACK_ASSET_DIRS {
36        let dir = assets.join(rel_dir);
37        if dir.is_dir() {
38            walk_into(&dir, &assets, &mut files)?;
39        }
40    }
41    // Publish marker so workers know the pack rev without a separate channel.
42    let marker = assets.join(".content-publish.json");
43    if marker.is_file() {
44        let meta = std::fs::metadata(&marker)?;
45        files.insert(
46            ".content-publish.json".to_string(),
47            AssetFileEntry {
48                sha256: sha256_file(&marker)?,
49                size: meta.len(),
50            },
51        );
52    }
53    if files.is_empty() {
54        anyhow::bail!(
55            "sim pack is empty — expected content under {}",
56            assets.display()
57        );
58    }
59    Ok(AssetBundleIndex {
60        publish_rev,
61        published_at: published_at.to_string(),
62        files,
63    })
64}
65
66fn walk_into(
67    dir: &Path,
68    assets_root: &Path,
69    files: &mut BTreeMap<String, AssetFileEntry>,
70) -> anyhow::Result<()> {
71    for entry in std::fs::read_dir(dir).with_context(|| format!("read_dir {}", dir.display()))? {
72        let entry = entry?;
73        let path = entry.path();
74        let name = entry.file_name();
75        let name_str = name.to_string_lossy();
76        if name_str.starts_with('.') || name_str == "node_modules" {
77            continue;
78        }
79        if name_str.ends_with(".map-locks.json") {
80            continue;
81        }
82        if path.is_dir() {
83            walk_into(&path, assets_root, files)?;
84            continue;
85        }
86        if !path.is_file() {
87            continue;
88        }
89        let rel = path
90            .strip_prefix(assets_root)
91            .with_context(|| format!("strip {}", path.display()))?
92            .to_string_lossy()
93            .replace('\\', "/");
94        let meta = std::fs::metadata(&path)?;
95        files.insert(
96            rel,
97            AssetFileEntry {
98                sha256: sha256_file(&path)?,
99                size: meta.len(),
100            },
101        );
102    }
103    Ok(())
104}
105
106/// Resolve an on-disk path for a sim pack relative key (`world/segments/…`).
107pub fn resolve_sim_pack_file(repo_root: &Path, relative: &str) -> PathBuf {
108    repo_root.join("assets").join(relative)
109}
110
111/// Upload sim pack files + `latest.json` via the configured asset store.
112pub async fn upload_sim_pack(
113    store: &dyn AssetStore,
114    cfg: &AssetBackendConfig,
115    repo_root: &Path,
116    index: &AssetBundleIndex,
117) -> anyhow::Result<()> {
118    for (rel, _) in &index.files {
119        let path = resolve_sim_pack_file(repo_root, rel);
120        let bytes = std::fs::read(&path)
121            .with_context(|| format!("read sim pack file {}", path.display()))?;
122        let key = cfg.sim_object_key(index.publish_rev, rel);
123        store
124            .put(&key, mime_for_path(&path), &bytes)
125            .await
126            .with_context(|| format!("upload sim {key}"))?;
127    }
128    let latest = serde_json::to_vec(index)?;
129    store
130        .put(&cfg.sim_index_object(), "application/json", &latest)
131        .await
132        .context("upload sim latest.json")?;
133    Ok(())
134}
135
136/// Download sim pack `publish_rev` into `dest_root/assets/…` (repo-shaped tree).
137pub async fn download_sim_pack(
138    store: &dyn AssetStore,
139    cfg: &AssetBackendConfig,
140    index: &AssetBundleIndex,
141    dest_root: &Path,
142) -> anyhow::Result<PathBuf> {
143    let assets_out = dest_root.join("assets");
144    std::fs::create_dir_all(&assets_out)?;
145
146    const CONCURRENCY: usize = 8;
147    let pending: Vec<(String, AssetFileEntry)> = index
148        .files
149        .iter()
150        .map(|(k, v)| (k.clone(), v.clone()))
151        .collect();
152    let total = pending.len();
153    let mut join_set = tokio::task::JoinSet::new();
154    let mut next = 0usize;
155    let done = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
156
157    // Local backend: read files from disk concurrently via blocking pool.
158    // Remote: each task uses its own HTTP client + config clone.
159    while next < pending.len() || !join_set.is_empty() {
160        while join_set.len() < CONCURRENCY && next < pending.len() {
161            let (rel, entry) = pending[next].clone();
162            next += 1;
163            let cfg = cfg.clone();
164            let assets_out = assets_out.clone();
165            let publish_rev = index.publish_rev;
166            let done = std::sync::Arc::clone(&done);
167            join_set.spawn(async move {
168                let store = crate::asset_backend::store_from_config(&cfg)?;
169                let key = cfg.sim_object_key(publish_rev, &rel);
170                let bytes = store
171                    .get(&key)
172                    .await
173                    .with_context(|| format!("download sim {key}"))?;
174                let got = {
175                    use sha2::{Digest, Sha256};
176                    hex::encode(Sha256::digest(&bytes))
177                };
178                if got != entry.sha256 {
179                    anyhow::bail!("sim pack hash mismatch for {rel}");
180                }
181                let dest = assets_out.join(&rel);
182                if let Some(parent) = dest.parent() {
183                    std::fs::create_dir_all(parent)?;
184                }
185                std::fs::write(&dest, &bytes)?;
186                let n = done.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
187                if n % 100 == 0 || n == total {
188                    tracing::info!(n, total, "sim pack download progress");
189                }
190                Ok::<(), anyhow::Error>(())
191            });
192        }
193        if let Some(res) = join_set.join_next().await {
194            res.map_err(|e| anyhow::anyhow!("sim pack download join: {e}"))??;
195        }
196    }
197    Ok(dest_root.to_path_buf())
198}
199
200/// Cache directory for a downloaded sim pack rev.
201pub fn sim_pack_cache_dir(publish_rev: u64) -> anyhow::Result<PathBuf> {
202    let base = dirs::home_dir().ok_or_else(|| anyhow::anyhow!("home directory not found"))?;
203    Ok(base
204        .join(".flatland3")
205        .join("sim-packs")
206        .join(format!("rev-{publish_rev}")))
207}
208
209/// Fetch sim `latest.json`, download pack if needed, return repo-shaped root.
210pub async fn ensure_sim_pack_cached(target_rev: Option<u64>) -> anyhow::Result<(u64, PathBuf)> {
211    let cfg = AssetBackendConfig::from_env();
212    let store = crate::asset_backend::store_from_config(&cfg)?;
213    let index_bytes = store
214        .get(&cfg.sim_index_object())
215        .await
216        .with_context(|| format!("fetch sim latest.json ({})", cfg.sim_index_object()))?;
217    let index: AssetBundleIndex = serde_json::from_slice(&index_bytes)?;
218    let rev = target_rev.unwrap_or(index.publish_rev);
219    if rev != index.publish_rev {
220        anyhow::bail!(
221            "requested sim pack rev {rev} but remote latest is {}",
222            index.publish_rev
223        );
224    }
225    let dest = sim_pack_cache_dir(rev)?;
226    if sim_pack_cache_complete(&dest, &index)? {
227        return Ok((rev, dest));
228    }
229    // Incomplete / corrupt cache — wipe and re-download.
230    let _ = std::fs::remove_dir_all(&dest);
231    download_sim_pack(store.as_ref(), &cfg, &index, &dest).await?;
232    if !sim_pack_cache_complete(&dest, &index)? {
233        anyhow::bail!("sim pack rev {rev} incomplete after download");
234    }
235    Ok((rev, dest))
236}
237
238fn sim_pack_cache_complete(dest_root: &Path, index: &AssetBundleIndex) -> anyhow::Result<bool> {
239    let assets = dest_root.join("assets");
240    if !assets.is_dir() {
241        return Ok(false);
242    }
243    for (rel, entry) in &index.files {
244        let path = assets.join(rel);
245        if !path.is_file() {
246            return Ok(false);
247        }
248        let meta = std::fs::metadata(&path)?;
249        if meta.len() != entry.size && entry.size > 0 {
250            // Size mismatch — treat as incomplete (hash check is expensive for every boot).
251            return Ok(false);
252        }
253    }
254    Ok(true)
255}
256
257#[cfg(test)]
258mod tests {
259    use super::*;
260    use crate::asset_backend::LocalAssetStore;
261
262    #[tokio::test]
263    async fn local_sim_pack_roundtrip() {
264        let repo = match flatland_repo_fixture() {
265            Some(p) => p,
266            None => return,
267        };
268        let tmp =
269            std::env::temp_dir().join(format!("flatland-sim-pack-test-{}", std::process::id()));
270        let _ = std::fs::remove_dir_all(&tmp);
271        std::fs::create_dir_all(&tmp).unwrap();
272        let store = LocalAssetStore {
273            root: tmp.join("store"),
274        };
275        let cfg = AssetBackendConfig {
276            kind: crate::asset_backend::AssetBackendKind::Local,
277            bucket: "local".into(),
278            client_prefix: "client".into(),
279            sim_prefix: "sim".into(),
280            local_root: tmp.join("store"),
281            s3_region: "us-east-1".into(),
282            s3_endpoint: None,
283            index_url_override: None,
284        };
285        let index = build_sim_pack_index(&repo, 42, "test").expect("index");
286        assert!(!index.files.is_empty());
287        upload_sim_pack(&store, &cfg, &repo, &index)
288            .await
289            .expect("upload");
290        let dest = tmp.join("out");
291        download_sim_pack(&store, &cfg, &index, &dest)
292            .await
293            .expect("download");
294        assert!(dest.join("assets/world").is_dir() || dest.join("assets/items").is_dir());
295        let _ = std::fs::remove_dir_all(&tmp);
296    }
297
298    fn flatland_repo_fixture() -> Option<PathBuf> {
299        let mut dir = std::env::current_dir().ok()?;
300        for _ in 0..8 {
301            if dir.join("assets/world/segments").is_dir() {
302                return Some(dir);
303            }
304            if !dir.pop() {
305                break;
306            }
307        }
308        None
309    }
310}