check-updates 0.3.1

CLI for checking for updates to your Cargo dependencies
Documentation
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
use std::{
    collections::{HashMap, HashSet},
    path::PathBuf,
    rc::Rc,
    time::Instant,
};

use cargo_metadata::{CargoOpt, MetadataCommand};
use semver::VersionReq;
use tame_index::index::{FileLock, IndexLocation, IndexUrl, SparseIndex};
use thiserror::Error;

use crate::{
    RegistryCachePolicy, State,
    package::{Package, PackageVersion, Unit, Usage},
    registry::RegistryError,
};

mod fetch;
mod resolve;
mod update;

use resolve::*;
use update::*;

#[derive(Debug, Error)]
pub enum CargoError {
    #[error("failed to get cargo metadata: {0}")]
    Metadata(String),
    #[error("failed to access crates.io index: {0}")]
    Index(#[from] tame_index::Error),
    #[error("HTTP request failed: {0}")]
    Http(#[from] http::Error),
    #[error("request error: {0}")]
    Reqwest(#[from] reqwest::Error),
    #[error("manifest is not writable: {0}")]
    ReadOnly(PathBuf),
}

pub struct CargoRegistry {
    state: Rc<State>,
}

impl CargoRegistry {
    pub fn new(state: Rc<State>) -> Self {
        Self { state }
    }
}

impl super::RegistryImpl for CargoRegistry {
    async fn packages(&self) -> Result<Vec<Package>, RegistryError> {
        let total_start = Instant::now();

        let index = SparseIndex::new(IndexLocation::new(IndexUrl::CratesIoSparse))
            .map_err(CargoError::from)?;
        let lock = FileLock::unlocked();

        let metadata_cmd = || {
            let mut cmd = MetadataCommand::new();
            if let Some(root) = self.state.root() {
                cmd.current_dir(root);
            }
            cmd
        };

        let metadata_start = Instant::now();
        let metadata = metadata_cmd()
            .features(CargoOpt::AllFeatures)
            .exec()
            .or_else(|_| {
                metadata_cmd()
                    .features(CargoOpt::SomeFeatures(vec![]))
                    .exec()
            })
            .or_else(|_| metadata_cmd().exec())
            .map_err(|e| CargoError::Metadata(e.to_string()))?;
        log::debug!(
            "cargo.packages: cargo metadata resolution took {:?}",
            metadata_start.elapsed()
        );

        let registry_start = Instant::now();
        let members = workspace_members(&metadata);
        let names = collect_crates_io_deps(&members);

        let mut versions: HashMap<String, Vec<PackageVersion>> = HashMap::new();
        let mut requests: Vec<(String, http::Request<()>)> = Vec::new();
        let mut cache_hits = 0usize;
        let policy = self.state.registry_cache_policy();
        let use_local_cache = matches!(policy, RegistryCachePolicy::PreferLocal);

        for name in &names {
            if use_local_cache {
                let crate_name = name.as_str().try_into().map_err(CargoError::from)?;
                match index.cached_krate(crate_name, &lock) {
                    Ok(Some(krate)) => {
                        versions.insert(name.clone(), versions_from_krate(&krate));
                        cache_hits += 1;
                        continue;
                    }
                    Ok(None) => {}
                    Err(err) => {
                        log::debug!("cargo.packages: cache miss for '{name}': {err}");
                    }
                }
            }

            let request = index
                .make_remote_request(
                    name.as_str().try_into().map_err(CargoError::from)?,
                    None,
                    &lock,
                )
                .map_err(|e| e.to_string());

            match request {
                Ok(req) => requests.push((name.clone(), req)),
                Err(e) => {
                    log::warn!("failed to build cache request for '{name}': {e}");
                }
            }
        }

        log::debug!(
            "cargo.packages: cache policy {:?}, cache hits {}, network requests {}, registry resolve took {:?}",
            policy,
            cache_hits,
            requests.len(),
            registry_start.elapsed()
        );

        if !requests.is_empty() {
            let mut responses = fetch::fetch_all(self.state.client(), requests).await;

            for name in names {
                if versions.contains_key(&name) {
                    continue;
                }

                let response = match responses.remove(&name) {
                    Some(Ok(r)) => r,
                    Some(Err(e)) => {
                        log::warn!("failed to fetch index for '{name}': {e}");
                        continue;
                    }
                    None => continue,
                };

                let write_cache_entry = !matches!(policy, RegistryCachePolicy::NoCache);
                let crate_name = match name.as_str().try_into() {
                    Ok(name) => name,
                    Err(e) => {
                        log::warn!("failed to parse crate name '{name}': {e}");
                        continue;
                    }
                };

                match index.parse_remote_response(crate_name, response, write_cache_entry, &lock) {
                    Ok(Some(krate)) => {
                        versions.insert(name, versions_from_krate(&krate));
                    }
                    Ok(None) => {
                        log::debug!("no crate data returned for '{name}'");
                    }
                    Err(e) => {
                        log::warn!("failed to parse versions for '{name}': {e}");
                    }
                }
            }
        }

        let workspace_root_manifest: PathBuf = metadata.workspace_root.join("Cargo.toml").into();

        let crate_meta = crate_meta_from_packages(&metadata.packages);

        let inherited_deps: HashMap<PathBuf, InheritedDeps> = members
            .iter()
            .map(|member| {
                let path: PathBuf = member.manifest_path.clone().into();
                let inherited = workspace_inherited_deps(&path);
                (path, inherited)
            })
            .collect();

        let packages = build_packages(
            &members,
            &versions,
            &workspace_root_manifest,
            &crate_meta,
            &inherited_deps,
        )
        .into_iter()
        .collect();
        log::debug!(
            "cargo.packages: total resolution took {:?}",
            total_start.elapsed()
        );

        Ok(packages)
    }

    fn update_versions<'a>(
        &self,
        packages: impl IntoIterator<Item = (&'a Usage, &'a Package, VersionReq)>,
    ) -> Result<(), RegistryError> {
        // Group all edits by manifest path so we only read/write each file once.
        let mut edits: HashMap<PathBuf, Vec<ManifestEdit>> = HashMap::new();

        for (usage, package, new_req) in packages {
            // Fan out to every dep-kind section that shares the same unit + req.
            // This handles the case where a package appears under both
            // [dependencies] and [dev-dependencies] with the same version.
            let matching_usages = package
                .usages
                .iter()
                .filter(|u| u.unit == usage.unit && u.req == usage.req);

            for u in matching_usages {
                let manifest = match u.unit.path() {
                    Some(p) => p.to_path_buf(),
                    None => {
                        log::warn!(
                            "skipping update for '{}': unit has no manifest path",
                            package.purl.name()
                        );
                        continue;
                    }
                };

                // The TOML key is the rename (alias) if present, otherwise the
                // real crate name.
                let toml_key = u
                    .rename
                    .as_deref()
                    .unwrap_or_else(|| package.purl.name())
                    .to_string();

                let section = match &u.unit {
                    Unit::Workspace { .. } => {
                        vec!["workspace".to_string(), "dependencies".to_string()]
                    }
                    _ => vec![u.kind.to_string()],
                };

                edits.entry(manifest).or_default().push(ManifestEdit {
                    section,
                    toml_key,
                    new_req: new_req.clone(),
                    old_req: u.req.clone(),
                    preserve_bare: true,
                });
            }
        }

        // Apply all edits, one manifest at a time.
        for (manifest, file_edits) in &edits {
            let mut seen = HashSet::new();
            let deduped: Vec<_> = file_edits
                .iter()
                .filter(|edit| {
                    seen.insert((
                        edit.section.clone(),
                        edit.toml_key.clone(),
                        edit.old_req.to_string(),
                        edit.new_req.to_string(),
                    ))
                })
                .cloned()
                .collect();

            apply_manifest_edits(manifest, &deduped)?;
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::package::DepKind;
    use crate::registry::RegistryImpl;
    use std::path::PathBuf;

    fn init() -> CargoRegistry {
        CargoRegistry::new(State::new(None, crate::Options::default()).into())
    }

    fn init_workspace_demo() -> CargoRegistry {
        let root =
            PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../examples/cargo/workspace-demo");
        CargoRegistry::new(State::new(Some(root), crate::Options::default()).into())
    }

    #[tokio::test]
    async fn fetch_this_workspace() {
        let registry = init();
        let packages = registry.packages().await.unwrap();
        assert!(packages.into_iter().any(|p| p.purl.name() == "clap"));
    }

    #[tokio::test]
    async fn workspace_deps_use_workspace_unit() {
        let registry = init();
        let packages = registry.packages().await.unwrap();

        // All deps in this project use `workspace = true`, so every usage
        // should point at the workspace root Cargo.toml via Unit::Workspace.
        for package in packages {
            for usage in &package.usages {
                assert!(
                    matches!(&usage.unit, Unit::Workspace { .. }),
                    "expected Unit::Workspace for '{}', got {:?}",
                    package.purl.name(),
                    usage.unit
                );
            }
        }
    }

    #[tokio::test]
    async fn workspace_unit_has_path() {
        let registry = init();
        let packages = registry.packages().await.unwrap();

        let any_workspace_usage = packages
            .into_iter()
            .flat_map(|pkg| pkg.usages)
            .find(|u| matches!(&u.unit, Unit::Workspace { .. }))
            .expect("should have at least one workspace usage");

        let path = any_workspace_usage.unit.path().unwrap();
        assert!(
            path.ends_with("Cargo.toml"),
            "workspace unit path should point to Cargo.toml, got {}",
            path.display()
        );
    }

    #[tokio::test]
    async fn dep_kinds_are_set() {
        let registry = init();
        let packages = registry.packages().await.unwrap();

        // semver is a normal dependency of check-updates
        let semver = packages
            .into_iter()
            .find(|p| p.purl.name() == "semver")
            .expect("semver should be in packages");

        assert!(
            semver.usages.iter().any(|u| u.kind == DepKind::Normal),
            "semver should have at least one Normal usage"
        );
    }

    #[tokio::test]
    async fn crate_meta_populated() {
        let registry = init();
        let packages = registry.packages().await.unwrap();

        // clap is a well-known crate that has a repository field
        let clap = packages
            .into_iter()
            .find(|p| p.purl.name() == "clap")
            .expect("clap should be in packages");

        assert!(
            clap.repository.is_some(),
            "clap should have a repository URL"
        );
    }

    #[tokio::test]
    async fn renamed_deps_are_not_mistaken_for_workspace_inherited() {
        let registry = init_workspace_demo();
        let packages = registry.packages().await.unwrap();

        let rand = packages
            .into_iter()
            .find(|p| p.purl.name() == "rand")
            .expect("rand should be in packages");

        let renamed_usages: Vec<_> = rand
            .usages
            .iter()
            .filter(|u| u.rename.as_deref() == Some("rand07"))
            .collect();

        assert!(
            !renamed_usages.is_empty(),
            "workspace demo should include renamed rand07 usages"
        );
        assert!(
            renamed_usages
                .iter()
                .all(|u| matches!(u.unit, Unit::Project { .. })),
            "renamed rand07 usages should map to project manifests, not workspace"
        );
    }

    #[tokio::test]
    async fn target_workspace_inherited_stays_workspace_unit() {
        let registry = init_workspace_demo();
        let packages = registry.packages().await.unwrap();

        let anyhow = packages
            .into_iter()
            .find(|p| p.purl.name() == "anyhow")
            .expect("anyhow should be in packages");

        assert!(
            anyhow
                .usages
                .iter()
                .any(|u| matches!(u.unit, Unit::Workspace { .. })),
            "workspace-inherited anyhow usages should include workspace unit"
        );
    }

    #[tokio::test]
    async fn target_non_workspace_dep_stays_project_unit() {
        let registry = init_workspace_demo();
        let packages = registry.packages().await.unwrap();

        let tokio = packages
            .into_iter()
            .find(|p| p.purl.name() == "tokio")
            .expect("tokio should be in packages");

        assert!(
            tokio
                .usages
                .iter()
                .any(|u| matches!(u.unit, Unit::Project { .. })),
            "target non-workspace tokio usage should include project unit"
        );
    }
}