    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

    use crate::core::registry::PackageRegistry;
    use crate::core::resolver::features::{CliFeatures, HasDevUnits};
    use crate::core::{PackageId, PackageIdSpec};
    use crate::core::{Resolve, SourceId, Workspace};
    use crate::ops;
    use crate::util::config::Config;
    use crate::util::CargoResult;
    use anyhow::Context;
    use log::debug;
    use std::collections::{BTreeMap, HashSet};
    use termcolor::Color::{self, Cyan, Green, Red, Yellow};

    pub struct UpdateOptions<'a> {
        pub config: &'a Config,
        pub to_update: Vec<String>,
        pub precise: Option<&'a str>,
        pub aggressive: bool,
        pub dry_run: bool,
        pub workspace: bool,
    }

    pub fn generate_lockfile(ws: &Workspace<'_>) -> CargoResult<()> {
        let mut registry = PackageRegistry::new(ws.config())?;
        let mut resolve = ops::resolve_with_previous(
            &mut registry,
            ws,
            &CliFeatures::new_all(true),
            HasDevUnits::Yes,
            None,
            None,
            &[],
            true,
        )?;
        ops::write_pkg_lockfile(ws, &mut resolve)?;
        Ok(())
    }

    pub fn update_lockfile(ws: &Workspace<'_>, opts: &UpdateOptions<'_>) -> CargoResult<()> {
        if opts.aggressive && opts.precise.is_some() {
            anyhow::bail!("cannot specify both aggressive and precise simultaneously")
        }

        if ws.members().count() == 0 {
            anyhow::bail!("you can't generate a lockfile for an empty workspace.")
        }

        // Updates often require a lot of modifications to the registry, so ensure
        // that we're synchronized against other Cargos.
        let _lock = ws.config().acquire_package_cache_lock()?;

        let previous_resolve = match ops::load_pkg_lockfile(ws)? {
            Some(resolve) => resolve,
            None => {
                match opts.precise {
                    None => return generate_lockfile(ws),

                    // Precise option specified, so calculate a previous_resolve required
                    // by precise package update later.
                    Some(_) => {
                        let mut registry = PackageRegistry::new(opts.config)?;
                        ops::resolve_with_previous(
                            &mut registry,
                            ws,
                            &CliFeatures::new_all(true),
                            HasDevUnits::Yes,
                            None,
                            None,
                            &[],
                            true,
                        )?
                    }
                }
            }
        };
        let mut registry = PackageRegistry::new(opts.config)?;
        let mut to_avoid = HashSet::new();

        if opts.to_update.is_empty() {
            if !opts.workspace {
                to_avoid.extend(previous_resolve.iter());
                to_avoid.extend(previous_resolve.unused_patches());
            }
        } else {
            let mut sources = Vec::new();
            for name in opts.to_update.iter() {
                let dep = previous_resolve.query(name)?;
                if opts.aggressive {
                    fill_with_deps(&previous_resolve, dep, &mut to_avoid, &mut HashSet::new());
                } else {
                    to_avoid.insert(dep);
                    sources.push(match opts.precise {
                        Some(precise) => {
                            // TODO: see comment in `resolve.rs` as well, but this
                            //       seems like a pretty hokey reason to single out
                            //       the registry as well.
                            let precise = if dep.source_id().is_registry() {
                                semver::Version::parse(precise).with_context(|| {
                                    format!("invalid version format for precise version `{}`", precise)
                                })?;
                                format!("{}={}->{}", dep.name(), dep.version(), precise)
                            } else {
                                precise.to_string()
                            };
                            dep.source_id().with_precise(Some(precise))
                        }
                        None => dep.source_id().with_precise(None),
                    });
                }
                if let Ok(unused_id) =
                    PackageIdSpec::query_str(name, previous_resolve.unused_patches().iter().cloned())
                {
                    to_avoid.insert(unused_id);
                }
            }

            registry.add_sources(sources)?;
        }

        let mut resolve = ops::resolve_with_previous(
            &mut registry,
            ws,
            &CliFeatures::new_all(true),
            HasDevUnits::Yes,
            Some(&previous_resolve),
            Some(&to_avoid),
            &[],
            true,
        )?;

        // Summarize what is changing for the user.
        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) {
            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())
                };

                if removed[0].version() > added[0].version() {
                    print_change("Downgrading", msg, Yellow)?;
                } else {
                    print_change("Updating", msg, Green)?;
                }
            } else {
                for package in removed.iter() {
                    print_change("Removing", format!("{}", package), Red)?;
                }
                for package in added.iter() {
                    print_change("Adding", format!("{}", package), Cyan)?;
                }
            }
        }
        if opts.dry_run {
            opts.config
                .shell()
                .warn("not updating lockfile due to dry run")?;
        } else {
            ops::write_pkg_lockfile(ws, &mut resolve)?;
        }
        return Ok(());

        fn fill_with_deps<'a>(
            resolve: &'a Resolve,
            dep: PackageId,
            set: &mut HashSet<PackageId>,
            visited: &mut HashSet<PackageId>,
        ) {
            if !visited.insert(dep) {
                return;
            }
            set.insert(dep);
            for (dep, _) in resolve.deps_not_replaced(dep) {
                fill_with_deps(resolve, dep, set, visited);
            }
        }

        fn compare_dependency_graphs(
            previous_resolve: &Resolve,
            resolve: &Resolve,
        ) -> Vec<(Vec<PackageId>, Vec<PackageId>)> {
            fn key(dep: PackageId) -> (&'static str, SourceId) {
                (dep.name().as_str(), dep.source_id())
            }

            // Removes all package IDs in `b` from `a`. Note that this is somewhat
            // more complicated because the equality for source IDs does not take
            // precise versions into account (e.g., git shas), but we want to take
            // that into account here.
            fn vec_subtract(a: &[PackageId], b: &[PackageId]) -> Vec<PackageId> {
                a.iter()
                    .filter(|a| {
                        // If this package ID is not found in `b`, then it's definitely
                        // in the subtracted set.
                        let i = match b.binary_search(a) {
                            Ok(i) => i,
                            Err(..) => return true,
                        };

                        // If we've found `a` in `b`, then we iterate over all instances
                        // (we know `b` is sorted) and see if they all have different
                        // precise versions. If so, then `a` isn't actually in `b` so
                        // we'll let it through.
                        //
                        // Note that we only check this for non-registry sources,
                        // however, as registries contain enough version information in
                        // the package ID to disambiguate.
                        if a.source_id().is_registry() {
                            return false;
                        }
                        b[i..]
                            .iter()
                            .take_while(|b| a == b)
                            .all(|b| a.source_id().precise() != b.source_id().precise())
                    })
                    .cloned()
                    .collect()
            }

            // Map `(package name, package source)` to `(removed versions, added versions)`.
            let mut changes = BTreeMap::new();
            let empty = (Vec::new(), Vec::new());
            for dep in previous_resolve.iter() {
                changes
                    .entry(key(dep))
                    .or_insert_with(|| empty.clone())
                    .0
                    .push(dep);
            }
            for dep in resolve.iter() {
                changes
                    .entry(key(dep))
                    .or_insert_with(|| empty.clone())
                    .1
                    .push(dep);
            }

            for v in changes.values_mut() {
                let (ref mut old, ref mut new) = *v;
                old.sort();
                new.sort();
                let removed = vec_subtract(old, new);
                let added = vec_subtract(new, old);
                *old = removed;
                *new = added;
            }
            debug!("{:#?}", changes);

            changes.into_iter().map(|(_, v)| v).collect()
        }
    }