gx 0.8.5

CLI to manage Github Actions dependencies
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

use crate::domain::action::identity::{ActionId, CommitSha, Version};
use crate::domain::action::resolved::Commit;
use crate::domain::resolution::{Error as ResolutionError, ShaDescription, VersionRegistry};
use elsa::FrozenMap;

/// Memoizes every [`VersionRegistry`] query for the lifetime of one command run.
///
/// One action referenced from several workflows would otherwise re-issue identical
/// lookups, spending quota an unauthenticated rate limit makes scarce. Wrapping at the
/// composition root deduplicates without any call site knowing a cache exists.
///
/// Entries are never evicted, and the map dies with the process — so a value cannot go
/// stale within a run, and the next run sees current state.
///
/// [`FrozenMap`] is what makes this work behind `&self`: it inserts through a shared
/// reference, so unlike `RefCell` there is no borrow to hold across the inner call.
pub struct Caching<R: VersionRegistry> {
    /// The registry that answers whatever this decorator has not already cached.
    inner: R,
    /// Commits by action and version, from [`VersionRegistry::lookup_sha`].
    commits: FrozenMap<(ActionId, Version), Box<Commit>>,
    /// Every tag for an action, from [`VersionRegistry::all_tags`].
    /// `Vec` is already `StableDeref`, so it needs no `Box`; the map yields `&[Version]`.
    repo_tags: FrozenMap<ActionId, Vec<Version>>,
    /// SHA descriptions, from [`VersionRegistry::describe_sha`].
    descriptions: FrozenMap<(ActionId, CommitSha), Box<ShaDescription>>,
}

impl<R: VersionRegistry> Caching<R> {
    /// Wrap `inner` so its results are reused within this run.
    #[must_use]
    pub fn new(inner: R) -> Self {
        Self {
            inner,
            commits: FrozenMap::new(),
            repo_tags: FrozenMap::new(),
            descriptions: FrozenMap::new(),
        }
    }
}

// Every method follows the same shape: return the memoized value if present,
// otherwise ask the inner registry and store only on success. An `Err` is
// propagated without being recorded, so a transient failure — a rate limit, a
// missing token — never poisons the rest of the run for that key.
impl<R: VersionRegistry> VersionRegistry for Caching<R> {
    fn lookup_sha(&self, id: &ActionId, version: &Version) -> Result<Commit, ResolutionError> {
        let key = (id.clone(), version.clone());
        if let Some(hit) = self.commits.get(&key) {
            return Ok(hit.clone());
        }
        let commit = self.inner.lookup_sha(id, version)?;
        Ok(self.commits.insert(key, Box::new(commit)).clone())
    }

    fn all_tags(&self, id: &ActionId) -> Result<Vec<Version>, ResolutionError> {
        if let Some(hit) = self.repo_tags.get(id) {
            return Ok(hit.to_vec());
        }
        let tags = self.inner.all_tags(id)?;
        Ok(self.repo_tags.insert(id.clone(), tags).to_vec())
    }

    fn describe_sha(
        &self,
        id: &ActionId,
        sha: &CommitSha,
    ) -> Result<ShaDescription, ResolutionError> {
        let key = (id.clone(), sha.clone());
        if let Some(hit) = self.descriptions.get(&key) {
            return Ok(hit.clone());
        }
        let description = self.inner.describe_sha(id, sha)?;
        Ok(self.descriptions.insert(key, Box::new(description)).clone())
    }
}

#[cfg(test)]
#[expect(
    clippy::unwrap_used,
    clippy::assertions_on_result_states,
    clippy::arithmetic_side_effects,
    reason = "tests use unwrap, indexing, and other patterns freely"
)]
#[path = "caching_tests.rs"]
mod tests;