zoi-install 1.23.4

Advanced Package Manager & Environment Orchestrator
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
use pubgrub::{Dependencies, DependencyProvider, Ranges};
use rusqlite::params;
use rustc_hash::FxHashMap;
use semver::Version;
use std::cell::RefCell;
use std::collections::HashMap;
use std::fmt::Display;
use thiserror::Error;
use zoi_core::types;
use zoi_db as db;
use zoi_resolver::resolve;

fn parse_pkgs_v2_key(key: &str) -> (String, String) {
    let key = key.trim_start_matches('#');
    let key = key.trim_start_matches('@');
    if let Some((repo, name)) = key.split_once('/') {
        let name = name.split(':').next().unwrap_or(name);
        (repo.to_string(), name.to_string())
    } else {
        (String::new(), key.to_string())
    }
}

#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct PkgName {
    pub name: String,
    pub sub_package: Option<String>,
    pub repo: String,
    pub registry: String,
    pub explicit_source: Option<String>,
}

impl Display for PkgName {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if let Some(source) = &self.explicit_source {
            return write!(f, "{}", source);
        }
        if let Some(sub) = &self.sub_package {
            write!(f, "#{}@{}/{}:{}", self.registry, self.repo, self.name, sub)
        } else {
            write!(f, "#{}@{}/{}", self.registry, self.repo, self.name)
        }
    }
}

#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct SemVersion(pub Version);

impl Display for SemVersion {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

#[derive(Error, Debug)]
pub enum ZoiSolverError {
    #[error("Dependency error: {0}")]
    Dependency(String),
    #[error("Version error: {0}")]
    Version(String),
    #[error("Anyhow error: {0}")]
    Anyhow(#[from] anyhow::Error),
    #[error("Other error: {0}")]
    Other(String),
}

/// Adapts Zoi's package and registry model to the PubGrub SAT solver.
///
/// This is the most performance-critical part of the resolution logic.
/// It implements the `DependencyProvider` trait, which allows the solver
/// to "ask" Zoi:
/// - "What versions are available for this package?"
/// - "What are the dependencies for this specific version?"
///
/// The adapter handles querying the local SQLite index, remote registries,
/// and project-local `zoi.lua` overrides in a unified way.
pub struct ZoiDependencyProvider {
    /// The initial set of direct dependencies requested by the user.
    pub root_deps: FxHashMap<PkgName, Ranges<SemVersion>>,
    /// The raw string sources (e.g. "#reg@repo/pkg@ver") provided to the CLI.
    pub initial_sources: Vec<String>,
    /// The target installation scope (User, System, Project).
    pub scope: Option<types::Scope>,
    /// Whether to suppress non-critical warnings during resolution.
    pub quiet: bool,
    /// Automatically accept default choices for interactive dependency options.
    pub yes: bool,
    /// Automatically include all optional dependencies.
    pub all_optional: bool,
    /// An in-memory cache of the registry used in 'mini' mode to avoid disk I/O.
    pub mini_index: Option<zoi_resolver::mini_resolve::MiniRegistryIndex>,
    /// The loaded `zoi.lua` or `zoi.yaml` project configuration, if applicable.
    pub project_config: Option<zoi_project::config::ProjectConfig>,
    /// Hard version constraints enforced by a project's lockfile or configuration.
    pub pkgs_v2_constraints: HashMap<(String, String), String>,
    /// Memoization cache mapping a package+version to its resolved dependency requirements.
    /// The `RefCell` allows interior mutability since the PubGrub solver requires `&self`.
    pub deps_cache:
        RefCell<FxHashMap<(PkgName, SemVersion), FxHashMap<PkgName, Ranges<SemVersion>>>>,
    /// Memoization cache storing the explicit options and optional dependencies chosen by the user.
    pub chosen_cache:
        RefCell<FxHashMap<(PkgName, SemVersion), (Vec<String>, Vec<String>, Vec<String>)>>,
}

/// Converts a SemVer requirement string into a PubGrub version range.
///
/// This function bridges the gap between the `semver` crate's flexible requirement
/// strings and `pubgrub`'s mathematical version ranges.
///
/// Mapping Examples:
/// - `1.2.3` -> `Ranges::singleton(1.2.3)` (Exact match)
/// - `^1.2.3` -> `[1.2.3, 2.0.0)` (Caret: compatible updates)
/// - `~1.2.3` -> `[1.2.3, 1.3.0)` (Tilde: patch-level updates)
/// - `>=1.0.0, <2.0.0` -> `[1.0.0, 2.0.0)` (Intersection of ranges)
///
/// If a version string is not a valid SemVer requirement (e.g. a channel name like
/// `@stable`), it is treated as a `Ranges::full()` to let Zoi's higher-level
/// resolver handle the channel-to-version mapping.
pub fn semver_to_range(req_str: &str) -> Ranges<SemVersion> {
    let req_str = req_str.trim_start_matches('@').trim_start_matches('v');

    if let Ok(version) = Version::parse(req_str) {
        return Ranges::singleton(SemVersion(version));
    }

    if let Ok(req) = semver::VersionReq::parse(req_str) {
        let mut range = Ranges::full();
        for comparator in &req.comparators {
            let v = SemVersion(Version {
                major: comparator.major,
                minor: comparator.minor.unwrap_or(0),
                patch: comparator.patch.unwrap_or(0),
                pre: comparator.pre.clone(),
                build: semver::BuildMetadata::EMPTY,
            });

            let comp_range = match comparator.op {
                semver::Op::Exact => Ranges::singleton(v),
                semver::Op::Greater => Ranges::strictly_higher_than(v),
                semver::Op::GreaterEq => Ranges::higher_than(v),
                semver::Op::Less => Ranges::strictly_lower_than(v),
                semver::Op::LessEq => Ranges::lower_than(v),
                semver::Op::Tilde => {
                    let next_minor = SemVersion(Version {
                        major: comparator.major,
                        minor: comparator.minor.unwrap_or(0) + 1,
                        patch: 0,
                        pre: semver::Prerelease::EMPTY,
                        build: semver::BuildMetadata::EMPTY,
                    });
                    Ranges::higher_than(v).intersection(&Ranges::strictly_lower_than(next_minor))
                }
                semver::Op::Caret => {
                    let next = if comparator.major > 0 {
                        Version {
                            major: comparator.major + 1,
                            minor: 0,
                            patch: 0,
                            pre: semver::Prerelease::EMPTY,
                            build: semver::BuildMetadata::EMPTY,
                        }
                    } else if let Some(minor) = comparator.minor {
                        if minor > 0 {
                            Version {
                                major: 0,
                                minor: minor + 1,
                                patch: 0,
                                pre: semver::Prerelease::EMPTY,
                                build: semver::BuildMetadata::EMPTY,
                            }
                        } else {
                            Version {
                                major: 0,
                                minor: 0,
                                patch: comparator.patch.unwrap_or(0) + 1,
                                pre: semver::Prerelease::EMPTY,
                                build: semver::BuildMetadata::EMPTY,
                            }
                        }
                    } else {
                        Version {
                            major: 1,
                            minor: 0,
                            patch: 0,
                            pre: semver::Prerelease::EMPTY,
                            build: semver::BuildMetadata::EMPTY,
                        }
                    };
                    Ranges::higher_than(v)
                        .intersection(&Ranges::strictly_lower_than(SemVersion(next)))
                }
                _ => Ranges::full(),
            };
            range = range.intersection(&comp_range);
        }
        return range;
    }

    Ranges::full()
}

impl ZoiDependencyProvider {
    pub fn new(
        root_deps: FxHashMap<PkgName, Ranges<SemVersion>>,
        initial_sources: Vec<String>,
        scope: Option<types::Scope>,
        quiet: bool,
        yes: bool,
        all_optional: bool,
        project_config: Option<zoi_project::config::ProjectConfig>,
    ) -> Result<Self, anyhow::Error> {
        let mini_index = if zoi_core::utils::is_mini_mode() {
            Some(zoi_resolver::mini_resolve::fetch_registry_index()?)
        } else {
            None
        };

        let pkgs_v2_constraints = project_config
            .as_ref()
            .map(|config| {
                config
                    .pkgs_v2
                    .iter()
                    .filter_map(|(key, spec)| {
                        spec.version
                            .as_ref()
                            .map(|v| (parse_pkgs_v2_key(key), v.clone()))
                    })
                    .collect::<HashMap<_, _>>()
            })
            .unwrap_or_default();

        Ok(Self {
            root_deps,
            initial_sources,
            scope,
            quiet,
            yes,
            all_optional,
            mini_index,
            project_config,
            pkgs_v2_constraints,
            deps_cache: RefCell::new(FxHashMap::default()),
            chosen_cache: RefCell::new(FxHashMap::default()),
        })
    }

    fn semver_to_range(&self, req_str: &str) -> Ranges<SemVersion> {
        semver_to_range(req_str)
    }

    fn source_matches_package(&self, package: &PkgName, source: &str) -> bool {
        if let Some(explicit_source) = &package.explicit_source {
            let explicit_base = explicit_source
                .rsplit_once('@')
                .map(|(base, _)| base)
                .unwrap_or(explicit_source.as_str());
            let source_base = source
                .rsplit_once('@')
                .map(|(base, _)| base)
                .unwrap_or(source);
            return explicit_base == source_base;
        }

        let Ok(req) = resolve::parse_source_string(source) else {
            return false;
        };

        if req.name != package.name || req.sub_package != package.sub_package {
            return false;
        }

        let Ok(resolved_source) = resolve::resolve_source(source, self.scope, true, true) else {
            return false;
        };

        resolved_source.repo_name.unwrap_or_default() == package.repo
            && resolved_source
                .registry_handle
                .unwrap_or_else(|| "zoidberg".to_string())
                == package.registry
    }

    pub fn get_versions(&self, package: &PkgName) -> Result<Vec<SemVersion>, ZoiSolverError> {
        let mut all_versions = Vec::new();

        if let Some(index) = &self.mini_index
            && let Some(pkg_info) = index.packages.get(&package.name)
            && let Ok(v) = Version::parse(pkg_info.version.trim_start_matches('v'))
        {
            all_versions.push(SemVersion(v));
        }

        if let Ok(version_strings) =
            db::get_all_versions(&package.registry, &package.name, &package.repo)
        {
            for v_str in version_strings {
                if let Ok(v) = Version::parse(&v_str) {
                    all_versions.push(SemVersion(v));
                }
            }
        }

        for source in &self.initial_sources {
            if self.source_matches_package(package, source)
                && let Ok(req) = resolve::parse_source_string(source)
                && let Some(v_spec) = req.version_spec
            {
                let v_clean = v_spec.trim_start_matches('@').trim_start_matches('v');
                if let Ok(v) = Version::parse(v_clean) {
                    all_versions.push(SemVersion(v));
                }
            }
        }

        let source_str = package.explicit_source.clone().unwrap_or_else(|| {
            if let Some(sub) = &package.sub_package {
                format!(
                    "#{}@{}/{}:{}",
                    package.registry, package.repo, package.name, sub
                )
            } else {
                format!("#{}@{}/{}", package.registry, package.repo, package.name)
            }
        });

        if let Ok(resolved) = resolve::resolve_source(&source_str, self.scope, true, true) {
            let path_str = resolved.path.to_string_lossy();
            if let Ok(pkg) = zoi_lua::parser::parse_lua_package(&path_str, None, self.scope, true) {
                if let Some(v_str) = &pkg.version {
                    let v_clean = v_str.trim_start_matches('v');
                    if let Ok(v) = Version::parse(v_clean) {
                        all_versions.push(SemVersion(v));
                    }
                }
                if let Some(versions_map) = &pkg.versions {
                    for channel in versions_map.keys() {
                        if let Ok(v_str) = resolve::resolve_channel(versions_map, channel) {
                            let v_clean = v_str.trim_start_matches('v');
                            if let Ok(v) = Version::parse(v_clean) {
                                all_versions.push(SemVersion(v));
                            }
                        }
                    }
                }
            }
        }

        if all_versions.is_empty()
            && let Ok(conn) = db::open_connection(&package.registry)
        {
            let mut stmt = conn
                .prepare("SELECT version FROM packages WHERE name = ?1")
                .map_err(|e| ZoiSolverError::Other(e.to_string()))?;
            let rows = stmt
                .query_map(params![package.name], |row| row.get::<_, Option<String>>(0))
                .map_err(|e| ZoiSolverError::Other(e.to_string()))?;

            for v_res in rows {
                if let Ok(Some(v_str)) = v_res {
                    let v_clean = v_str.trim_start_matches('v');
                    if let Ok(v) = Version::parse(v_clean) {
                        all_versions.push(SemVersion(v));
                    }
                }
            }
        }

        all_versions.sort();
        all_versions.dedup();

        if let Some(version_spec) = self
            .pkgs_v2_constraints
            .get(&(package.repo.clone(), package.name.clone()))
        {
            let range = semver_to_range(version_spec);
            all_versions.retain(|v| range.contains(v));
        }

        Ok(all_versions)
    }
}

impl DependencyProvider for ZoiDependencyProvider {
    type P = PkgName;
    type V = SemVersion;
    type VS = Ranges<SemVersion>;
    type M = String;
    type Priority = i32;
    type Err = ZoiSolverError;

    fn get_dependencies(
        &self,
        package: &Self::P,
        version: &Self::V,
    ) -> Result<Dependencies<Self::P, Self::VS, Self::M>, Self::Err> {
        if package.name == "$root" {
            return Ok(Dependencies::Available(
                pubgrub::DependencyConstraints::from_iter(self.root_deps.clone()),
            ));
        }

        let cache_key = (package.clone(), version.clone());
        if let Some(cached) = self.deps_cache.borrow().get(&cache_key) {
            return Ok(Dependencies::Available(
                pubgrub::DependencyConstraints::from_iter(cached.clone()),
            ));
        }

        let version_str = version.to_string();

        let mut package_deps: Option<types::DependenciesV2> = None;

        if let Some(config) = &self.project_config {
            let packages_key = if let Some(sub) = &package.sub_package {
                format!("@{}/{}:{}", package.repo, package.name, sub)
            } else {
                format!("@{}/{}", package.repo, package.name)
            };

            if let Some(spec) = config.pkgs_v2.get(&packages_key)
                && spec.version.as_ref().is_none_or(|v| {
                    let range = semver_to_range(v);
                    let parsed = Version::parse(&version_str);
                    parsed.is_ok_and(|pv| range.contains(&SemVersion(pv))) || v == &version_str
                })
            {
                package_deps = spec.dependencies.clone().map(types::to_dependencies_v2);
            }
        }

        if package_deps.is_none() {
            let dependencies_opt = db::get_package_dependencies(
                &package.registry,
                &package.name,
                &version_str,
                package.sub_package.as_deref(),
                &package.repo,
            )
            .ok()
            .flatten();

            let v1_deps = if let Some(deps_json) = dependencies_opt
                && !deps_json.is_empty()
            {
                serde_json::from_str::<types::Dependencies>(&deps_json).ok()
            } else {
                let source = package
                    .explicit_source
                    .clone()
                    .unwrap_or_else(|| format!("{}@{}", package, version_str));
                let pkg_res =
                    resolve::resolve_package_and_version(&source, self.scope, self.quiet, self.yes);

                match pkg_res {
                    Ok((pkg, _, _, _, _, _, _)) => pkg.dependencies,
                    Err(_) => None,
                }
            };
            package_deps = v1_deps.map(types::to_dependencies_v2);
        }

        let mut deps = FxHashMap::default();

        let chosen_opts = Vec::new();
        let chosen_opts_opt = Vec::new();
        let mut all_req = Vec::new();

        if let Some(dependencies) = package_deps {
            let mut groups = Vec::new();
            groups.push(&dependencies.runtime);
            for b in &dependencies.build {
                groups.push(&b.packages);
            }

            for group_pkgs in groups {
                for dep_str in group_pkgs {
                    let dep_req = zoi_deps::parse_dependency_string(dep_str)
                        .map_err(|e| ZoiSolverError::Dependency(e.to_string()))?;

                    if dep_req.manager == "zoi" {
                        let req = resolve::parse_source_string(dep_req.package)
                            .map_err(|e| ZoiSolverError::Dependency(e.to_string()))?;
                        let resolved_dep = resolve::resolve_source(
                            dep_req.package,
                            self.scope,
                            self.quiet,
                            self.yes,
                        )
                        .map_err(|e| ZoiSolverError::Dependency(e.to_string()))?;

                        let dep_name = PkgName {
                            name: req.name,
                            sub_package: req.sub_package,
                            repo: resolved_dep.repo_name.unwrap_or_default(),
                            registry: resolved_dep
                                .registry_handle
                                .unwrap_or_else(|| "zoidberg".to_string()),
                            explicit_source: matches!(
                                resolved_dep.source_type,
                                zoi_core::types::SourceType::LocalFile
                                    | zoi_core::types::SourceType::Url
                                    | zoi_core::types::SourceType::GitRepo(_)
                            )
                            .then(|| dep_req.package.to_string()),
                        };

                        let range = if req.version_spec.is_some() {
                            let resolved_version = resolve::resolve_requested_version_spec(
                                dep_req.package,
                                self.scope,
                                true,
                                true,
                            )
                            .map_err(|e| ZoiSolverError::Dependency(e.to_string()))?
                            .ok_or_else(|| {
                                ZoiSolverError::Dependency(format!(
                                    "version spec missing for '{}'",
                                    dep_req.package
                                ))
                            })?;
                            self.semver_to_range(&resolved_version)
                        } else {
                            Ranges::full()
                        };

                        deps.insert(dep_name, range);
                    }
                }
            }
            all_req = dependencies.runtime.clone();
        }

        self.deps_cache
            .borrow_mut()
            .insert(cache_key.clone(), deps.clone());
        self.chosen_cache
            .borrow_mut()
            .insert(cache_key, (chosen_opts, chosen_opts_opt, all_req));
        Ok(Dependencies::Available(
            pubgrub::DependencyConstraints::from_iter(deps),
        ))
    }

    fn choose_version(
        &self,
        package: &Self::P,
        versions: &pubgrub::Ranges<Self::V>,
    ) -> Result<Option<Self::V>, Self::Err> {
        if package.name == "$root" {
            return Ok(Some(SemVersion(Version::new(0, 0, 0))));
        }
        let all_versions = self.get_versions(package)?;
        let best_version = all_versions.into_iter().rfind(|v| versions.contains(v));
        Ok(best_version)
    }

    fn prioritize(
        &self,
        _package: &Self::P,
        _range: &Self::VS,
        _stats: &pubgrub::PackageResolutionStatistics,
    ) -> Self::Priority {
        0
    }
}