zsh/extensions/pkg/
store.rs

1//! Global store + installed index. Ported from strykelang's `pkg/store.rs`,
2//! retargeted to `$ZSHRS_HOME/pkg/` and reduced to the global-only model.
3//!
4//! Layout (`$ZSHRS_HOME` defaults to `~/.zshrs`, matching
5//! `autoload_cache::zshrs_home`):
6//! ```text
7//! $ZSHRS_HOME/pkg/
8//!   store/  name@version/     # one extracted copy per (name, version)
9//!   cache/                    # download scratch
10//!   git/                      # bare/working git clones
11//!   bin/                      # launcher symlinks (future)
12//!   installed.toml            # the global install index (source of truth)
13//! ```
14//! Human-readable `name@version` paths give Nix-grade reproducibility from the
15//! index's content hashes without Nix-grade opaque path UX.
16
17use serde::{Deserialize, Serialize};
18use std::path::{Path, PathBuf};
19
20use super::{PkgError, PkgResult};
21
22/// Installed-index filename under the store root.
23pub const INSTALLED_FILE: &str = "installed.toml";
24
25/// Resolves and lazily creates the `$ZSHRS_HOME/pkg/...` layout.
26pub struct Store {
27    root: PathBuf,
28}
29
30impl Store {
31    /// Construct a [`Store`] rooted at `$ZSHRS_HOME/pkg/` (default
32    /// `~/.zshrs/pkg/`). Honors `ZSHRS_HOME` like the rest of zshrs.
33    pub fn user_default() -> PkgResult<Store> {
34        let home = if let Some(custom) = std::env::var_os("ZSHRS_HOME") {
35            PathBuf::from(custom)
36        } else {
37            let h = std::env::var_os("HOME")
38                .ok_or_else(|| PkgError::Other("HOME environment variable not set".into()))?;
39            PathBuf::from(h).join(".zshrs")
40        };
41        Ok(Store {
42            root: home.join("pkg"),
43        })
44    }
45
46    /// Root at an explicit path (tests).
47    pub fn at(root: impl Into<PathBuf>) -> Store {
48        Store { root: root.into() }
49    }
50
51    /// `store/` — extracted packages.
52    pub fn store_dir(&self) -> PathBuf {
53        self.root.join("store")
54    }
55    /// `cache/` — download scratch.
56    pub fn cache_dir(&self) -> PathBuf {
57        self.root.join("cache")
58    }
59    /// `git/` — git clones.
60    pub fn git_dir(&self) -> PathBuf {
61        self.root.join("git")
62    }
63    /// `bin/` — launcher links.
64    pub fn bin_dir(&self) -> PathBuf {
65        self.root.join("bin")
66    }
67    /// `$ZSHRS_HOME/pkg/` root.
68    pub fn root(&self) -> &Path {
69        &self.root
70    }
71
72    /// Where a package extraction lives: `store/{name}@{version}/`.
73    pub fn package_dir(&self, name: &str, version: &str) -> PathBuf {
74        self.store_dir().join(format!("{}@{}", name, version))
75    }
76
77    /// Create the full directory layout. Idempotent.
78    pub fn ensure_layout(&self) -> PkgResult<()> {
79        for d in [
80            self.store_dir(),
81            self.cache_dir(),
82            self.git_dir(),
83            self.bin_dir(),
84        ] {
85            std::fs::create_dir_all(&d)
86                .map_err(|e| PkgError::Io(format!("create {}: {}", d.display(), e)))?;
87        }
88        Ok(())
89    }
90
91    /// True if a `name@version` extraction already exists.
92    pub fn has_package(&self, name: &str, version: &str) -> bool {
93        self.package_dir(name, version).is_dir()
94    }
95
96    /// Copy a staged plugin tree wholesale into `store/{name}@{version}/`,
97    /// excluding VCS/build scratch (`.git/`, `target/`) so the store holds only
98    /// the loadable plugin. The destination is cleared first for fresh
99    /// re-installs. Returns the store path.
100    pub fn install_dir(&self, name: &str, version: &str, src: &Path) -> PkgResult<PathBuf> {
101        let dst = self.package_dir(name, version);
102        if dst.exists() {
103            std::fs::remove_dir_all(&dst)
104                .map_err(|e| PkgError::Io(format!("clear {}: {}", dst.display(), e)))?;
105        }
106        std::fs::create_dir_all(&dst)?;
107        copy_dir_filtered(src, &dst)?;
108        Ok(dst)
109    }
110}
111
112/// The global install index at `$ZSHRS_HOME/pkg/installed.toml` — the single
113/// source of truth for what's installed. `znative load` reads it at shell startup
114/// to load every plugin with zero network.
115#[derive(Debug, Clone, Serialize, Deserialize, Default)]
116pub struct InstalledIndex {
117    /// Schema version.
118    pub version: u32,
119    /// One entry per installed plugin, sorted by name for deterministic diffs.
120    #[serde(default, rename = "package")]
121    pub packages: Vec<InstalledPlugin>,
122}
123
124/// One installed plugin: identity + provenance + everything `znative load` needs
125/// to load it without re-resolving.
126#[derive(Debug, Clone, Serialize, Deserialize, Default)]
127pub struct InstalledPlugin {
128    /// Plugin name (store key `name@version`).
129    pub name: String,
130    /// Installed version (`0.0.0` when the plugin declared none).
131    pub version: String,
132    /// Provenance: `github:owner/repo`, `git+URL`, or `path+file://DIR`.
133    pub source: String,
134    /// `"native"` or `"script"`.
135    pub kind: String,
136    /// SHA-256 of the extracted tree, `sha256-<hex>` (audit / change detection).
137    #[serde(default, skip_serializing_if = "String::is_empty")]
138    pub integrity: String,
139    /// Native: the cdylib filename inside the store dir (e.g. `libfoo.dylib`).
140    #[serde(default, skip_serializing_if = "String::is_empty")]
141    pub lib: String,
142    /// Script: files to `source`, relative to the store dir.
143    #[serde(default, skip_serializing_if = "Vec::is_empty")]
144    pub source_files: Vec<String>,
145    /// Script: dirs to prepend to `$fpath`, relative to the store dir.
146    #[serde(default, skip_serializing_if = "Vec::is_empty")]
147    pub fpath: Vec<String>,
148}
149
150impl InstalledIndex {
151    /// Empty index stamped with the current schema version.
152    pub fn new() -> InstalledIndex {
153        InstalledIndex {
154            version: 1,
155            packages: Vec::new(),
156        }
157    }
158
159    /// Load the index from a [`Store`], or an empty index when it doesn't exist.
160    pub fn load_from(store: &Store) -> PkgResult<InstalledIndex> {
161        let path = store.root().join(INSTALLED_FILE);
162        if !path.is_file() {
163            return Ok(InstalledIndex::new());
164        }
165        let s = std::fs::read_to_string(&path)
166            .map_err(|e| PkgError::Io(format!("read {}: {}", path.display(), e)))?;
167        toml::from_str::<InstalledIndex>(&s)
168            .map_err(|e| PkgError::Other(format!("parse {}: {}", path.display(), e.message())))
169    }
170
171    /// Write the index (packages sorted by name) under `store.root()`.
172    pub fn save_to(&mut self, store: &Store) -> PkgResult<()> {
173        self.packages.sort_by(|a, b| a.name.cmp(&b.name));
174        let path = store.root().join(INSTALLED_FILE);
175        if let Some(parent) = path.parent() {
176            std::fs::create_dir_all(parent)?;
177        }
178        let body = toml::to_string_pretty(&self)
179            .map_err(|e| PkgError::Other(format!("serialize {}: {}", INSTALLED_FILE, e)))?;
180        std::fs::write(
181            &path,
182            format!("# znative — auto-generated. Do not edit.\n{}", body),
183        )
184        .map_err(|e| PkgError::Io(format!("write {}: {}", path.display(), e)))?;
185        Ok(())
186    }
187
188    /// Find an installed plugin by name.
189    pub fn find(&self, name: &str) -> Option<&InstalledPlugin> {
190        self.packages.iter().find(|p| p.name == name)
191    }
192
193    /// Insert or replace the entry for `p.name`.
194    pub fn upsert(&mut self, p: InstalledPlugin) {
195        if let Some(slot) = self.packages.iter_mut().find(|e| e.name == p.name) {
196            *slot = p;
197        } else {
198            self.packages.push(p);
199        }
200    }
201
202    /// Remove the entry named `name`; returns it if present.
203    pub fn remove(&mut self, name: &str) -> Option<InstalledPlugin> {
204        let idx = self.packages.iter().position(|p| p.name == name)?;
205        Some(self.packages.remove(idx))
206    }
207}
208
209/// Recursively copy `src` into `dst`, skipping `.git/` and `target/` (VCS +
210/// Rust build scratch) at any depth.
211fn copy_dir_filtered(src: &Path, dst: &Path) -> PkgResult<()> {
212    std::fs::create_dir_all(dst)?;
213    for entry in std::fs::read_dir(src)? {
214        let entry = entry?;
215        let name = entry.file_name();
216        let name_s = name.to_string_lossy();
217        if name_s == ".git" || name_s == "target" {
218            continue;
219        }
220        let from = entry.path();
221        let to = dst.join(&name);
222        let ft = entry.file_type()?;
223        if ft.is_dir() {
224            copy_dir_filtered(&from, &to)?;
225        } else if ft.is_symlink() {
226            // Copy the resolved file content (plugins rarely ship symlinks; a
227            // dangling link in the store would break loads).
228            if let Ok(target) = std::fs::read(&from) {
229                std::fs::write(&to, target)?;
230            }
231        } else {
232            std::fs::copy(&from, &to)
233                .map_err(|e| PkgError::Io(format!("copy {}: {}", from.display(), e)))?;
234        }
235    }
236    Ok(())
237}
238
239#[cfg(test)]
240mod tests {
241    use super::*;
242
243    fn tmp() -> PathBuf {
244        let p = std::env::temp_dir().join(format!(
245            "znative-test-{}-{}",
246            std::process::id(),
247            std::time::SystemTime::now()
248                .duration_since(std::time::UNIX_EPOCH)
249                .unwrap()
250                .subsec_nanos()
251        ));
252        let _ = std::fs::remove_dir_all(&p);
253        std::fs::create_dir_all(&p).unwrap();
254        p
255    }
256
257    #[test]
258    fn install_dir_skips_git_and_target() {
259        let src = tmp();
260        std::fs::write(src.join("a.plugin.zsh"), b"echo hi").unwrap();
261        std::fs::create_dir_all(src.join(".git")).unwrap();
262        std::fs::write(src.join(".git/HEAD"), b"ref").unwrap();
263        std::fs::create_dir_all(src.join("target")).unwrap();
264        std::fs::write(src.join("target/junk"), b"x").unwrap();
265        let store = Store::at(tmp().join("pkg"));
266        store.ensure_layout().unwrap();
267        let dst = store.install_dir("a", "0.1.0", &src).unwrap();
268        assert!(dst.join("a.plugin.zsh").is_file());
269        assert!(!dst.join(".git").exists());
270        assert!(!dst.join("target").exists());
271        let _ = std::fs::remove_dir_all(&src);
272    }
273
274    #[test]
275    fn index_round_trip() {
276        let store = Store::at(tmp().join("pkg"));
277        let mut idx = InstalledIndex::new();
278        idx.upsert(InstalledPlugin {
279            name: "zed".into(),
280            version: "1.0.0".into(),
281            source: "github:o/zed".into(),
282            kind: "script".into(),
283            source_files: vec!["zed.plugin.zsh".into()],
284            ..Default::default()
285        });
286        idx.upsert(InstalledPlugin {
287            name: "abc".into(),
288            version: "0.1.0".into(),
289            source: "github:o/abc".into(),
290            kind: "native".into(),
291            lib: "libabc.dylib".into(),
292            ..Default::default()
293        });
294        idx.save_to(&store).unwrap();
295        let back = InstalledIndex::load_from(&store).unwrap();
296        assert_eq!(back.packages.len(), 2);
297        // Sorted by name: abc before zed.
298        assert_eq!(back.packages[0].name, "abc");
299        assert_eq!(back.find("zed").unwrap().kind, "script");
300        let _ = std::fs::remove_dir_all(store.root());
301    }
302}
zsh/extensions/pkg/store.rs

zsh/extensions/pkg/
store.rs
