diff --git a/.github/workflows/permaref.yaml b/.github/workflows/permaref.yaml new file mode 100644 index 00000000..eee99e6f --- /dev/null +++ b/.github/workflows/permaref.yaml @@ -0,0 +1,40 @@ +# Automatically creates a tag for each commit to `main` so when we rebase +# changes on top of the upstream, we retain permanent references to each +# previous commit so they are not orphaned and eventually deleted. +name: Create permanent reference + +on: + push: + branches: + - "main" + +jobs: + create-permaref: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Get the permanent ref number + id: get_version + run: | + # Enable pipefail so git command failures do not result in null versions downstream + set -x + + echo "LAST_PERMA_NUMBER=$(\ + git ls-remote --tags --refs --sort="v:refname" \ + https://github.com/zanieb/pubgrub.git | grep "tags/perma-" | tail -n1 | sed 's/.*\/perma-//' \ + )" >> $GITHUB_OUTPUT + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Create and push the new tag + run: | + TAG="perma-$((LAST_PERMA_NUMBER + 1))" + git tag -a "$TAG" -m 'Automatically created on push to `main`' + git push origin "$TAG" + env: + LAST_PERMA_NUMBER: ${{ steps.get_version.outputs.LAST_PERMA_NUMBER }} diff --git a/src/internal/arena.rs b/src/internal/arena.rs index 6edb85df..826de1a4 100644 --- a/src/internal/arena.rs +++ b/src/internal/arena.rs @@ -10,7 +10,7 @@ use std::ops::{Index, Range}; /// that we actually don't need since it is phantom. /// /// -pub(crate) struct Id { +pub struct Id { raw: u32, _ty: PhantomData T>, } @@ -71,7 +71,7 @@ impl Id { /// to have references between those items. /// They are all dropped at once when the arena is dropped. #[derive(Clone, PartialEq, Eq)] -pub(crate) struct Arena { +pub struct Arena { data: Vec, } diff --git a/src/internal/core.rs b/src/internal/core.rs index 0e30d15c..c098d8b1 100644 --- a/src/internal/core.rs +++ b/src/internal/core.rs @@ -14,12 +14,13 @@ use crate::{DependencyProvider, DerivationTree, Map, NoSolutionError, VersionSet /// Current state of the PubGrub algorithm. #[derive(Clone)] -pub(crate) struct State { +pub struct State { root_package: DP::P, root_version: DP::V, + /// All incompatibilities indexed by package. #[allow(clippy::type_complexity)] - incompatibilities: Map>>, + pub incompatibilities: Map>>, /// Store the ids of incompatibilities that are already contradicted. /// For each one keep track of the decision level when it was found to be contradicted. @@ -32,11 +33,10 @@ pub(crate) struct State { merged_dependencies: Map<(DP::P, DP::P), SmallVec>>, /// Partial solution. - /// TODO: remove pub. - pub(crate) partial_solution: PartialSolution, + pub partial_solution: PartialSolution, /// The store is the reference storage for all incompatibilities. - pub(crate) incompatibility_store: Arena>, + pub incompatibility_store: Arena>, /// This is a stack of work to be done in `unit_propagation`. /// It can definitely be a local variable to that method, but @@ -46,7 +46,7 @@ pub(crate) struct State { impl State { /// Initialization of PubGrub state. - pub(crate) fn init(root_package: DP::P, root_version: DP::V) -> Self { + pub fn init(root_package: DP::P, root_version: DP::V) -> Self { let mut incompatibility_store = Arena::new(); let not_root_id = incompatibility_store.alloc(Incompatibility::not_root( root_package.clone(), @@ -66,8 +66,28 @@ impl State { } } + /// Add the dependencies for the current version of the current package as incompatibilities. + pub fn add_package_version_dependencies( + &mut self, + package: DP::P, + version: DP::V, + dependencies: impl IntoIterator, + ) { + let dep_incompats = self.add_incompatibility_from_dependencies( + package.clone(), + version.clone(), + dependencies, + ); + self.partial_solution.add_package_version_incompatibilities( + package.clone(), + version.clone(), + dep_incompats, + &self.incompatibility_store, + ) + } + /// Add an incompatibility to the state. - pub(crate) fn add_incompatibility(&mut self, incompat: Incompatibility) { + pub fn add_incompatibility(&mut self, incompat: Incompatibility) { let id = self.incompatibility_store.alloc(incompat); self.merge_incompatibility(id); } @@ -98,7 +118,7 @@ impl State { /// Unit propagation is the core mechanism of the solving algorithm. /// CF - pub(crate) fn unit_propagation(&mut self, package: DP::P) -> Result<(), NoSolutionError> { + pub fn unit_propagation(&mut self, package: DP::P) -> Result<(), NoSolutionError> { self.unit_propagation_buffer.clear(); self.unit_propagation_buffer.push(package); while let Some(current_package) = self.unit_propagation_buffer.pop() { diff --git a/src/internal/incompatibility.rs b/src/internal/incompatibility.rs index 33b59cfe..082a0156 100644 --- a/src/internal/incompatibility.rs +++ b/src/internal/incompatibility.rs @@ -28,9 +28,10 @@ use crate::{ /// during conflict resolution. More about all this in /// [PubGrub documentation](https://github.com/dart-lang/pub/blob/master/doc/solver.md#incompatibility). #[derive(Debug, Clone)] -pub(crate) struct Incompatibility { +pub struct Incompatibility { package_terms: SmallMap>, - kind: Kind, + /// The reason for the incompatibility. + pub kind: Kind, } /// Type alias of unique identifiers for incompatibilities. @@ -42,8 +43,9 @@ pub(crate) type IncompDpId = IncompId< ::M, >; +/// The reason for the incompatibility. #[derive(Debug, Clone)] -enum Kind { +pub enum Kind { /// Initial incompatibility aiming at picking the root package for the first decision. /// /// This incompatibility drives the resolution, it requires that we pick the (virtual) root @@ -104,7 +106,7 @@ impl Incompatibilit } /// Create an incompatibility to remember that a given set does not contain any version. - pub(crate) fn no_versions(package: P, term: Term) -> Self { + pub fn no_versions(package: P, term: Term) -> Self { let set = match &term { Term::Positive(r) => r.clone(), Term::Negative(_) => panic!("No version should have a positive term"), @@ -117,7 +119,7 @@ impl Incompatibilit /// Create an incompatibility for a reason outside pubgrub. #[allow(dead_code)] // Used by uv - pub(crate) fn custom_term(package: P, term: Term, metadata: M) -> Self { + pub fn custom_term(package: P, term: Term, metadata: M) -> Self { let set = match &term { Term::Positive(r) => r.clone(), Term::Negative(_) => panic!("No version should have a positive term"), @@ -129,7 +131,7 @@ impl Incompatibilit } /// Create an incompatibility for a reason outside pubgrub. - pub(crate) fn custom_version(package: P, version: VS::V, metadata: M) -> Self { + pub fn custom_version(package: P, version: VS::V, metadata: M) -> Self { let set = VS::singleton(version); let term = Term::Positive(set.clone()); Self { @@ -139,7 +141,7 @@ impl Incompatibilit } /// Build an incompatibility from a given dependency. - pub(crate) fn from_dependency(package: P, versions: VS, dep: (P, VS)) -> Self { + pub fn from_dependency(package: P, versions: VS, dep: (P, VS)) -> Self { let (p2, set2) = dep; Self { package_terms: if set2 == VS::empty() { diff --git a/src/internal/mod.rs b/src/internal/mod.rs index 643634f3..fd5ed9ba 100644 --- a/src/internal/mod.rs +++ b/src/internal/mod.rs @@ -10,8 +10,11 @@ mod small_map; mod small_vec; pub(crate) use arena::{Arena, Id}; -pub(crate) use core::State; -pub(crate) use incompatibility::{IncompDpId, IncompId, Incompatibility, Relation}; +pub(crate) use incompatibility::{IncompDpId, IncompId, Relation}; pub(crate) use partial_solution::{DecisionLevel, PartialSolution, SatisfierSearch}; pub(crate) use small_map::SmallMap; pub(crate) use small_vec::SmallVec; + +// uv-specific additions +pub use core::State; +pub use incompatibility::{Incompatibility, Kind}; diff --git a/src/internal/partial_solution.rs b/src/internal/partial_solution.rs index 44795582..1f605685 100644 --- a/src/internal/partial_solution.rs +++ b/src/internal/partial_solution.rs @@ -9,8 +9,7 @@ use std::hash::BuildHasherDefault; use priority_queue::PriorityQueue; use rustc_hash::FxHasher; -use super::small_vec::SmallVec; -use crate::internal::{Arena, IncompDpId, IncompId, Incompatibility, Relation, SmallMap}; +use crate::internal::{Arena, IncompDpId, IncompId, Incompatibility, Relation, SmallMap, SmallVec}; use crate::{DependencyProvider, Package, SelectedDependencies, Term, VersionSet}; type FnvIndexMap = indexmap::IndexMap>; @@ -27,7 +26,7 @@ impl DecisionLevel { /// The partial solution contains all package assignments, /// organized by package and historically ordered. #[derive(Clone, Debug)] -pub(crate) struct PartialSolution { +pub struct PartialSolution { next_global_index: u32, current_decision_level: DecisionLevel, /// `package_assignments` is primarily a HashMap from a package to its @@ -158,7 +157,7 @@ impl PartialSolution { } /// Add a decision. - pub(crate) fn add_decision(&mut self, package: DP::P, version: DP::V) { + pub fn add_decision(&mut self, package: DP::P, version: DP::V) { // Check that add_decision is never used in the wrong context. if cfg!(debug_assertions) { match self.package_assignments.get_mut(&package) { @@ -257,7 +256,25 @@ impl PartialSolution { } } - pub(crate) fn pick_highest_priority_pkg( + pub fn prioritized_packages(&self) -> impl Iterator { + let check_all = self.changed_this_decision_level + == self.current_decision_level.0.saturating_sub(1) as usize; + let current_decision_level = self.current_decision_level; + self.package_assignments + .get_range(self.changed_this_decision_level..) + .unwrap() + .iter() + .filter(move |(_, pa)| { + // We only actually need to update the package if its Been changed + // since the last time we called prioritize. + // Which means it's highest decision level is the current decision level, + // or if we backtracked in the mean time. + check_all || pa.highest_decision_level == current_decision_level + }) + .filter_map(|(p, pa)| pa.assignments_intersection.potential_package_filter(p)) + } + + pub fn pick_highest_priority_pkg( &mut self, prioritizer: impl Fn(&DP::P, &DP::VS) -> DP::Priority, ) -> Option { @@ -288,7 +305,7 @@ impl PartialSolution { /// If a partial solution has, for every positive derivation, /// a corresponding decision that satisfies that assignment, /// it's a total solution and version solving has succeeded. - pub(crate) fn extract_solution(&self) -> SelectedDependencies { + pub fn extract_solution(&self) -> SelectedDependencies { self.package_assignments .iter() .take(self.current_decision_level.0 as usize) @@ -348,7 +365,7 @@ impl PartialSolution { /// In practice I think it can only produce a conflict if one of the dependencies /// (which are used to make the new incompatibilities) /// is already in the partial solution with an incompatible version. - pub(crate) fn add_version( + pub(crate) fn add_package_version_incompatibilities( &mut self, package: DP::P, version: DP::V, @@ -398,7 +415,7 @@ impl PartialSolution { } /// Retrieve intersection of terms related to package. - pub(crate) fn term_intersection_for_package(&self, package: &DP::P) -> Option<&Term> { + pub fn term_intersection_for_package(&self, package: &DP::P) -> Option<&Term> { self.package_assignments .get(package) .map(|pa| pa.assignments_intersection.term()) @@ -504,6 +521,18 @@ impl PartialSolution { pub(crate) fn current_decision_level(&self) -> DecisionLevel { self.current_decision_level } + + /// Retrieve the constraints on a package that will not change. + pub fn unchanging_term_for_package(&self, package: &DP::P) -> Option<&Term> { + let pa = self.package_assignments.get(package)?; + + let idx_newer = pa + .dated_derivations + .as_slice() + .partition_point(|dd| dd.decision_level <= DecisionLevel(1)); + let idx = idx_newer.checked_sub(1)?; + Some(&pa.dated_derivations[idx].accumulated_intersection) + } } impl PackageAssignments { diff --git a/src/lib.rs b/src/lib.rs index 498b5907..159c7410 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -234,4 +234,7 @@ pub use version_ranges::Ranges; pub use version_ranges::Ranges as Range; pub use version_set::VersionSet; +// uv-specific additions +pub use internal::{Incompatibility, Kind, State}; + mod internal; diff --git a/src/report.rs b/src/report.rs index af232260..d2445225 100644 --- a/src/report.rs +++ b/src/report.rs @@ -144,6 +144,9 @@ impl DerivationTree // // Cannot be merged because the reason may not match DerivationTree::External(External::NoVersions(_, _)) => None, + DerivationTree::External(External::Custom(_, r, reason)) => Some( + DerivationTree::External(External::Custom(package, set.union(&r), reason)), + ), DerivationTree::External(External::FromDependencyOf(p1, r1, p2, r2)) => { if p1 == package { Some(DerivationTree::External(External::FromDependencyOf( @@ -161,8 +164,6 @@ impl DerivationTree ))) } } - // Cannot be merged because the reason may not match - DerivationTree::External(External::Custom(_, _, _)) => None, } } } diff --git a/src/solver.rs b/src/solver.rs index 2abc2e37..87bdad3c 100644 --- a/src/solver.rs +++ b/src/solver.rs @@ -157,15 +157,7 @@ pub fn resolve( }; // Add that package and version if the dependencies are not problematic. - let dep_incompats = - state.add_incompatibility_from_dependencies(p.clone(), v.clone(), dependencies); - - state.partial_solution.add_version( - p.clone(), - v.clone(), - dep_incompats, - &state.incompatibility_store, - ); + state.add_package_version_dependencies(p.clone(), v.clone(), dependencies); } else { // `dep_incompats` are already in `incompatibilities` so we know there are not satisfied // terms and can add the decision directly. diff --git a/src/term.rs b/src/term.rs index f8d51b9e..ec7a7066 100644 --- a/src/term.rs +++ b/src/term.rs @@ -72,7 +72,7 @@ impl Term { /// Unwrap the set contained in a positive term. /// Will panic if used on a negative set. - pub(crate) fn unwrap_positive(&self) -> &VS { + pub fn unwrap_positive(&self) -> &VS { match self { Self::Positive(set) => set, _ => panic!("Negative term cannot unwrap positive set"), diff --git a/tests/examples.rs b/tests/examples.rs index fcc237c1..00547f8d 100644 --- a/tests/examples.rs +++ b/tests/examples.rs @@ -237,13 +237,13 @@ fn confusing_with_lots_of_holes() { }; assert_eq!( &DefaultStringReporter::report(&derivation_tree), - r#"Because there is no available version for bar and foo 1 | 2 | 3 | 4 | 5 depends on bar, foo 1 | 2 | 3 | 4 | 5 is forbidden. -And because there is no version of foo in <1 | >1, <2 | >2, <3 | >3, <4 | >4, <5 | >5 and root 1 depends on foo, root 1 is forbidden."# + r#"Because there is no available version for bar and foo ==1 | ==2 | ==3 | ==4 | ==5 depends on bar, foo ==1 | ==2 | ==3 | ==4 | ==5 is forbidden. +And because there is no version of foo in <1 | >1, <2 | >2, <3 | >3, <4 | >4, <5 | >5 and root ==1 depends on foo, root ==1 is forbidden."# ); derivation_tree.collapse_no_versions(); assert_eq!( &DefaultStringReporter::report(&derivation_tree), - "Because foo depends on bar and root 1 depends on foo, root 1 is forbidden." + "Because foo depends on bar and root ==1 depends on foo, root ==1 is forbidden." ); assert_eq!( derivation_tree.packages(), diff --git a/version-ranges/src/lib.rs b/version-ranges/src/lib.rs index f8847d43..6d7119d7 100644 --- a/version-ranges/src/lib.rs +++ b/version-ranges/src/lib.rs @@ -283,6 +283,36 @@ impl Ranges { } } + /// We want to use `iterator_try_collect`, but since it's unstable at the time of writing, + /// we expose a public `FromIterator<(Bound, Bound)>` method and use this for internal + /// testing. + fn try_from( + into_iter: impl IntoIterator, Bound)>, + ) -> Result { + let mut iter = into_iter.into_iter(); + let Some(mut previous) = iter.next() else { + return Ok(Self { + segments: SmallVec::new(), + }); + }; + let mut segments = SmallVec::with_capacity(iter.size_hint().0); + for current in iter { + if !valid_segment(&previous.start_bound(), &previous.end_bound()) { + return Err(FromIterError::InvalidSegment); + } + if !end_before_start_with_gap(&previous.end_bound(), ¤t.start_bound()) { + return Err(FromIterError::OverlappingSegments); + } + segments.push(previous); + previous = current; + } + if !valid_segment(&previous.start_bound(), &previous.end_bound()) { + return Err(FromIterError::InvalidSegment); + } + segments.push(previous); + Ok(Self { segments }) + } + fn check_invariants(self) -> Self { if cfg!(debug_assertions) { for p in self.segments.as_slice().windows(2) { @@ -826,6 +856,40 @@ impl Ranges { } } +/// User provided segment iterator breaks [`Ranges`] invariants. +/// +/// Not user accessible since `FromIterator<(Bound, Bound)>` panics and `iterator_try_collect` +/// is unstable. +#[derive(Debug, PartialEq, Eq)] +enum FromIterError { + /// The start of a segment must be before its end, and a segment must contain at least one + /// version. + InvalidSegment, + /// The end of a segment is not before the start of the next segment, leaving at least one + /// version space. + OverlappingSegments, +} + +impl Display for FromIterError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + FromIterError::InvalidSegment => f.write_str("segment must be valid"), + FromIterError::OverlappingSegments => { + f.write_str("end of a segment and start of the next segment must not overlap") + } + } + } +} + +impl FromIterator<(Bound, Bound)> for Ranges { + /// Construct a [`Ranges`] from an ordered list of bounds. + /// + /// Panics if the bounds aren't sorted, are empty or have no space to the next bound. + fn from_iter, Bound)>>(iter: T) -> Self { + Self::try_from(iter).unwrap() + } +} + // REPORT ###################################################################### impl Display for Ranges { @@ -844,7 +908,7 @@ impl Display for Ranges { (Included(v), Unbounded) => write!(f, ">={v}")?, (Included(v), Included(b)) => { if v == b { - write!(f, "{v}")? + write!(f, "=={v}")? } else { write!(f, ">={v}, <={b}")? } @@ -1130,6 +1194,24 @@ pub mod tests { } assert!(simp.segments.len() <= range.segments.len()) } + + #[test] + fn from_iter_valid(segments in proptest::collection::vec(any::<(Bound, Bound)>(), ..30)) { + match Ranges::try_from(segments.clone()) { + Ok(ranges) => { + ranges.check_invariants(); + } + Err(_) => { + assert!( + segments + .as_slice() + .windows(2) + .any(|p| !end_before_start_with_gap(&p[0].1, &p[1].0)) + || segments.iter().any(|(start, end)| !valid_segment(start, end)) + ); + } + } + } } #[test] @@ -1194,4 +1276,37 @@ pub mod tests { version_reverse_sorted.sort(); assert_eq!(version_reverse_sorted, versions); } + + /// Test all error conditions in [`Ranges::try_from`]. + #[test] + fn from_iter_errors() { + // Unbounded in not at an end + let result = Ranges::try_from([ + (Bound::Included(1), Bound::Unbounded), + (Bound::Included(2), Bound::Unbounded), + ]); + assert_eq!(result, Err(FromIterError::OverlappingSegments)); + // Not a version in between + let result = Ranges::try_from([ + (Bound::Included(1), Bound::Excluded(2)), + (Bound::Included(2), Bound::Unbounded), + ]); + assert_eq!(result, Err(FromIterError::OverlappingSegments)); + // First segment + let result = Ranges::try_from([(Bound::Excluded(2), Bound::Included(2))]); + assert_eq!(result, Err(FromIterError::InvalidSegment)); + // Middle segment + let result = Ranges::try_from([ + (Bound::Included(1), Bound::Included(2)), + (Bound::Included(3), Bound::Included(2)), + (Bound::Included(4), Bound::Included(5)), + ]); + assert_eq!(result, Err(FromIterError::InvalidSegment)); + // Last segment + let result = Ranges::try_from([ + (Bound::Included(1), Bound::Included(2)), + (Bound::Included(3), Bound::Included(2)), + ]); + assert_eq!(result, Err(FromIterError::InvalidSegment)); + } }