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

add more ResolvedVc best-practices lints #73331

Merged
merged 2 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions .config/ast-grep/rule-tests/resolved-vc-in-return-type-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
id: resolved-vc-in-return-type
valid:
- |
pub async fn ignore_this(x: ResolvedVc<MyType>) -> Result<ResolvedVc<MyType>> {}
- |
pub trait OtherTrait() {
fn ignore_this() -> ResolvedVc<MyType>;
}
invalid:
- |
#[turbo_tasks::function]
pub async fn flag_this(x: ResolvedVc<MyType>) -> ResolvedVc<MyType> {}
- |
#[turbo_tasks::function]
pub async fn flag_this_too(x: ResolvedVc<MyType>) -> Result<ResolvedVc<MyType>> {}
- |
#[turbo_tasks::value_trait]
pub trait ValueTrait() {
fn flag_this() -> ResolvedVc<MyType>;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
id: resolved-vc-in-trait-arguments
valid:
- |
#[turbo_tasks::value_trait]
pub trait Example {
fn write_to_disk(self: Vc<Self>);
fn write_to_disk(self: Resolvedvc<Self>) {}
mischnic marked this conversation as resolved.
Show resolved Hide resolved
}
invalid:
- |
#[turbo_tasks::value_trait]
pub trait Example {
fn write_to_disk(self: ResolvedVc<Self>);
}
52 changes: 52 additions & 0 deletions .config/ast-grep/rules/resolved-vc-in-return-type.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/main/schemas/rule.json

id: resolved-vc-in-return-type
message: Returning a `ResolvedVc` in a turbo task is not recommended. Consider replacing `$TYPE` in `$FN_NAME` with `$RESOLVED_VC` instead.
severity: warning # error, warning, info, hint
language: Rust
rule:
any:
# turbo tasks function
- all:
- pattern:
context: 'let x: ResolvedVc<$A> = 1;'
selector: generic_type
- pattern: $TYPE
inside:
kind: function_item
field: return_type
stopBy: end
follows:
pattern: '#[turbo_tasks::function]'
has:
kind: identifier
pattern: $FN_NAME
# turbo tasks value trait
- all:
- pattern:
context: 'let x: ResolvedVc<$A> = 1;'
selector: generic_type
- pattern: $TYPE
inside:
kind: function_signature_item
field: return_type
stopBy: end
inside:
inside:
kind: trait_item
follows:
pattern: '#[turbo_tasks::value_trait]'
has:
kind: identifier
pattern: $FN_NAME
rewriters:
- id: rewrite-vc
rule:
pattern: $TYPE
fix: Vc<$A>
transform:
RESOLVED_VC:
rewrite:
rewriters: [rewrite-vc]
source: $TYPE
fix: $RESOLVED_VC
20 changes: 20 additions & 0 deletions .config/ast-grep/rules/resolved-vc-in-trait.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/main/schemas/rule.json

id: resolved-vc-in-trait-arguments
message: Using `ResolvedVc` in a turbo tasks trait is unsound. Consider making `$FN_NAME` take `Vc` instead.
severity: warning # error, warning, info, hint
language: Rust
rule:
pattern:
context: 'let x: ResolvedVc<$A> = 1;'
selector: generic_type
inside:
kind: function_signature_item
stopBy: end
pattern: fn $FN_NAME($_ARGS)
inside:
inside:
kind: trait_item
follows:
pattern: '#[turbo_tasks::value_trait]'
fix: Vc<$A>
30 changes: 30 additions & 0 deletions .config/ast-grep/rules/to-resolved-in-loop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/main/schemas/rule.json

id: to-resolved-in-loop
message: 'Calling `$EXPR` in a loop could be a doing a lot of work sequentially. Consider producing an iterator of futures and using `try_join`.'
severity: info # error, warning, info, hint
language: Rust
rule:
kind: for_expression
pattern: for $VAR in $ITER {$$$_ARGS}
has:
kind: try_expression
stopBy: end
all:
- pattern: $ARG.to_resolved().await?
- pattern: $EXPR
# ignore sequential application
- not:
inside:
kind: assignment_expression
pattern: '*$VAR = $_EXPR'
# ignore conditionals via match
- not:
inside:
kind: match_arm
stopBy: end
# ignore conditionals via if
- not:
inside:
kind: if_expression
stopBy: end
Loading