EndOfSentenceFormat - Fix #3893 by only calling super.visit once #3904
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In #3660 the EndOfSentenceFormat rule got refactored. The rule is called by the MultiRule 'KDocStyle'. Both the called and calling visitor function execute a super.visit(). This can cause problems. Hence, super.visit only called once with the changes made. Suspicion: Multiple KtDeclaration super.visit calls cause the crash in #3893.
Codecov Report
@@ Coverage Diff @@
## main #3904 +/- ##
============================================
+ Coverage 83.55% 83.58% +0.03%
- Complexity 3118 3122 +4
============================================
Files 456 456
Lines 8973 9012 +39
Branches 1746 1756 +10
============================================
+ Hits 7497 7533 +36
Misses 564 564
- Partials 912 915 +3
Continue to review full report at Codecov.
|
marschwar
approved these changes
Jun 26, 2021
cortinico
approved these changes
Jun 27, 2021
BraisGabin
reviewed
Jun 27, 2021
...n/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/EndOfSentenceFormatSpec.kt
Show resolved
Hide resolved
BraisGabin
approved these changes
Jun 30, 2021
chao2zhang
reviewed
Jul 1, 2021
Comment on lines
+18
to
+19
| deprecatedBlockTag.visitDeclaration(dcl) | ||
| endOfSentenceFormat.visitDeclaration(dcl) |
Member
There was a problem hiding this comment.
Does deprecatedBlockTag and endOfSentenceFormat each invokes super.visitDeclaration(dcl), thus in total calling twice?
Member
Author
There was a problem hiding this comment.
Each rule calls its own super visit method. Before that, each rule called its own super visit method as well as the calling KDocStyle multi-rule.
Member
There was a problem hiding this comment.
I assume that before this PR, KDocStyle.visitDeclaration() is called but DeprecatedBlockTag.visitDeclaration is not invoked at runtime.
chao2zhang
approved these changes
Jul 1, 2021
Member
|
Are we ok merging this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #3660 the EndOfSentenceFormat rule got refactored.
The rule is called by the MultiRule 'KDocStyle'.
Both the called and calling visitor function execute a super.visit().
This can cause problems.
Hence, super.visit only called once with the changes made.
Suspicion:
Multiple KtDeclaration super.visit calls cause the crash in #3893.