Skip to main content

lux_lib/manifest/
mod.rs

1use miette::Diagnostic;
2use path_slash::PathExt;
3use thiserror::Error;
4use url::Url;
5
6pub use crate::manifest::metadata::*;
7use crate::manifest::metadata_from_server::*;
8use crate::manifest::metadata_from_vendor_dir::manifest_from_vendor_dir;
9use crate::package::{RemotePackageType, RemotePackageTypeFilterSpec};
10use crate::{
11    config::Config,
12    package::{PackageReq, RemotePackage},
13    remote_package_source::RemotePackageSource,
14};
15
16pub mod metadata;
17mod metadata_from_server;
18mod metadata_from_vendor_dir;
19
20#[derive(Error, Debug, Diagnostic)]
21#[non_exhaustive]
22pub enum ManifestError {
23    #[error(transparent)]
24    #[diagnostic(transparent)]
25    Lua(#[from] ManifestLuaError),
26    #[error("failed to fetch manifest from {url}:\n{source}")]
27    #[diagnostic(forward(source))]
28    Server {
29        url: String,
30        source: Box<ManifestFromServerError>,
31    },
32    #[error("error parsing URL from `vendor-dir`: {0}:")]
33    Vendor(String),
34}
35
36#[derive(Clone, Debug)]
37pub(crate) struct Manifest {
38    server_url: Url,
39    metadata: ManifestMetadata,
40}
41
42impl Manifest {
43    pub fn new(server_url: Url, metadata: ManifestMetadata) -> Self {
44        Self {
45            server_url,
46            metadata,
47        }
48    }
49
50    #[tracing::instrument(level = "trace", skip(config))]
51    pub async fn from_config(server_url: Url, config: &Config) -> Result<Self, ManifestError> {
52        if let Some(vendor_dir) = config.vendor_dir() {
53            let server_url: Url = Url::from_file_path(vendor_dir)
54                .map_err(|_err| ManifestError::Vendor(vendor_dir.to_slash_lossy().to_string()))?;
55            return Ok(Self::new(server_url, manifest_from_vendor_dir(vendor_dir)));
56        }
57        let content = manifest_from_cache_or_server(&server_url, config)
58            .await
59            .map_err(|source| ManifestError::Server {
60                url: server_url.to_string(),
61                source: Box::new(source),
62            })?;
63        match ManifestMetadata::new(&content) {
64            Ok(metadata) => Ok(Self::new(server_url, metadata)),
65            Err(_) => {
66                let manifest = manifest_from_server_only(&server_url, config)
67                    .await
68                    .map_err(|source| ManifestError::Server {
69                        url: server_url.to_string(),
70                        source: Box::new(source),
71                    })?;
72                Ok(Self::new(server_url, ManifestMetadata::new(&manifest)?))
73            }
74        }
75    }
76
77    pub fn server_url(&self) -> &Url {
78        &self.server_url
79    }
80
81    pub fn metadata(&self) -> &ManifestMetadata {
82        &self.metadata
83    }
84
85    /// Find a package that matches the requirement, returning the latest match
86    pub fn find(
87        &self,
88        package_req: &PackageReq,
89        filter: Option<RemotePackageTypeFilterSpec>,
90    ) -> Option<RemotePackage> {
91        match self.metadata().latest_match(package_req, filter) {
92            None => None,
93            Some((package, package_type)) => {
94                let remote_source = match package_type {
95                    RemotePackageType::Rockspec => {
96                        RemotePackageSource::LuarocksRockspec(self.server_url().clone())
97                    }
98                    RemotePackageType::Src => {
99                        RemotePackageSource::LuarocksSrcRock(self.server_url().clone())
100                    }
101                    RemotePackageType::Binary => {
102                        RemotePackageSource::LuarocksBinaryRock(self.server_url().clone())
103                    }
104                };
105                Some(RemotePackage::new(package, remote_source, None))
106            }
107        }
108    }
109}