Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(toml): Warn on unused workspace.dependencies keys on virtual workspaces #13664

Merged
merged 12 commits into from
Mar 28, 2024
Merged

fix(toml): Warn on unused workspace.dependencies keys on virtual workspaces #13664

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e30ddc4
refactor(toml): Remove a variable that doesnt need tracking
epage Mar 19, 2024
dd8f8dc
refactor(toml): Group workspace inheritance logic
epage Mar 19, 2024
b63e385
refactor(toml): Group workspace inheritance functions
epage Mar 27, 2024
386c4b6
refactor(toml): Consistently don't include pkgid
epage Mar 19, 2024
3b7fddb
refactor(toml): Delay pkgid/summary creation
epage Mar 19, 2024
1855a4a
refactor(toml): Pull out the dep resolve/validate code
epage Mar 19, 2024
e4f1eb0
refactor(toml): Decouple Dep and TomlDep creation
epage Mar 20, 2024
5d2fa44
refactor(toml): Consolidate public nightly check with clearing it
epage Mar 21, 2024
573fe52
fix(toml): Warn on unused workspace.dependencies keys on virtual work…
epage Mar 27, 2024
9312590
refator(tom): Give up and allow warnings anywhere
epage Mar 25, 2024
453f39f
refactor(toml): Centralize workspace config processing
epage Mar 27, 2024
8a82df2
refactor(toml): Consolidate workspace dependency verification
epage Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/cargo/core/manifest.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ pub enum EitherManifest {
}

impl EitherManifest {
pub fn warnings_mut(&mut self) -> &mut Warnings {
match self {
EitherManifest::Real(r) => r.warnings_mut(),
EitherManifest::Virtual(v) => v.warnings_mut(),
}
}
pub(crate) fn workspace_config(&self) -> &WorkspaceConfig {
match *self {
EitherManifest::Real(ref r) => r.workspace_config(),
Expand Down
4 changes: 4 additions & 0 deletions src/cargo/ops/cargo_package.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,13 +458,17 @@ fn build_lock(ws: &Workspace<'_>, orig_pkg: &Package) -> CargoResult<String> {
let toml_manifest =
prepare_for_publish(orig_pkg.manifest().resolved_toml(), ws, orig_pkg.root())?;
let source_id = orig_pkg.package_id().source_id();
let mut warnings = Default::default();
let mut errors = Default::default();
Comment on lines +461 to +462
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Default::default is used here and in read_manifest we use vec![]. Any reason for the inconsistency?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really but this will be going away in the next PR

let manifest = to_real_manifest(
contents.to_owned(),
document.clone(),
toml_manifest,
source_id,
orig_pkg.manifest_path(),
gctx,
&mut warnings,
&mut errors,
)?;
let new_pkg = Package::new(manifest, orig_pkg.manifest_path());

Expand Down
102 changes: 56 additions & 46 deletions src/cargo/util/toml/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,29 +48,58 @@ pub fn read_manifest(
source_id: SourceId,
gctx: &GlobalContext,
) -> CargoResult<EitherManifest> {
let mut warnings = vec![];
let mut errors = vec![];

let contents =
read_toml_string(path, gctx).map_err(|err| ManifestError::new(err, path.into()))?;
let document =
parse_document(&contents).map_err(|e| emit_diagnostic(e.into(), &contents, path, gctx))?;
let original_toml = deserialize_toml(&document)
.map_err(|e| emit_diagnostic(e.into(), &contents, path, gctx))?;

(|| {
let mut manifest = (|| {
if original_toml.package().is_some() {
to_real_manifest(contents, document, original_toml, source_id, path, gctx)
.map(EitherManifest::Real)
to_real_manifest(
contents,
document,
original_toml,
source_id,
path,
gctx,
&mut warnings,
&mut errors,
)
.map(EitherManifest::Real)
} else {
to_virtual_manifest(contents, document, original_toml, source_id, path, gctx)
.map(EitherManifest::Virtual)
to_virtual_manifest(
contents,
document,
original_toml,
source_id,
path,
gctx,
&mut warnings,
&mut errors,
)
.map(EitherManifest::Virtual)
}
})()
.map_err(|err| {
ManifestError::new(
err.context(format!("failed to parse manifest at `{}`", path.display())),
path.into(),
)
.into()
})
})?;

for warning in warnings {
manifest.warnings_mut().add_warning(warning);
}
for error in errors {
manifest.warnings_mut().add_critical_warning(error);
}

Ok(manifest)
}

#[tracing::instrument(skip_all)]
Expand Down Expand Up @@ -438,6 +467,8 @@ pub fn to_real_manifest(
source_id: SourceId,
manifest_file: &Path,
gctx: &GlobalContext,
warnings: &mut Vec<String>,
errors: &mut Vec<String>,
) -> CargoResult<Manifest> {
let embedded = is_embedded(manifest_file);
let package_root = manifest_file.parent().unwrap();
Expand All @@ -463,13 +494,10 @@ pub fn to_real_manifest(
}
}

let mut warnings = vec![];
let mut errors = vec![];

// Parse features first so they will be available when parsing other parts of the TOML.
let empty = Vec::new();
let cargo_features = original_toml.cargo_features.as_ref().unwrap_or(&empty);
let features = Features::new(cargo_features, gctx, &mut warnings, source_id.is_path())?;
let features = Features::new(cargo_features, gctx, warnings, source_id.is_path())?;

let mut package = match (&original_toml.package, &original_toml.project) {
(Some(_), Some(project)) => {
Expand All @@ -494,15 +522,10 @@ pub fn to_real_manifest(

let workspace_config = match (original_toml.workspace.as_ref(), package.workspace.as_ref()) {
(Some(toml_config), None) => {
verify_lints(toml_config.lints.as_ref(), gctx, &mut warnings)?;
verify_lints(toml_config.lints.as_ref(), gctx, warnings)?;
if let Some(ws_deps) = &toml_config.dependencies {
for (name, dep) in ws_deps {
unused_dep_keys(
name,
"workspace.dependencies",
dep.unused_keys(),
&mut warnings,
);
unused_dep_keys(name, "workspace.dependencies", dep.unused_keys(), warnings);
}
}
let ws_root_config = to_workspace_config(toml_config, package_root);
Expand Down Expand Up @@ -649,8 +672,8 @@ pub fn to_real_manifest(
edition,
&package.build,
&package.metabuild,
&mut warnings,
&mut errors,
warnings,
errors,
)?;

if targets.iter().all(|t| t.is_custom_build()) {
Expand Down Expand Up @@ -689,7 +712,7 @@ pub fn to_real_manifest(
deps: &mut deps,
source_id,
gctx,
warnings: &mut warnings,
warnings,
features: &features,
platform: None,
root: package_root,
Expand Down Expand Up @@ -964,7 +987,7 @@ pub fn to_real_manifest(

if let Some(profiles) = &original_toml.profile {
let cli_unstable = gctx.cli_unstable();
validate_profiles(profiles, cli_unstable, &features, &mut warnings)?;
validate_profiles(profiles, cli_unstable, &features, warnings)?;
}

let publish = package
Expand Down Expand Up @@ -1075,7 +1098,7 @@ pub fn to_real_manifest(
}),
_unused_keys: Default::default(),
};
let mut manifest = Manifest::new(
let manifest = Manifest::new(
Rc::new(contents),
Rc::new(document),
Rc::new(original_toml),
Expand Down Expand Up @@ -1114,13 +1137,7 @@ pub fn to_real_manifest(
.to_owned(),
);
}
warn_on_unused(&manifest.original_toml()._unused_keys, &mut warnings);
for warning in warnings {
manifest.warnings_mut().add_warning(warning);
}
for error in errors {
manifest.warnings_mut().add_critical_warning(error);
}
warn_on_unused(&manifest.original_toml()._unused_keys, warnings);

manifest.feature_gate()?;

Expand Down Expand Up @@ -1239,6 +1256,8 @@ fn to_virtual_manifest(
source_id: SourceId,
manifest_file: &Path,
gctx: &GlobalContext,
warnings: &mut Vec<String>,
_errors: &mut Vec<String>,
) -> CargoResult<VirtualManifest> {
let root = manifest_file.parent().unwrap();

Expand All @@ -1263,11 +1282,10 @@ fn to_virtual_manifest(
bail!("this virtual manifest specifies a `{field}` section, which is not allowed");
}

let mut warnings = Vec::new();
let mut deps = Vec::new();
let empty = Vec::new();
let cargo_features = original_toml.cargo_features.as_ref().unwrap_or(&empty);
let features = Features::new(cargo_features, gctx, &mut warnings, source_id.is_path())?;
let features = Features::new(cargo_features, gctx, warnings, source_id.is_path())?;

resolved_toml._unused_keys = Default::default();

Expand All @@ -1276,7 +1294,7 @@ fn to_virtual_manifest(
deps: &mut deps,
source_id,
gctx,
warnings: &mut warnings,
warnings,
platform: None,
features: &features,
root,
Expand All @@ -1287,7 +1305,7 @@ fn to_virtual_manifest(
)
};
if let Some(profiles) = &original_toml.profile {
validate_profiles(profiles, gctx.cli_unstable(), &features, &mut warnings)?;
validate_profiles(profiles, gctx.cli_unstable(), &features, warnings)?;
}
let resolve_behavior = original_toml
.workspace
Expand All @@ -1297,15 +1315,10 @@ fn to_virtual_manifest(
.transpose()?;
let workspace_config = match original_toml.workspace {
Some(ref toml_config) => {
verify_lints(toml_config.lints.as_ref(), gctx, &mut warnings)?;
verify_lints(toml_config.lints.as_ref(), gctx, warnings)?;
if let Some(ws_deps) = &toml_config.dependencies {
for (name, dep) in ws_deps {
unused_dep_keys(
name,
"workspace.dependencies",
dep.unused_keys(),
&mut warnings,
);
unused_dep_keys(name, "workspace.dependencies", dep.unused_keys(), warnings);
}
}
let ws_root_config = to_workspace_config(toml_config, root);
Expand All @@ -1318,7 +1331,7 @@ fn to_virtual_manifest(
bail!("virtual manifests must be configured with [workspace]");
}
};
let mut manifest = VirtualManifest::new(
let manifest = VirtualManifest::new(
Rc::new(contents),
Rc::new(document),
Rc::new(original_toml),
Expand All @@ -1330,10 +1343,7 @@ fn to_virtual_manifest(
resolve_behavior,
);

warn_on_unused(&manifest.original_toml()._unused_keys, &mut warnings);
for warning in warnings {
manifest.warnings_mut().add_warning(warning);
}
warn_on_unused(&manifest.original_toml()._unused_keys, warnings);

Ok(manifest)
}
Expand Down