Use lockfile versions as resolution preferences (#3921)

charliermarsh · web-flow · commit 144566907e1d · 2024-05-30T17:59:53.000Z
## Summary Ensures that we avoid upgrading packages unless `--upgrade` or similar is passed. For now, the resolver only respects these for registry distributions. Closes #3918.
diff --git a/crates/uv-resolver/src/lock.rs b/crates/uv-resolver/src/lock.rs
@@ -52,6 +52,11 @@ impl Lock {
         Lock::try_from(wire)
     }
 
+    /// Returns the [`Distribution`] entries in this lock.
+    pub fn distributions(&self) -> &[Distribution] {
+        &self.distributions
+    }
+
     pub fn to_resolution(
         &self,
         marker_env: &MarkerEnvironment,
@@ -202,7 +207,7 @@ impl TryFrom<LockWire> for Lock {
 }
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
-pub(crate) struct Distribution {
+pub struct Distribution {
     #[serde(flatten)]
     pub(crate) id: DistributionId,
     #[serde(default)]
diff --git a/crates/uv-resolver/src/preferences.rs b/crates/uv-resolver/src/preferences.rs
@@ -86,6 +86,16 @@ impl Preference {
         }
     }
 
+    /// Create a [`Preference`] from a locked distribution.
+    pub fn from_lock(dist: &crate::lock::Distribution) -> Self {
+        Self {
+            name: dist.id.name.clone(),
+            version: dist.id.version.clone(),
+            marker: None,
+            hashes: Vec::new(),
+        }
+    }
+
     /// Return the [`PackageName`] of the package for this [`Preference`].
     pub fn name(&self) -> &PackageName {
         &self.name
diff --git a/crates/uv/src/cli.rs b/crates/uv/src/cli.rs
@@ -372,8 +372,6 @@ pub(crate) struct PipCompileArgs {
     #[arg(long, env = "UV_CUSTOM_COMPILE_COMMAND")]
     pub(crate) custom_compile_command: Option<String>,
 
-    /// Run offline, i.e., without accessing the network.
-
     /// Refresh all cached data.
     #[arg(long, conflicts_with("offline"), overrides_with("no_refresh"))]
     pub(crate) refresh: bool,
@@ -1786,6 +1784,33 @@ pub(crate) struct RunArgs {
     #[arg(long)]
     pub(crate) with: Vec<String>,
 
+    /// Refresh all cached data.
+    #[arg(long, conflicts_with("offline"), overrides_with("no_refresh"))]
+    pub(crate) refresh: bool,
+
+    #[arg(
+        long,
+        conflicts_with("offline"),
+        overrides_with("refresh"),
+        hide = true
+    )]
+    pub(crate) no_refresh: bool,
+
+    /// Refresh cached data for a specific package.
+    #[arg(long)]
+    pub(crate) refresh_package: Vec<PackageName>,
+
+    /// Allow package upgrades, ignoring pinned versions in the existing lockfile.
+    #[arg(long, short = 'U', overrides_with("no_upgrade"))]
+    pub(crate) upgrade: bool,
+
+    #[arg(long, overrides_with("upgrade"), hide = true)]
+    pub(crate) no_upgrade: bool,
+
+    /// Allow upgrades for a specific package, ignoring pinned versions in the existing lockfile.
+    #[arg(long, short = 'P')]
+    pub(crate) upgrade_package: Vec<PackageName>,
+
     /// The Python interpreter to use to build the run environment.
     ///
     /// By default, `uv` uses the virtual environment in the current working directory or any parent
@@ -1822,6 +1847,22 @@ pub(crate) struct SyncArgs {
     #[arg(long, overrides_with("all_extras"), hide = true)]
     pub(crate) no_all_extras: bool,
 
+    /// Refresh all cached data.
+    #[arg(long, conflicts_with("offline"), overrides_with("no_refresh"))]
+    pub(crate) refresh: bool,
+
+    #[arg(
+        long,
+        conflicts_with("offline"),
+        overrides_with("refresh"),
+        hide = true
+    )]
+    pub(crate) no_refresh: bool,
+
+    /// Refresh cached data for a specific package.
+    #[arg(long)]
+    pub(crate) refresh_package: Vec<PackageName>,
+
     /// The Python interpreter to use to build the run environment.
     ///
     /// By default, `uv` uses the virtual environment in the current working directory or any parent
@@ -1840,6 +1881,33 @@ pub(crate) struct SyncArgs {
 #[derive(Args)]
 #[allow(clippy::struct_excessive_bools)]
 pub(crate) struct LockArgs {
+    /// Refresh all cached data.
+    #[arg(long, conflicts_with("offline"), overrides_with("no_refresh"))]
+    pub(crate) refresh: bool,
+
+    #[arg(
+        long,
+        conflicts_with("offline"),
+        overrides_with("refresh"),
+        hide = true
+    )]
+    pub(crate) no_refresh: bool,
+
+    /// Refresh cached data for a specific package.
+    #[arg(long)]
+    pub(crate) refresh_package: Vec<PackageName>,
+
+    /// Allow package upgrades, ignoring pinned versions in the existing lockfile.
+    #[arg(long, short = 'U', overrides_with("no_upgrade"))]
+    pub(crate) upgrade: bool,
+
+    #[arg(long, overrides_with("upgrade"), hide = true)]
+    pub(crate) no_upgrade: bool,
+
+    /// Allow upgrades for a specific package, ignoring pinned versions in the existing lockfile.
+    #[arg(long, short = 'P')]
+    pub(crate) upgrade_package: Vec<PackageName>,
+
     /// The Python interpreter to use to build the run environment.
     ///
     /// By default, `uv` uses the virtual environment in the current working directory or any parent
diff --git a/crates/uv/src/commands/project/lock.rs b/crates/uv/src/commands/project/lock.rs
@@ -12,7 +12,7 @@ use uv_configuration::{
 use uv_dispatch::BuildDispatch;
 use uv_interpreter::PythonEnvironment;
 use uv_requirements::ProjectWorkspace;
-use uv_resolver::{ExcludeNewer, FlatIndex, InMemoryIndex, Lock, OptionsBuilder};
+use uv_resolver::{ExcludeNewer, FlatIndex, InMemoryIndex, Lock, OptionsBuilder, Preference};
 use uv_types::{BuildIsolation, EmptyInstalledPackages, HashStrategy, InFlight};
 use uv_warnings::warn_user;
 
@@ -23,6 +23,7 @@ use crate::printer::Printer;
 /// Resolve the project requirements into a lockfile.
 #[allow(clippy::too_many_arguments)]
 pub(crate) async fn lock(
+    upgrade: Upgrade,
     exclude_newer: Option<ExcludeNewer>,
     preview: PreviewMode,
     cache: &Cache,
@@ -39,7 +40,7 @@ pub(crate) async fn lock(
     let venv = project::init_environment(&project, preview, cache, printer)?;
 
     // Perform the lock operation.
-    match do_lock(&project, &venv, exclude_newer, cache, printer).await {
+    match do_lock(&project, &venv, upgrade, exclude_newer, cache, printer).await {
         Ok(_) => Ok(ExitStatus::Success),
         Err(ProjectError::Operation(pip::operations::Error::Resolve(
             uv_resolver::ResolveError::NoSolution(err),
@@ -57,6 +58,7 @@ pub(crate) async fn lock(
 pub(super) async fn do_lock(
     project: &ProjectWorkspace,
     venv: &PythonEnvironment,
+    upgrade: Upgrade,
     exclude_newer: Option<ExcludeNewer>,
     cache: &Cache,
     printer: Printer,
@@ -96,14 +98,34 @@ pub(super) async fn do_lock(
     let link_mode = LinkMode::default();
     let no_binary = NoBinary::default();
     let no_build = NoBuild::default();
-    let preferences = Vec::default();
     let reinstall = Reinstall::default();
     let setup_py = SetupPyStrategy::default();
-    let upgrade = Upgrade::default();
 
     let hasher = HashStrategy::Generate;
     let options = OptionsBuilder::new().exclude_newer(exclude_newer).build();
 
+    // If an existing lockfile exists, build up a set of preferences.
+    let lockfile = project.workspace().root().join("uv.lock");
+    let lock = match fs_err::tokio::read_to_string(&lockfile).await {
+        Ok(encoded) => match toml::from_str::<Lock>(&encoded) {
+            Ok(lock) => Some(lock),
+            Err(err) => {
+                eprint!("Failed to parse lockfile; ignoring locked requirements: {err}");
+                None
+            }
+        },
+        Err(err) if err.kind() == std::io::ErrorKind::NotFound => None,
+        Err(err) => return Err(err.into()),
+    };
+    let preferences: Vec<Preference> = lock
+        .map(|lock| {
+            lock.distributions()
+                .iter()
+                .map(Preference::from_lock)
+                .collect()
+        })
+        .unwrap_or_default();
+
     // Create a build dispatch.
     let build_dispatch = BuildDispatch::new(
         &client,
diff --git a/crates/uv/src/commands/project/run.rs b/crates/uv/src/commands/project/run.rs
@@ -9,7 +9,7 @@ use tracing::debug;
 
 use uv_cache::Cache;
 use uv_client::Connectivity;
-use uv_configuration::{ExtrasSpecification, PreviewMode};
+use uv_configuration::{ExtrasSpecification, PreviewMode, Upgrade};
 use uv_interpreter::{PythonEnvironment, SystemPython};
 use uv_requirements::{ProjectWorkspace, RequirementsSource};
 use uv_resolver::ExcludeNewer;
@@ -26,6 +26,7 @@ pub(crate) async fn run(
     mut args: Vec<OsString>,
     requirements: Vec<RequirementsSource>,
     python: Option<String>,
+    upgrade: Upgrade,
     exclude_newer: Option<ExcludeNewer>,
     isolated: bool,
     preview: PreviewMode,
@@ -47,7 +48,8 @@ pub(crate) async fn run(
         let venv = project::init_environment(&project, preview, cache, printer)?;
 
         // Lock and sync the environment.
-        let lock = project::lock::do_lock(&project, &venv, exclude_newer, cache, printer).await?;
+        let lock =
+            project::lock::do_lock(&project, &venv, upgrade, exclude_newer, cache, printer).await?;
         project::sync::do_sync(&project, &venv, &lock, extras, cache, printer).await?;
 
         Some(venv)
diff --git a/crates/uv/src/main.rs b/crates/uv/src/main.rs
@@ -550,7 +550,7 @@ async fn run() -> Result<ExitStatus> {
             let args = settings::RunSettings::resolve(args, workspace);
 
             // Initialize the cache.
-            let cache = cache.init()?;
+            let cache = cache.init()?.with_refresh(args.refresh);
 
             let requirements = args
                 .with
@@ -578,6 +578,7 @@ async fn run() -> Result<ExitStatus> {
                 args.args,
                 requirements,
                 args.python,
+                args.upgrade,
                 args.exclude_newer,
                 globals.isolated,
                 globals.preview,
@@ -592,7 +593,7 @@ async fn run() -> Result<ExitStatus> {
             let args = settings::SyncSettings::resolve(args, workspace);
 
             // Initialize the cache.
-            let cache = cache.init()?;
+            let cache = cache.init()?.with_refresh(args.refresh);
 
             commands::sync(args.extras, globals.preview, &cache, printer).await
         }
@@ -601,9 +602,16 @@ async fn run() -> Result<ExitStatus> {
             let args = settings::LockSettings::resolve(args, workspace);
 
             // Initialize the cache.
-            let cache = cache.init()?;
+            let cache = cache.init()?.with_refresh(args.refresh);
 
-            commands::lock(args.exclude_newer, globals.preview, &cache, printer).await
+            commands::lock(
+                args.upgrade,
+                args.exclude_newer,
+                globals.preview,
+                &cache,
+                printer,
+            )
+            .await
         }
         #[cfg(feature = "self-update")]
         Commands::Self_(SelfNamespace {
diff --git a/crates/uv/src/settings.rs b/crates/uv/src/settings.rs
@@ -102,6 +102,8 @@ pub(crate) struct RunSettings {
     pub(crate) args: Vec<OsString>,
     pub(crate) with: Vec<String>,
     pub(crate) python: Option<String>,
+    pub(crate) refresh: Refresh,
+    pub(crate) upgrade: Upgrade,
     pub(crate) exclude_newer: Option<ExcludeNewer>,
 }
 
@@ -116,11 +118,19 @@ impl RunSettings {
             target,
             args,
             with,
+            refresh,
+            no_refresh,
+            refresh_package,
+            upgrade,
+            no_upgrade,
+            upgrade_package,
             python,
             exclude_newer,
         } = args;
 
         Self {
+            refresh: Refresh::from_args(flag(refresh, no_refresh), refresh_package),
+            upgrade: Upgrade::from_args(flag(upgrade, no_upgrade), upgrade_package),
             extras: ExtrasSpecification::from_args(
                 flag(all_extras, no_all_extras).unwrap_or_default(),
                 extra.unwrap_or_default(),
@@ -138,6 +148,7 @@ impl RunSettings {
 #[allow(clippy::struct_excessive_bools, dead_code)]
 #[derive(Debug, Clone)]
 pub(crate) struct SyncSettings {
+    pub(crate) refresh: Refresh,
     pub(crate) extras: ExtrasSpecification,
     pub(crate) python: Option<String>,
 }
@@ -150,10 +161,14 @@ impl SyncSettings {
             extra,
             all_extras,
             no_all_extras,
+            refresh,
+            no_refresh,
+            refresh_package,
             python,
         } = args;
 
         Self {
+            refresh: Refresh::from_args(flag(refresh, no_refresh), refresh_package),
             extras: ExtrasSpecification::from_args(
                 flag(all_extras, no_all_extras).unwrap_or_default(),
                 extra.unwrap_or_default(),
@@ -167,6 +182,8 @@ impl SyncSettings {
 #[allow(clippy::struct_excessive_bools, dead_code)]
 #[derive(Debug, Clone)]
 pub(crate) struct LockSettings {
+    pub(crate) refresh: Refresh,
+    pub(crate) upgrade: Upgrade,
     pub(crate) exclude_newer: Option<ExcludeNewer>,
     pub(crate) python: Option<String>,
 }
@@ -176,11 +193,19 @@ impl LockSettings {
     #[allow(clippy::needless_pass_by_value)]
     pub(crate) fn resolve(args: LockArgs, _workspace: Option<Workspace>) -> Self {
         let LockArgs {
+            refresh,
+            no_refresh,
+            refresh_package,
+            upgrade,
+            no_upgrade,
+            upgrade_package,
             exclude_newer,
             python,
         } = args;
 
         Self {
+            refresh: Refresh::from_args(flag(refresh, no_refresh), refresh_package),
+            upgrade: Upgrade::from_args(flag(upgrade, no_upgrade), upgrade_package),
             exclude_newer,
             python,
         }
diff --git a/crates/uv/tests/lock.rs b/crates/uv/tests/lock.rs
