    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
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    809
    810
    811
    812
    813
    814
    815
    816
    817
    818
    819
    820
    821
    822
    823
    824
    825
    826
    827
    828
    829
    830
    831
    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    924
    925
    926
    927
    928
    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    962
    963
    964
    965
    966
    967
    968
    969
    970
    971
    972
    973
    974
    975
    976
    977
    978
    979
    980
    981
    982
    983
    984
    985
    986
    987
    988
    989
    990
    991
    992
    993
    994
    995
    996
    997
    998
    999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    1076
    1077
    1078
    1079
    1080
    1081
    1082
    1083
    1084
    1085
    1086
    1087
    1088
    1089
    1090
    1091
    1092
    1093
    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    1129
    1130
    1131
    1132
    1133
    1134
    1135
    1136
    1137

    //! Core of cargo-add command

    mod crate_spec;

    use std::collections::BTreeMap;
    use std::collections::BTreeSet;
    use std::collections::VecDeque;
    use std::fmt::Write;
    use std::path::Path;
    use std::str::FromStr;

    use anyhow::Context as _;
    use cargo_util::paths;
    use cargo_util_schemas::core::PartialVersion;
    use cargo_util_schemas::manifest::RustVersion;
    use indexmap::IndexSet;
    use itertools::Itertools;
    use toml_edit::Item as TomlItem;

    use crate::core::dependency::DepKind;
    use crate::core::registry::PackageRegistry;
    use crate::core::FeatureValue;
    use crate::core::Package;
    use crate::core::Registry;
    use crate::core::Shell;
    use crate::core::Summary;
    use crate::core::Workspace;
    use crate::sources::source::QueryKind;
    use crate::util::cache_lock::CacheLockMode;
    use crate::util::style;
    use crate::util::toml_mut::dependency::Dependency;
    use crate::util::toml_mut::dependency::GitSource;
    use crate::util::toml_mut::dependency::MaybeWorkspace;
    use crate::util::toml_mut::dependency::PathSource;
    use crate::util::toml_mut::dependency::Source;
    use crate::util::toml_mut::dependency::WorkspaceSource;
    use crate::util::toml_mut::is_sorted;
    use crate::util::toml_mut::manifest::DepTable;
    use crate::util::toml_mut::manifest::LocalManifest;
    use crate::CargoResult;
    use crate::GlobalContext;
    use crate_spec::CrateSpec;

    /// Information on what dependencies should be added
    #[derive(Clone, Debug)]
    pub struct AddOptions<'a> {
        /// Configuration information for cargo operations
        pub gctx: &'a GlobalContext,
        /// Package to add dependencies to
        pub spec: &'a Package,
        /// Dependencies to add or modify
        pub dependencies: Vec<DepOp>,
        /// Which dependency section to add these to
        pub section: DepTable,
        /// Act as if dependencies will be added
        pub dry_run: bool,
        /// Whether the minimum supported Rust version should be considered during resolution
        pub honor_rust_version: bool,
    }

    /// Add dependencies to a manifest
    pub fn add(workspace: &Workspace<'_>, options: &AddOptions<'_>) -> CargoResult<()> {
        let dep_table = options
            .section
            .to_table()
            .into_iter()
            .map(String::from)
            .collect::<Vec<_>>();

        let manifest_path = options.spec.manifest_path().to_path_buf();
        let mut manifest = LocalManifest::try_new(&manifest_path)?;
        let original_raw_manifest = manifest.to_string();
        let legacy = manifest.get_legacy_sections();
        if !legacy.is_empty() {
            anyhow::bail!(
                "Deprecated dependency sections are unsupported: {}",
                legacy.join(", ")
            );
        }

        let mut registry = PackageRegistry::new(options.gctx)?;

        let deps = {
            let _lock = options
                .gctx
                .acquire_package_cache_lock(CacheLockMode::DownloadExclusive)?;
            registry.lock_patches();
            options
                .dependencies
                .iter()
                .map(|raw| {
                    resolve_dependency(
                        &manifest,
                        raw,
                        workspace,
                        &options.spec,
                        &options.section,
                        options.honor_rust_version,
                        options.gctx,
                        &mut registry,
                    )
                })
                .collect::<CargoResult<Vec<_>>>()?
        };

        let was_sorted = manifest
            .get_table(&dep_table)
            .map(TomlItem::as_table)
            .map_or(true, |table_option| {
                table_option.map_or(true, |table| {
                    is_sorted(table.get_values().iter_mut().map(|(key, _)| {
                        // get_values key paths always have at least one key.
                        key.remove(0)
                    }))
                })
            });
        for dep in deps {
            print_action_msg(&mut options.gctx.shell(), &dep, &dep_table)?;
            if let Some(Source::Path(src)) = dep.source() {
                if src.path == manifest.path.parent().unwrap_or_else(|| Path::new("")) {
                    anyhow::bail!(
                        "cannot add `{}` as a dependency to itself",
                        manifest.package_name()?
                    )
                }
            }

            let available_features = dep
                .available_features
                .keys()
                .map(|s| s.as_ref())
                .collect::<BTreeSet<&str>>();
            let mut unknown_features: Vec<&str> = Vec::new();
            if let Some(req_feats) = dep.features.as_ref() {
                let req_feats: BTreeSet<_> = req_feats.iter().map(|s| s.as_str()).collect();
                unknown_features.extend(req_feats.difference(&available_features).copied());
            }
            if let Some(inherited_features) = dep.inherited_features.as_ref() {
                let inherited_features: BTreeSet<_> =
                    inherited_features.iter().map(|s| s.as_str()).collect();
                unknown_features.extend(inherited_features.difference(&available_features).copied());
            }

            unknown_features.sort();

            if !unknown_features.is_empty() {
                let (mut activated, mut deactivated) = dep.features();
                // Since the unknown features have been added to the DependencyUI we need to remove
                // them to present the "correct" features that can be specified for the crate.
                deactivated.retain(|f| !unknown_features.contains(f));
                activated.retain(|f| !unknown_features.contains(f));

                let mut message = format!(
                    "unrecognized feature{} for crate {}: {}\n",
                    if unknown_features.len() == 1 { "" } else { "s" },
                    dep.name,
                    unknown_features.iter().format(", "),
                );
                if activated.is_empty() && deactivated.is_empty() {
                    write!(message, "no features available for crate {}", dep.name)?;
                } else {
                    if !deactivated.is_empty() {
                        writeln!(
                            message,
                            "disabled features:\n    {}",
                            deactivated
                                .iter()
                                .map(|s| s.to_string())
                                .coalesce(|x, y| if x.len() + y.len() < 78 {
                                    Ok(format!("{x}, {y}"))
                                } else {
                                    Err((x, y))
                                })
                                .into_iter()
                                .format("\n    ")
                        )?
                    }
                    if !activated.is_empty() {
                        writeln!(
                            message,
                            "enabled features:\n    {}",
                            activated
                                .iter()
                                .map(|s| s.to_string())
                                .coalesce(|x, y| if x.len() + y.len() < 78 {
                                    Ok(format!("{x}, {y}"))
                                } else {
                                    Err((x, y))
                                })
                                .into_iter()
                                .format("\n    ")
                        )?
                    }
                }
                anyhow::bail!(message.trim().to_owned());
            }

            print_dep_table_msg(&mut options.gctx.shell(), &dep)?;

            manifest.insert_into_table(&dep_table, &dep)?;
            if dep.optional == Some(true) {
                let is_namespaced_features_supported =
                    check_rust_version_for_optional_dependency(options.spec.rust_version())?;
                if is_namespaced_features_supported {
                    let dep_key = dep.toml_key();
                    if !manifest.is_explicit_dep_activation(dep_key) {
                        let table = manifest.get_table_mut(&[String::from("features")])?;
                        let dep_name = dep.rename.as_deref().unwrap_or(&dep.name);
                        let new_feature: toml_edit::Value =
                            [format!("dep:{dep_name}")].iter().collect();
                        table[dep_key] = toml_edit::value(new_feature);
                        options
                            .gctx
                            .shell()
                            .status("Adding", format!("feature `{dep_key}`"))?;
                    }
                }
            }
            manifest.gc_dep(dep.toml_key());
        }

        if was_sorted {
            if let Some(table) = manifest
                .get_table_mut(&dep_table)
                .ok()
                .and_then(TomlItem::as_table_like_mut)
            {
                table.sort_values();
            }
        }

        if options.gctx.locked() {
            let new_raw_manifest = manifest.to_string();
            if original_raw_manifest != new_raw_manifest {
                anyhow::bail!(
                    "the manifest file {} needs to be updated but --locked was passed to prevent this",
                    manifest.path.display()
                );
            }
        }

        if options.dry_run {
            options.gctx.shell().warn("aborting add due to dry run")?;
        } else {
            manifest.write()?;
        }

        Ok(())
    }

    /// Dependency entry operation
    #[derive(Clone, Debug, PartialEq, Eq)]
    pub struct DepOp {
        /// Describes the crate
        pub crate_spec: Option<String>,
        /// Dependency key, overriding the package name in crate_spec
        pub rename: Option<String>,

        /// Feature flags to activate
        pub features: Option<IndexSet<String>>,
        /// Whether the default feature should be activated
        pub default_features: Option<bool>,

        /// Whether dependency is optional
        pub optional: Option<bool>,

        /// Whether dependency is public
        pub public: Option<bool>,

        /// Registry for looking up dependency version
        pub registry: Option<String>,

        /// Git repo for dependency
        pub path: Option<String>,
        /// Git repo for dependency
        pub git: Option<String>,
        /// Specify an alternative git branch
        pub branch: Option<String>,
        /// Specify a specific git rev
        pub rev: Option<String>,
        /// Specify a specific git tag
        pub tag: Option<String>,
    }

    fn resolve_dependency(
        manifest: &LocalManifest,
        arg: &DepOp,
        ws: &Workspace<'_>,
        spec: &Package,
        section: &DepTable,
        honor_rust_version: bool,
        gctx: &GlobalContext,
        registry: &mut PackageRegistry<'_>,
    ) -> CargoResult<DependencyUI> {
        let crate_spec = arg
            .crate_spec
            .as_deref()
            .map(CrateSpec::resolve)
            .transpose()?;
        let mut selected_dep = if let Some(url) = &arg.git {
            let mut src = GitSource::new(url);
            if let Some(branch) = &arg.branch {
                src = src.set_branch(branch);
            }
            if let Some(tag) = &arg.tag {
                src = src.set_tag(tag);
            }
            if let Some(rev) = &arg.rev {
                src = src.set_rev(rev);
            }

            let selected = if let Some(crate_spec) = &crate_spec {
                if let Some(v) = crate_spec.version_req() {
                    // crate specifier includes a version (e.g. `docopt@0.8`)
                    anyhow::bail!("cannot specify a git URL (`{url}`) with a version (`{v}`).");
                }
                let dependency = crate_spec.to_dependency()?.set_source(src);
                let selected = select_package(&dependency, gctx, registry)?;
                if dependency.name != selected.name {
                    gctx.shell().warn(format!(
                        "translating `{}` to `{}`",
                        dependency.name, selected.name,
                    ))?;
                }
                selected
            } else {
                let mut source = crate::sources::GitSource::new(src.source_id()?, gctx)?;
                let packages = source.read_packages()?;
                let package = infer_package_for_git_source(packages, &src)?;
                Dependency::from(package.summary())
            };
            selected
        } else if let Some(raw_path) = &arg.path {
            let path = paths::normalize_path(&std::env::current_dir()?.join(raw_path));
            let src = PathSource::new(&path);

            let selected = if let Some(crate_spec) = &crate_spec {
                if let Some(v) = crate_spec.version_req() {
                    // crate specifier includes a version (e.g. `docopt@0.8`)
                    anyhow::bail!("cannot specify a path (`{raw_path}`) with a version (`{v}`).");
                }
                let dependency = crate_spec.to_dependency()?.set_source(src);
                let selected = select_package(&dependency, gctx, registry)?;
                if dependency.name != selected.name {
                    gctx.shell().warn(format!(
                        "translating `{}` to `{}`",
                        dependency.name, selected.name,
                    ))?;
                }
                selected
            } else {
                let source = crate::sources::PathSource::new(&path, src.source_id()?, gctx);
                let package = source
                    .read_packages()?
                    .pop()
                    .expect("read_packages errors when no packages");
                Dependency::from(package.summary())
            };
            selected
        } else if let Some(crate_spec) = &crate_spec {
            crate_spec.to_dependency()?
        } else {
            anyhow::bail!("dependency name is required");
        };
        selected_dep = populate_dependency(selected_dep, arg);

        let old_dep = get_existing_dependency(manifest, selected_dep.toml_key(), section)?;
        let mut dependency = if let Some(mut old_dep) = old_dep.clone() {
            if old_dep.name != selected_dep.name {
                // Assuming most existing keys are not relevant when the package changes
                if selected_dep.optional.is_none() {
                    selected_dep.optional = old_dep.optional;
                }
                selected_dep
            } else {
                if selected_dep.source().is_some() {
                    // Overwrite with `crate_spec`
                    old_dep.source = selected_dep.source;
                }
                populate_dependency(old_dep, arg)
            }
        } else {
            selected_dep
        };

        if dependency.source().is_none() {
            // Checking for a workspace dependency happens first since a member could be specified
            // in the workspace dependencies table as a dependency
            if let Some(_dep) = find_workspace_dep(dependency.toml_key(), ws.root_manifest()).ok() {
                dependency = dependency.set_source(WorkspaceSource::new());
            } else if let Some(package) = ws.members().find(|p| p.name().as_str() == dependency.name) {
                // Only special-case workspaces when the user doesn't provide any extra
                // information, otherwise, trust the user.
                let mut src = PathSource::new(package.root());
                // dev-dependencies do not need the version populated
                if section.kind() != DepKind::Development {
                    let op = "";
                    let v = format!("{op}{version}", version = package.version());
                    src = src.set_version(v);
                }
                dependency = dependency.set_source(src);
            } else {
                let latest = get_latest_dependency(
                    spec,
                    &dependency,
                    false,
                    honor_rust_version,
                    gctx,
                    registry,
                )?;

                if dependency.name != latest.name {
                    gctx.shell().warn(format!(
                        "translating `{}` to `{}`",
                        dependency.name, latest.name,
                    ))?;
                    dependency.name = latest.name; // Normalize the name
                }
                dependency = dependency.set_source(latest.source.expect("latest always has a source"));
            }
        }

        if let Some(Source::Workspace(_)) = dependency.source() {
            check_invalid_ws_keys(dependency.toml_key(), arg)?;
        }

        let version_required = dependency.source().and_then(|s| s.as_registry()).is_some();
        let version_optional_in_section = section.kind() == DepKind::Development;
        let preserve_existing_version = old_dep
            .as_ref()
            .map(|d| d.version().is_some())
            .unwrap_or(false);
        if !version_required && !preserve_existing_version && version_optional_in_section {
            // dev-dependencies do not need the version populated
            dependency = dependency.clear_version();
        }

        let query = dependency.query(gctx)?;
        let query = match query {
            MaybeWorkspace::Workspace(_workspace) => {
                let dep = find_workspace_dep(dependency.toml_key(), ws.root_manifest())?;
                if let Some(features) = dep.features.clone() {
                    dependency = dependency.set_inherited_features(features);
                }
                let query = dep.query(gctx)?;
                match query {
                    MaybeWorkspace::Workspace(_) => {
                        unreachable!("This should have been caught when parsing a workspace root")
                    }
                    MaybeWorkspace::Other(query) => query,
                }
            }
            MaybeWorkspace::Other(query) => query,
        };

        let dependency = populate_available_features(dependency, &query, registry)?;

        Ok(dependency)
    }

    /// When { workspace = true } you cannot define other keys that configure
    /// the source of the dependency such as `version`, `registry`, `registry-index`,
    /// `path`, `git`, `branch`, `tag`, `rev`, or `package`. You can also not define
    /// `default-features`.
    ///
    /// Only `default-features`, `registry` and `rename` need to be checked
    ///  for currently. This is because `git` and its associated keys, `path`, and
    /// `version`  should all bee checked before this is called. `rename` is checked
    /// for as it turns into `package`
    fn check_invalid_ws_keys(toml_key: &str, arg: &DepOp) -> CargoResult<()> {
        fn err_msg(toml_key: &str, flag: &str, field: &str) -> String {
            format!(
                "cannot override workspace dependency with `{flag}`, \
                either change `workspace.dependencies.{toml_key}.{field}` \
                or define the dependency exclusively in the package's manifest"
            )
        }

        if arg.default_features.is_some() {
            anyhow::bail!(
                "{}",
                err_msg(toml_key, "--default-features", "default-features")
            )
        }
        if arg.registry.is_some() {
            anyhow::bail!("{}", err_msg(toml_key, "--registry", "registry"))
        }
        // rename is `package`
        if arg.rename.is_some() {
            anyhow::bail!("{}", err_msg(toml_key, "--rename", "package"))
        }
        Ok(())
    }

    /// When the `--optional` option is added using `cargo add`, we need to
    /// check the current rust-version. As the `dep:` syntax is only avaliable
    /// starting with Rust 1.60.0
    ///
    /// `true` means that the rust-version is None or the rust-version is higher
    /// than the version needed.
    ///
    /// Note: Previous versions can only use the implicit feature name.
    fn check_rust_version_for_optional_dependency(
        rust_version: Option<&RustVersion>,
    ) -> CargoResult<bool> {
        match rust_version {
            Some(version) => {
                let syntax_support_version = RustVersion::from_str("1.60.0")?;
                Ok(&syntax_support_version <= version)
            }
            None => Ok(true),
        }
    }

    /// Provide the existing dependency for the target table
    ///
    /// If it doesn't exist but exists in another table, let's use that as most likely users
    /// want to use the same version across all tables unless they are renaming.
    fn get_existing_dependency(
        manifest: &LocalManifest,
        dep_key: &str,
        section: &DepTable,
    ) -> CargoResult<Option<Dependency>> {
        #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
        enum Key {
            Error,
            Dev,
            Build,
            Normal,
            Existing,
        }

        let mut possible: Vec<_> = manifest
            .get_dependency_versions(dep_key)
            .map(|(path, dep)| {
                let key = if path == *section {
                    (Key::Existing, true)
                } else if dep.is_err() {
                    (Key::Error, path.target().is_some())
                } else {
                    let key = match path.kind() {
                        DepKind::Normal => Key::Normal,
                        DepKind::Build => Key::Build,
                        DepKind::Development => Key::Dev,
                    };
                    (key, path.target().is_some())
                };
                (key, dep)
            })
            .collect();
        possible.sort_by_key(|(key, _)| *key);
        let Some((key, dep)) = possible.pop() else {
            return Ok(None);
        };
        let mut dep = dep?;

        if key.0 != Key::Existing {
            // When the dep comes from a different section, we only care about the source and not any
            // of the other fields, like `features`
            let unrelated = dep;
            dep = Dependency::new(&unrelated.name);
            dep.source = unrelated.source.clone();
            dep.registry = unrelated.registry.clone();

            // dev-dependencies do not need the version populated when path is set though we
            // should preserve it if the user chose to populate it.
            let version_required = unrelated.source().and_then(|s| s.as_registry()).is_some();
            let version_optional_in_section = section.kind() == DepKind::Development;
            if !version_required && version_optional_in_section {
                dep = dep.clear_version();
            }
        }

        Ok(Some(dep))
    }

    fn get_latest_dependency(
        spec: &Package,
        dependency: &Dependency,
        _flag_allow_prerelease: bool,
        honor_rust_version: bool,
        gctx: &GlobalContext,
        registry: &mut PackageRegistry<'_>,
    ) -> CargoResult<Dependency> {
        let query = dependency.query(gctx)?;
        match query {
            MaybeWorkspace::Workspace(_) => {
                unreachable!("registry dependencies required, found a workspace dependency");
            }
            MaybeWorkspace::Other(query) => {
                let possibilities = loop {
                    match registry.query_vec(&query, QueryKind::Normalized) {
                        std::task::Poll::Ready(res) => {
                            break res?;
                        }
                        std::task::Poll::Pending => registry.block_until_ready()?,
                    }
                };

                let mut possibilities: Vec<_> = possibilities
                    .into_iter()
                    .map(|s| s.into_summary())
                    .collect();

                possibilities.sort_by_key(|s| {
                    // Fallback to a pre-release if no official release is available by sorting them as
                    // less.
                    let stable = s.version().pre.is_empty();
                    (stable, s.version().clone())
                });

                let mut latest = possibilities.last().ok_or_else(|| {
                    anyhow::format_err!(
                        "the crate `{dependency}` could not be found in registry index."
                    )
                })?;

                if gctx.cli_unstable().msrv_policy && honor_rust_version {
                    let (req_msrv, is_msrv) = spec
                        .rust_version()
                        .cloned()
                        .map(|msrv| CargoResult::Ok((msrv.clone().into_partial(), true)))
                        .unwrap_or_else(|| {
                            let rustc = gctx.load_global_rustc(None)?;

                            // Remove any pre-release identifiers for easier comparison
                            let rustc_version = rustc.version.clone().into();
                            Ok((rustc_version, false))
                        })?;

                    let msrvs = possibilities
                        .iter()
                        .map(|s| (s, s.rust_version()))
                        .collect::<Vec<_>>();

                    // Find the latest version of the dep which has a compatible rust-version. To
                    // determine whether or not one rust-version is compatible with another, we
                    // compare the lowest possible versions they could represent, and treat
                    // candidates without a rust-version as compatible by default.
                    let latest_msrv = latest_compatible(&msrvs, &req_msrv).ok_or_else(|| {
                            let name = spec.name();
                            let dep_name = &dependency.name;
                            let latest_version = latest.version();
                            let latest_msrv = latest
                                .rust_version()
                                .expect("as `None` are compatible, we can't be here");
                            if is_msrv {
                                anyhow::format_err!(
                                    "\
    no version of crate `{dep_name}` can maintain {name}'s rust-version of {req_msrv}
    help: pass `--ignore-rust-version` to select {dep_name}@{latest_version} which requires rustc {latest_msrv}"
                                )
                            } else {
                                anyhow::format_err!(
                                    "\
    no version of crate `{dep_name}` is compatible with rustc {req_msrv}
    help: pass `--ignore-rust-version` to select {dep_name}@{latest_version} which requires rustc {latest_msrv}"
                                )
                            }
                        })?;

                    if latest_msrv.version() < latest.version() {
                        let latest_version = latest.version();
                        let latest_rust_version = latest.rust_version().unwrap();
                        let name = spec.name();
                        if is_msrv {
                            gctx.shell().warn(format_args!(
                                "\
    ignoring {dependency}@{latest_version} (which requires rustc {latest_rust_version}) to maintain {name}'s rust-version of {req_msrv}",
                            ))?;
                        } else {
                            gctx.shell().warn(format_args!(
                                "\
    ignoring {dependency}@{latest_version} (which requires rustc {latest_rust_version}) as it is incompatible with rustc {req_msrv}",
                            ))?;
                        }

                        latest = latest_msrv;
                    }
                }

                let mut dep = Dependency::from(latest);
                if let Some(reg_name) = dependency.registry.as_deref() {
                    dep = dep.set_registry(reg_name);
                }
                Ok(dep)
            }
        }
    }

    /// Of MSRV-compatible summaries, find the highest version
    ///
    /// Assumptions:
    /// - `msrvs` is sorted by version
    fn latest_compatible<'s>(
        msrvs: &[(&'s Summary, Option<&RustVersion>)],
        pkg_msrv: &PartialVersion,
    ) -> Option<&'s Summary> {
        msrvs
            .iter()
            .filter(|(_, dep_msrv)| {
                dep_msrv
                    .as_ref()
                    .map(|dep_msrv| dep_msrv.is_compatible_with(pkg_msrv))
                    .unwrap_or(true)
            })
            .map(|(s, _)| s)
            .last()
            .copied()
    }

    fn select_package(
        dependency: &Dependency,
        gctx: &GlobalContext,
        registry: &mut PackageRegistry<'_>,
    ) -> CargoResult<Dependency> {
        let query = dependency.query(gctx)?;
        match query {
            MaybeWorkspace::Workspace(_) => {
                unreachable!("path or git dependency expected, found workspace dependency");
            }
            MaybeWorkspace::Other(query) => {
                let possibilities = loop {
                    // Exact to avoid returning all for path/git
                    match registry.query_vec(&query, QueryKind::Normalized) {
                        std::task::Poll::Ready(res) => {
                            break res?;
                        }
                        std::task::Poll::Pending => registry.block_until_ready()?,
                    }
                };

                let possibilities: Vec<_> = possibilities
                    .into_iter()
                    .map(|s| s.into_summary())
                    .collect();

                match possibilities.len() {
                    0 => {
                        let source = dependency
                            .source()
                            .expect("source should be resolved before here");
                        anyhow::bail!("the crate `{dependency}` could not be found at `{source}`")
                    }
                    1 => {
                        let mut dep = Dependency::from(&possibilities[0]);
                        if let Some(reg_name) = dependency.registry.as_deref() {
                            dep = dep.set_registry(reg_name);
                        }
                        Ok(dep)
                    }
                    _ => {
                        let source = dependency
                            .source()
                            .expect("source should be resolved before here");
                        anyhow::bail!(
                            "unexpectedly found multiple copies of crate `{dependency}` at `{source}`"
                        )
                    }
                }
            }
        }
    }

    fn infer_package_for_git_source(
        mut packages: Vec<Package>,
        src: &dyn std::fmt::Display,
    ) -> CargoResult<Package> {
        let package = match packages.len() {
            0 => unreachable!(
                "this function should only be called with packages from `GitSource::read_packages` \
                and that call should error for us when there are no packages"
            ),
            1 => packages.pop().expect("match ensured element is present"),
            _ => {
                let mut names: Vec<_> = packages
                    .iter()
                    .map(|p| p.name().as_str().to_owned())
                    .collect();
                names.sort_unstable();
                anyhow::bail!(
                    "multiple packages found at `{src}`:\n    {}\nTo disambiguate, run `cargo add --git {src} <package>`",
                    names
                        .iter()
                        .map(|s| s.to_string())
                        .coalesce(|x, y| if x.len() + y.len() < 78 {
                            Ok(format!("{x}, {y}"))
                        } else {
                            Err((x, y))
                        })
                        .into_iter()
                        .format("\n    "),
                );
            }
        };
        Ok(package)
    }

    fn populate_dependency(mut dependency: Dependency, arg: &DepOp) -> Dependency {
        if let Some(registry) = &arg.registry {
            if registry.is_empty() {
                dependency.registry = None;
            } else {
                dependency.registry = Some(registry.to_owned());
            }
        }
        if let Some(value) = arg.optional {
            if value {
                dependency.optional = Some(true);
            } else {
                dependency.optional = None;
            }
        }
        if let Some(value) = arg.public {
            if value {
                dependency.public = Some(true);
            } else {
                dependency.public = None;
            }
        }
        if let Some(value) = arg.default_features {
            if value {
                dependency.default_features = None;
            } else {
                dependency.default_features = Some(false);
            }
        }
        if let Some(value) = arg.features.as_ref() {
            dependency = dependency.extend_features(value.iter().cloned());
        }

        if let Some(rename) = &arg.rename {
            dependency = dependency.set_rename(rename);
        }

        dependency
    }

    /// Track presentation-layer information with the editable representation of a `[dependencies]`
    /// entry (Dependency)
    pub struct DependencyUI {
        /// Editable representation of a `[depednencies]` entry
        dep: Dependency,
        /// The version of the crate that we pulled `available_features` from
        available_version: Option<semver::Version>,
        /// The widest set of features compatible with `Dependency`s version requirement
        available_features: BTreeMap<String, Vec<String>>,
    }

    impl DependencyUI {
        fn new(dep: Dependency) -> Self {
            Self {
                dep,
                available_version: None,
                available_features: Default::default(),
            }
        }

        fn apply_summary(&mut self, summary: &Summary) {
            self.available_version = Some(summary.version().clone());
            self.available_features = summary
                .features()
                .iter()
                .map(|(k, v)| {
                    (
                        k.as_str().to_owned(),
                        v.iter()
                            .filter_map(|v| match v {
                                FeatureValue::Feature(f) => Some(f.as_str().to_owned()),
                                FeatureValue::Dep { .. } | FeatureValue::DepFeature { .. } => None,
                            })
                            .collect::<Vec<_>>(),
                    )
                })
                .collect();
        }

        fn features(&self) -> (IndexSet<&str>, IndexSet<&str>) {
            let mut activated: IndexSet<_> =
                self.features.iter().flatten().map(|s| s.as_str()).collect();
            if self.default_features().unwrap_or(true) {
                activated.insert("default");
            }
            activated.extend(self.inherited_features.iter().flatten().map(|s| s.as_str()));
            let mut walk: VecDeque<_> = activated.iter().cloned().collect();
            while let Some(next) = walk.pop_front() {
                walk.extend(
                    self.available_features
                        .get(next)
                        .into_iter()
                        .flatten()
                        .map(|s| s.as_str())
                        .filter(|s| !activated.contains(s)),
                );
                activated.extend(
                    self.available_features
                        .get(next)
                        .into_iter()
                        .flatten()
                        .map(|s| s.as_str()),
                );
            }
            activated.remove("default");
            activated.sort();
            let mut deactivated = self
                .available_features
                .keys()
                .filter(|f| !activated.contains(f.as_str()) && *f != "default")
                .map(|f| f.as_str())
                .collect::<IndexSet<_>>();
            deactivated.sort();
            (activated, deactivated)
        }
    }

    impl<'s> From<&'s Summary> for DependencyUI {
        fn from(other: &'s Summary) -> Self {
            let dep = Dependency::from(other);
            let mut dep = Self::new(dep);
            dep.apply_summary(other);
            dep
        }
    }

    impl std::fmt::Display for DependencyUI {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            self.dep.fmt(f)
        }
    }

    impl std::ops::Deref for DependencyUI {
        type Target = Dependency;

        fn deref(&self) -> &Self::Target {
            &self.dep
        }
    }

    /// Lookup available features
    fn populate_available_features(
        dependency: Dependency,
        query: &crate::core::dependency::Dependency,
        registry: &mut PackageRegistry<'_>,
    ) -> CargoResult<DependencyUI> {
        let mut dependency = DependencyUI::new(dependency);

        if !dependency.available_features.is_empty() {
            return Ok(dependency);
        }

        let possibilities = loop {
            match registry.query_vec(&query, QueryKind::Normalized) {
                std::task::Poll::Ready(res) => {
                    break res?;
                }
                std::task::Poll::Pending => registry.block_until_ready()?,
            }
        };
        // Ensure widest feature flag compatibility by picking the earliest version that could show up
        // in the lock file for a given version requirement.
        let lowest_common_denominator = possibilities
            .iter()
            .map(|s| s.as_summary())
            .min_by_key(|s| {
                // Fallback to a pre-release if no official release is available by sorting them as
                // more.
                let is_pre = !s.version().pre.is_empty();
                (is_pre, s.version())
            })
            .ok_or_else(|| {
                anyhow::format_err!("the crate `{dependency}` could not be found in registry index.")
            })?;
        dependency.apply_summary(&lowest_common_denominator);

        Ok(dependency)
    }

    fn print_action_msg(shell: &mut Shell, dep: &DependencyUI, section: &[String]) -> CargoResult<()> {
        if matches!(shell.verbosity(), crate::core::shell::Verbosity::Quiet) {
            return Ok(());
        }

        let mut message = String::new();
        write!(message, "{}", dep.name)?;
        match dep.source() {
            Some(Source::Registry(src)) => {
                if src.version.chars().next().unwrap_or('0').is_ascii_digit() {
                    write!(message, " v{}", src.version)?;
                } else {
                    write!(message, " {}", src.version)?;
                }
            }
            Some(Source::Path(_)) => {
                write!(message, " (local)")?;
            }
            Some(Source::Git(_)) => {
                write!(message, " (git)")?;
            }
            Some(Source::Workspace(_)) => {
                write!(message, " (workspace)")?;
            }
            None => {}
        }
        write!(message, " to")?;
        if dep.optional().unwrap_or(false) {
            write!(message, " optional")?;
        }
        if dep.public().unwrap_or(false) {
            write!(message, " public")?;
        }
        let section = if section.len() == 1 {
            section[0].clone()
        } else {
            format!("{} for target `{}`", &section[2], &section[1])
        };
        write!(message, " {section}")?;
        shell.status("Adding", message)
    }

    fn print_dep_table_msg(shell: &mut Shell, dep: &DependencyUI) -> CargoResult<()> {
        if matches!(shell.verbosity(), crate::core::shell::Verbosity::Quiet) {
            return Ok(());
        }

        let stderr = shell.err();
        let good = style::GOOD;
        let error = style::ERROR;

        let (activated, deactivated) = dep.features();
        if !activated.is_empty() || !deactivated.is_empty() {
            let prefix = format!("{:>13}", " ");
            let suffix = format_features_version_suffix(&dep);

            writeln!(stderr, "{prefix}Features{suffix}:")?;

            const MAX_FEATURE_PRINTS: usize = 30;
            let total_activated = activated.len();
            let total_deactivated = deactivated.len();

            if total_activated <= MAX_FEATURE_PRINTS {
                for feat in activated {
                    writeln!(stderr, "{prefix}{good}+{good:#} {feat}")?;
                }
            } else {
                writeln!(stderr, "{prefix}{total_activated} activated features")?;
            }

            if total_activated + total_deactivated <= MAX_FEATURE_PRINTS {
                for feat in deactivated {
                    writeln!(stderr, "{prefix}{error}-{error:#} {feat}")?;
                }
            } else {
                writeln!(stderr, "{prefix}{total_deactivated} deactivated features")?;
            }
        }

        Ok(())
    }

    fn format_features_version_suffix(dep: &DependencyUI) -> String {
        if let Some(version) = &dep.available_version {
            let mut version = version.clone();
            version.build = Default::default();
            let version = version.to_string();
            // Avoid displaying the version if it will visually look like the version req that we
            // showed earlier
            let version_req = dep
                .version()
                .and_then(|v| semver::VersionReq::parse(v).ok())
                .and_then(|v| precise_version(&v));
            if version_req.as_deref() != Some(version.as_str()) {
                format!(" as of v{version}")
            } else {
                "".to_owned()
            }
        } else {
            "".to_owned()
        }
    }

    fn find_workspace_dep(toml_key: &str, root_manifest: &Path) -> CargoResult<Dependency> {
        let manifest = LocalManifest::try_new(root_manifest)?;
        let manifest = manifest
            .data
            .as_item()
            .as_table_like()
            .context("could not make `manifest.data` into a table")?;
        let workspace = manifest
            .get("workspace")
            .context("could not find `workspace`")?
            .as_table_like()
            .context("could not make `manifest.data.workspace` into a table")?;
        let dependencies = workspace
            .get("dependencies")
            .context("could not find `dependencies` table in `workspace`")?
            .as_table_like()
            .context("could not make `dependencies` into a table")?;
        let dep_item = dependencies.get(toml_key).context(format!(
            "could not find {} in `workspace.dependencies`",
            toml_key
        ))?;
        Dependency::from_toml(root_manifest.parent().unwrap(), toml_key, dep_item)
    }

    /// Convert a `semver::VersionReq` into a rendered `semver::Version` if all fields are fully
    /// specified.
    fn precise_version(version_req: &semver::VersionReq) -> Option<String> {
        version_req
            .comparators
            .iter()
            .filter(|c| {
                matches!(
                    c.op,
                    // Only ops we can determine a precise version from
                    semver::Op::Exact
                        | semver::Op::GreaterEq
                        | semver::Op::LessEq
                        | semver::Op::Tilde
                        | semver::Op::Caret
                        | semver::Op::Wildcard
                )
            })
            .filter_map(|c| {
                // Only do it when full precision is specified
                c.minor.and_then(|minor| {
                    c.patch.map(|patch| semver::Version {
                        major: c.major,
                        minor,
                        patch,
                        pre: c.pre.clone(),
                        build: Default::default(),
                    })
                })
            })
            .max()
            .map(|v| v.to_string())
    }