Implement rule to check the correct usage of `@RequiresTypeResolution` #5182

BraisGabin · 2022-08-04T17:50:36Z

This rule detects all the mixed behaviour rules that we have on our project so I added them to the baseline meanwhile we don't fix them. But at least with this rule we ensure that we don't add any new mixed and we know all the current mixed rules too.

~~I know that the test are failing but I have no idea why the tests are failing. I debugged and~~

bindingContext[BindingContext.CLASS, this]
        ?.defaultType
        ?.supertypes()

~~Only returns a List with a single element: kotlin.Any. But when I run the rule over the code base of detekt it seems to work. Any idea?~~

marschwar · 2022-08-05T20:09:03Z

Only returns a List with a single element: kotlin.Any. But when I run the rule over the code base of detekt it seems to work. Any idea?

It seems like that Rule and BaseRule types are not known to the test compiler. I will try to figure out a way to add them.

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt

...uleauthors/src/test/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolutionSpec.kt

BraisGabin · 2022-08-05T22:42:44Z

It seems like that Rule and BaseRule types are not known to the test compiler. I will try to figure out a way to add them.

I thought the same. But they compile successfully.

github-actions · 2022-08-05T22:45:54Z

	Messages
📖	Thanks for adding a new rule to Detekt ❤️

Generated by 🚫 dangerJS against c4bdd5c

codecov · 2022-09-04T12:38:45Z

Codecov Report

Merging #5182 (c4bdd5c) into main (6274f21) will increase coverage by 85.97%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main    #5182       +/-   ##
===========================================
+ Coverage        0   85.97%   +85.97%     
- Complexity      0     3614     +3614     
===========================================
  Files           0      514      +514     
  Lines           0    12056    +12056     
  Branches        0     2162     +2162     
===========================================
+ Hits            0    10365    +10365     
- Misses          0      618      +618     
- Partials        0     1073     +1073

Impacted Files	Coverage Δ
...otlin/io/gitlab/arturbosch/detekt/api/MultiRule.kt	`100.00% <ø> (ø)`
...bosch/detekt/rules/complexity/LongParameterList.kt	`87.75% <ø> (ø)`
...urbosch/detekt/rules/bugs/ImplicitDefaultLocale.kt	`75.00% <ø> (ø)`
...tlab/arturbosch/detekt/rules/bugs/LateinitUsage.kt	`92.59% <ø> (ø)`
...t/rules/bugs/MapGetWithNotNullAssertionOperator.kt	`81.25% <ø> (ø)`
...kt/rules/exceptions/InstanceOfCheckForException.kt	`79.16% <ø> (ø)`
...h/detekt/rules/naming/MemberNameEqualsClassName.kt	`87.80% <ø> (ø)`
...urbosch/detekt/rules/performance/SpreadOperator.kt	`83.33% <ø> (ø)`
...etekt/rules/style/FunctionOnlyReturningConstant.kt	`93.75% <ø> (ø)`
...sch/detekt/rules/style/UnnecessaryAbstractClass.kt	`77.35% <ø> (ø)`
... and 520 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

BraisGabin · 2022-10-04T14:54:14Z

This should be ready to review :)

config/detekt/baseline.xml

chao2zhang · 2022-10-04T15:20:42Z

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt

+
+    override fun visitKtFile(file: KtFile) {
+        super.visitKtFile(file)
+        klasses.forEach { klass ->


is it possible to move the checking logic inside visitClass(klass: KtClass) to avoid maintaining klass: MutableList<KtClass>?

The problem is that we have rules that uses the BindingContext inside private extension functions. So if I move it to visitClass we would hava false positives. For that reason I moved it to visitClass. I don't like the MutableList either but i don't know other way to implement it.

I'm wondering if the check here is too sophisticated and we should just do a syntactic check on whether BindingContext or bindingContext are present as string in the body of the rule.

That was my initial implementation but I got this comment: #5182 (comment) so I made it more sophisticated. I think it's better like it's now.

cortinico

Let's make sure we ship this inside RC2 otherwise we'll end up shipping an empty ruleset :)

config/detekt/baseline.xml

cortinico · 2022-10-04T21:42:39Z

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt

+import kotlin.reflect.KClass
+
+/**
+ * If a rule uses `bindingContext` should be annotated with `@RequiresTypeResolution`. And if it doesn't it shouldn't


Suggested change

* If a rule uses `bindingContext` should be annotated with `@RequiresTypeResolution`. And if it doesn't it shouldn't

* If a rule uses [BindingContext] should be annotated with `@RequiresTypeResolution`. And if it doesn't it shouldn't

Here I'm talking about the bindingContext property. No the type BindingContext. I rephrased it to be more clear.

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt

cortinico · 2022-10-04T21:45:39Z

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt

+
+    override fun visitKtFile(file: KtFile) {
+        super.visitKtFile(file)
+        klasses.forEach { klass ->


I'm wondering if the check here is too sophisticated and we should just do a syntactic check on whether BindingContext or bindingContext are present as string in the body of the rule.

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt

BraisGabin · 2022-10-07T09:23:10Z

@cortinico can you re-review this? I adressed some of the issues you pointed out and comment in other that I'm not 100% sure if they should be implemented.

cortinico

Minor typo in the rule name. Other than that, looks good to me 👍

cortinico · 2022-10-07T09:59:07Z

config/detekt/detekt.yml

@@ -271,3 +271,8 @@ style:
  WildcardImport:
    active: true
    excludeImports: []
+
+ruleauthors:
+  ViolateTypeResolutionRequirements:


Suggested change

ViolateTypeResolutionRequirements:

ViolatesTypeResolutionRequirements:

We also have UseX as imperative sentences though, so I don't think it is a typo.

But we also use Has (HasPlatformType) which is a plural.

To me the UseX rules (like UseRequire) should be interpreted in a sentence like "You should use require here".

While the one with plurarls should be interpreted in sentences where the subject is "the code" so like "your code has platform type" or "your code violates type resolution".

Also this is a nit, so feel free to skip it :)

...ors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/ViolateTypeResolutionRequirements.kt

cortinico · 2022-10-15T14:15:00Z

@BraisGabin can we finalize this as I'd like to prepare RC2 tomorrow 👍

BraisGabin · 2022-10-15T17:35:09Z

I don't have a computer near this weekend. I'm OK with keeping the current name or adding the s.

If you want to release tomorrow feel free to change the name yourself.

…detekt/authors/RequiresTypeResolutionSpec.kt Co-authored-by: marschwar <marschwar@users.noreply.github.com>

github-actions bot added api build labels Aug 4, 2022

BraisGabin changed the base branch from main to create-authors-rules August 4, 2022 17:50

BraisGabin added rules and removed api build labels Aug 4, 2022

vercel bot deployed to Preview August 4, 2022 17:54 View deployment

marschwar reviewed Aug 5, 2022

View reviewed changes

...es-ruleauthors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolution.kt Outdated Show resolved Hide resolved

marschwar reviewed Aug 5, 2022

View reviewed changes

...uleauthors/src/test/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolutionSpec.kt Outdated Show resolved Hide resolved

marschwar reviewed Aug 5, 2022

View reviewed changes

...uleauthors/src/test/kotlin/io/gitlab/arturbosch/detekt/authors/RequiresTypeResolutionSpec.kt Outdated Show resolved Hide resolved

marschwar mentioned this pull request Aug 5, 2022

Allow additional types in @KotlinCoreEnvironmentTest annotation #5188

Closed

BraisGabin force-pushed the requires-type-resolution branch from f6a5567 to 6b50290 Compare August 7, 2022 10:12

github-actions bot added api build and removed rules labels Aug 7, 2022

BraisGabin force-pushed the create-authors-rules branch from 0f8cb03 to f6692e1 Compare August 7, 2022 10:17

vercel bot deployed to Preview August 7, 2022 10:18 View deployment

BraisGabin force-pushed the requires-type-resolution branch 2 times, most recently from 1f289af to c720dc1 Compare August 7, 2022 11:22

vercel bot deployed to Preview August 7, 2022 11:30 View deployment

BraisGabin force-pushed the requires-type-resolution branch from c720dc1 to d024ed0 Compare August 7, 2022 11:37

vercel bot deployed to Preview August 7, 2022 11:43 View deployment

vercel bot deployed to Preview September 4, 2022 12:35 View deployment

BraisGabin mentioned this pull request Sep 4, 2022

Provide the current classpath inside KotlinEnvironmentResolver #5275

Merged

BraisGabin force-pushed the create-authors-rules branch from f6692e1 to 6d37691 Compare September 4, 2022 20:41

BraisGabin force-pushed the requires-type-resolution branch from 2830585 to 6c2c21a Compare September 4, 2022 20:45

BraisGabin force-pushed the requires-type-resolution branch from 25f122d to 239d04d Compare September 9, 2022 23:02

vercel bot deployed to Preview September 9, 2022 23:08 View deployment

vercel bot deployed to Preview September 10, 2022 09:43 View deployment

chao2zhang reviewed Oct 4, 2022

View reviewed changes

cortinico reviewed Oct 4, 2022

View reviewed changes

github-actions bot added the rules label Oct 7, 2022

vercel bot deployed to Preview October 7, 2022 09:20 View deployment

BraisGabin requested a review from cortinico October 7, 2022 09:23

vercel bot deployed to Preview October 7, 2022 09:26 View deployment

cortinico approved these changes Oct 7, 2022

View reviewed changes

chao2zhang approved these changes Oct 10, 2022

View reviewed changes

...ors/src/main/kotlin/io/gitlab/arturbosch/detekt/authors/ViolateTypeResolutionRequirements.kt Outdated Show resolved Hide resolved

BraisGabin and others added 10 commits October 16, 2022 15:14

Implement requiresTypeResoultion Rule

1b88189

Improve RequiresTypeResolution

46bf5e4

Update detekt-rules-ruleauthors/src/test/kotlin/io/gitlab/arturbosch/…

0ac4749

…detekt/authors/RequiresTypeResolutionSpec.kt Co-authored-by: marschwar <marschwar@users.noreply.github.com>

Improve rule even more

6966dde

Fix bug

304dc23

exclude tests

d5ea8a8

Rename rule to ViolateTypeResolutionRequirements

1caa6ee

Use Suppress instead of baseline

e8b5145

Improve description

bf3f86a

Rename rule to ViolatesTypeResolutionRequirements

c4bdd5c

cortinico force-pushed the requires-type-resolution branch from bb84d73 to c4bdd5c Compare October 16, 2022 14:35

cortinico enabled auto-merge (squash) October 16, 2022 14:35

vercel bot deployed to Preview October 16, 2022 14:43 View deployment

cortinico merged commit 3f9e95a into main Oct 16, 2022

cortinico deleted the requires-type-resolution branch October 16, 2022 14:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement rule to check the correct usage of `@RequiresTypeResolution` #5182

Implement rule to check the correct usage of `@RequiresTypeResolution` #5182

BraisGabin commented Aug 4, 2022 •

edited

marschwar commented Aug 5, 2022

BraisGabin commented Aug 5, 2022

github-actions bot commented Aug 5, 2022 •

edited

codecov bot commented Sep 4, 2022 •

edited

BraisGabin commented Oct 4, 2022

chao2zhang Oct 4, 2022

BraisGabin Oct 4, 2022

cortinico Oct 4, 2022

BraisGabin Oct 7, 2022

cortinico left a comment

cortinico Oct 4, 2022

BraisGabin Oct 7, 2022

cortinico Oct 4, 2022

BraisGabin commented Oct 7, 2022

cortinico left a comment

cortinico Oct 7, 2022

chao2zhang Oct 10, 2022

cortinico Oct 14, 2022

cortinico commented Oct 15, 2022

BraisGabin commented Oct 15, 2022

	* If a rule uses `bindingContext` should be annotated with `@RequiresTypeResolution`. And if it doesn't it shouldn't
	* If a rule uses [BindingContext] should be annotated with `@RequiresTypeResolution`. And if it doesn't it shouldn't

	ViolateTypeResolutionRequirements:
	ViolatesTypeResolutionRequirements:

Implement rule to check the correct usage of @RequiresTypeResolution #5182

Implement rule to check the correct usage of @RequiresTypeResolution #5182

Conversation

BraisGabin commented Aug 4, 2022 • edited

marschwar commented Aug 5, 2022

BraisGabin commented Aug 5, 2022

github-actions bot commented Aug 5, 2022 • edited

codecov bot commented Sep 4, 2022 • edited

Codecov Report

BraisGabin commented Oct 4, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cortinico left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BraisGabin commented Oct 7, 2022

cortinico left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cortinico commented Oct 15, 2022

BraisGabin commented Oct 15, 2022

Implement rule to check the correct usage of `@RequiresTypeResolution` #5182

Implement rule to check the correct usage of `@RequiresTypeResolution` #5182

BraisGabin commented Aug 4, 2022 •

edited

github-actions bot commented Aug 5, 2022 •

edited

codecov bot commented Sep 4, 2022 •

edited