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
use std::sync::Arc;
use wasmer_config::package::PackageSource;
use crate::runtime::resolver::{PackageSummary, QueryError, Source};
/// A [`Source`] that works by querying multiple [`Source`]s in succession.
///
/// # Error Handling
///
/// A [`Source`] implementation can return certain non-fatal errors and,
/// depending on the [`MultiSourceStrategy`], the [`MultiSource`] can choose to
/// deal with it in different ways. Sometimes
///
///
/// The first [`Source`] to return one or more [`Summaries`][PackageSummary]
/// will be treated as the canonical source for that [`Dependency`][dep] and no
/// further [`Source`]s will be queried.
///
/// [dep]: crate::runtime::resolver::Dependency
#[derive(Debug, Clone)]
pub struct MultiSource {
sources: Vec<Arc<dyn Source + Send + Sync>>,
strategy: MultiSourceStrategy,
}
impl Default for MultiSource {
fn default() -> Self {
Self::new()
}
}
impl MultiSource {
pub fn new() -> Self {
MultiSource {
sources: Vec::new(),
strategy: MultiSourceStrategy::default(),
}
}
pub fn add_source(&mut self, source: impl Source + Send + 'static) -> &mut Self {
self.add_shared_source(Arc::new(source))
}
pub fn add_shared_source(&mut self, source: Arc<dyn Source + Send + Sync>) -> &mut Self {
self.sources.push(source);
self
}
/// Override the strategy used when a [`Source`] returns a non-fatal error.
pub fn with_strategy(self, strategy: MultiSourceStrategy) -> Self {
MultiSource { strategy, ..self }
}
}
#[async_trait::async_trait]
impl Source for MultiSource {
#[tracing::instrument(level = "debug", skip_all, fields(%package))]
async fn query(&self, package: &PackageSource) -> Result<Vec<PackageSummary>, QueryError> {
let mut output = Vec::<PackageSummary>::new();
for source in &self.sources {
match source.query(package).await {
Ok(mut summaries) => {
if self.strategy.merge_results {
// Extend matches, but skip already found versions.
summaries.retain(|new| {
!output.iter().any(|existing| new.pkg.id == existing.pkg.id)
});
output.extend(summaries);
} else {
return Ok(summaries);
}
}
Err(QueryError::Unsupported { .. })
if self.strategy.continue_if_unsupported || self.strategy.merge_results =>
{
continue
}
Err(QueryError::NotFound { .. })
if self.strategy.continue_if_not_found || self.strategy.merge_results =>
{
continue
}
Err(QueryError::NoMatches { .. })
if self.strategy.continue_if_no_matches || self.strategy.merge_results =>
{
continue
}
// Generic errors do not respect the `merge_results` strategy
// flag, because unexpected errors should be bubbled to the
// caller.
Err(e) => return Err(e),
}
}
if !output.is_empty() {
output.sort_by(|a, b| a.pkg.id.cmp(&b.pkg.id));
Ok(output)
} else {
Err(QueryError::NotFound {
query: package.clone(),
})
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct MultiSourceStrategy {
/// If encountered, treat [`QueryError::Unsupported`] as a non-fatal error
/// and query the next [`Source`] in turn.
///
/// This flag is **enabled** by default.
pub continue_if_unsupported: bool,
/// If encountered, treat [`QueryError::NotFound`] as a non-fatal error and
/// query the next [`Source`] in turn.
///
/// This flag is **enabled** by default and can be used to let earlier
/// [`Source`]s "override" later ones.
pub continue_if_not_found: bool,
/// If encountered, treat [`QueryError::NoMatches`] as a non-fatal error and
/// query the next [`Source`] in turn.
///
/// This flag is **disabled** by default.
pub continue_if_no_matches: bool,
/// Merge results from all sources into a single result.
///
/// True by default.
pub merge_results: bool,
}
impl Default for MultiSourceStrategy {
fn default() -> Self {
MultiSourceStrategy {
continue_if_unsupported: true,
continue_if_not_found: true,
continue_if_no_matches: true,
merge_results: true,
}
}
}
#[cfg(test)]
mod tests {
use wasmer_config::package::PackageId;
use super::super::{DistributionInfo, InMemorySource, PackageInfo, WebcHash};
use super::*;
/// Test that the `MultiSource` can merge results from multiple sources.
#[tokio::test]
async fn test_multi_source_merge() {
let id1 = PackageId::new_named("ns/pkg", "0.0.1".parse().unwrap());
let pkg1 = PackageSummary {
pkg: PackageInfo {
id: id1.clone(),
commands: Vec::new(),
entrypoint: None,
dependencies: Vec::new(),
filesystem: Vec::new(),
},
dist: DistributionInfo {
webc: "https://example.com/ns/pkg/0.0.1".parse().unwrap(),
webc_sha256: WebcHash([0u8; 32]),
},
};
let id2 = PackageId::new_named("ns/pkg", "0.0.2".parse().unwrap());
let mut pkg2 = pkg1.clone();
pkg2.pkg.id = id2.clone();
let mut mem1 = InMemorySource::new();
mem1.add(pkg1);
let mut mem2 = InMemorySource::new();
mem2.add(pkg2);
let mut multi = MultiSource::new();
multi.add_source(mem1);
multi.add_source(mem2);
let summaries = multi.query(&"ns/pkg".parse().unwrap()).await.unwrap();
assert_eq!(summaries.len(), 2);
assert_eq!(summaries[0].pkg.id, id1);
assert_eq!(summaries[1].pkg.id, id2);
}
}