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

Jump to bottom

verbose update of dependencies #5634

Closed
wants to merge 2 commits into from
Closed

verbose update of dependencies #5634

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23db4c3
verbose update of dependencies, fixes #5530
debris Jun 15, 2018
ecd3b06
compare_dependency_graphs
debris Jun 16, 2018
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
131 changes: 116 additions & 15 deletions src/cargo/ops/cargo_generate_lockfile.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::collections::{BTreeMap, HashSet};
use std::collections::{BTreeMap, HashSet, HashMap};

use termcolor::Color::{self, Cyan, Green, Red};

Expand Down Expand Up @@ -97,17 +97,10 @@ pub fn update_lockfile(ws: &Workspace, opts: &UpdateOptions) -> CargoResult<()>
let print_change = |status: &str, msg: String, color: Color| {
opts.config.shell().status_with_color(status, msg, color)
};
for (removed, added) in compare_dependency_graphs(&previous_resolve, &resolve) {
let diff = compare_dependency_graphs(&previous_resolve, &resolve);
for (removed, added) in diff.removed_and_added {
if removed.len() == 1 && added.len() == 1 {
let msg = if removed[0].source_id().is_git() {
format!(
"{} -> #{}",
removed[0],
&added[0].source_id().precise().unwrap()[..8]
)
} else {
format!("{} -> v{}", removed[0], added[0].version())
};
let msg = format_package_for_update(removed[0], added[0]);
print_change("Updating", msg, Green)?;
} else {
for package in removed.iter() {
Expand All @@ -119,9 +112,44 @@ pub fn update_lockfile(ws: &Workspace, opts: &UpdateOptions) -> CargoResult<()>
}
}

for (package, dependents) in diff.partly_added {
let dependents = format_dependents(&dependents);
print_change("Adding", format!("{} to {}", package, dependents), Cyan)?;
}

for ((old, new), dependents) in diff.partly_updated {
let dependents = format_dependents(&dependents);
let msg = format_package_for_update(old, new);
print_change("Updating", format!("{} in {}", msg, dependents), Green)?;
}

for (package, dependents) in diff.partly_removed {
let dependents = format_dependents(&dependents);
print_change("Removing", format!("{} from {}", package, dependents), Red)?;
}

ops::write_pkg_lockfile(ws, &resolve)?;
return Ok(());

fn format_dependents(packages: &[&PackageId]) -> String {
packages.iter()
.map(|p| format!("{} v{}", p.name(), p.version()))
.collect::<Vec<_>>()
.join(", ")
}

fn format_package_for_update(removed: &PackageId, added: &PackageId) -> String {
if removed.source_id().is_git() {
format!(
"{} -> #{}",
removed,
&added.source_id().precise().unwrap()[..8]
)
} else {
format!("{} -> v{}", removed, added.version())
}
}

fn fill_with_deps<'a>(
resolve: &'a Resolve,
dep: &'a PackageId,
Expand All @@ -137,10 +165,21 @@ pub fn update_lockfile(ws: &Workspace, opts: &UpdateOptions) -> CargoResult<()>
}
}

struct DependencyGraphDiff<'a> {
/// completely new, updated and removed dependencies
removed_and_added: Vec<(Vec<&'a PackageId>, Vec<&'a PackageId>)>,
/// dependencies that are not new, but some crates were not using them before
partly_added: BTreeMap<&'a PackageId, Vec<&'a PackageId>>,
/// dependencies that are updated, but there are still some crates using old versions
partly_updated: BTreeMap<(&'a PackageId, &'a PackageId), Vec<&'a PackageId>>,
/// dependencies that are no longer used by some packages
partly_removed: BTreeMap<&'a PackageId, Vec<&'a PackageId>>,
}

fn compare_dependency_graphs<'a>(
previous_resolve: &'a Resolve,
resolve: &'a Resolve,
) -> Vec<(Vec<&'a PackageId>, Vec<&'a PackageId>)> {
) -> DependencyGraphDiff<'a> {
fn key(dep: &PackageId) -> (&str, &SourceId) {
(dep.name().as_str(), dep.source_id())
}
Expand Down Expand Up @@ -181,20 +220,44 @@ pub fn update_lockfile(ws: &Workspace, opts: &UpdateOptions) -> CargoResult<()>

// Map (package name, package source) to (removed versions, added versions).
let mut changes = BTreeMap::new();
let mut versions = BTreeMap::new();
let mut old_key_to_dep = HashMap::new();
let mut key_to_dep = HashMap::new();
let empty = (Vec::new(), Vec::new());
for dep in previous_resolve.iter() {
let entry = key(dep);
old_key_to_dep.insert(entry, dep);
changes
.entry(key(dep))
.entry(entry)
.or_insert_with(|| empty.clone())
.0
.push(dep);
for (id, _) in previous_resolve.deps(dep) {
versions
.entry(key(id))
.or_insert_with(BTreeMap::new)
.entry(entry)
.or_insert_with(|| (None, None))
.0 = Some(id);
}
}
for dep in resolve.iter() {
let entry = key(dep);
key_to_dep.insert(entry, dep);
changes
.entry(key(dep))
.entry(entry)
.or_insert_with(|| empty.clone())
.1
.push(dep);

for (id, _) in resolve.deps(dep) {
versions
.entry(key(id))
.or_insert_with(BTreeMap::new)
.entry(entry)
.or_insert_with(|| (None, None))
.1 = Some(id);
}
}

for v in changes.values_mut() {
Expand All @@ -208,6 +271,44 @@ pub fn update_lockfile(ws: &Workspace, opts: &UpdateOptions) -> CargoResult<()>
}
debug!("{:#?}", changes);

changes.into_iter().map(|(_, v)| v).collect()
let mut partly_added = BTreeMap::new();
let mut partly_updated = BTreeMap::new();
let mut partly_removed = BTreeMap::new();

{
let dependents_iter = changes.iter()
.filter(|(_, v)| v.0.len() == 0 && v.1.len() == 0)
Copy link
Contributor Author

@debris debris Jun 15, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

there is one edge case where this check is not enough, e.g.

  1. Set up a workspace with the following members and dependencies:
a → bitflags="0.9"
b → bitflags="1.0"
c → bitflags="0.9"
  1. cargo update to build the lock file
  2. New version of bitflags is released on crates.io - 1.x
  3. Edit c's version of bitflags to 1.0
  4. cargo update will print only the message describing an update from 1.0 to 1.x

.filter_map(|(k, _)| versions.get(k));

for dependents in dependents_iter {
for (dependent, versions) in dependents {
match versions {
(None, Some(new)) => {
partly_added.entry(*new)
.or_insert_with(Vec::new)
.push(key_to_dep[dependent]);
},
(Some(old), Some(new)) if old != new => {
partly_updated.entry((*old, *new))
.or_insert_with(Vec::new)
.push(key_to_dep[dependent]);
},
(Some(old), None) => {
partly_removed.entry(*old)
.or_insert_with(Vec::new)
.push(old_key_to_dep[dependent]);
},
_ => (),
}
}
}
}

DependencyGraphDiff {
removed_and_added: changes.into_iter().map(|(_, v)| v).collect(),
partly_added,
partly_updated,
partly_removed,
}
}
}