wally 0.3.2

Package manager for Roblox
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

mod in_memory;
mod registry;
mod test_registry;

pub use self::in_memory::InMemoryRegistry;
use self::in_memory::InMemoryRegistrySource;
pub use self::registry::Registry;
pub use self::test_registry::TestRegistry;

use std::collections::HashMap;
use std::path::PathBuf;

use serde::Serialize;

use crate::manifest::Manifest;
use crate::package_contents::PackageContents;
use crate::package_id::PackageId;
use crate::package_req::PackageReq;

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize)]
pub enum PackageSourceId {
    DefaultRegistry,
    Git(String),
    Path(PathBuf),
}

#[derive(Clone)]
pub struct PackageSourceMap {
    sources: HashMap<PackageSourceId, Box<PackageSource>>,
    source_order: Vec<PackageSourceId>,
}

impl PackageSourceMap {
    pub fn new(default_registry: Box<PackageSource>) -> Self {
        let mut sources = HashMap::new();
        sources.insert(PackageSourceId::DefaultRegistry, default_registry);

        Self {
            sources,
            source_order: vec![PackageSourceId::DefaultRegistry],
        }
    }

    pub fn get(&self, id: &PackageSourceId) -> Option<&PackageSource> {
        self.sources.get(id).map(|source| source.as_ref())
    }

    pub fn source_order(&self) -> &Vec<PackageSourceId> {
        &self.source_order
    }

    /// Searches the current list of sources for fallbacks and adds any not yet in the list, producing
    /// a complete tree of reachable sources for packages.
    /// Sources are searched breadth-first to ensure correct fallback priority.
    pub fn add_fallbacks(&mut self) -> anyhow::Result<()> {
        let mut source_index = 0;

        while source_index < self.source_order.len() {
            let registry = self.sources.get(&self.source_order[source_index]).unwrap();

            for fallback in registry.fallback_sources()? {
                // Prevent circular references by only adding new sources
                if !self.source_order.contains(&fallback) {
                    let source: Box<PackageSource> = match &fallback {
                        PackageSourceId::Git(url) => {
                            Box::new(PackageSource::Registry(Registry::from_registry_spec(url)?))
                        }
                        PackageSourceId::Path(path) => {
                            Box::new(PackageSource::TestRegistry(TestRegistry::new(path.clone())))
                        }
                        PackageSourceId::DefaultRegistry => {
                            panic!("Default registry should never be added as a fallback source!")
                        }
                    };

                    self.sources.insert(fallback.clone(), source);
                    self.source_order.push(fallback);
                }
            }

            source_index += 1;
        }

        Ok(())
    }
}

pub trait PackageSourceProvider: Sync + Send + Clone {
    /// Update this package source, if it has state that needs to be updated.
    fn update(&self) -> anyhow::Result<()>;

    /// Query this package source for all of the packages that match this
    /// `PackageReq`.
    fn query(&self, package_req: &PackageReq) -> anyhow::Result<Vec<Manifest>>;

    /// Downloads the contents of a package given its fully-qualified
    /// `PackageId`.
    fn download_package(&self, package_id: &PackageId) -> anyhow::Result<PackageContents>;

    /// Provide a list of fallback sources to search if this source can't provide a package
    fn fallback_sources(&self) -> anyhow::Result<Vec<PackageSourceId>>;
}

#[derive(Clone)]
pub enum PackageSource {
    InMemory(InMemoryRegistrySource),
    Registry(Registry),
    TestRegistry(TestRegistry),
}

impl PackageSourceProvider for PackageSource {
    fn update(&self) -> anyhow::Result<()> {
        match self {
            PackageSource::InMemory(source) => source.update(),
            PackageSource::Registry(source) => source.update(),
            PackageSource::TestRegistry(source) => source.update(),
        }
    }

    fn query(&self, package_req: &PackageReq) -> anyhow::Result<Vec<Manifest>> {
        match self {
            PackageSource::InMemory(source) => source.query(package_req),
            PackageSource::Registry(source) => source.query(package_req),
            PackageSource::TestRegistry(source) => source.query(package_req),
        }
    }

    fn download_package(&self, package_id: &PackageId) -> anyhow::Result<PackageContents> {
        match self {
            PackageSource::InMemory(source) => source.download_package(package_id),
            PackageSource::Registry(source) => source.download_package(package_id),
            PackageSource::TestRegistry(source) => source.download_package(package_id),
        }
    }

    fn fallback_sources(&self) -> anyhow::Result<Vec<PackageSourceId>> {
        match self {
            PackageSource::InMemory(source) => source.fallback_sources(),
            PackageSource::Registry(source) => source.fallback_sources(),
            PackageSource::TestRegistry(source) => source.fallback_sources(),
        }
    }
}