Allow running `cargo add foo` when a `foo.workspace = true` already exists #10585

Muscraft · 2022-04-20T17:09:45Z

Tracking issue: #8415
RFC: rust-lang/rfcs#2906

PRs in this RFC:

Base Implementation
New Fields
- Part 5 of RFC2906 - Add support for inheriting rust-version #10563
- Part 7 of RFC2906 - Add support for inheriting exclude and include #10565
Update inheritance source
- Part 6 of RFC2906 - Switch the inheritance source from workspace to… #10564
Optimizations
- Part 8 of RFC2906 - Keep InheritableFields in a LazyCell inside `… #10568
Documentation changes
- Prefer key.workspace = true to key = { workspace = true } #10584

This is currently a draft

This PR focuses on adding initial support to allow running cargo add foo when a foo.workspace = true already exists.

Changes:

Added WorkspaceSource to allow for foo.workspace = true
Added MaybeWorkspace to allow returning a WorkspaceSource when trying to query for a dependency or trying to get a SourceId for that query.

Remaining implementation work for the RFC

cargo-add support, see epage's comment
Optimizations as needed

r? @epage

Muscraft · 2022-04-20T17:13:52Z

I accidentally had my commits from an earlier branch that hadn't been merged under this one. It should be fixed now.

epage · 2022-04-20T17:12:44Z

src/cargo/ops/cargo_add/dependency.rs

+    /// features for this dependency not specified by workspace
+    pub features: Option<Vec<String>>,
+    /// if dependency is optional
+    pub optional: Option<bool>,


This is unrelated to the source

Features and optional are unrelated to the source?

See

pub struct Dependency { /// The name of the dependency (as it is set in its `Cargo.toml` and known to crates.io) pub name: String, /// Whether the dependency is opted-in with a feature flag pub optional: Option<bool>, /// List of features to add (or None to keep features unchanged). pub features: Option<IndexSet<String>>, /// Whether default features are enabled pub default_features: Option<bool>, /// Where the dependency comes from pub source: Option<Source>, /// Non-default registry pub registry: Option<String>, /// If the dependency is renamed, this is the new name for the dependency /// as a string. None if it is not renamed. pub rename: Option<String>, /// Features that are exposed by the dependency pub available_features: BTreeMap<String, Vec<String>>, }

Ah so we should make it so features from foo = { workspace = true, features = ["test"]} get put into the Dependency

epage · 2022-04-20T17:13:40Z

src/cargo/ops/cargo_add/dependency.rs

+
+impl Display for WorkspaceSource {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        self.workspace.fmt(f)


This will just print a bool. We should probably just print workspace

epage · 2022-04-20T17:14:03Z

src/cargo/ops/cargo_add/dependency.rs

+#[non_exhaustive]
+pub struct WorkspaceSource {
+    /// if workspace = true or false
+    pub workspace: bool,


Can this ever be false? Should we just have the presence of this assume true?

That is up to you. I don't think it should be false ever since we check if it's false before we create it.

Let's just have this be a unit struct for now. We can always add fields later

epage · 2022-04-20T17:14:55Z

src/cargo/ops/cargo_add/dependency.rs

+                        table.insert("optional", toml_edit::value(optional));
+                    }
+
+                    for key in ["path", "git", "branch", "tag", "rev", "version"] {


We should delete all of the keys incompatible with workspace = true.

epage · 2022-04-20T17:15:45Z

src/cargo/ops/cargo_add/dependency.rs

@@ -480,6 +545,22 @@ impl Dependency {
                        table.remove(key);
                    }
                }
+                Some(Source::Workspace(src)) => {
+                    table.insert("workspace", toml_edit::value(src.workspace));


The other branches should remove "workspace"

epage · 2022-04-20T17:20:27Z

src/cargo/ops/cargo_add/dependency.rs

+                        invalid_type(key, "workspace", workspace.type_name(), "bool")
+                    })?);
+                    if !src.workspace {
+                        anyhow::bail!("workspace was false for `{key}`")


Would it be more clear to say "{key}.workspace = false is unsupported"

epage · 2022-04-20T17:23:17Z

src/cargo/ops/cargo_add/mod.rs

-            std::task::Poll::Ready(res) => {
-                break res?;
+    match query {
+        MaybeWorkspace::Workspace(_) => Err(anyhow!("query was workspace")),


I might go as far as an unreachable!("registry depedencies required, found a workspace dependency")

epage · 2022-04-20T17:24:10Z

src/cargo/ops/cargo_add/mod.rs

-            if let Some(reg_name) = dependency.registry.as_deref() {
-                dep = dep.set_registry(reg_name);
+    match query {
+        MaybeWorkspace::Workspace(_) => Err(anyhow!("query was workspace")),


ditto

unreachable!("path or git dependency expected, found workspace dependency");

epage · 2022-04-20T17:25:13Z

src/cargo/ops/cargo_add/mod.rs

+            if let Some(features) = workspace.features {
+                let mut b_tree: BTreeMap<String, Vec<String>> = BTreeMap::new();
+                for feature in features {
+                    b_tree.insert(feature, vec![]);
+                }
+                dependency = dependency.set_available_features(b_tree)


Don't we need to be looking up the workspace's dependency and getting its query?

Possibly, this was one area that I wasn't sure how we should be going about this. I know that this makes it so foo = { workspace = true, features = ["test"]} works.

We have two feature lists

What the user specified

What the crate defines

This code is putting the user-specified features into the list of what the crate defines so anything the user enters will always be valid.

epage · 2022-04-20T17:26:11Z

tests/testsuite/cargo_add.rs

+    let cwd = &project_root;
+
+    cargo_command()
+        .env("__CARGO_TEST_CHANNEL_OVERRIDE_DO_NOT_USE_THIS", "nightly")


#10581 will add a masquerade_as_nightly_cargo() function to Command.

I saw that and put this in until that PR is merged or we plan to merge this one and then have a cleanup PR that fixes it

…xists

Muscraft · 2022-04-27T21:36:31Z

Closing as #10606 includes this commit

Cargo add support for workspace inheritance Tracking issue: #8415 RFC: rust-lang/rfcs#2906 This PR adds all the required support for workspace inheritance within `cargo-add`. It was split up across a few different PRs as it required `snapbox` support from #10581 and a new `toml_edit` version from #10603. `@epage` and I decided to go ahead with this PR and add in some of the changes those PRs made. `@epage's` name on the commits is from helping to rewrite commits and some very minor additions. Changes: - #10585 - Muscraft#1 - Muscraft#3 - Muscraft#2 - Muscraft#4 r? `@epage`

rust-highfive assigned epage Apr 20, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 20, 2022

Muscraft changed the title ~~Rfc2906 part10~~ Allow running cargo add foo when a foo.workspace = true already exists Apr 20, 2022

Muscraft force-pushed the rfc2906-part10 branch from a291941 to 2989335 Compare April 20, 2022 17:12

epage reviewed Apr 20, 2022

View reviewed changes

Muscraft force-pushed the rfc2906-part10 branch 2 times, most recently from 46b90e7 to 730f69a Compare April 22, 2022 01:14

Muscraft marked this pull request as ready for review April 22, 2022 01:15

Muscraft force-pushed the rfc2906-part10 branch from 730f69a to 395538d Compare April 22, 2022 01:53

Allow running cargo add foo when a foo.workspace = true already e…

d0bf960

…xists

Muscraft force-pushed the rfc2906-part10 branch from 395538d to d0bf960 Compare April 22, 2022 12:49

Muscraft closed this Apr 27, 2022

Muscraft deleted the rfc2906-part10 branch May 27, 2022 01:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow running `cargo add foo` when a `foo.workspace = true` already exists #10585

Allow running `cargo add foo` when a `foo.workspace = true` already exists #10585

Muscraft commented Apr 20, 2022 •

edited

Loading

Muscraft commented Apr 20, 2022

epage Apr 20, 2022

Muscraft Apr 20, 2022

epage Apr 20, 2022

Muscraft Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

Muscraft Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

Muscraft Apr 20, 2022

epage Apr 20, 2022

epage Apr 20, 2022

Muscraft Apr 20, 2022

Muscraft commented Apr 27, 2022

Allow running cargo add foo when a foo.workspace = true already exists #10585

Allow running cargo add foo when a foo.workspace = true already exists #10585

Conversation

Muscraft commented Apr 20, 2022 • edited Loading

Muscraft commented Apr 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Muscraft commented Apr 27, 2022

Allow running `cargo add foo` when a `foo.workspace = true` already exists #10585

Allow running `cargo add foo` when a `foo.workspace = true` already exists #10585

Muscraft commented Apr 20, 2022 •

edited

Loading