Skip override resolution in lock

astral-sh · Aug 21, 2024 · 06baf49 · 06baf49
1 parent 6f34a25
commit 06baf49
Show file tree

Hide file tree

Showing 14 changed files with 224 additions and 9 deletions.
diff --git a/crates/uv-resolver/src/lock.rs b/crates/uv-resolver/src/lock.rs
@@ -567,6 +567,26 @@ impl Lock {
                 );
             }
 
+            if !self.manifest.requirements.is_empty() {
+                let requirements = self
+                    .manifest
+                    .requirements
+                    .iter()
+                    .map(|requirement| {
+                        serde::Serialize::serialize(
+                            &requirement,
+                            toml_edit::ser::ValueSerializer::new(),
+                        )
+                    })
+                    .collect::<Result<Vec<_>, _>>()?;
+                let requirements = match requirements.as_slice() {
+                    [] => Array::new(),
+                    [requirement] => Array::from_iter([requirement]),
+                    requirements => each_element_on_its_line_array(requirements.iter()),
+                };
+                manifest_table.insert("requirements", value(requirements));
+            }
+
             if !self.manifest.constraints.is_empty() {
                 let constraints = self
                     .manifest
@@ -657,6 +677,7 @@ impl Lock {
         &self,
         workspace: &Workspace,
         members: &[PackageName],
+        requirements: &[Requirement],
         constraints: &[Requirement],
         overrides: &[Requirement],
         indexes: Option<&IndexLocations>,
@@ -679,6 +700,29 @@ impl Lock {
             }
         }
 
+        // Validate that the lockfile was generated with the same requirements.
+        {
+            let expected: BTreeSet<_> = requirements
+                .iter()
+                .cloned()
+                .map(|requirement| normalize_requirement(requirement, workspace))
+                .collect::<Result<_, _>>()?;
+            let actual: BTreeSet<_> = self
+                .manifest
+                .requirements
+                .iter()
+                .cloned()
+                .map(|requirement| normalize_requirement(requirement, workspace))
+                .collect::<Result<_, _>>()?;
+            if expected != actual {
+                debug!(
+                    "Mismatched requirements:\n  expected: {:?}\n  found: {:?}",
+                    expected, actual
+                );
+                return Ok(SatisfiesResult::MismatchedConstraints(expected, actual));
+            }
+        }
+
         // Validate that the lockfile was generated with the same constraints.
         {
             let expected: BTreeSet<_> = constraints
@@ -901,6 +945,8 @@ pub enum SatisfiesResult<'lock> {
     Satisfied,
     /// The lockfile uses a different set of workspace members.
     MismatchedMembers(BTreeSet<PackageName>, &'lock BTreeSet<PackageName>),
+    /// The lockfile uses a different set of requirements.
+    MismatchedRequirements(BTreeSet<Requirement>, BTreeSet<Requirement>),
     /// The lockfile uses a different set of constraints.
     MismatchedConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
     /// The lockfile uses a different set of overrides.
@@ -947,6 +993,9 @@ pub struct ResolverManifest {
     /// The workspace members included in the lockfile.
     #[serde(default)]
     members: BTreeSet<PackageName>,
+    /// The requirements provided to the resolver, exclusive of the workspace members.
+    #[serde(default)]
+    requirements: BTreeSet<Requirement>,
     /// The constraints provided to the resolver.
     #[serde(default)]
     constraints: BTreeSet<Requirement>,
@@ -958,11 +1007,13 @@ pub struct ResolverManifest {
 impl ResolverManifest {
     pub fn new(
         members: impl IntoIterator<Item = PackageName>,
+        requirements: impl IntoIterator<Item = Requirement>,
         constraints: impl IntoIterator<Item = Requirement>,
         overrides: impl IntoIterator<Item = Requirement>,
     ) -> Self {
         Self {
             members: members.into_iter().collect(),
+            requirements: requirements.into_iter().collect(),
             constraints: constraints.into_iter().collect(),
             overrides: overrides.into_iter().collect(),
         }

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_optional_missing.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_optional_missing.snap
@@ -79,6 +79,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_optional_present.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_optional_present.snap
@@ -86,6 +86,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_required_present.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_required_present.snap
@@ -82,6 +82,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/...solver/src/snapshots/uv_resolver__lock__tests__missing_dependency_source_unambiguous.snap b/...solver/src/snapshots/uv_resolver__lock__tests__missing_dependency_source_unambiguous.snap
@@ -141,6 +141,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/...rc/snapshots/uv_resolver__lock__tests__missing_dependency_source_version_unambiguous.snap b/...rc/snapshots/uv_resolver__lock__tests__missing_dependency_source_version_unambiguous.snap
@@ -141,6 +141,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/...olver/src/snapshots/uv_resolver__lock__tests__missing_dependency_version_unambiguous.snap b/...olver/src/snapshots/uv_resolver__lock__tests__missing_dependency_version_unambiguous.snap
@@ -141,6 +141,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_direct_has_subdir.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_direct_has_subdir.snap
@@ -63,6 +63,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_direct_no_subdir.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_direct_no_subdir.snap
@@ -59,6 +59,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_directory.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_directory.snap
@@ -49,6 +49,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_editable.snap b/crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__source_editable.snap
@@ -49,6 +49,7 @@ Ok(
         },
         manifest: ResolverManifest {
             members: {},
+            requirements: {},
             constraints: {},
             overrides: {},
         },

diff --git a/crates/uv/src/commands/project/lock.rs b/crates/uv/src/commands/project/lock.rs
@@ -249,11 +249,8 @@ async fn do_lock(
         sources,
     } = settings;
 
-    // When locking, include the project itself (as editable).
-    let requirements = workspace
-        .members_requirements()
-        .chain(workspace.root_requirements())
-        .collect::<Vec<_>>();
+    // Collect the requirements, etc.
+    let requirements = workspace.root_requirements().collect::<Vec<_>>();
     let overrides = workspace.overrides().into_iter().collect::<Vec<_>>();
     let constraints = workspace.constraints();
     let dev = vec![DEV_DEPENDENCIES.clone()];
@@ -413,6 +410,7 @@ async fn do_lock(
             existing_lock,
             workspace,
             &members,
+            &requirements,
             &constraints,
             &overrides,
             environments,
@@ -486,9 +484,9 @@ async fn do_lock(
 
             // Resolve the requirements.
             let resolution = pip::operations::resolve(
-                requirements
-                    .iter()
-                    .cloned()
+                workspace
+                    .members_requirements()
+                    .chain(requirements.iter().cloned())
                     .map(UnresolvedRequirementSpecification::from)
                     .collect(),
                 constraints.clone(),
@@ -529,7 +527,12 @@ async fn do_lock(
 
             let previous = existing_lock.map(ValidatedLock::into_lock);
             let lock = Lock::from_resolution_graph(&resolution)?
-                .with_manifest(ResolverManifest::new(members, constraints, overrides))
+                .with_manifest(ResolverManifest::new(
+                    members,
+                    requirements,
+                    constraints,
+                    overrides,
+                ))
                 .with_supported_environments(
                     environments
                         .cloned()
@@ -559,6 +562,7 @@ impl ValidatedLock {
         lock: Lock,
         workspace: &Workspace,
         members: &[PackageName],
+        requirements: &[Requirement],
         constraints: &[Requirement],
         overrides: &[Requirement],
         environments: Option<&SupportedEnvironments>,
@@ -679,6 +683,7 @@ impl ValidatedLock {
             .satisfies(
                 workspace,
                 members,
+                requirements,
                 constraints,
                 overrides,
                 indexes,
@@ -698,6 +703,13 @@ impl ValidatedLock {
                 );
                 Ok(Self::Preferable(lock))
             }
+            SatisfiesResult::MismatchedRequirements(expected, actual) => {
+                debug!(
+                    "Ignoring existing lockfile due to mismatched requirements:\n  Expected: {:?}\n  Actual: {:?}",
+                    expected, actual
+                );
+                Ok(Self::Preferable(lock))
+            }
             SatisfiesResult::MismatchedConstraints(expected, actual) => {
                 debug!(
                     "Ignoring existing lockfile due to mismatched constraints:\n  Expected: {:?}\n  Actual: {:?}",

diff --git a/crates/uv/tests/edit.rs b/crates/uv/tests/edit.rs
@@ -3227,6 +3227,9 @@ fn add_virtual() -> Result<()> {
         [options]
         exclude-newer = "2024-03-25T00:00:00Z"
 
+        [manifest]
+        requirements = [{ name = "iniconfig" }]
+
         [[package]]
         name = "iniconfig"
         version = "2.0.0"