aube-resolver 1.41.0

Dependency resolver for Aube
Documentation
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use aube_manifest::BundledDependencies;
use aube_registry::{Attestations, Dist, NpmUser, Packument, PeerDepMeta, VersionMetadata};
use std::collections::BTreeMap;
use std::io::{Cursor, Write};
use std::path::{Path, PathBuf};
use std::sync::OnceLock;
use std::time::Duration;

#[path = "primer_schema.rs"]
mod primer_schema;

pub(crate) use primer_schema::Seed;
use primer_schema::{
    PrimerBundledDependencies, PrimerDist, PrimerPackument, PrimerPeerDepMeta,
    PrimerVersionMetadata,
};

const PRIMER_FORMAT: &str = "rkyv-v1";
const PRUNE_AGE: Duration = Duration::from_secs(30 * 24 * 60 * 60);
const AUTO_PRUNE_COOLDOWN: Duration = Duration::from_secs(24 * 60 * 60);
const AUTO_PRUNE_DENOMINATOR: u8 = 100;

include!(concat!(env!("OUT_DIR"), "/primer_index.rs"));

#[derive(Default)]
pub struct PruneStats {
    pub files: u64,
    pub bytes: u64,
}

impl Seed {
    pub(crate) fn packument(&self) -> Packument {
        self.packument.to_packument()
    }
}

impl PrimerPackument {
    fn to_packument(&self) -> Packument {
        let mut time = BTreeMap::new();
        let versions = self
            .versions
            .iter()
            .map(|v| {
                if let Some(published_at) = v.published_at.as_ref() {
                    time.insert(v.version.clone(), published_at.clone());
                }
                (
                    v.version.clone(),
                    v.metadata.to_version_metadata(&self.name, &v.version),
                )
            })
            .collect();
        Packument {
            name: self.name.clone(),
            modified: self.modified.clone(),
            versions,
            dist_tags: self.dist_tags.clone(),
            time,
        }
    }
}

impl PrimerVersionMetadata {
    fn to_version_metadata(&self, name: &str, version: &str) -> VersionMetadata {
        VersionMetadata {
            name: name.to_owned(),
            version: version.to_owned(),
            dependencies: self.dependencies.clone(),
            dev_dependencies: BTreeMap::new(),
            peer_dependencies: self.peer_dependencies.clone(),
            peer_dependencies_meta: self
                .peer_dependencies_meta
                .iter()
                .map(|(name, meta)| (name.clone(), meta.to_peer_dep_meta()))
                .collect(),
            optional_dependencies: self.optional_dependencies.clone(),
            bundled_dependencies: self
                .bundled_dependencies
                .as_ref()
                .map(PrimerBundledDependencies::to_bundled_dependencies),
            dist: self.dist.as_ref().map(|d| d.to_dist(name, version)),
            os: self.os.clone(),
            cpu: self.cpu.clone(),
            libc: self.libc.clone(),
            engines: self.engines.clone(),
            license: self.license.clone(),
            funding_url: self.funding_url.clone(),
            bin: self.bin.clone(),
            has_install_script: self.has_install_script,
            deprecated: self.deprecated.clone(),
            approver: None,
            npm_user: self.trusted_publisher.then(|| NpmUser {
                trusted_publisher: Some(serde_json::json!({"id": "npm-primer"})),
            }),
        }
    }
}

impl PrimerPeerDepMeta {
    fn to_peer_dep_meta(&self) -> PeerDepMeta {
        PeerDepMeta {
            optional: self.optional,
        }
    }
}

impl PrimerBundledDependencies {
    fn to_bundled_dependencies(&self) -> BundledDependencies {
        match self {
            Self::List(v) => BundledDependencies::List(v.clone()),
            Self::All(v) => BundledDependencies::All(*v),
        }
    }
}

impl PrimerDist {
    fn to_dist(&self, name: &str, version: &str) -> Dist {
        Dist {
            tarball: self
                .tarball
                .clone()
                .unwrap_or_else(|| deterministic_tarball_url(name, version)),
            integrity: self.integrity.clone(),
            shasum: None,
            unpacked_size: None,
            attestations: self.provenance.then(|| Attestations {
                provenance: Some(serde_json::json!({
                    "predicateType": "https://slsa.dev/provenance/v1"
                })),
            }),
        }
    }
}

/// Reconstruct the npmjs tarball URL when the primer omitted it
/// (the common case — see PrimerDist::tarball docs). Mirrors
/// `RegistryClient::tarball_url`'s format for `registry.npmjs.org`.
/// In force-metadata-primer mode the URL is rewritten to the active
/// registry by the resolver, so this default is only consulted on
/// the default-registry path.
fn deterministic_tarball_url(name: &str, version: &str) -> String {
    let unscoped = name
        .strip_prefix('@')
        .and_then(|rest| rest.split('/').nth(1))
        .unwrap_or(name);
    format!("https://registry.npmjs.org/{name}/-/{unscoped}-{version}.tgz")
}

static GENERATED_AT: OnceLock<Option<String>> = OnceLock::new();
static AUTO_PRUNED: OnceLock<()> = OnceLock::new();
static POPULAR_NAMES: OnceLock<Option<String>> = OnceLock::new();

pub(crate) fn get(name: &str) -> Option<Seed> {
    let (_, offset, len) = PRIMER_INDEX
        .binary_search_by(|(candidate, _, _)| candidate.cmp(&name))
        .ok()
        .and_then(|idx| PRIMER_INDEX.get(idx))?;
    auto_prune_once();
    let end = offset.checked_add(*len)?;
    let compressed = PRIMER_BLOB.get(*offset..end)?;
    let archived = zstd::stream::decode_all(Cursor::new(compressed)).ok()?;
    rkyv::from_bytes::<Seed, rkyv::rancor::Error>(&archived).ok()
}

pub(crate) fn covers_cutoff(cutoff: &str) -> bool {
    generated_at().is_some_and(|generated_at| generated_at.as_str() >= cutoff)
}

/// Ranked public npm package names used as typo/squatting reference data.
///
/// Release builds embed the top 100,000 names. Development and downstream
/// builds without the generated artifact fall back to the metadata-primer
/// names, so callers always get a valid newline-delimited corpus.
pub fn popular_package_names() -> &'static str {
    POPULAR_NAMES
        .get_or_init(|| {
            let decoded = zstd::stream::decode_all(Cursor::new(POPULAR_NAMES_BLOB)).ok()?;
            String::from_utf8(decoded).ok()
        })
        .as_deref()
        .unwrap_or_default()
}

fn generated_at() -> Option<&'static String> {
    GENERATED_AT
        .get_or_init(|| {
            let secs = option_env!("AUBE_PRIMER_GENERATED_AT")?.parse().ok()?;
            Some(crate::types::format_iso8601_utc(secs))
        })
        .as_ref()
}

fn auto_prune_once() {
    AUTO_PRUNED.get_or_init(|| {
        if let Some(dir) = primer_cache_dir() {
            auto_prune(&dir);
        }
    });
}

fn auto_prune(dir: &Path) {
    if !random_byte().is_multiple_of(AUTO_PRUNE_DENOMINATOR) {
        return;
    }
    if let Err(e) = prune_old(dir, PRUNE_AGE, false, Some(AUTO_PRUNE_COOLDOWN)) {
        tracing::debug!("failed to prune old primer cache files: {e}");
    }
}

pub fn prune_cache(dry_run: bool, age: Duration) -> std::io::Result<PruneStats> {
    let Some(dir) = primer_cache_dir() else {
        return Ok(PruneStats::default());
    };
    prune_old(&dir, age, dry_run, None)
}

fn prune_old(
    dir: &Path,
    age: Duration,
    dry_run: bool,
    sentinel_cooldown: Option<Duration>,
) -> std::io::Result<PruneStats> {
    let mut stats = PruneStats::default();
    std::fs::create_dir_all(dir)?;
    let sentinel = dir.join(".auto_prune");
    if let Some(cooldown) = sentinel_cooldown
        && let Ok(modified) = sentinel.metadata().and_then(|m| m.modified())
        && modified.elapsed().unwrap_or_default() < cooldown
    {
        return Ok(stats);
    }
    if sentinel_cooldown.is_some() {
        touch(&sentinel)?;
    }
    let entries = std::fs::read_dir(dir)?;
    for entry in entries {
        let entry = entry?;
        let path = entry.path();
        let Some(name) = path.file_name().and_then(|s| s.to_str()) else {
            continue;
        };
        if !is_primer_cache_file(name) {
            continue;
        }
        let metadata = entry.metadata()?;
        if metadata.modified()?.elapsed().unwrap_or_default() > age {
            stats.files += 1;
            stats.bytes += metadata.len();
            if !dry_run {
                std::fs::remove_file(&path)?;
            }
        }
    }
    Ok(stats)
}

fn touch(path: &Path) -> std::io::Result<()> {
    if let Some(parent) = path.parent() {
        std::fs::create_dir_all(parent)?;
    }
    std::fs::OpenOptions::new()
        .create(true)
        .write(true)
        .truncate(true)
        .open(path)?
        .write_all(b"\n")
}

fn is_primer_cache_file(name: &str) -> bool {
    name.starts_with(&format!("{PRIMER_FORMAT}-")) && name.ends_with(".rkyv")
}

fn random_byte() -> u8 {
    let nanos = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_nanos())
        .unwrap_or_default();
    (nanos as u8) ^ (std::process::id() as u8)
}

fn primer_cache_dir() -> Option<PathBuf> {
    // First-class config knob, read under the active embedder's brand
    // (`AUBE_CACHE_DIR` for standalone aube, `<BRAND>_CACHE_DIR` for an embedder
    // with its own `config_env_prefix`) via `config_env` — never the branded
    // `AUBE_*` form under such a host.
    if let Some(base) = aube_util::env::config_env("CACHE_DIR") {
        return Some(PathBuf::from(base).join("primer"));
    }
    // Active embedder's `cache_namespace` (standalone aube → "aube"), not a literal,
    // so the primer lands beside the packument cache in aube-store's `cache_dir`
    // rather than under an aube-named path in a host embedder's $XDG_CACHE.
    cache_base_dir().map(|p| p.join(aube_util::embedder().cache_namespace).join("primer"))
}

#[cfg(unix)]
fn cache_base_dir() -> Option<PathBuf> {
    std::env::var_os("XDG_CACHE_HOME")
        .map(PathBuf::from)
        .or_else(|| std::env::var_os("HOME").map(|h| PathBuf::from(h).join(".cache")))
}

#[cfg(windows)]
fn cache_base_dir() -> Option<PathBuf> {
    std::env::var_os("LOCALAPPDATA").map(PathBuf::from)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn bundled_primer_loads() {
        let Some((name, _, _)) = PRIMER_INDEX.first() else {
            return;
        };
        assert!(super::get(name).is_some());
    }

    #[test]
    fn bundled_popular_names_load() {
        let names = popular_package_names();
        if !PRIMER_INDEX.is_empty() {
            assert!(!names.is_empty());
        }
        assert!(names.lines().all(|name| !name.is_empty()));
    }

    #[test]
    fn bundled_primer_synthesizes_tarball_urls() {
        // The generator omits the tarball URL when it matches the
        // deterministic `{registry}/{name}/-/{unscoped}-{version}.tgz`
        // pattern. Verify the runtime fills it in correctly: every
        // dist must surface a tarball URL whose path segments match
        // the package name + version we asked for, so a synthesis bug
        // that drops or swaps either field can't pass silently.
        let Some((name, _, _)) = PRIMER_INDEX.first() else {
            return;
        };
        let packument = super::get(name).expect("primer hit").packument();
        let (version, meta) = packument
            .versions
            .iter()
            .find(|(_, v)| v.dist.is_some())
            .expect("packument has at least one version with dist metadata");
        let dist = meta.dist.as_ref().unwrap();
        assert!(
            dist.tarball.starts_with("https://"),
            "tarball: {}",
            dist.tarball
        );
        assert!(dist.tarball.ends_with(".tgz"), "tarball: {}", dist.tarball);
        assert!(
            dist.tarball.contains(*name),
            "tarball {} missing package name {name}",
            dist.tarball,
        );
        assert!(
            dist.tarball.contains(version),
            "tarball {} missing version {version}",
            dist.tarball,
        );
    }

    #[test]
    fn deterministic_tarball_url_handles_scoped_names() {
        assert_eq!(
            deterministic_tarball_url("react", "18.2.0"),
            "https://registry.npmjs.org/react/-/react-18.2.0.tgz"
        );
        assert_eq!(
            deterministic_tarball_url("@types/node", "20.10.0"),
            "https://registry.npmjs.org/@types/node/-/node-20.10.0.tgz"
        );
    }

    #[test]
    fn primer_cache_file_match_is_narrow() {
        assert!(is_primer_cache_file("rkyv-v1-abc.rkyv"));
        assert!(!is_primer_cache_file(".auto_prune"));
        assert!(!is_primer_cache_file("rkyv-v1-abc.tmp"));
        assert!(!is_primer_cache_file("other-v1-abc.rkyv"));
    }

    #[test]
    fn prune_removes_old_extracted_primer_files() {
        let temp = tempfile::tempdir().unwrap();
        let dir = temp.path();
        std::fs::write(dir.join("rkyv-v1-old-0-old.rkyv"), "{}").unwrap();
        std::fs::write(dir.join("packument.json"), "{}").unwrap();
        let stats = prune_old(dir, Duration::from_secs(0), false, None).unwrap();
        assert_eq!(stats.files, 1);
        assert!(!dir.join("rkyv-v1-old-0-old.rkyv").exists());
        assert!(dir.join("packument.json").exists());
    }

    #[test]
    fn prune_sentinel_uses_own_cooldown() {
        let temp = tempfile::tempdir().unwrap();
        let dir = temp.path();
        let primer_file = dir.join("rkyv-v1-old-0-old.rkyv");
        std::fs::write(&primer_file, "{}").unwrap();
        touch(&dir.join(".auto_prune")).unwrap();

        let stats = prune_old(
            dir,
            Duration::from_secs(0),
            false,
            Some(Duration::from_secs(60)),
        )
        .unwrap();

        assert_eq!(stats.files, 0);
        assert!(primer_file.exists());
    }
}