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
567
568
569
570
571
572
573
574
575
576
577
578
579
use crate::pubgrub::{PkgName, SemVersion, ZoiDependencyProvider};
use anyhow::{Result, anyhow};
use pubgrub::{DependencyProvider, Ranges, resolve as pubgrub_resolve};
use rustc_hash::FxHashMap;
use semver::Version;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, HashSet, VecDeque};
use zoi_core::types::{self, InstallReason, Package};
use zoi_deps as dependencies;
use zoi_project::lockfile::FrozenLockPackage;
use zoi_resolver::resolve;

/// Represents a single package node within the resolved dependency graph.
///
/// This node encapsulates everything needed to install the package, including:
/// - The fully parsed package metadata.
/// - The exact resolved version and sub-package selection.
/// - The reason it was included (Direct request vs. Dependency).
/// - The specific options and optionals chosen by the user/resolver.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InstallNode {
    /// The core metadata definition for the package.
    pub pkg: Package,
    /// The exact resolved SemVer version.
    pub version: String,
    /// The package revision number (used for packaging updates).
    pub revision: String,
    /// The selected sub-package, if applicable (e.g. `Some("docs")`).
    pub sub_package: Option<String>,
    /// The tier of the repository this package belongs to (e.g. "official", "community").
    pub repo_type: String,
    /// A short description of the package.
    pub description: String,
    /// Why this package is being installed (e.g. Direct request vs Dependency).
    pub reason: InstallReason,
    /// The original source string used to request this package.
    pub source: String,
    /// The handle of the registry this package was resolved from.
    pub registry_handle: String,
    /// The names of explicit dependency options chosen by the user.
    pub chosen_options: Vec<String>,
    /// The names of optional dependencies chosen by the user.
    pub chosen_optionals: Vec<String>,
    /// The final list of runtime dependency source strings required by this node.
    pub dependencies: Vec<String>,
    /// The Git commit SHA of the repository when this package was resolved (used for lockfiles).
    pub git_sha: Option<String>,
}

/// A Directed Acyclic Graph (DAG) representing the installation plan.
///
/// The graph ensures that dependencies are installed before the packages
/// that require them. The `$root` node acts as the entry point linking
/// all direct user requests.
#[derive(Default, Debug)]
pub struct DependencyGraph {
    /// A map of package IDs to their complete installation data.
    pub nodes: HashMap<String, InstallNode>,
    /// The adjacency list representing the directed edges (dependencies) between packages.
    pub adj: HashMap<String, HashSet<String>>,
}

impl DependencyGraph {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn toposort(&self) -> Result<Vec<Vec<String>>> {
        let mut in_degree: HashMap<String, usize> =
            self.nodes.keys().map(|id| (id.clone(), 0)).collect();

        for (from, to_set) in &self.adj {
            if from == "$root" {
                continue;
            }
            for to in to_set {
                if let Some(degree) = in_degree.get_mut(to) {
                    *degree += 1;
                }
            }
        }

        let mut queue: VecDeque<String> = in_degree
            .iter()
            .filter(|&(_, d)| *d == 0)
            .map(|(id, _)| id.clone())
            .collect();

        let mut stages = Vec::new();
        let mut count = 0;

        while !queue.is_empty() {
            let mut stage = Vec::new();
            for _ in 0..queue.len() {
                let u = queue
                    .pop_front()
                    .ok_or_else(|| anyhow!("Queue length inconsistency in toposort"))?;
                stage.push(u.clone());
                count += 1;

                if let Some(neighbors) = self.adj.get(&u) {
                    for v_id in neighbors {
                        let degree = in_degree
                            .get_mut(v_id)
                            .ok_or_else(|| anyhow!("v_id '{}' missing from in_degree", v_id))?;
                        *degree -= 1;
                        if *degree == 0 {
                            queue.push_back(v_id.clone());
                        }
                    }
                }
            }
            stages.push(stage);
        }

        if count != self.nodes.len() {
            return Err(anyhow!("Cycle detected in dependency graph."));
        }

        stages.reverse();

        Ok(stages)
    }
}

fn extract_zoi_dependencies(deps: &types::DependenciesV2) -> Vec<String> {
    let mut zoi_deps = Vec::new();

    let mut to_process = deps.runtime.clone();
    for b in &deps.build {
        to_process.extend(b.packages.clone());
    }

    for dep_str in to_process {
        if let Ok(dep) = dependencies::parse_dependency_string(&dep_str)
            && dep.manager == "zoi"
        {
            zoi_deps.push(dep.package.to_string());
        }
    }
    zoi_deps
}

pub fn build_graph_from_locked_packages(
    locked_packages: &[FrozenLockPackage],
    scope_override: Option<types::Scope>,
    quiet: bool,
    yes: bool,
) -> Result<(DependencyGraph, Vec<String>)> {
    if !quiet {
        println!(":: Resolving dependencies from zoi.lock...");
    }

    let mut graph = DependencyGraph::new();
    let mut reverse_deps: HashMap<String, Vec<String>> = HashMap::new();
    let mut pkg_id_to_locked_deps: HashMap<String, Vec<String>> = HashMap::new();
    let mut pkg_id_to_locked_deps_v2: HashMap<String, Option<types::DependenciesV2>> =
        HashMap::new();

    for locked in locked_packages {
        let request = resolve::parse_source_string(&locked.source)?;
        let (pkg, version_str, _, pkg_lua_path, handle, repo_type, git_sha) =
            resolve::resolve_package_and_version(&locked.source, scope_override, quiet, yes)?;

        let mut pkg = pkg;
        if let Some(scope) = scope_override {
            pkg.scope = scope;
        }

        let pkg_id = if let Some(sub) = &request.sub_package {
            format!("{}@{}:{}", pkg.name, version_str, sub)
        } else {
            format!("{}@{}", pkg.name, version_str)
        };

        let flattened_deps = if let Some(deps) = &locked.dependencies {
            extract_zoi_dependencies(deps)
        } else {
            Vec::new()
        };

        pkg_id_to_locked_deps.insert(pkg_id.clone(), flattened_deps.clone());
        pkg_id_to_locked_deps_v2.insert(pkg_id.clone(), locked.dependencies.clone());

        graph.nodes.insert(
            pkg_id.clone(),
            InstallNode {
                description: pkg.description.clone(),
                repo_type: repo_type.unwrap_or_else(|| "unofficial".to_string()),
                pkg,
                version: version_str,
                revision: locked.revision.clone(),
                sub_package: request.sub_package.clone(),
                reason: if locked.direct {
                    InstallReason::Direct
                } else {
                    InstallReason::Dependency {
                        parent: "unknown".to_string(),
                    }
                },
                source: pkg_lua_path.to_string_lossy().to_string(),
                registry_handle: handle.unwrap_or_else(|| "zoidberg".to_string()),
                chosen_options: locked.chosen_options.clone(),
                chosen_optionals: locked.chosen_optionals.clone(),
                dependencies: Vec::new(),
                git_sha: locked.git_sha.clone().or(git_sha),
            },
        );
    }

    for pkg_id in graph.nodes.keys() {
        let mut children = HashSet::new();
        if let Some(locked_deps) = pkg_id_to_locked_deps.get(pkg_id) {
            for dep_pkg_source in locked_deps {
                let dep_req = resolve::parse_source_string(dep_pkg_source)?;
                let dep_version = dep_req.version_spec.as_deref().unwrap_or_default();
                let dep_id = if let Some(sub) = dep_req.sub_package {
                    format!("{}@{}:{}", dep_req.name, dep_version, sub)
                } else {
                    format!("{}@{}", dep_req.name, dep_version)
                };

                if graph.nodes.contains_key(&dep_id) {
                    children.insert(dep_id.clone());
                    reverse_deps.entry(dep_id).or_default().push(pkg_id.clone());
                }
            }
        }
        graph.adj.insert(pkg_id.clone(), children);
    }

    let direct_ids: Vec<String> = graph
        .nodes
        .iter()
        .filter_map(|(pkg_id, node)| {
            let is_direct =
                matches!(node.reason, InstallReason::Direct) || !reverse_deps.contains_key(pkg_id);
            is_direct.then(|| pkg_id.clone())
        })
        .collect();

    graph
        .adj
        .insert("$root".to_string(), direct_ids.iter().cloned().collect());

    let direct_id_set: HashSet<String> = direct_ids.iter().cloned().collect();

    let mut parent_map = HashMap::new();
    for (pkg_id, parents) in &reverse_deps {
        if !direct_id_set.contains(pkg_id)
            && let Some(parent_id) = parents.first()
            && let Some(parent_node) = graph.nodes.get(parent_id)
        {
            let parent_source = zoi_resolver::local::package_source_string(
                &parent_node.registry_handle,
                &parent_node.pkg.repo,
                &parent_node.pkg.name,
                parent_node.sub_package.as_deref(),
                &parent_node.version,
            );
            parent_map.insert(pkg_id.clone(), parent_source);
        }
    }

    let resolved_child_sources: HashMap<String, Vec<String>> = graph
        .adj
        .iter()
        .map(|(pkg_id, children)| {
            let deps = children
                .iter()
                .filter_map(|child| {
                    graph.nodes.get(child).map(|child_node| {
                        format!(
                            "zoi:{}",
                            zoi_resolver::local::package_source_string(
                                &child_node.registry_handle,
                                &child_node.pkg.repo,
                                &child_node.pkg.name,
                                child_node.sub_package.as_deref(),
                                &child_node.version,
                            )
                        )
                    })
                })
                .collect::<Vec<_>>();
            (pkg_id.clone(), deps)
        })
        .collect();

    for (pkg_id, node) in &mut graph.nodes {
        if direct_id_set.contains(pkg_id) {
            node.reason = InstallReason::Direct;
        } else if let Some(parent_source) = parent_map.get(pkg_key_as_str(pkg_id)) {
            node.reason = InstallReason::Dependency {
                parent: parent_source.clone(),
            };
        }

        let mut resolved_deps = resolved_child_sources
            .get(pkg_id)
            .cloned()
            .unwrap_or_default();

        if let Some(Some(deps_v2)) = pkg_id_to_locked_deps_v2.get(pkg_id) {
            for dep_str in &deps_v2.runtime {
                if let Ok(dep_req) = dependencies::parse_dependency_string(dep_str)
                    && dep_req.manager != "zoi"
                {
                    resolved_deps.push(dep_str.clone());
                }
            }
        }
        node.dependencies = resolved_deps;
    }

    Ok((graph, Vec::new()))
}

fn pkg_key_as_str(s: &String) -> &String {
    s
}

/// Computes the complete dependency graph for a set of input sources.
///
/// This is the core "Resolution Engine" of Zoi. It:
/// - Maps each source string to a `PkgName` in the PubGrub solver.
/// - Uses the PubGrub SAT algorithm to find a set of versions that satisfy all
///   SemVer requirements and constraints.
/// - Handles backtracking and human-readable error reporting on failure.
/// - Returns a `DependencyGraph` containing all nodes (packages) and edges (dependencies).
pub fn resolve_dependency_graph(
    initial_sources: &[String],
    scope_override: Option<types::Scope>,
    _force: bool,
    yes: bool,
    all_optional: bool,
    _build_type: Option<&str>,
    quiet: bool,
) -> Result<(DependencyGraph, Vec<String>)> {
    if !quiet {
        println!(":: Resolving dependencies...");
    }

    let mut non_zoi_deps = Vec::new();
    let mut root_deps = FxHashMap::default();

    for source in initial_sources {
        let parse_result = dependencies::parse_dependency_string(source);
        if let Ok(dep) = parse_result
            && dep.manager != "zoi"
        {
            non_zoi_deps.push(source.clone());
            continue;
        }

        let request = resolve::parse_source_string(source)?;
        let resolved = resolve::resolve_source(source, scope_override, quiet, yes)?;

        let pkg_name = PkgName {
            name: request.name,
            sub_package: request.sub_package,
            repo: resolved.repo_name.unwrap_or_default(),
            registry: resolved
                .registry_handle
                .unwrap_or_else(|| "zoidberg".to_string()),
            explicit_source: matches!(
                resolved.source_type,
                zoi_core::types::SourceType::LocalFile
                    | zoi_core::types::SourceType::Url
                    | zoi_core::types::SourceType::GitRepo(_)
            )
            .then(|| source.clone()),
        };

        let range = if request.version_spec.is_some() {
            let resolved_version =
                resolve::resolve_requested_version_spec(source, scope_override, true, true)?
                    .ok_or_else(|| {
                        anyhow!("version spec missing despite check for '{}'", source)
                    })?;
            crate::pubgrub::semver_to_range(&resolved_version)
        } else {
            Ranges::full()
        };

        root_deps.insert(pkg_name, range);
    }

    let project_config = zoi_project::config::load().ok();

    let provider = ZoiDependencyProvider::new(
        root_deps,
        initial_sources.to_vec(),
        scope_override,
        quiet,
        yes,
        all_optional,
        project_config,
    )?;
    let root_pkg = PkgName {
        name: "$root".to_string(),
        sub_package: None,
        repo: "".to_string(),
        registry: "".to_string(),
        explicit_source: None,
    };
    let root_version = SemVersion(Version::new(0, 0, 0));

    let mut final_nodes = HashMap::new();
    let mut final_adj: HashMap<String, HashSet<String>> = HashMap::new();

    match pubgrub_resolve::<ZoiDependencyProvider>(&provider, root_pkg, root_version) {
        Ok(solution) => {
            for (name, version) in solution.iter() {
                if name.name == "$root" {
                    continue;
                }

                let source = name
                    .explicit_source
                    .clone()
                    .unwrap_or_else(|| format!("{}@{}", name, version));
                let (pkg, version_str, _, pkg_lua_path, handle, repo_type, git_sha) =
                    resolve::resolve_package_and_version(&source, scope_override, quiet, yes)?;

                let mut pkg = pkg;
                if let Some(s) = scope_override {
                    pkg.scope = s;
                }

                let pkg_id = if let Some(sub) = &name.sub_package {
                    format!("{}@{}:{}", pkg.name, version_str, sub)
                } else {
                    format!("{}@{}", pkg.name, version_str)
                };

                let cache_key = (name.clone(), version.clone());
                let (chosen_options, chosen_optionals, all_req_deps) = provider
                    .chosen_cache
                    .borrow()
                    .get(&cache_key)
                    .cloned()
                    .unwrap_or_default();

                for dep_str in &all_req_deps {
                    if let Ok(dep_req) = zoi_deps::parse_dependency_string(dep_str)
                        && dep_req.manager != "zoi"
                    {
                        non_zoi_deps.push(dep_str.clone());
                    }
                }

                let node = InstallNode {
                    description: pkg.description.clone(),
                    repo_type: repo_type.unwrap_or_else(|| "unofficial".to_string()),
                    pkg: pkg.clone(),
                    version: version_str,
                    revision: pkg.revision.clone(),
                    sub_package: name.sub_package.clone(),
                    reason: InstallReason::Direct,
                    source: pkg_lua_path.to_string_lossy().to_string(),
                    registry_handle: handle.unwrap_or_else(|| "zoidberg".to_string()),
                    chosen_options,
                    chosen_optionals,
                    dependencies: all_req_deps,
                    git_sha,
                };
                final_nodes.insert(pkg_id, node);
            }

            for (name, version) in solution.iter() {
                let from_id = if name.name == "$root" {
                    "$root".to_string()
                } else if let Some(sub) = &name.sub_package {
                    format!("{}@{}:{}", name.name, version, sub)
                } else {
                    format!("{}@{}", name.name, version)
                };

                if let Ok(pubgrub::Dependencies::Available(deps)) =
                    provider.get_dependencies(name, version)
                {
                    for (dep_name, _) in deps {
                        if let Some(dep_version) = solution.get(&dep_name) {
                            let to_id = if let Some(sub) = &dep_name.sub_package {
                                format!("{}@{}:{}", dep_name.name, dep_version, sub)
                            } else {
                                format!("{}@{}", dep_name.name, dep_version)
                            };
                            final_adj.entry(from_id.clone()).or_default().insert(to_id);
                        }
                    }
                }
            }
            let mut direct_ids = HashSet::new();
            if let Some(root_children) = final_adj.get("$root") {
                direct_ids = root_children.clone();
            }

            let mut parent_map = HashMap::new();
            for (from, to_set) in &final_adj {
                if from != "$root"
                    && let Some(parent_node) = final_nodes.get(from)
                {
                    let parent_id = format!(
                        "#{}@{}/{}@{}",
                        parent_node.registry_handle,
                        parent_node.pkg.repo,
                        parent_node.pkg.name,
                        parent_node.version
                    );
                    for to in to_set {
                        parent_map.entry(to.clone()).or_insert(parent_id.clone());
                    }
                }
            }

            let resolved_child_sources: HashMap<String, Vec<String>> = final_adj
                .iter()
                .map(|(pkg_id, children)| {
                    let deps = children
                        .iter()
                        .filter_map(|child| {
                            final_nodes.get(child).map(|child_node| {
                                format!(
                                    "zoi:{}",
                                    zoi_resolver::local::package_source_string(
                                        &child_node.registry_handle,
                                        &child_node.pkg.repo,
                                        &child_node.pkg.name,
                                        child_node.sub_package.as_deref(),
                                        &child_node.version,
                                    )
                                )
                            })
                        })
                        .collect::<Vec<_>>();
                    (pkg_id.clone(), deps)
                })
                .collect();

            for (pkg_id, node) in final_nodes.iter_mut() {
                let child_sources = resolved_child_sources
                    .get(pkg_id)
                    .cloned()
                    .unwrap_or_default();

                if direct_ids.contains(pkg_id) {
                    node.reason = InstallReason::Direct;
                } else {
                    let parent_id = parent_map
                        .get(pkg_id)
                        .cloned()
                        .unwrap_or_else(|| "unknown".to_string());
                    node.reason = InstallReason::Dependency { parent: parent_id };
                }

                let mut resolved_deps = child_sources;
                for dep_str in &node.dependencies {
                    if let Ok(dep_req) = zoi_deps::parse_dependency_string(dep_str)
                        && dep_req.manager != "zoi"
                    {
                        resolved_deps.push(dep_str.clone());
                    }
                }
                node.dependencies = resolved_deps;
            }
        }
        Err(e) => return Err(anyhow!("Dependency resolution failed: {}", e)),
    }

    Ok((
        DependencyGraph {
            nodes: final_nodes,
            adj: final_adj,
        },
        non_zoi_deps,
    ))
}