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: unconditionally_sealed_trait_became_unsealed #1164

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/unconditionally_sealed_trait_became_unsealed.ron
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
SemverQuery(
id: "unconditionally_sealed_trait_became_unsealed",
human_readable_name: "unconditionally sealed trait became unsealed",
description: "An unconditionally 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
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"])
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: "An unconditionally 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 @@ -1355,6 +1355,7 @@ add_lints!(
type_mismatched_generic_lifetimes,
type_requires_more_const_generic_params,
type_requires_more_generic_type_params,
unconditionally_sealed_trait_became_unsealed,
union_field_added_with_all_pub_fields,
union_field_added_with_non_pub_fields,
union_field_missing,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "unconditionally_sealed_trait_became_unsealed"
version = "0.1.0"
edition = "2021"

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

pub trait ExtendsTraitInHiddenModule: hidden::Sealed {}

pub trait TransitivelyTraitSealed: ExtendsTraitInHiddenModule {}

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

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

pub trait SealedWithWhereSelfBound
where
Self: hidden::Sealed,
{
}
}

// Traits transitioning from Unconditionally Sealed -> Public API Sealed (Lint should not detect these)
pub mod unconditionally_sealed_to_public_api_sealed {
#[doc(hidden)]
pub mod hidden {
pub trait Sealed {}
pub struct Token;
}

pub trait ExtendsTraitInHiddenModule: hidden::Sealed {}

pub trait ReturnsTraitInHiddenModule {
fn method(&self) -> hidden::Token;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[package]
publish = false
name = "unconditionally_sealed_trait_became_unsealed"
version = "0.1.0"
edition = "2021"

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

pub trait ExtendsTraitInHiddenModule: hidden::Sealed {}

pub trait TransitivelyTraitSealed: ExtendsTraitInHiddenModule {}

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

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

pub trait SealedWithWhereSelfBound
where
Self: hidden::Sealed,
{
}
}

// Traits transitioning from Unconditionally Sealed -> Public API Sealed (Lint should not detect these)
pub mod unconditionally_sealed_to_public_api_sealed {
mod hidden {
pub trait Sealed {}
pub struct Token;
}

pub trait ExtendsTraitInHiddenModule: hidden::Sealed {}

pub trait ReturnsTraitInHiddenModule {
fn method(&self) -> hidden::Token;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
source: src/query.rs
expression: "&query_execution_results"
---
{
"./test_crates/trait_method_added/": [
{
"name": String("WillGainMethodWithoutDefaultAndLoseSeal"),
"path": List([
String("trait_method_added"),
String("WillGainMethodWithoutDefaultAndLoseSeal"),
]),
"span_begin_line": Uint64(43),
"span_end_line": Uint64(45),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
"./test_crates/unconditionally_sealed_trait_became_unsealed/": [
{
"name": String("ExtendsTraitInHiddenModule"),
"path": List([
String("unconditionally_sealed_trait_became_unsealed"),
String("unconditionally_sealed_to_unsealed"),
String("ExtendsTraitInHiddenModule"),
]),
"span_begin_line": Uint64(8),
"span_end_line": Uint64(8),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("TransitivelyTraitSealed"),
"path": List([
String("unconditionally_sealed_trait_became_unsealed"),
String("unconditionally_sealed_to_unsealed"),
String("TransitivelyTraitSealed"),
]),
"span_begin_line": Uint64(10),
"span_end_line": Uint64(10),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("ReturnsTraitInHiddenModule"),
"path": List([
String("unconditionally_sealed_trait_became_unsealed"),
String("unconditionally_sealed_to_unsealed"),
String("ReturnsTraitInHiddenModule"),
]),
"span_begin_line": Uint64(12),
"span_end_line": Uint64(14),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("AcceptsTraitInHiddenModule"),
"path": List([
String("unconditionally_sealed_trait_became_unsealed"),
String("unconditionally_sealed_to_unsealed"),
String("AcceptsTraitInHiddenModule"),
]),
"span_begin_line": Uint64(16),
"span_end_line": Uint64(18),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
{
"name": String("SealedWithWhereSelfBound"),
"path": List([
String("unconditionally_sealed_trait_became_unsealed"),
String("unconditionally_sealed_to_unsealed"),
String("SealedWithWhereSelfBound"),
]),
"span_begin_line": Uint64(20),
"span_end_line": Uint64(24),
"span_filename": String("src/lib.rs"),
"visibility_limit": String("public"),
},
],
}
Loading