fix(vendor): dont remove non-cached source #15260

weihanglo · 2025-03-04T01:56:11Z

What does this PR try to resolve?

With this fix,
cargo vendor will not delete original sources,
if you want to vendor things from one directory sources to the other

Background

cargo-vendor has a workaround that to mitigate #5956:
it removes all cached sources in order to trigger a re-unpack.
It was meant for dealing with registry sources only,
but accidentally applied to directory source kind.

While directory source kind was invented for vendoring,
and vendoring from one vendored directory to the other seems unusual,
Cargo IMO should not delete any real sources.

It does not mean that registry sources are okay to delete,
In long term, we should explore a way that unpacks .crate files
directly, without any removal. See
#12509 (comment)

How should we test and review this PR?

The added test should suffice.

Also, although this is for fixing #15244,
cargo vendor still doesn't support vendor from and to the same location.
Unless we figure out an rsync-like solutin to update vendor sources,
it is not going to support in short term.
(And I also doubt the real world use case of it)

Additional information

Sources like directory sources (which usually are vendored source) likely contains real sources not cached sources. Cargo shouldn't delete them.

cargo-vendor has a workaround that to mitigate rust-lang#5956, it removes all cached sources in order to trigger a re-unpack. It was meant for dealing with registry sources only, but accidentally applied to directory source kind. While directory source kind was invented for vendoring, and vendoring from one vendored directory to the other seems unusual, Cargo IMO should not delete any real sources. It does not mean that registry sources are okay to delete, In long term, we should explore a way that unpacks `.crate` files directly, without any removal. See rust-lang#12509 (comment)

rustbot · 2025-03-04T01:56:16Z

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

epage · 2025-03-04T02:11:34Z

src/cargo/ops/vendor.rs

                }
                continue;
            }
-            if pkg.source_id().is_git() {
+            if sid.is_git() {
                continue;
            }


nit: rather than ifs with continues that keep falling through cases, it seems like if/else if would better express the mutually exclusive nature of this loop.

epage

nit is unlikely worth waiting on a merge

Update cargo 22 commits in 2622e844bc1e2e6123e54e94e4706f7b6195ce3d..ab1463d632528e39daf35f263e10c14cbe590ce8 2025-02-28 12:33:57 +0000 to 2025-03-08 01:45:05 +0000 - test: redact host target when comparing CARGO_ENV path (rust-lang/cargo#15279) - feat: add completions for install --path (rust-lang/cargo#15266) - fix(package): report lockfile / workspace manifest is dirty (rust-lang/cargo#15276) - feat(tree): Add `--depth public` behind `-Zunstable-options` (rust-lang/cargo#15243) - Don't use `$CARGO_BUILD_TARGET` in `cargo metadata` (rust-lang/cargo#15271) - feat: show extra build description from bootstrap (rust-lang/cargo#15269) - Upgrade to `rustc-stable-hash v0.1.2` (rust-lang/cargo#15268) - fix: Respect --frozen everywhere --offline or --locked is accepted (rust-lang/cargo#15263) - feat(tree): Color the output (rust-lang/cargo#15242) - fix(vendor): dont remove non-cached source (rust-lang/cargo#15260) - docs: lockfile is always included since 1.84 (rust-lang/cargo#15257) - Remove `Cargo.toml` from `package.include` in example (rust-lang/cargo#15253) - Small cleanup: remove unneeded result (rust-lang/cargo#15256) - Fix typo in build-scripts.md (rust-lang/cargo#15254) - chore(deps): update rust crate pulldown-cmark to 0.13.0 (rust-lang/cargo#15250) - chore(deps): update compatible (rust-lang/cargo#15249) - feat(cli): forward bash completions of third party subcommands (rust-lang/cargo#15247) - feat: add completions for `--lockfile-path` (rust-lang/cargo#15238) - fix: reset $CARGO if the running program is real `cargo[.exe]` (rust-lang/cargo#15208) - Get all members as `available targets` even though default-members was specified. (rust-lang/cargo#15199) - refactor: control byte display precision with std::fmt options (rust-lang/cargo#15246) - fix(package): Ensure we can package directories ending with '.rs' (rust-lang/cargo#15240)

weihanglo added 2 commits March 3, 2025 20:16

test: show problematic behavior that delete non-cached sources

48f147c

Sources like directory sources (which usually are vendored source) likely contains real sources not cached sources. Cargo shouldn't delete them.

rustbot assigned ehuss Mar 4, 2025

rustbot added A-cli Area: Command-line interface, option parsing, etc. Command-vendor S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 4, 2025

weihanglo changed the title ~~test: show problematic behavior that delete non-cached sources~~ fix(vendor): dont remove non-cached source Mar 4, 2025

epage reviewed Mar 4, 2025

View reviewed changes

epage approved these changes Mar 4, 2025

View reviewed changes

epage enabled auto-merge March 4, 2025 02:11

epage added this pull request to the merge queue Mar 4, 2025

Merged via the queue into rust-lang:master with commit 29f8d03 Mar 4, 2025
21 checks passed

weihanglo mentioned this pull request Mar 8, 2025

Update cargo rust-lang/rust#138200

Merged

weihanglo mentioned this pull request Mar 9, 2025

Fix cargo add overwriting symlinked Cargo.toml files #15281

Open

rustbot added this to the 1.87.0 milestone Mar 10, 2025

weihanglo deleted the vendor branch May 10, 2025 00:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(vendor): dont remove non-cached source #15260

fix(vendor): dont remove non-cached source #15260

weihanglo commented Mar 4, 2025

rustbot commented Mar 4, 2025

epage Mar 4, 2025

epage left a comment

fix(vendor): dont remove non-cached source #15260

fix(vendor): dont remove non-cached source #15260

Conversation

weihanglo commented Mar 4, 2025

What does this PR try to resolve?

Background

How should we test and review this PR?

Additional information

rustbot commented Mar 4, 2025

epage Mar 4, 2025

Choose a reason for hiding this comment

epage left a comment

Choose a reason for hiding this comment