Skip to content

Commit

Permalink
Invalidate lockfile when member versions change (#7102)
Browse files Browse the repository at this point in the history 
## Summary

Closes #7101.

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
  • Loading branch information
@charliermarsh @zanieb
charliermarsh and zanieb authored Sep 5, 2024
1 parent 29f53c3 commit 58b25b5
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 3 deletions.
30 changes: 28 additions & 2 deletions crates/uv-resolver/src/lock/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -897,9 +897,9 @@ impl Lock {
}
}

// Validate that the member sources have not changed (e.g., switched from packaged to
// virtual).
// Validate that the member sources have not changed.
{
// E.g., that they've switched from virtual to non-virtual or vice versa.
for (name, member) in workspace.packages() {
let expected = !member.pyproject_toml().is_package();
let actual = self
Expand All @@ -911,6 +911,30 @@ impl Lock {
return Ok(SatisfiesResult::MismatchedSources(name.clone(), expected));
}
}

// E.g., that the version has changed.
for (name, member) in workspace.packages() {
let Some(expected) = member
.pyproject_toml()
.project
.as_ref()
.and_then(|project| project.version.as_ref())
else {
continue;
};
let actual = self
.find_by_name(name)
.ok()
.flatten()
.map(|package| &package.id.version);
if actual.map_or(true, |actual| actual != expected) {
return Ok(SatisfiesResult::MismatchedVersion(
name.clone(),
expected.clone(),
actual.cloned(),
));
}
}
}

// Validate that the lockfile was generated with the same requirements.
Expand Down Expand Up @@ -1194,6 +1218,8 @@ pub enum SatisfiesResult<'lock> {
MismatchedMembers(BTreeSet<PackageName>, &'lock BTreeSet<PackageName>),
/// The lockfile uses a different set of sources for its workspace members.
MismatchedSources(PackageName, bool),
/// The lockfile uses a different set of version for its workspace members.
MismatchedVersion(PackageName, Version, Option<Version>),
/// The lockfile uses a different set of requirements.
MismatchedRequirements(BTreeSet<Requirement>, BTreeSet<Requirement>),
/// The lockfile uses a different set of constraints.
Expand Down
4 changes: 3 additions & 1 deletion crates/uv-workspace/src/pyproject.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use serde::{Deserialize, Serialize};
use thiserror::Error;
use url::Url;

use pep440_rs::VersionSpecifiers;
use pep440_rs::{Version, VersionSpecifiers};
use pypi_types::{RequirementSource, SupportedEnvironments, VerbatimParsedUrl};
use uv_fs::relative_to;
use uv_git::GitReference;
Expand Down Expand Up @@ -87,6 +87,8 @@ impl AsRef<[u8]> for PyProjectToml {
pub struct Project {
/// The name of the project
pub name: PackageName,
/// The version of the project
pub version: Option<Version>,
/// The Python versions this project is compatible with.
pub requires_python: Option<VersionSpecifiers>,
/// The optional dependencies of the project.
Expand Down
13 changes: 13 additions & 0 deletions crates/uv-workspace/src/workspace.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1581,6 +1581,7 @@ mod tests {
"root": "[ROOT]/albatross-in-example/examples/bird-feeder",
"project": {
"name": "bird-feeder",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1591,6 +1592,7 @@ mod tests {
"pyproject_toml": {
"project": {
"name": "bird-feeder",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand Down Expand Up @@ -1624,6 +1626,7 @@ mod tests {
"root": "[ROOT]/albatross-project-in-excluded/excluded/bird-feeder",
"project": {
"name": "bird-feeder",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1634,6 +1637,7 @@ mod tests {
"pyproject_toml": {
"project": {
"name": "bird-feeder",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand Down Expand Up @@ -1666,6 +1670,7 @@ mod tests {
"root": "[ROOT]/albatross-root-workspace",
"project": {
"name": "albatross",
"version": "0.1.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1675,6 +1680,7 @@ mod tests {
"root": "[ROOT]/albatross-root-workspace/packages/bird-feeder",
"project": {
"name": "bird-feeder",
"version": "1.0.0",
"requires-python": ">=3.8",
"optional-dependencies": null
},
Expand All @@ -1684,6 +1690,7 @@ mod tests {
"root": "[ROOT]/albatross-root-workspace/packages/seeds",
"project": {
"name": "seeds",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1698,6 +1705,7 @@ mod tests {
"pyproject_toml": {
"project": {
"name": "albatross",
"version": "0.1.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand Down Expand Up @@ -1751,6 +1759,7 @@ mod tests {
"root": "[ROOT]/albatross-virtual-workspace/packages/albatross",
"project": {
"name": "albatross",
"version": "0.1.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1760,6 +1769,7 @@ mod tests {
"root": "[ROOT]/albatross-virtual-workspace/packages/bird-feeder",
"project": {
"name": "bird-feeder",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1769,6 +1779,7 @@ mod tests {
"root": "[ROOT]/albatross-virtual-workspace/packages/seeds",
"project": {
"name": "seeds",
"version": "1.0.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand Down Expand Up @@ -1823,6 +1834,7 @@ mod tests {
"root": "[ROOT]/albatross-just-project",
"project": {
"name": "albatross",
"version": "0.1.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand All @@ -1833,6 +1845,7 @@ mod tests {
"pyproject_toml": {
"project": {
"name": "albatross",
"version": "0.1.0",
"requires-python": ">=3.12",
"optional-dependencies": null
},
Expand Down
12 changes: 12 additions & 0 deletions crates/uv/src/commands/project/lock.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -739,6 +739,18 @@ impl ValidatedLock {
}
Ok(Self::Preferable(lock))
}
SatisfiesResult::MismatchedVersion(name, expected, actual) => {
if let Some(actual) = actual {
debug!(
"Ignoring existing lockfile due to mismatched version: `{name}` (expected: `{expected}`, found: `{actual}`)"
);
} else {
debug!(
"Ignoring existing lockfile due to mismatched version: `{name}` (expected: `{expected}`)"
);
}
Ok(Self::Preferable(lock))
}
SatisfiesResult::MismatchedRequirements(expected, actual) => {
debug!(
"Ignoring existing lockfile due to mismatched requirements:\n Expected: {:?}\n Actual: {:?}",
Expand Down
66 changes: 66 additions & 0 deletions crates/uv/tests/sync.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1892,6 +1892,72 @@ fn sync_virtual_env_warning() -> Result<()> {
Ok(())
}

#[test]
fn sync_update_project() -> Result<()> {
let context = TestContext::new_with_versions(&["3.12"]);

let pyproject_toml = context.temp_dir.child("pyproject.toml");
pyproject_toml.write_str(
r#"
[project]
name = "my-project"
version = "0.1.0"
requires-python = ">=3.12"
dependencies = ["iniconfig"]
[build-system]
requires = ["setuptools>=42"]
build-backend = "setuptools.build_meta"
"#,
)?;

uv_snapshot!(context.filters(), context.sync(), @r###"
success: true
exit_code: 0
----- stdout -----
----- stderr -----
Using Python 3.12.[X] interpreter at: [PYTHON-3.12]
Creating virtualenv at: .venv
Resolved 2 packages in [TIME]
Prepared 2 packages in [TIME]
Installed 2 packages in [TIME]
+ iniconfig==2.0.0
+ my-project==0.1.0 (from file://[TEMP_DIR]/)
"###);

// Bump the project version.
pyproject_toml.write_str(
r#"
[project]
name = "my-project"
version = "0.2.0"
requires-python = ">=3.12"
dependencies = ["iniconfig"]
[build-system]
requires = ["setuptools>=42"]
build-backend = "setuptools.build_meta"
"#,
)?;

uv_snapshot!(context.filters(), context.sync(), @r###"
success: true
exit_code: 0
----- stdout -----
----- stderr -----
Resolved 2 packages in [TIME]
Prepared 1 package in [TIME]
Uninstalled 1 package in [TIME]
Installed 1 package in [TIME]
- my-project==0.1.0 (from file://[TEMP_DIR]/)
+ my-project==0.2.0 (from file://[TEMP_DIR]/)
"###);

Ok(())
}

#[test]
fn sync_environment_prompt() -> Result<()> {
let context = TestContext::new_with_versions(&["3.12"]);
Expand Down

0 comments on commit 58b25b5

Please sign in to comment.