Skip to content

Commit e7ff7a6

Browse files
borsbors
committed
Auto merge of #12861 - weihanglo:msrv-aware-lockfile, r=ehuss
feat: respect `rust-version` when generating lockfile
2 parents 5c9ebe1 + b82910f commit e7ff7a6

File tree

15 files changed

+218
-46
lines changed

15 files changed

+218
-46
lines changed

‎benches/benchsuite/benches/resolve.rs

-4
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ fn do_resolve<'cfg>(config: &'cfg Config, ws_root: &Path) -> ResolveInfo<'cfg> {
3131
let specs = pkgs.to_package_id_specs(&ws).unwrap();
3232
let has_dev_units = HasDevUnits::Yes;
3333
let force_all_targets = ForceAllTargets::No;
34-
let max_rust_version = None;
3534
// Do an initial run to download anything necessary so that it does
3635
// not confuse criterion's warmup.
3736
let ws_resolve = cargo::ops::resolve_ws_with_opts(
@@ -42,7 +41,6 @@ fn do_resolve<'cfg>(config: &'cfg Config, ws_root: &Path) -> ResolveInfo<'cfg> {
4241
&specs,
4342
has_dev_units,
4443
force_all_targets,
45-
max_rust_version,
4644
)
4745
.unwrap();
4846
ResolveInfo {
@@ -84,7 +82,6 @@ fn resolve_ws(c: &mut Criterion) {
8482
force_all_targets,
8583
..
8684
} = lazy_info.get_or_insert_with(|| do_resolve(&config, &ws_root));
87-
let max_rust_version = None;
8885
b.iter(|| {
8986
cargo::ops::resolve_ws_with_opts(
9087
ws,
@@ -94,7 +91,6 @@ fn resolve_ws(c: &mut Criterion) {
9491
specs,
9592
*has_dev_units,
9693
*force_all_targets,
97-
max_rust_version,
9894
)
9995
.unwrap();
10096
})

‎crates/cargo-util-schemas/src/manifest.rs

+8
Original file line numberDiff line numberDiff line change
@@ -1417,6 +1417,14 @@ impl std::str::FromStr for RustVersion {
14171417
fn from_str(value: &str) -> Result<Self, Self::Err> {
14181418
let partial = value.parse::<PartialVersion>();
14191419
let partial = partial.map_err(RustVersionErrorKind::PartialVersion)?;
1420+
partial.try_into()
1421+
}
1422+
}
1423+
1424+
impl TryFrom<PartialVersion> for RustVersion {
1425+
type Error = RustVersionError;
1426+
1427+
fn try_from(partial: PartialVersion) -> Result<Self, Self::Error> {
14201428
if partial.pre.is_some() {
14211429
return Err(RustVersionErrorKind::Prerelease.into());
14221430
}

‎crates/resolver-tests/src/lib.rs

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ use std::time::Instant;
1414
use cargo::core::dependency::DepKind;
1515
use cargo::core::resolver::{self, ResolveOpts, VersionOrdering, VersionPreferences};
1616
use cargo::core::Resolve;
17+
use cargo::core::ResolveVersion;
1718
use cargo::core::{Dependency, PackageId, Registry, Summary};
1819
use cargo::core::{GitReference, SourceId};
1920
use cargo::sources::source::QueryKind;
@@ -174,6 +175,7 @@ pub fn resolve_with_config_raw(
174175
&[],
175176
&mut registry,
176177
&version_prefs,
178+
ResolveVersion::with_rust_version(None),
177179
Some(config),
178180
);
179181

‎src/cargo/core/compiler/standard_lib.rs

-2
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,6 @@ pub fn resolve_std<'cfg>(
145145
let cli_features = CliFeatures::from_command_line(
146146
&features, /*all_features*/ false, /*uses_default_features*/ false,
147147
)?;
148-
let max_rust_version = ws.rust_version();
149148
let resolve = ops::resolve_ws_with_opts(
150149
&std_ws,
151150
target_data,
@@ -154,7 +153,6 @@ pub fn resolve_std<'cfg>(
154153
&specs,
155154
HasDevUnits::No,
156155
crate::core::resolver::features::ForceAllTargets::No,
157-
max_rust_version,
158156
)?;
159157
Ok((
160158
resolve.pkg_set,

‎src/cargo/core/resolver/mod.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,16 @@ mod version_prefs;
118118
/// * `version_prefs` - this represents a preference for some versions over others,
119119
/// based on the lock file or other reasons such as `[patch]`es.
120120
///
121+
/// * `resolve_version` - this controls how the lockfile will be serialized.
122+
///
121123
/// * `config` - a location to print warnings and such, or `None` if no warnings
122124
/// should be printed
123125
pub fn resolve(
124126
summaries: &[(Summary, ResolveOpts)],
125127
replacements: &[(PackageIdSpec, Dependency)],
126128
registry: &mut dyn Registry,
127129
version_prefs: &VersionPreferences,
130+
resolve_version: ResolveVersion,
128131
config: Option<&Config>,
129132
) -> CargoResult<Resolve> {
130133
let _p = profile::start("resolving");
@@ -169,7 +172,7 @@ pub fn resolve(
169172
cksums,
170173
BTreeMap::new(),
171174
Vec::new(),
172-
ResolveVersion::default(),
175+
resolve_version,
173176
summaries,
174177
);
175178

‎src/cargo/core/resolver/resolve.rs

+61-8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
use cargo_util_schemas::core::PartialVersion;
2+
use cargo_util_schemas::manifest::RustVersion;
3+
14
use super::encode::Metadata;
25
use crate::core::dependency::DepKind;
36
use crate::core::{Dependency, PackageId, PackageIdSpec, PackageIdSpecQuery, Summary, Target};
@@ -48,7 +51,7 @@ pub struct Resolve {
4851

4952
/// A version to indicate how a `Cargo.lock` should be serialized.
5053
///
51-
/// When creating a new lockfile, the version with `#[default]` is used.
54+
/// When creating a new lockfile, the version in [`ResolveVersion::default`] is used.
5255
/// If an old version of lockfile already exists, it will stay as-is.
5356
///
5457
/// It's important that if a new version is added that this is not updated
@@ -64,25 +67,30 @@ pub struct Resolve {
6467
///
6568
/// It's theorized that we can add more here over time to track larger changes
6669
/// to the `Cargo.lock` format, but we've yet to see how that strategy pans out.
67-
#[derive(Default, PartialEq, Eq, Clone, Copy, Debug, PartialOrd, Ord)]
70+
#[derive(PartialEq, Eq, Clone, Copy, Debug, PartialOrd, Ord)]
6871
pub enum ResolveVersion {
6972
/// Historical baseline for when this abstraction was added.
7073
V1,
7174
/// A more compact format, more amenable to avoiding source-control merge
7275
/// conflicts. The `dependencies` arrays are compressed and checksums are
73-
/// listed inline. Introduced in 2019 in version 1.38. New lockfiles use
74-
/// V2 by default from 1.41 to 1.52.
76+
/// listed inline.
77+
///
78+
/// * Introduced in 2019 in version 1.38.
79+
/// * New lockfiles use V2 by default from 1.41 to 1.52.
7580
V2,
7681
/// A format that explicitly lists a `version` at the top of the file as
7782
/// well as changing how git dependencies are encoded. Dependencies with
7883
/// `branch = "master"` are no longer encoded the same way as those without
79-
/// branch specifiers. Introduced in 2020 in version 1.47. New lockfiles use
80-
/// V3 by default staring in 1.53.
81-
#[default]
84+
/// branch specifiers.
85+
///
86+
/// * Introduced in 2020 in version 1.47.
87+
/// * New lockfiles use V3 by default starting in 1.53.
8288
V3,
8389
/// SourceId URL serialization is aware of URL encoding. For example,
8490
/// `?branch=foo bar` is now encoded as `?branch=foo+bar` and can be decoded
85-
/// back and forth correctly. Introduced in 2024 in version 1.77.
91+
/// back and forth correctly.
92+
///
93+
/// * Introduced in 2024 in version 1.78.
8694
V4,
8795
/// Unstable. Will collect a certain amount of changes and then go.
8896
///
@@ -91,6 +99,17 @@ pub enum ResolveVersion {
9199
}
92100

93101
impl ResolveVersion {
102+
/// Gets the default lockfile version.
103+
///
104+
/// This is intended to be private.
105+
/// You shall use [`ResolveVersion::with_rust_version`] always.
106+
///
107+
/// Update this and the description of enum variants of [`ResolveVersion`]
108+
/// when we're changing the default lockfile version.
109+
fn default() -> ResolveVersion {
110+
ResolveVersion::V3
111+
}
112+
94113
/// The maximum version of lockfile made into the stable channel.
95114
///
96115
/// Any version larger than this needs `-Znext-lockfile-bump` to enable.
@@ -99,6 +118,40 @@ impl ResolveVersion {
99118
pub fn max_stable() -> ResolveVersion {
100119
ResolveVersion::V4
101120
}
121+
122+
/// Gets the default lockfile version for the given Rust version.
123+
pub fn with_rust_version(rust_version: Option<&RustVersion>) -> Self {
124+
let Some(rust_version) = rust_version else {
125+
return ResolveVersion::default();
126+
};
127+
128+
let rust_1_41 = PartialVersion {
129+
major: 1,
130+
minor: Some(41),
131+
patch: None,
132+
pre: None,
133+
build: None,
134+
}
135+
.try_into()
136+
.expect("PartialVersion 1.41");
137+
let rust_1_53 = PartialVersion {
138+
major: 1,
139+
minor: Some(53),
140+
patch: None,
141+
pre: None,
142+
build: None,
143+
}
144+
.try_into()
145+
.expect("PartialVersion 1.53");
146+
147+
if rust_version >= &rust_1_53 {
148+
ResolveVersion::V3
149+
} else if rust_version >= &rust_1_41 {
150+
ResolveVersion::V2
151+
} else {
152+
ResolveVersion::V1
153+
}
154+
}
102155
}
103156

104157
impl Resolve {

‎src/cargo/ops/cargo_compile/mod.rs

-2
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,6 @@ pub fn create_bcx<'a, 'cfg>(
262262
HasDevUnits::No
263263
}
264264
};
265-
let max_rust_version = ws.rust_version();
266265
let resolve = ops::resolve_ws_with_opts(
267266
ws,
268267
&mut target_data,
@@ -271,7 +270,6 @@ pub fn create_bcx<'a, 'cfg>(
271270
&specs,
272271
has_dev_units,
273272
crate::core::resolver::features::ForceAllTargets::No,
274-
max_rust_version,
275273
)?;
276274
let WorkspaceResolve {
277275
mut pkg_set,

‎src/cargo/ops/cargo_generate_lockfile.rs

-6
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ pub struct UpdateOptions<'a> {
2626

2727
pub fn generate_lockfile(ws: &Workspace<'_>) -> CargoResult<()> {
2828
let mut registry = PackageRegistry::new(ws.config())?;
29-
let max_rust_version = ws.rust_version();
3029
let mut resolve = ops::resolve_with_previous(
3130
&mut registry,
3231
ws,
@@ -36,7 +35,6 @@ pub fn generate_lockfile(ws: &Workspace<'_>) -> CargoResult<()> {
3635
None,
3736
&[],
3837
true,
39-
max_rust_version,
4038
)?;
4139
ops::write_pkg_lockfile(ws, &mut resolve)?;
4240
Ok(())
@@ -57,8 +55,6 @@ pub fn update_lockfile(ws: &Workspace<'_>, opts: &UpdateOptions<'_>) -> CargoRes
5755
.config()
5856
.acquire_package_cache_lock(CacheLockMode::DownloadExclusive)?;
5957

60-
let max_rust_version = ws.rust_version();
61-
6258
let previous_resolve = match ops::load_pkg_lockfile(ws)? {
6359
Some(resolve) => resolve,
6460
None => {
@@ -78,7 +74,6 @@ pub fn update_lockfile(ws: &Workspace<'_>, opts: &UpdateOptions<'_>) -> CargoRes
7874
None,
7975
&[],
8076
true,
81-
max_rust_version,
8277
)?
8378
}
8479
}
@@ -157,7 +152,6 @@ pub fn update_lockfile(ws: &Workspace<'_>, opts: &UpdateOptions<'_>) -> CargoRes
157152
Some(&to_avoid),
158153
&[],
159154
true,
160-
max_rust_version,
161155
)?;
162156

163157
// Summarize what is changing for the user.

‎src/cargo/ops/cargo_output_metadata.rs

-3
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,6 @@ fn build_resolve_graph(
140140
crate::core::resolver::features::ForceAllTargets::No
141141
};
142142

143-
let max_rust_version = ws.rust_version();
144-
145143
// Note that even with --filter-platform we end up downloading host dependencies as well,
146144
// as that is the behavior of download_accessible.
147145
let ws_resolve = ops::resolve_ws_with_opts(
@@ -152,7 +150,6 @@ fn build_resolve_graph(
152150
&specs,
153151
HasDevUnits::Yes,
154152
force_all,
155-
max_rust_version,
156153
)?;
157154

158155
let package_map: BTreeMap<PackageId, Package> = ws_resolve

‎src/cargo/ops/cargo_package.rs

-3
Original file line numberDiff line numberDiff line change
@@ -461,8 +461,6 @@ fn build_lock(ws: &Workspace<'_>, orig_pkg: &Package) -> CargoResult<String> {
461461
to_real_manifest(toml_manifest, false, source_id, package_root, config)?;
462462
let new_pkg = Package::new(manifest, orig_pkg.manifest_path());
463463

464-
let max_rust_version = new_pkg.rust_version().cloned();
465-
466464
// Regenerate Cargo.lock using the old one as a guide.
467465
let tmp_ws = Workspace::ephemeral(new_pkg, ws.config(), None, true)?;
468466
let mut tmp_reg = PackageRegistry::new(ws.config())?;
@@ -475,7 +473,6 @@ fn build_lock(ws: &Workspace<'_>, orig_pkg: &Package) -> CargoResult<String> {
475473
None,
476474
&[],
477475
true,
478-
max_rust_version.as_ref(),
479476
)?;
480477
let pkg_set = ops::get_resolved_packages(&new_resolve, tmp_reg)?;
481478

‎src/cargo/ops/fix.rs

-3
Original file line numberDiff line numberDiff line change
@@ -245,8 +245,6 @@ fn check_resolver_change(ws: &Workspace<'_>, opts: &FixOptions) -> CargoResult<(
245245
let mut target_data =
246246
RustcTargetData::new(ws, &opts.compile_opts.build_config.requested_kinds)?;
247247
let mut resolve_differences = |has_dev_units| -> CargoResult<(WorkspaceResolve<'_>, DiffMap)> {
248-
let max_rust_version = ws.rust_version();
249-
250248
let ws_resolve = ops::resolve_ws_with_opts(
251249
ws,
252250
&mut target_data,
@@ -255,7 +253,6 @@ fn check_resolver_change(ws: &Workspace<'_>, opts: &FixOptions) -> CargoResult<(
255253
&specs,
256254
has_dev_units,
257255
crate::core::resolver::features::ForceAllTargets::No,
258-
max_rust_version,
259256
)?;
260257

261258
let feature_opts = FeatureOpts::new_behavior(ResolveBehavior::V2, has_dev_units);

‎src/cargo/ops/lockfile.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,10 @@ pub fn write_pkg_lockfile(ws: &Workspace<'_>, resolve: &mut Resolve) -> CargoRes
6464
// out lock file updates as they're otherwise already updated, and changes
6565
// which don't touch dependencies won't seemingly spuriously update the lock
6666
// file.
67-
let default_version = ResolveVersion::default();
67+
let default_version = ResolveVersion::with_rust_version(ws.rust_version());
6868
let current_version = resolve.version();
6969
let next_lockfile_bump = ws.config().cli_unstable().next_lockfile_bump;
70+
tracing::debug!("lockfile - current: {current_version:?}, default: {default_version:?}");
7071

7172
if current_version < default_version {
7273
resolve.set_version(default_version);

0 commit comments

Comments
 (0)