Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace #11414

Muscraft · 2022-11-23T21:39:34Z

In #11192 it was noted that workspace inheritance causes vendored git dependencies to fail since workspace = true does not get resolved during vendoring.

To fix this, it was suggested to make cargo vendor work similar to cargo package since it resolves manifests before packaging them. There were problems with this potential solution, so it was decided to use a Manifest's "original" Cargo.toml. This isn't exactly the original Cargo.toml since {}.workspace = true gets removed in to_real_manifest where the "original" is from. There were concerns that this would cause churn in the output Cargo.toml. To get around this, we only use the Manifest's "original" Cargo.toml if a git dependency is being vendored. This is because the bug from #11192 only affects git dependencies since published dependencies have workspace = true removed before publishing.

close #11192

rustbot · 2022-11-23T21:39:38Z

r? @weihanglo

(rustbot has picked a reviewer for you, use r? to override)

weihanglo

Just had a skim on this. I am not sure how well we should maintain the compatibility of output of cargo vendor between each versions. Maybe we should try hard not to churn the version control system too much.

BTW, I got this error while vendoring Cargo itself.

$ cargo vendor
   Vendoring adler v1.0.2 (/home/weihanglo/.cargo/registry/src/github.com-1ecc6299db9ec823/adler-1.0.2) to vendor/adler
error: failed to sync

Caused by:
  failed to copy over vendored sources for: adler v1.0.2

Caused by:
  invalid inclusion of reserved file name Cargo.toml.orig in package source

tests/testsuite/vendor.rs

src/cargo/ops/vendor.rs

src/cargo/ops/cargo_package.rs

weihanglo

Ooops. The latest update hit the same problem. It generates completely different Cargo.toml from crates.io, which again churns the version control system. To reproduce, under cargo the project itself, run cargo +stable vendor. Stage them with git add vendor, and then cargo run -- cargo vendor.

Sorry I didn't think about it carefully. We might go back and reuse things behind cargo package, or anything doesn't change existing Cargo.toml. 😞

tests/testsuite/vendor.rs

weihanglo

Looks great! At least we reduce the affected radius to git dependencies. Thank you!

Should we prepend a header in the generated content telling that this is also generated, as what Cargo.lock and registry source do?

src/cargo/ops/vendor.rs

weihanglo

Thanks a lot. This is so much better than our initial plan!

I will go ahead and merge it :)

⚠️ Potential behavior change ⚠️

There was an overlook regarding workspace inheritance interacting with git dependency when doing cargo vendor. After this PR, Cargo starts generating a normalized Cargo.toml for git dependencies when vendoring. The normalized Cargo.toml won't be identical to the original hand written one.

Edit: relevant discussion on Zulip t-cargo

weihanglo · 2023-01-19T10:08:57Z

@bors r+

bors · 2023-01-19T10:09:00Z

📌 Commit b64b605 has been approved by weihanglo

It is now in the queue for this repository.

bors · 2023-01-19T10:09:08Z

⌛ Testing commit b64b605 with merge 50eb688...

bors · 2023-01-19T11:09:40Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 50eb688 to master...

3 commits in a5d47a72595dd6fbe7d4e4f6ec20dc5fe724edd1..50eb688c2bbea5de5a2e8496230a7428798089d1 2023-01-16 18:51:50 +0000 to 2023-01-19 10:09:05 +0000 - Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace (rust-lang/cargo#11414) - Ignore `workspace.default-members` when running `cargo install` on root package of a non-virtual workspace (rust-lang/cargo#11067) - Corrected documentation of how to cache binaries installed with `cargo install` in CI workflows (rust-lang/cargo#11592)

Update cargo 3 commits in a5d47a72595dd6fbe7d4e4f6ec20dc5fe724edd1..50eb688c2bbea5de5a2e8496230a7428798089d1 2023-01-16 18:51:50 +0000 to 2023-01-19 10:09:05 +0000 - Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace (rust-lang/cargo#11414) - Ignore `workspace.default-members` when running `cargo install` on root package of a non-virtual workspace (rust-lang/cargo#11067) - Corrected documentation of how to cache binaries installed with `cargo install` in CI workflows (rust-lang/cargo#11592) r? `@ghost`

…se workspace inheritance Rust 1.64.0 added support for workspace inheritance, which allows for crates to inherit values such as dependency version constraints or package metadata information from their workspaces [0]. This works by having workspace members specify a value as a table, with `workspace` set to true. Thus, supporting this in importCargoLock is as simple as walking the crate's Cargo.toml, replacing inherited values with their workspace counterpart. This is also what a forthcoming Cargo release will do for `cargo vendor` [1], but we can get ahead of it ;) [0]: https://blog.rust-lang.org/2022/09/22/Rust-1.64.0.html#cargo-improvements-workspace-inheritance-and-multi-target-builds [1]: rust-lang/cargo#11414

rustbot assigned weihanglo Nov 23, 2022

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 23, 2022

tomhoule mentioned this pull request Nov 24, 2022

Support workspace dependencies ipetkov/crane#113

Closed

weihanglo reviewed Nov 28, 2022

View reviewed changes

tests/testsuite/vendor.rs Outdated Show resolved Hide resolved

src/cargo/ops/vendor.rs Outdated Show resolved Hide resolved

src/cargo/ops/vendor.rs Outdated Show resolved Hide resolved

src/cargo/ops/cargo_package.rs Outdated Show resolved Hide resolved

weihanglo added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 8, 2022

Muscraft force-pushed the vendor-use-package branch from dcaeaad to 465a3f0 Compare January 11, 2023 00:57

weihanglo added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. labels Jan 11, 2023

weihanglo reviewed Jan 11, 2023

View reviewed changes

tests/testsuite/vendor.rs Outdated Show resolved Hide resolved

Muscraft force-pushed the vendor-use-package branch 2 times, most recently from 4aa890e to 92f1232 Compare January 18, 2023 16:54

weihanglo reviewed Jan 18, 2023

View reviewed changes

src/cargo/ops/vendor.rs Show resolved Hide resolved

src/cargo/ops/vendor.rs Show resolved Hide resolved

Muscraft force-pushed the vendor-use-package branch from 92f1232 to 1316dc7 Compare January 19, 2023 04:17

fix(vendor): Make vendor use Manifest's "original" Cargo.toml

b64b605

Muscraft force-pushed the vendor-use-package branch from 1316dc7 to b64b605 Compare January 19, 2023 04:20

weihanglo approved these changes Jan 19, 2023

View reviewed changes

weihanglo changed the title ~~fix(vendor): Make vendor work similar to package since it resolve…~~ Normalize git deps when doing cargo vendor for resolving deps inherited from a workspace Jan 19, 2023

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 19, 2023

bors merged commit 50eb688 into rust-lang:master Jan 19, 2023

This was referenced Jan 19, 2023

Cannot build vendored git dependency if it inherits info from a workspace #11192

Closed

Update cargo rust-lang/rust#107072

Merged

jimblandy mentioned this pull request Jan 19, 2023

Reintroduce workspace inheritance gfx-rs/wgpu#3407

Open

CobaltCause mentioned this pull request Jan 19, 2023

buildCargoPackage fails when a dependency uses [workspace.dependencies] NixOS/nixpkgs#202762

Closed

Muscraft deleted the vendor-use-package branch January 25, 2023 15:29

ehuss added this to the 1.68.0 milestone Jan 28, 2023

gasinvein mentioned this pull request Feb 13, 2023

cargo: Embed resolved manifest in generated sources flatpak/flatpak-builder-tools#349

Merged

winterqt mentioned this pull request Feb 19, 2023

RFC: Migrate all Rust packages to importCargoLock NixOS/nixpkgs#217084

Closed

figsoda mentioned this pull request Feb 19, 2023

rustPlatform.importCargoLock: add support for git dependencies that use workspace inheritance NixOS/nixpkgs#217232

Merged

12 tasks

RaitoBezarius mentioned this pull request Mar 9, 2023

rustc: 1.67.1 -> 1.68.1 NixOS/nixpkgs#220373

Merged

12 tasks

epage mentioned this pull request Aug 8, 2024

[stable-1.80] fix(vendor): Strip excluded build targets #14369

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace #11414

Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace #11414

Muscraft commented Nov 23, 2022 •

edited

Loading

rustbot commented Nov 23, 2022

weihanglo left a comment

weihanglo left a comment

weihanglo left a comment

weihanglo left a comment •

edited

Loading

weihanglo commented Jan 19, 2023

bors commented Jan 19, 2023

bors commented Jan 19, 2023

bors commented Jan 19, 2023

Normalize git deps when doing cargo vendor for resolving deps inherited from a workspace #11414

Normalize git deps when doing cargo vendor for resolving deps inherited from a workspace #11414

Conversation

Muscraft commented Nov 23, 2022 • edited Loading

rustbot commented Nov 23, 2022

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo left a comment • edited Loading

Choose a reason for hiding this comment

⚠️ Potential behavior change ⚠️

weihanglo commented Jan 19, 2023

bors commented Jan 19, 2023

bors commented Jan 19, 2023

bors commented Jan 19, 2023

Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace #11414

Normalize git deps when doing `cargo vendor` for resolving deps inherited from a workspace #11414

Muscraft commented Nov 23, 2022 •

edited

Loading

weihanglo left a comment •

edited

Loading