Custom CheckStyle Rule #9: Thrown exception use ClientLogger #4566
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
added 8 commits
July 11, 2019 11:40
…heck for public class for external Dependency check
mssfang
requested review from
danieljurek,
mitchdenny and
weshaggard
as code owners
conniey
reviewed
Jul 24, 2019
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
conniey
reviewed
Jul 24, 2019
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
conniey
reviewed
Jul 24, 2019
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
conniey
reviewed
Jul 24, 2019
eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
Outdated
Show resolved
Hide resolved
conniey
reviewed
Jul 24, 2019
...thubs/azure-eventhubs/src/main/java/com/azure/messaging/eventhubs/EventHubClientBuilder.java
Show resolved
Hide resolved
joshfree
approved these changes
Jul 25, 2019
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
srnagar
requested changes
Jul 26, 2019
sdk/core/azure-core-management/src/main/java/com/azure/core/management/PagedList.java
Outdated
Show resolved
Hide resolved
sdk/core/azure-core-management/src/main/java/com/azure/core/management/PagedList.java
Outdated
Show resolved
Hide resolved
...quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrownClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
Contributor
Author
|
The rule requirement changes. Thank you for your past and next code reviews. Includes the fixes for Storages as well now. |
| } else { | ||
| return; | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Is this no longer necessary as you are instead configuring it via suppressions?
Contributor
Author
There was a problem hiding this comment.
Yes. you are right.
...lity-reports/src/main/java/com/azure/tools/checkstyle/checks/ThrowFromClientLoggerCheck.java
Outdated
Show resolved
Hide resolved
mssfang
commented
Aug 19, 2019
| protected Object handleResumeOperation(HttpRequest httpRequest, OperationDescription operationDescription, SwaggerMethodParser methodParser, Type returnType, Context context) | ||
| throws Exception { | ||
| throw new Exception("The resume operation is not available in the base RestProxy class."); | ||
| throw logger.logExceptionAsError(new RuntimeException("The resume operation is not available in the base RestProxy class.")); |
Contributor
Author
There was a problem hiding this comment.
Need double confirm that change Exception to RuntimeException. If can't, will suppress this error
alzimmermsft
approved these changes
Aug 19, 2019
Member
alzimmermsft
left a comment
alzimmermsft
left a comment
There was a problem hiding this comment.
Changes look good to me, we'll want to file issues to each library to update whether the exceptions should be logged as warnings or errors, this is important to help reduce non-important logging and reducing how many logs customs have.
sdk/core/azure-core/src/main/java/com/azure/core/implementation/RestProxy.java
Show resolved
Hide resolved
sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobInputStream.java
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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.
PR includes:
(1) the implementation for Rule 9: Thrown exception use ClientLogger
To throw an exception, Must throw it through a 'logger.logExceptionAsError', rather than by directly calling 'throw exception'.
Skip check if throw exception from
(2) code fixes based on the new rule: ThrowFromClientLoggerCheck.java
(3) a minor fixes for NoImplInPublicAPI.java checker:
(4) fixes for ServiceClientBuilder checker for Storage service.