Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use an iterator for logging upgrade events #11301

Merged
merged 1 commit into from
Feb 7, 2025
+115 −75
Merged

Use an iterator for logging upgrade events #11301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 114 additions & 75 deletions crates/uv/src/commands/project/lock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,14 @@ pub(crate) async fn lock(
{
Ok(lock) => {
if dry_run {
let changed = if let LockResult::Changed(previous, lock) = &lock {
report_upgrades(previous.as_ref(), lock, printer, dry_run)?
} else {
false
};
// In `--dry-run` mode, show all changes.
let mut changed = false;
if let LockResult::Changed(previous, lock) = &lock {
for event in LockEvent::detect_changes(previous.as_ref(), lock, dry_run) {
changed = true;
writeln!(printer.stderr(), "{event}")?;
}
}
if !changed {
writeln!(
printer.stderr(),
Expand All @@ -189,7 +192,9 @@ pub(crate) async fn lock(
}
} else {
if let LockResult::Changed(Some(previous), lock) = &lock {
report_upgrades(Some(previous), lock, printer, dry_run)?;
for event in LockEvent::detect_changes(Some(previous), lock, dry_run) {
writeln!(printer.stderr(), "{event}")?;
}
}
}

Expand Down Expand Up @@ -1072,104 +1077,138 @@ impl ValidatedLock {
}
}

/// Reports on the versions that were upgraded in the new lockfile.
///
/// Returns `true` if any upgrades were reported.
fn report_upgrades(
existing_lock: Option<&Lock>,
new_lock: &Lock,
printer: Printer,
dry_run: bool,
) -> anyhow::Result<bool> {
let existing_packages: FxHashMap<&PackageName, BTreeSet<Option<&Version>>> =
if let Some(existing_lock) = existing_lock {
existing_lock.packages().iter().fold(
FxHashMap::with_capacity_and_hasher(existing_lock.packages().len(), FxBuildHasher),
/// A modification to a lockfile.
#[derive(Debug, Clone)]
pub(crate) enum LockEvent<'lock> {
Update(
bool,
PackageName,
BTreeSet<Option<&'lock Version>>,
BTreeSet<Option<&'lock Version>>,
),
Add(bool, PackageName, BTreeSet<Option<&'lock Version>>),
Remove(bool, PackageName, BTreeSet<Option<&'lock Version>>),
}

impl<'lock> LockEvent<'lock> {
/// Detect the change events between an (optional) existing and updated lockfile.
pub(crate) fn detect_changes(
existing_lock: Option<&'lock Lock>,
new_lock: &'lock Lock,
dry_run: bool,
) -> impl Iterator<Item = Self> {
// Identify the package-versions in the existing lockfile.
let mut existing_packages: FxHashMap<&PackageName, BTreeSet<Option<&Version>>> =
if let Some(existing_lock) = existing_lock {
existing_lock.packages().iter().fold(
FxHashMap::with_capacity_and_hasher(
existing_lock.packages().len(),
FxBuildHasher,
),
|mut acc, package| {
acc.entry(package.name())
.or_default()
.insert(package.version());
acc
},
)
} else {
FxHashMap::default()
};

// Identify the package-versions in the updated lockfile.
let mut new_packages: FxHashMap<&PackageName, BTreeSet<Option<&Version>>> =
new_lock.packages().iter().fold(
FxHashMap::with_capacity_and_hasher(new_lock.packages().len(), FxBuildHasher),
|mut acc, package| {
acc.entry(package.name())
.or_default()
.insert(package.version());
acc
},
)
} else {
FxHashMap::default()
};
);

let new_distributions: FxHashMap<&PackageName, BTreeSet<Option<&Version>>> =
new_lock.packages().iter().fold(
FxHashMap::with_capacity_and_hasher(new_lock.packages().len(), FxBuildHasher),
|mut acc, package| {
acc.entry(package.name())
.or_default()
.insert(package.version());
acc
},
);
let names = existing_packages
.keys()
.chain(new_packages.keys())
.map(|name| (*name).clone())
.collect::<BTreeSet<_>>();

names.into_iter().filter_map(move |name| {
match (existing_packages.remove(&name), new_packages.remove(&name)) {
(Some(existing_versions), Some(new_versions)) => {
if existing_versions != new_versions {
Some(Self::Update(dry_run, name, existing_versions, new_versions))
} else {
None
}
}
(Some(existing_versions), None) => {
Some(Self::Remove(dry_run, name, existing_versions))
}
(None, Some(new_versions)) => Some(Self::Add(dry_run, name, new_versions)),
(None, None) => {
unreachable!("The key `{name}` should exist in at least one of the maps");
}
}
})
}
}

let mut updated = false;
for name in existing_packages
.keys()
.chain(new_distributions.keys())
.collect::<BTreeSet<_>>()
{
impl std::fmt::Display for LockEvent<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
/// Format a version for inclusion in the upgrade report.
fn format_version(version: Option<&Version>) -> String {
version
.map(|version| format!("v{version}"))
.unwrap_or_else(|| "(dynamic)".to_string())
}

updated = true;
match (existing_packages.get(name), new_distributions.get(name)) {
(Some(existing_versions), Some(new_versions)) => {
if existing_versions != new_versions {
let existing_versions = existing_versions
.iter()
.map(|version| format_version(*version))
.collect::<Vec<_>>()
.join(", ");
let new_versions = new_versions
.iter()
.map(|version| format_version(*version))
.collect::<Vec<_>>()
.join(", ");
writeln!(
printer.stderr(),
"{} {name} {existing_versions} -> {new_versions}",
if dry_run { "Update" } else { "Updated" }.green().bold()
)?;
}
}
(Some(existing_versions), None) => {
match self {
Self::Update(dry_run, name, existing_versions, new_versions) => {
let existing_versions = existing_versions
.iter()
.map(|version| format_version(*version))
.collect::<Vec<_>>()
.join(", ");
writeln!(
printer.stderr(),
"{} {name} {existing_versions}",
if dry_run { "Remove" } else { "Removed" }.red().bold()
)?;
let new_versions = new_versions
.iter()
.map(|version| format_version(*version))
.collect::<Vec<_>>()
.join(", ");

write!(
f,
"{} {name} {existing_versions} -> {new_versions}",
if *dry_run { "Update" } else { "Updated" }.green().bold()
)
}
(None, Some(new_versions)) => {
Self::Add(dry_run, name, new_versions) => {
let new_versions = new_versions
.iter()
.map(|version| format_version(*version))
.collect::<Vec<_>>()
.join(", ");
writeln!(
printer.stderr(),

write!(
f,
"{} {name} {new_versions}",
if dry_run { "Add" } else { "Added" }.green().bold()
)?;
if *dry_run { "Add" } else { "Added" }.green().bold()
)
}
(None, None) => {
unreachable!("The key `{name}` should exist in at least one of the maps");
Self::Remove(dry_run, name, existing_versions) => {
let existing_versions = existing_versions
.iter()
.map(|version| format_version(*version))
.collect::<Vec<_>>()
.join(", ");

write!(
f,
"{} {name} {existing_versions}",
if *dry_run { "Remove" } else { "Removed" }.red().bold()
)
}
}
}

Ok(updated)
}
1 change: 1 addition & 0 deletions crates/uv/tests/it/lock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18736,6 +18736,7 @@ fn lock_dry_run_noop() -> Result<()> {

----- stderr -----
Resolved 5 packages in [TIME]
No lockfile changes detected
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This was a bug.)

"###);

Ok(())
Expand Down
Loading