creeper 1.0.0-alpha.5

Minecraft Package Manager
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
use std::{
    cmp::Reverse,
    collections::{BTreeMap, BTreeSet, HashMap, HashSet},
    fmt::{Debug, Display},
    hash::Hash,
    iter::once,
    ops::Deref,
    sync::RwLock,
};

use anyhow::anyhow;
use creeper_semver_pubgrub::SemverPubgrub;
use petgraph::{algo::toposort, graph::DiGraph};
use pubgrub::{DefaultStringReporter, Dependencies, DependencyProvider, Reporter};
use semver::{BuildMetadata, Prerelease, Version, VersionReq};
use tracing::{debug, error, info, trace, warn};

use crate::{Creeper, Id, index::VersionRev, pack::PackNode};

struct Error(anyhow::Error);

impl From<anyhow::Error> for Error {
    fn from(value: anyhow::Error) -> Self {
        Self(value)
    }
}

impl Debug for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Debug::fmt(&self.0, f)
    }
}

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

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.0.source()
    }
}

#[derive(Clone, PartialEq, Eq, Hash)]
enum Package {
    Normal(Id),
    Root,
    OneHot(Conflict),
    Either(BTreeMap<Id, VersionReq>),
}

impl Display for Package {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Package::Normal(id) => write!(f, "{id}"),
            Package::Root => write!(f, "<root>"),
            Package::OneHot(clause) => write!(f, "{clause}"),
            Package::Either(btree_map) => {
                let data = btree_map
                    .iter()
                    .map(|(k, v)| format!("{k}@{v}"))
                    .collect::<Vec<_>>()
                    .join(" ");
                write!(f, "<either: {data}>")
            }
        }
    }
}

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

/// A conflict, or "onehot" clause.
/// Denotes that at most one of the requirements can be satisfied at the same time.
#[derive(Clone, PartialEq, Eq, Hash)]
pub struct Conflict(pub BTreeMap<Id, VersionReq>);

impl Conflict {
    pub fn versions(&self) -> impl Iterator<Item = Version> {
        (1..=self.len()).map(|i| Version::new(i as u64, 0, 0))
    }

    /// If the clause is depended by the given package, returns the specific version being depended on.
    /// Otherwise, return `None`.
    pub fn dep_of(&self, package: &Id, version: &Version) -> Option<Version> {
        self.iter()
            .position(|(id, req)| id == package && req.matches(version))
            .map(|i| Version::new(i as u64 + 1, 0, 0))
    }
}

impl Deref for Conflict {
    type Target = BTreeMap<Id, VersionReq>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl From<BTreeMap<Id, VersionReq>> for Conflict {
    fn from(value: BTreeMap<Id, VersionReq>) -> Self {
        Self(value)
    }
}

impl From<Conflict> for BTreeMap<Id, VersionReq> {
    fn from(value: Conflict) -> Self {
        value.0
    }
}

impl Display for Conflict {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let data = self
            .iter()
            .map(|(k, v)| format!("{k}@{v}"))
            .collect::<Vec<_>>()
            .join(" ");
        write!(f, "<onehot: {data}>")
    }
}

struct ConflictManager {
    clause: HashSet<Conflict>,
}

impl ConflictManager {
    fn new() -> Self {
        Self {
            clause: HashSet::new(),
        }
    }

    fn get_dependencies(&self, package: &Id, version: &Version) -> HashMap<Package, VersionReq> {
        let mut deps = HashMap::new();

        for clause in &self.clause {
            if let Some(version) = clause.dep_of(package, version) {
                deps.insert(
                    Package::OneHot(clause.clone()),
                    format!("={version}").parse().unwrap(),
                );
            }
        }

        deps
    }

    /// Simplify the conflict clauses logically, e.g. deduplication or removing clauses implied by others,
    /// in order to improve performance.
    // the function shall not exceed O(n^2) in time complexity
    fn simp(&mut self) {
        warn!("TODO: simplify conflict clauses to improve performance");
    }
}

impl Extend<Conflict> for ConflictManager {
    fn extend<T: IntoIterator<Item = Conflict>>(&mut self, iter: T) {
        for i in iter {
            self.clause.insert(i.into());
        }
    }
}

struct Resolve {
    lib: Creeper,
    root: PackNode,
    conflict: RwLock<ConflictManager>,
}

impl Resolve {
    fn new(lib: Creeper, root: PackNode) -> Self {
        Self {
            lib,
            root,
            conflict: RwLock::new(ConflictManager::new()),
        }
    }

    fn prepare(&self) -> anyhow::Result<()> {
        let reachable = self
            .lib
            .blocking_get_reachable_package(self.root.clone().neighbours())?;

        let mut clause = vec![];

        for id in reachable {
            let index = self.lib.blocking_get_index(&id)?;
            for (VersionRev(v, _), node) in index {
                let new = node.conflict_clause(id.clone(), v);
                clause.push(new);
            }
        }

        debug!("prepared {} conflict clauses", clause.len());

        let mut conflict = self.conflict.write().unwrap();

        conflict.extend(clause);

        conflict.simp();

        Ok(())
    }
}

impl DependencyProvider for Resolve {
    type P = Package;

    type V = Version;

    type VS = SemverPubgrub<Version>;

    type Priority = Reverse<usize>;

    type M = String;

    type Err = crate::pubgrub::Error;

    fn prioritize(
        &self,
        package: &Self::P,
        range: &Self::VS,
        // TODO(konsti): Are we always refreshing the priorities when `PackageResolutionStatistics`
        // changed for a package?
        _package_conflicts_counts: &pubgrub::PackageResolutionStatistics,
    ) -> Self::Priority {
        let package = match package {
            Package::Normal(id) => id,
            Package::Root => return Reverse(usize::MAX),
            Package::OneHot(btree_map) => return Reverse(btree_map.len()),
            Package::Either(btree_map) => return Reverse(btree_map.len()),
        };

        trace!("determining priority for {package}");

        let index = self.lib.blocking_get_index(package).unwrap_or_else(|e| {
            error!("failed to prioritize package {package}: {e}");
            error!("package resolution will continue with no available versions for this package");
            BTreeMap::new()
        });

        let available = index
            .keys()
            .map(|VersionRev(v, _)| v)
            .filter(|v| range.contains(v))
            .count();

        trace!("priority for {package} is {available} (smaller is higher)");
        Reverse(available)
    }

    fn choose_version(
        &self,
        package: &Self::P,
        range: &Self::VS,
    ) -> Result<Option<Self::V>, Self::Err> {
        let available = match package {
            Package::Normal(id) => self
                .lib
                .blocking_get_index(id)?
                .into_keys()
                .map(|VersionRev(v, _)| v)
                .filter(|v| range.contains(v))
                .collect::<BTreeSet<_>>(),
            Package::Root => return Ok(Some(Version::new(0, 0, 0))),
            Package::OneHot(clause) => clause
                .versions()
                .filter(|v| range.contains(v))
                .collect::<BTreeSet<_>>(),
            Package::Either(map) => (1..=map.len())
                .map(|i| Version::new(i as u64, 0, 0))
                .filter(|v| range.contains(v))
                .collect::<BTreeSet<_>>(),
        };

        let highest = available.last();

        if let Some(version) = highest {
            trace!("selected {package} {version}",);
        } else {
            trace!("no available version for {package} in {range}");
        };

        Ok(highest.cloned())
    }

    // TODO: add conflict virtual packages to dependencies
    fn get_dependencies(
        &self,
        package: &Self::P,
        version: &Self::V,
    ) -> Result<pubgrub::Dependencies<Self::P, Self::VS, Self::M>, Self::Err> {
        let package = match package {
            Package::Normal(id) => id,
            Package::Root => {
                return Ok(Dependencies::Available(
                    self.root
                        .dep
                        .iter()
                        .map(|(k, v)| (Package::Normal(k.clone()), SemverPubgrub::from(v)))
                        .collect(),
                ));
            }
            Package::OneHot(_) => return Ok(Dependencies::Available(Default::default())),
            Package::Either(map) => {
                if version.major > map.len() as u64
                    || version.minor != 0
                    || version.patch != 0
                    || version.pre != Prerelease::EMPTY
                    || version.build != BuildMetadata::EMPTY
                {
                    return Err(
                        anyhow!("invalid version {version} for virtual package {package}").into(),
                    );
                }

                let (id, req) = map.iter().nth(version.major as usize - 1).unwrap();

                let dep = once((Package::Normal(id.clone()), SemverPubgrub::from(req))).collect();

                return Ok(Dependencies::Available(dep));
            }
        };

        let index = self.lib.blocking_get_index(package)?;

        // TODO: support revision number instead of defaulting to 0
        let node = &index[&VersionRev(version.clone(), 0)];

        let conflict = self
            .conflict
            .read()
            .unwrap()
            .get_dependencies(package, version);

        let mut either_dep = vec![];

        for grp in node.either_dep.clone() {
            let clause = grp.into_iter().collect::<BTreeMap<_, _>>();
            either_dep.push((Package::Either(clause), VersionReq::STAR));
        }

        let dep = node
            .dep
            .iter()
            .map(|(k, v)| (Package::Normal(k.clone()), SemverPubgrub::from(v)))
            .chain(
                conflict
                    .into_iter()
                    .chain(either_dep)
                    .map(|(k, v)| (k, SemverPubgrub::from(&v))),
            )
            .collect();

        Ok(Dependencies::Available(dep))
    }
}

impl Creeper {
    pub fn resolve(&self, req: BTreeMap<Id, VersionReq>) -> anyhow::Result<HashMap<Id, Version>> {
        info!("resolving {} required packages", req.len());

        let resolve = Resolve::new(
            self.clone(),
            PackNode {
                dep: req,
                ..Default::default()
            },
        );

        resolve.prepare()?;

        let res = pubgrub::resolve(&resolve, Package::Root, Version::new(0, 0, 0));

        let sol = res.map_err(|e| match e {
            pubgrub::PubGrubError::NoSolution(derivation_tree) => {
                let mut report = DefaultStringReporter::report(&derivation_tree);

                // remove the ugly double newlines in the report
                while report.find("\n\n").is_some() {
                    report = report.replace("\n\n", "\n");
                }

                anyhow!("no solution:\n{report}")
            }
            pubgrub::PubGrubError::ErrorRetrievingDependencies {
                package,
                version,
                source,
            } => anyhow!(
                "failed to retrieve dependencies for package {package} version {version}: {source}"
            ),
            pubgrub::PubGrubError::ErrorChoosingVersion { package, source } => {
                anyhow!("failed to choose version for package {package}: {source}")
            }
            pubgrub::PubGrubError::ErrorInShouldCancel(_) => {
                anyhow!("package resolution cancelled")
            }
        })?;

        let sol = sol.into_iter();

        let all = sol.len();

        // PubGrub uses non-default hasher, convert to standard before returning
        let sol = sol
            .filter_map(|(k, v)| match k {
                Package::Normal(id) => Some((id, v)),
                _ => None,
            })
            .collect::<HashMap<_, _>>();

        let real = sol.len();

        info!(
            "resolved {all} packages, of which {real} real and {} virtual",
            all - real
        );

        Ok(sol)
    }

    /// Topologically sort the dependencies. Dependencies goes before dependents in the output.
    ///
    /// The behavior is undefined unless the input is a valid solution, i.e. dependencies of each package in the input are also present in the input.
    pub fn sort_dependency(&self, dep: HashMap<Id, Version>) -> anyhow::Result<Vec<(Id, Version)>> {
        let mut graph = DiGraph::<&Id, ()>::new();
        let mut id_to_node = HashMap::new();
        let mut node_to_id = HashMap::new();

        for (package, _) in &dep {
            let node = graph.add_node(package);
            id_to_node.insert(package, node);
            node_to_id.insert(node, package);
        }

        for (package, version) in &dep {
            let node = self.blocking_get_node(package, version, 0)?;
            let node_package = id_to_node[package];

            for (d, _) in node.dep {
                let node_dep = id_to_node
                    .get(&d)
                    .ok_or(anyhow!("broken solution: dependency {d} not recorded"))?;

                graph.add_edge(node_package, *node_dep, ());
            }

            for (d, _) in node.either_dep.into_iter().flatten() {
                if let Some(node_dep) = id_to_node.get(&d) {
                    error!(
                        "TODO: avoid assuming {package} dependency on {d}, which may be incorrect"
                    );
                    graph.add_edge(node_package, *node_dep, ());
                }
            }
        }

        let order = toposort(&graph, None).map_err(|e| {
            let package = graph[e.node_id()];
            error!("cycle detected around package {package}");
            anyhow!("cycle in dependency DAG")
        })?;

        let order = order
            .into_iter()
            .rev()
            .map(|node| (node_to_id[&node].clone(), dep[node_to_id[&node]].clone()))
            .collect();

        Ok(order)
    }
}