|
| 1 | +//! This module implements support for preferring some versions of a package |
| 2 | +//! over other versions. |
| 3 | +
|
| 4 | +use std::cmp::Ordering; |
| 5 | +use std::collections::{HashMap, HashSet}; |
| 6 | + |
| 7 | +use crate::core::{Dependency, PackageId, Summary}; |
| 8 | +use crate::util::interning::InternedString; |
| 9 | + |
| 10 | +/// A collection of preferences for particular package versions. |
| 11 | +/// |
| 12 | +/// This is built up with [`prefer_package_id`] and [`prefer_dep`], then used to sort the set of |
| 13 | +/// summaries for a package during resolution via [`sort_summaries`]. |
| 14 | +/// |
| 15 | +/// As written, a version is either "preferred" or "not preferred". Later extensions may |
| 16 | +/// introduce more granular preferences. |
| 17 | +#[derive(Default)] |
| 18 | +pub struct VersionPreferences { |
| 19 | + try_to_use: HashSet<PackageId>, |
| 20 | + prefer_patch_deps: HashMap<InternedString, HashSet<Dependency>>, |
| 21 | +} |
| 22 | + |
| 23 | +pub enum VersionOrdering { |
| 24 | + MaximumVersionsFirst, |
| 25 | + MinimumVersionsFirst, |
| 26 | +} |
| 27 | + |
| 28 | +impl VersionPreferences { |
| 29 | + /// Indicate that the given package (specified as a [`PackageId`]) should be preferred. |
| 30 | + pub fn prefer_package_id(&mut self, pkg_id: PackageId) { |
| 31 | + self.try_to_use.insert(pkg_id); |
| 32 | + } |
| 33 | + |
| 34 | + /// Indicate that the given package (specified as a [`Dependency`]) should be preferred. |
| 35 | + pub fn prefer_dependency(&mut self, dep: Dependency) { |
| 36 | + self.prefer_patch_deps |
| 37 | + .entry(dep.package_name()) |
| 38 | + .or_insert_with(HashSet::new) |
| 39 | + .insert(dep); |
| 40 | + } |
| 41 | + |
| 42 | + /// Sort the given vector of summaries in-place, with all summaries presumed to be for |
| 43 | + /// the same package. Preferred versions appear first in the result, sorted by |
| 44 | + /// `version_ordering`, followed by non-preferred versions sorted the same way. |
| 45 | + pub fn sort_summaries(&self, summaries: &mut Vec<Summary>, version_ordering: VersionOrdering) { |
| 46 | + let should_prefer = |pkg_id: &PackageId| { |
| 47 | + self.try_to_use.contains(pkg_id) |
| 48 | + || self |
| 49 | + .prefer_patch_deps |
| 50 | + .get(&pkg_id.name()) |
| 51 | + .map(|deps| deps.iter().any(|d| d.matches_id(*pkg_id))) |
| 52 | + .unwrap_or(false) |
| 53 | + }; |
| 54 | + summaries.sort_unstable_by(|a, b| { |
| 55 | + let prefer_a = should_prefer(&a.package_id()); |
| 56 | + let prefer_b = should_prefer(&b.package_id()); |
| 57 | + let previous_cmp = prefer_a.cmp(&prefer_b).reverse(); |
| 58 | + match previous_cmp { |
| 59 | + Ordering::Equal => { |
| 60 | + let cmp = a.version().cmp(b.version()); |
| 61 | + match version_ordering { |
| 62 | + VersionOrdering::MaximumVersionsFirst => cmp.reverse(), |
| 63 | + VersionOrdering::MinimumVersionsFirst => cmp, |
| 64 | + } |
| 65 | + } |
| 66 | + _ => previous_cmp, |
| 67 | + } |
| 68 | + }); |
| 69 | + } |
| 70 | +} |
| 71 | + |
| 72 | +#[cfg(test)] |
| 73 | +mod test { |
| 74 | + use super::*; |
| 75 | + use crate::core::SourceId; |
| 76 | + use crate::util::Config; |
| 77 | + use std::collections::BTreeMap; |
| 78 | + |
| 79 | + fn pkgid(name: &str, version: &str) -> PackageId { |
| 80 | + let src_id = |
| 81 | + SourceId::from_url("registry+https://github.com/rust-lang/crates.io-index").unwrap(); |
| 82 | + PackageId::new(name, version, src_id).unwrap() |
| 83 | + } |
| 84 | + |
| 85 | + fn dep(name: &str, version: &str) -> Dependency { |
| 86 | + let src_id = |
| 87 | + SourceId::from_url("registry+https://github.com/rust-lang/crates.io-index").unwrap(); |
| 88 | + Dependency::parse(name, Some(version), src_id).unwrap() |
| 89 | + } |
| 90 | + |
| 91 | + fn summ(name: &str, version: &str) -> Summary { |
| 92 | + let pkg_id = pkgid(name, version); |
| 93 | + let config = Config::default().unwrap(); |
| 94 | + let features = BTreeMap::new(); |
| 95 | + Summary::new(&config, pkg_id, Vec::new(), &features, None::<&String>).unwrap() |
| 96 | + } |
| 97 | + |
| 98 | + fn describe(summaries: &Vec<Summary>) -> String { |
| 99 | + let strs: Vec<String> = summaries |
| 100 | + .iter() |
| 101 | + .map(|summary| format!("{}/{}", summary.name(), summary.version())) |
| 102 | + .collect(); |
| 103 | + strs.join(", ") |
| 104 | + } |
| 105 | + |
| 106 | + #[test] |
| 107 | + fn test_prefer_package_id() { |
| 108 | + let mut vp = VersionPreferences::default(); |
| 109 | + vp.prefer_package_id(pkgid("foo", "1.2.3")); |
| 110 | + |
| 111 | + let mut summaries = vec![ |
| 112 | + summ("foo", "1.2.4"), |
| 113 | + summ("foo", "1.2.3"), |
| 114 | + summ("foo", "1.1.0"), |
| 115 | + summ("foo", "1.0.9"), |
| 116 | + ]; |
| 117 | + |
| 118 | + vp.sort_summaries(&mut summaries, VersionOrdering::MaximumVersionsFirst); |
| 119 | + assert_eq!( |
| 120 | + describe(&summaries), |
| 121 | + "foo/1.2.3, foo/1.2.4, foo/1.1.0, foo/1.0.9".to_string() |
| 122 | + ); |
| 123 | + |
| 124 | + vp.sort_summaries(&mut summaries, VersionOrdering::MinimumVersionsFirst); |
| 125 | + assert_eq!( |
| 126 | + describe(&summaries), |
| 127 | + "foo/1.2.3, foo/1.0.9, foo/1.1.0, foo/1.2.4".to_string() |
| 128 | + ); |
| 129 | + } |
| 130 | + |
| 131 | + #[test] |
| 132 | + fn test_prefer_dependency() { |
| 133 | + let mut vp = VersionPreferences::default(); |
| 134 | + vp.prefer_dependency(dep("foo", "=1.2.3")); |
| 135 | + |
| 136 | + let mut summaries = vec![ |
| 137 | + summ("foo", "1.2.4"), |
| 138 | + summ("foo", "1.2.3"), |
| 139 | + summ("foo", "1.1.0"), |
| 140 | + summ("foo", "1.0.9"), |
| 141 | + ]; |
| 142 | + |
| 143 | + vp.sort_summaries(&mut summaries, VersionOrdering::MaximumVersionsFirst); |
| 144 | + assert_eq!( |
| 145 | + describe(&summaries), |
| 146 | + "foo/1.2.3, foo/1.2.4, foo/1.1.0, foo/1.0.9".to_string() |
| 147 | + ); |
| 148 | + |
| 149 | + vp.sort_summaries(&mut summaries, VersionOrdering::MinimumVersionsFirst); |
| 150 | + assert_eq!( |
| 151 | + describe(&summaries), |
| 152 | + "foo/1.2.3, foo/1.0.9, foo/1.1.0, foo/1.2.4".to_string() |
| 153 | + ); |
| 154 | + } |
| 155 | + |
| 156 | + #[test] |
| 157 | + fn test_prefer_both() { |
| 158 | + let mut vp = VersionPreferences::default(); |
| 159 | + vp.prefer_package_id(pkgid("foo", "1.2.3")); |
| 160 | + vp.prefer_dependency(dep("foo", "=1.1.0")); |
| 161 | + |
| 162 | + let mut summaries = vec![ |
| 163 | + summ("foo", "1.2.4"), |
| 164 | + summ("foo", "1.2.3"), |
| 165 | + summ("foo", "1.1.0"), |
| 166 | + summ("foo", "1.0.9"), |
| 167 | + ]; |
| 168 | + |
| 169 | + vp.sort_summaries(&mut summaries, VersionOrdering::MaximumVersionsFirst); |
| 170 | + assert_eq!( |
| 171 | + describe(&summaries), |
| 172 | + "foo/1.2.3, foo/1.1.0, foo/1.2.4, foo/1.0.9".to_string() |
| 173 | + ); |
| 174 | + |
| 175 | + vp.sort_summaries(&mut summaries, VersionOrdering::MinimumVersionsFirst); |
| 176 | + assert_eq!( |
| 177 | + describe(&summaries), |
| 178 | + "foo/1.1.0, foo/1.2.3, foo/1.0.9, foo/1.2.4".to_string() |
| 179 | + ); |
| 180 | + } |
| 181 | +} |
0 commit comments