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.

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

new lint: pub_api_sealed_trait_became_unconditionally_sealed #1166

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions src/lints/pub_api_sealed_trait_became_unconditionally_sealed.ron
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
SemverQuery(
id: "pub_api_sealed_trait_became_unconditionally_sealed",
human_readable_name: "public API sealed trait became unconditionally sealed",
description: "A public API sealed trait has become unconditionally sealed, blocking all downstream implementations including those from first-party crates that rely on the non-public API.",
required_update: Minor,
lint_level: Warn,
reference_link: Some("https://rust-lang.github.io/api-guidelines/future-proofing.html#sealed-traits-protect-against-downstream-implementations-c-sealed"),
query: r#"
{
CrateDiff {
baseline {
item {
... on Trait {
visibility_limit @filter(op: "=", value: ["$public"]) @output
public_api_sealed @filter(op: "=", value: ["$true"])
unconditionally_sealed @filter(op: "!=", value: ["$true"])

importable_path {
path @output @tag
public_api @filter(op: "=", value: ["$true"])
}
}
}
}
current {
item {
... on Trait {
visibility_limit @filter(op: "=", value: ["$public"])
unconditionally_sealed @filter(op: "=", value: ["$true"])
name @output

importable_path {
path @filter(op: "=", value: ["%path"])
public_api @filter(op: "=", value: ["$true"])
}

span_: span @optional {
filename @output
begin_line @output
end_line @output
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"true": true,
},
error_message: "A public API sealed trait has become unconditionally sealed, blocking all downstream implementations including those from first-party crates that rely on the non-public API.",
per_result_error_template: Some("trait {{join \"::\" path}} in file {{span_filename}}:{{span_begin_line}}"),
witness: None,
)
1 change: 1 addition & 0 deletions src/query.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1287,6 +1287,7 @@ add_lints!(
partial_ord_struct_fields_reordered,
proc_macro_marked_deprecated,
proc_macro_now_doc_hidden,
pub_api_sealed_trait_became_unconditionally_sealed,
pub_module_level_const_missing,
pub_module_level_const_now_doc_hidden,
pub_static_missing,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "pub_api_sealed_trait_became_unconditionally_sealed"
version = "0.1.0"
edition = "2021"

[dependencies]
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Traits transitioning from Public API Sealed → Unconditionally Sealed (Lint should detect these)
pub mod public_api_sealed_to_unconditionally_sealed {
mod hidden {
pub trait Sealed {}
pub struct Token;
}

pub trait TraitExtendsUnconditionallyHiddenTrait: hidden::Sealed {}

pub trait MethodReturningUnconditionallyHiddenToken {
fn method(&self) -> hidden::Token;
}

pub trait MethodTakingUnconditionallyHiddenToken {
fn method(&self, token: hidden::Token);
}

pub trait HiddenSealedWithWhereSelfBound
where
Self: hidden::Sealed,
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "pub_api_sealed_trait_became_unconditionally_sealed"
version = "0.1.0"
edition = "2021"

[dependencies]
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Traits transitioning from Public API Sealed → Unconditionally Sealed (Lint should detect these)
pub mod public_api_sealed_to_unconditionally_sealed {
#[doc(hidden)]
pub mod hidden {
pub trait Sealed {}
pub struct Token;
}

pub trait TraitExtendsUnconditionallyHiddenTrait: hidden::Sealed {}

pub trait MethodReturningUnconditionallyHiddenToken {
fn method(&self) -> hidden::Token;
}

pub trait MethodTakingUnconditionallyHiddenToken {
fn method(&self, token: hidden::Token);
}

pub trait HiddenSealedWithWhereSelfBound
where
Self: hidden::Sealed,
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
source: src/query.rs
expression: "&query_execution_results"
---
{
"./test_crates/pub_api_sealed_trait_became_unconditionally_sealed/": [
{
"name": String("TraitExtendsUnconditionallyHiddenTrait"),
"path": List([
String("pub_api_sealed_trait_became_unconditionally_sealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("TraitExtendsUnconditionallyHiddenTrait"),
]),
"span_begin_line": Uint64(8),
"span_end_line": Uint64(8),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("MethodReturningUnconditionallyHiddenToken"),
"path": List([
String("pub_api_sealed_trait_became_unconditionally_sealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("MethodReturningUnconditionallyHiddenToken"),
]),
"span_begin_line": Uint64(10),
"span_end_line": Uint64(12),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("MethodTakingUnconditionallyHiddenToken"),
"path": List([
String("pub_api_sealed_trait_became_unconditionally_sealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("MethodTakingUnconditionallyHiddenToken"),
]),
"span_begin_line": Uint64(14),
"span_end_line": Uint64(16),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("HiddenSealedWithWhereSelfBound"),
"path": List([
String("pub_api_sealed_trait_became_unconditionally_sealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("HiddenSealedWithWhereSelfBound"),
]),
"span_begin_line": Uint64(18),
"span_end_line": Uint64(22),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
"./test_crates/pub_api_sealed_trait_became_unsealed/": [
{
"name": String("TraitExtendsUnconditionallyHiddenTrait"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("TraitExtendsUnconditionallyHiddenTrait"),
]),
"span_begin_line": Uint64(30),
"span_end_line": Uint64(30),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("MethodReturningUnconditionallyHiddenToken"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("MethodReturningUnconditionallyHiddenToken"),
]),
"span_begin_line": Uint64(32),
"span_end_line": Uint64(34),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("MethodTakingUnconditionallyHiddenToken"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unconditionally_sealed"),
String("MethodTakingUnconditionallyHiddenToken"),
]),
"span_begin_line": Uint64(36),
"span_end_line": Uint64(38),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
"./test_crates/trait_newly_sealed/": [
{
"name": String("PublicAPISealed"),
"path": List([
String("trait_newly_sealed"),
String("PublicAPISealed"),
]),
"span_begin_line": Uint64(29),
"span_end_line": Uint64(32),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
}
Loading