[EPIC] enable all error-prone check

[coolderli]

Describe the proposal

In #1746 we introduce an error-prone plugin to validate code quality. But only enable the @FormatMethhod check. In this epic, we will enable all error-prone checks.

Task list

• [Subtask] Improvement(build) : enable some safe error-prone checks #2273
• [Subtask] Improvement: enable MissingSummary error-prone check #2334
• [Improvement] In StorageLayoutException.java and StorageLayoutException.java no passing final variable in format string #2152
• [Improvement] in HTTPClient.java character set should be specified #2153
• [Improvement] Column.java Prefer instanceof to getClass #2154
• [Improvement] Improve use of JavaUtilDate in KerberosTokenProvider.java #2156
• [Improvement] throwIfUnchecked is a no-op #2160
• [Improvement] In GravitinoErrorCode.java errorCode in not Immutable #2162
• [Improvement] JdbcConnectorUtils.java contains mutable array #2164
• [Improvement] LockManager.java comparison using reference equality instead of value equality #2166
• [Improvement] GravitinoConnectorFactory.java writes to a static field is not thread-safe #2167
• [Subtask] enable InlineFormatString error-prone #2471
• [Subtask] enable ClassCanBeStatic error-prone #2472
• [Subtask] enable UnusedVariable error-prone #2473
• [Subtask] enable ComparableType error-prone #2474
• [Subtask] enable MissingOverride error-prone #2475
• [Subtask] enable BadImport error-prone #2476

[coolderli]

@justinmclean I submit an EPIC to trace enable all error-prone checks. And I will continue to work on this. If a check changes too much, I will submit a separate PR for better code review.
Before the work starts, I want to confirm if all checks should be enabled?

[justinmclean]

If you enable all checks, we'll get a lot of failures. It would be better to add all (or most) passing checks in one issue and then raise an issue for each failing check one by one.

[jerryshao]

@coolderli I think I've also created a similar issue to introduce errorprone to improve the code. I think it is a good start, really appreciated. We can fix the issue one by one to improve the quality of codes.

[coolderli]

#1876

[jerryshao]

@coolderli How many issues are we left to achieve this epic issue?

[coolderli]

@coolderli How many issues are we left to achieve this epic issue?

@jerryshao At lease 10+. Do you have any suggestions?

InlineFormatString
ReferenceEquality
ClassCanBeStatic
UnusedVariable
MissingSummary
UnusedMethod
ComparableType
MissingOverride
MutableConstantField
BadImport
UnnecessaryParentheses
ThrowIfUncheckedKnownChecked
ImmutableEnumChecker
StaticGuardedByInstance

[jerryshao]

I have no specific suggestion. We can do it one by one. I just want to know how many policies we still left, I plan to target this to 0.5.0, so hopes we can get it done before release.

[coolderli]

I have no specific suggestion. We can do it one by one. I just want to how many policies we still left, I plan to target this to 0.5.0, so hopes we can get it done before release.

@jerryshao I got it. Due to my recent exam preparation, the speed may be slower. After this weekend, I will have more time to participate, which will speed up the process. I think I should be able to complete it in March.

[jerryshao]

@coolderli would you please create all the subtasks about this? So that other people who have spare time can help you to achieve this.

InlineFormatString
ReferenceEquality
ClassCanBeStatic
UnusedVariable
MissingSummary
UnusedMethod
ComparableType
MissingOverride
MutableConstantField
BadImport
UnnecessaryParentheses
ThrowIfUncheckedKnownChecked
ImmutableEnumChecker
StaticGuardedByInstance

[coolderli]

@jerryshao I'm sorry about this epic can't finish before 0.5 release. But I think there is still some error-prone we can add. So I want to continue this work in 0.6. But I think I may not add all of them, because some of error-prone like MissingSummary changing too many codes. I don't think I can finish it.

Before 0.5 release, I'd like to submit a MR to exclude some error-prone that not supported for now and enable the remaining . So we can clearly see how far we are from completing this task and what we really need. What do you think?

[jerryshao]

Sure, thanks a lot.