guppy_summaries/diff.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
// Copyright (c) The cargo-guppy Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
//! Compare and diff summaries.
//!
//! A diff of two summaries is a list of changes between them.
//!
//! The main entry point is `SummaryDiff`, which can be created through the `diff` method on
//! summaries or through `SummaryDiff::new`.
pub use crate::report::SummaryReport;
use crate::{PackageInfo, PackageMap, PackageStatus, Summary, SummaryId, SummarySource};
use ahash::AHashMap;
use diffus::{edit, Diffable};
use semver::Version;
use serde::{ser::SerializeStruct, Serialize};
use std::{
collections::{BTreeMap, BTreeSet},
fmt, mem,
};
/// A diff of two package summaries.
///
/// This struct contains information on the packages that were changed, as well as those that were
/// not.
///
/// ## Human-readable reports
///
/// The [`report`](SummaryDiff::report) method can be used with `fmt::Display` to generate a
/// friendly, human-readable report.
///
/// ## Machine-readable serialization
///
/// A `SummaryDiff` can be serialized through `serde`. The output format is part of the API.
///
/// An example of TOML-serialized output:
///
/// ```toml
/// [[target-packages.changed]]
/// name = "dep"
/// version = "0.4.3"
/// crates-io = true
/// change = "added"
/// status = "direct"
/// features = ["std"]
///
/// [[target-packages.changed]]
/// name = "foo"
/// version = "1.2.3"
/// workspace-path = "foo"
/// change = "modified"
/// new-status = "initial"
/// added-features = ["feature2"]
/// removed-features = []
/// unchanged-features = ["default", "feature1"]
///
/// [[target-packages.unchanged]]
/// name = "no-changes"
/// version = "1.5.3"
/// crates-io = true
/// status = "transitive"
/// features = ["default"]
///
/// [[host-packages.changed]]
/// name = "dep"
/// version = "0.4.2"
/// crates-io = true
/// change = "removed"
/// old-status = "direct"
/// old-features = ["std"]
/// ```
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct SummaryDiff<'a> {
/// Diff of target packages.
pub target_packages: PackageDiff<'a>,
/// Diff of host packages.
pub host_packages: PackageDiff<'a>,
}
impl<'a> SummaryDiff<'a> {
/// Computes a diff between two summaries.
pub fn new(old: &'a Summary, new: &'a Summary) -> Self {
Self {
target_packages: PackageDiff::new(&old.target_packages, &new.target_packages),
host_packages: PackageDiff::new(&old.host_packages, &new.host_packages),
}
}
/// Returns true if there are any changes in this diff.
pub fn is_changed(&self) -> bool {
!self.is_unchanged()
}
/// Returns true if there are no changes in this diff.
pub fn is_unchanged(&self) -> bool {
self.target_packages.is_unchanged() && self.host_packages.is_unchanged()
}
/// Returns a report for this diff.
///
/// This report can be used with `fmt::Display`.
pub fn report<'b>(&'b self) -> SummaryReport<'a, 'b> {
SummaryReport::new(self)
}
}
/// Type alias for list entries in the `PackageDiff::unchanged` map.
pub type UnchangedInfo<'a> = (&'a Version, &'a SummarySource, &'a PackageInfo);
/// A diff from a particular section of a summary.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PackageDiff<'a> {
/// Changed packages.
pub changed: BTreeMap<&'a SummaryId, SummaryDiffStatus<'a>>,
/// Unchanged packages, keyed by name.
pub unchanged: BTreeMap<&'a str, Vec<UnchangedInfo<'a>>>,
}
impl<'a> PackageDiff<'a> {
/// Constructs a new `PackageDiff` from a pair of `PackageMap` instances.
pub fn new(old: &'a PackageMap, new: &'a PackageMap) -> Self {
let mut changed = BTreeMap::new();
let mut unchanged = BTreeMap::new();
let mut add_unchanged = |summary_id: &'a SummaryId, info: &'a PackageInfo| {
unchanged
.entry(summary_id.name.as_str())
.or_insert_with(Vec::new)
.push((&summary_id.version, &summary_id.source, info));
};
match (*old).diff(new) {
edit::Edit::Copy(_) => {
// Add all elements to unchanged.
for (summary_id, info) in new {
add_unchanged(summary_id, info);
}
}
edit::Edit::Change(diff) => {
for (summary_id, diff) in diff {
match diff {
edit::map::Edit::Copy(info) => {
// No changes.
add_unchanged(summary_id, info);
}
edit::map::Edit::Insert(info) => {
// New package.
let status = SummaryDiffStatus::Added { info };
changed.insert(summary_id, status);
}
edit::map::Edit::Remove(old_info) => {
// Removed package.
let status = SummaryDiffStatus::Removed { old_info };
changed.insert(summary_id, status);
}
edit::map::Edit::Change((old_info, new_info)) => {
// The feature set or status changed.
let status =
SummaryDiffStatus::make_changed(None, None, old_info, new_info);
changed.insert(summary_id, status);
}
}
}
}
}
// Combine lone inserts and removes into changes.
Self::combine_insert_remove(&mut changed);
Self { changed, unchanged }
}
/// Returns true if there are no changes in this diff.
pub fn is_unchanged(&self) -> bool {
self.changed.is_empty()
}
// ---
// Helper methods
// ---
fn combine_insert_remove(changed: &mut BTreeMap<&'a SummaryId, SummaryDiffStatus<'a>>) {
let mut combine_statuses: AHashMap<&str, CombineStatus<'_>> =
AHashMap::with_capacity(changed.len());
for (summary_id, status) in &*changed {
let entry = combine_statuses
.entry(summary_id.name.as_str())
.or_insert_with(|| CombineStatus::None);
match status {
SummaryDiffStatus::Added { .. } => entry.record_added(summary_id),
SummaryDiffStatus::Removed { .. } => entry.record_removed(summary_id),
SummaryDiffStatus::Modified { .. } => entry.record_changed(),
}
}
for status in combine_statuses.values() {
if let CombineStatus::Combine { added, removed } = status {
let removed_status = changed
.remove(removed)
.expect("removed ID should be present");
let old_info = match removed_status {
SummaryDiffStatus::Removed { old_info } => old_info,
other => panic!("expected Removed, found {:?}", other),
};
let added_status = changed.get_mut(added).expect("added ID should be present");
let new_info = match &*added_status {
SummaryDiffStatus::Added { info } => *info,
other => panic!("expected Added, found {:?}", other),
};
let old_version = if added.version != removed.version {
Some(&removed.version)
} else {
None
};
let old_source = if added.source != removed.source {
Some(&removed.source)
} else {
None
};
// Don't need the old value of added_status any more since we've already extracted the value out of it.
let _ = mem::replace(
added_status,
SummaryDiffStatus::make_changed(old_version, old_source, old_info, new_info),
);
}
}
}
}
pub(crate) fn changed_sort_key<'a>(
summary_id: &'a SummaryId,
status: &SummaryDiffStatus<'_>,
) -> impl Ord + 'a {
// The sort order is:
// * diff tag (added/modified/removed)
// * package status
// * summary id
// TODO: allow customizing sort order?
(status.tag(), status.latest_status(), summary_id)
}
impl<'a> Serialize for PackageDiff<'a> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
#[derive(Serialize)]
struct Changed<'a> {
// Flatten both fields so that all the details show up in a single map. (This is
// required for TOML.)
#[serde(flatten)]
package: &'a SummaryId,
#[serde(flatten)]
changes: &'a SummaryDiffStatus<'a>,
}
let mut changed: Vec<Changed> = self
.changed
.iter()
.map(|(package, changes)| Changed { package, changes })
.collect();
// The sorting ensures the order added -> modified -> removed.
changed.sort_by_key(|item| changed_sort_key(item.package, item.changes));
let mut state = serializer.serialize_struct("PackageDiff", 2)?;
state.serialize_field("changed", &changed)?;
#[derive(Serialize)]
struct Unchanged<'a> {
// This matches the SummaryId format.
name: &'a str,
version: &'a Version,
#[serde(flatten)]
source: &'a SummarySource,
#[serde(flatten)]
info: &'a PackageInfo,
}
// Trying to print out an empty unchanged can cause a ValueAfterTable issue with the TOML
// output.
if !self.unchanged.is_empty() {
let mut unchanged: Vec<_> = self
.unchanged
.iter()
.flat_map(|(&name, info)| {
info.iter().map(move |(version, source, info)| Unchanged {
name,
version,
source,
info,
})
})
.collect();
// Sort by (name, version, source).
unchanged.sort_by_key(|item| (item.name, item.version, item.source));
state.serialize_field("unchanged", &unchanged)?;
}
state.end()
}
}
/// The diff status for a particular summary ID and source.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case", tag = "change")]
pub enum SummaryDiffStatus<'a> {
/// This package was added.
#[serde(rename_all = "kebab-case")]
Added {
/// The information for this package.
#[serde(flatten)]
info: &'a PackageInfo,
},
/// This package was removed.
#[serde(rename_all = "kebab-case")]
Removed {
/// The information this package used to have.
#[serde(flatten, with = "removed_impl")]
old_info: &'a PackageInfo,
},
/// Some details about the package changed:
/// * a feature was added or removed
/// * the version or source changed.
#[serde(rename_all = "kebab-case")]
Modified {
/// The old version of this package, if the version changed.
old_version: Option<&'a Version>,
/// The old source of this package, if the source changed.
old_source: Option<&'a SummarySource>,
/// The old status of this package, if the status changed.
old_status: Option<PackageStatus>,
/// The current status of this package.
new_status: PackageStatus,
/// The set of features added to the package.
added_features: BTreeSet<&'a str>,
/// The set of features removed from the package.
removed_features: BTreeSet<&'a str>,
/// The set of features which were enabled both in both the old and new summaries.
unchanged_features: BTreeSet<&'a str>,
/// The set of optional dependencies added to the package.
#[serde(default)]
added_optional_deps: BTreeSet<&'a str>,
/// The set of optional dependencies removed from the package.
#[serde(default)]
removed_optional_deps: BTreeSet<&'a str>,
/// The set of optional dependencies enabled both in both the old and new summaries.
#[serde(default)]
unchanged_optional_deps: BTreeSet<&'a str>,
},
}
impl<'a> SummaryDiffStatus<'a> {
fn make_changed(
old_version: Option<&'a Version>,
old_source: Option<&'a SummarySource>,
old_info: &'a PackageInfo,
new_info: &'a PackageInfo,
) -> Self {
let old_status = if old_info.status != new_info.status {
Some(old_info.status)
} else {
None
};
let [added_features, removed_features, unchanged_features] =
Self::make_changed_diff(&old_info.features, &new_info.features);
let [added_optional_deps, removed_optional_deps, unchanged_optional_deps] =
Self::make_changed_diff(&old_info.optional_deps, &new_info.optional_deps);
SummaryDiffStatus::Modified {
old_version,
old_source,
old_status,
new_status: new_info.status,
added_features,
removed_features,
unchanged_features,
added_optional_deps,
removed_optional_deps,
unchanged_optional_deps,
}
}
fn make_changed_diff(
old_features: &'a BTreeSet<String>,
new_features: &'a BTreeSet<String>,
) -> [BTreeSet<&'a str>; 3] {
let mut added_features = BTreeSet::new();
let mut removed_features = BTreeSet::new();
let mut unchanged_features = BTreeSet::new();
match old_features.diff(new_features) {
edit::Edit::Copy(features) => {
unchanged_features.extend(features.iter().map(|feature| feature.as_str()));
}
edit::Edit::Change(diff) => {
for (_, diff) in diff {
match diff {
edit::set::Edit::Copy(feature) => {
unchanged_features.insert(feature.as_str());
}
edit::set::Edit::Insert(feature) => {
added_features.insert(feature.as_str());
}
edit::set::Edit::Remove(feature) => {
removed_features.insert(feature.as_str());
}
}
}
}
}
[added_features, removed_features, unchanged_features]
}
/// Returns the tag for this status.
///
/// The tag is similar to this enum, except it has no associated data.
pub fn tag(&self) -> SummaryDiffTag {
match self {
SummaryDiffStatus::Added { .. } => SummaryDiffTag::Added,
SummaryDiffStatus::Removed { .. } => SummaryDiffTag::Removed,
SummaryDiffStatus::Modified { .. } => SummaryDiffTag::Modified,
}
}
/// Returns the new package status if available, otherwise the old status.
pub fn latest_status(&self) -> PackageStatus {
match self {
SummaryDiffStatus::Added { info } => info.status,
SummaryDiffStatus::Removed { old_info } => old_info.status,
SummaryDiffStatus::Modified { new_status, .. } => *new_status,
}
}
}
mod removed_impl {
use super::*;
use serde::Serializer;
pub fn serialize<S>(item: &PackageInfo, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
#[derive(Serialize)]
#[serde(rename_all = "kebab-case")]
struct OldPackageInfo<'a> {
old_status: &'a PackageStatus,
old_features: &'a BTreeSet<String>,
}
let old_info = OldPackageInfo {
old_status: &item.status,
old_features: &item.features,
};
old_info.serialize(serializer)
}
}
/// A tag representing `SummaryDiffStatus` except with no data attached.
///
/// The order is significant: it is what's used as the default order in reports.
#[derive(Copy, Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum SummaryDiffTag {
/// This package was added.
Added,
/// This package was modified.
Modified,
/// This package was removed.
Removed,
}
impl fmt::Display for SummaryDiffTag {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
SummaryDiffTag::Added => write!(f, "A"),
SummaryDiffTag::Modified => write!(f, "M"),
SummaryDiffTag::Removed => write!(f, "R"),
}
}
}
impl<'a> Diffable<'a> for PackageInfo {
type Diff = (&'a PackageInfo, &'a PackageInfo);
fn diff(&'a self, other: &'a Self) -> edit::Edit<'a, Self> {
if self == other {
edit::Edit::Copy(self)
} else {
edit::Edit::Change((self, other))
}
}
}
impl<'a> Diffable<'a> for PackageStatus {
type Diff = (&'a PackageStatus, &'a PackageStatus);
fn diff(&'a self, other: &'a Self) -> edit::Edit<'a, Self> {
if self == other {
edit::Edit::Copy(self)
} else {
edit::Edit::Change((self, other))
}
}
}
// Status tracker for combining inserts and removes.
enum CombineStatus<'a> {
None,
Added(&'a SummaryId),
Removed(&'a SummaryId),
Combine {
added: &'a SummaryId,
removed: &'a SummaryId,
},
Ignore,
}
impl<'a> CombineStatus<'a> {
fn record_added(&mut self, summary_id: &'a SummaryId) {
let new = match self {
CombineStatus::None => CombineStatus::Added(summary_id),
CombineStatus::Removed(removed) => CombineStatus::Combine {
added: summary_id,
removed,
},
_ => CombineStatus::Ignore,
};
let _ = mem::replace(self, new);
}
fn record_removed(&mut self, summary_id: &'a SummaryId) {
let new = match self {
CombineStatus::None => CombineStatus::Removed(summary_id),
CombineStatus::Added(added) => CombineStatus::Combine {
added,
removed: summary_id,
},
_ => CombineStatus::Ignore,
};
let _ = mem::replace(self, new);
}
fn record_changed(&mut self) {
// If this package name appears in the changed list at all, don't combine its
// features.
let _ = mem::replace(self, CombineStatus::Ignore);
}
}