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_unsealed #1162

Merged
54 changes: 54 additions & 0 deletions src/lints/pub_api_sealed_trait_became_unsealed.ron
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
SemverQuery(
id: "pub_api_sealed_trait_became_unsealed",
human_readable_name: "public API sealed trait became unsealed",
description: "A public API sealed trait has become unsealed, allowing downstream crates to implement it. Reverting this would be a major breaking change.",
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"])
public_api_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 unsealed, allowing downstream crates to implement it. Reverting this would be a major breaking change.",
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 @@ -1340,6 +1340,7 @@ add_lints!(
trait_removed_supertrait,
trait_requires_more_const_generic_params,
trait_requires_more_generic_type_params,
pub_api_sealed_trait_became_unsealed,
trait_unsafe_added,
trait_unsafe_removed,
tuple_struct_to_plain_struct,
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_unsealed"
version = "0.1.0"
edition = "2021"

[dependencies]
39 changes: 39 additions & 0 deletions test_crates/pub_api_sealed_trait_became_unsealed/new/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Traits transitioning from Public API Sealed → Unsealed (Lint should detect these)
pub mod public_api_sealed_to_unsealed {
pub mod hidden {
pub trait Sealed {}
pub struct Token;
}

pub trait PublicAPIToBeUnsealed {
type Hidden;
}

pub trait TraitExtendsHiddenPublicAPITrait: hidden::Sealed {}

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

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

// Traits transitioning from Public API Sealed → Unconditionally Sealed (Lint should ignore 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);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "pub_api_sealed_trait_became_unsealed"
version = "0.1.0"
edition = "2021"

[dependencies]
42 changes: 42 additions & 0 deletions test_crates/pub_api_sealed_trait_became_unsealed/old/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Traits transitioning from Public API Sealed → Unsealed (Lint should detect these)
pub mod public_api_sealed_to_unsealed {
#[doc(hidden)]
pub mod hidden {
pub trait Sealed {}
pub struct Token;
}

pub trait PublicAPIToBeUnsealed {
#[doc(hidden)]
type Hidden;
}

pub trait TraitExtendsHiddenPublicAPITrait: hidden::Sealed {}

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

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

// Traits transitioning from Public API Sealed → Unconditionally Sealed (Lint should ignore 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);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
source: src/query.rs
expression: "&query_execution_results"
---
{
"./test_crates/pub_api_sealed_trait_became_unsealed/": [
{
"name": String("PublicAPIToBeUnsealed"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unsealed"),
String("PublicAPIToBeUnsealed"),
]),
"span_begin_line": Uint64(8),
"span_end_line": Uint64(10),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("TraitExtendsHiddenPublicAPITrait"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unsealed"),
String("TraitExtendsHiddenPublicAPITrait"),
]),
"span_begin_line": Uint64(12),
"span_end_line": Uint64(12),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("MethodReturnPublicAPIHiddenToken"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unsealed"),
String("MethodReturnPublicAPIHiddenToken"),
]),
"span_begin_line": Uint64(14),
"span_end_line": Uint64(16),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("MethodTakingPublicAPIHiddenToken"),
"path": List([
String("pub_api_sealed_trait_became_unsealed"),
String("public_api_sealed_to_unsealed"),
String("MethodTakingPublicAPIHiddenToken"),
]),
"span_begin_line": Uint64(18),
"span_end_line": Uint64(20),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
"./test_crates/trait_associated_type_marked_deprecated/": [
{
"name": String("PublicTraitWithHiddenType"),
"path": List([
String("trait_associated_type_marked_deprecated"),
String("PublicTraitWithHiddenType"),
]),
"span_begin_line": Uint64(40),
"span_end_line": Uint64(44),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
"./test_crates/trait_method_marked_deprecated/": [
{
"name": String("PublicTraitWithHiddenMethod"),
"path": List([
String("trait_method_marked_deprecated"),
String("PublicTraitWithHiddenMethod"),
]),
"span_begin_line": Uint64(47),
"span_end_line": Uint64(51),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
}
Loading