deprecate *PUBLIC*API* metrics #1510
Closed
Conversation
This file contains 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
ivangalkin
force-pushed
the
deprecate_public_api
branch
from
923cd00 to
ad0da49
Compare
* `PUBLIC_API`, `PUBLIC_UNDOCUMENTED_API` and `PUBLIC_DOCUMENTED_API_DENSITY` were depricated since SQ 6.2 (https://jira.sonarsource.com/browse/SONAR-8328) but existed as custom sonar-cxx metrics * the minimal supported SQ version now is 6.7 * moreover, it looks like there is a general problem in displaying custom metrics (see SonarOpenCommunity#1509) * that means that nobody a) expects that the SQ plugin implements the deprectad metrics and b) nobody misses them (because they are just not visualized) * the squid check `UndocumentedApiCheck` is not affected (it doesn't rely on the stored metric, but visits the AST by itself) but `CxxPublicApiVisitorTest` had to be rewritten * BTW public API measurements belong to the obligatory AST Visitors and introduce the time overhead of ~6% (measured with SonarOpenCommunity#1507, 6% means, that if there is no sensors activated at all the importing of C++ project will still cause a calculation of a bunch of metrics; summary overhead of this calculation considered as 100%)
ivangalkin
force-pushed
the
deprecate_public_api
branch
from
ad0da49 to
f176ec0
Compare
|
|
|
Hi @ivangalkin, there was by intention a custom metric introduced. Think there is much value to detect undocumented public API. This is for sure technical debt. Never understood why SonarSource removed it? What’s correct: if someone don’t use it he should not pay for it. Maybe we can check if rule i s active. Regards, |
|
Alternativ would be #1062 |
|
will be abandoned as soon as #1509 is finished |
|
abandon in favor of #1514 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PUBLIC_API,PUBLIC_UNDOCUMENTED_APIandPUBLIC_DOCUMENTED_API_DENSITYwere depricated since SQ 6.2 (https://jira.sonarsource.com/browse/SONAR-8328)
but existed as custom sonar-cxx metrics
the minimal supported SQ version now is 6.7
moreover, it looks like there is a general problem in displaying
custom metrics (see sonar-cxx custom metrics are not dispayed/saved #1509)
that means that nobody a) expects that the SQ plugin implements the
deprectad metrics and b) nobody misses them (because they are just not
visualized)
BTW public API measurements belong to the obligatory AST Visitors
and introduce the time overhead of ~6% (measured with introduce CxxAstVisitorProfiler for CxxAstScanner #1507,
6% means, that if there is no sensors activated at all
the importing of C++ project will still cause a calculation
of a bunch of metrics; summary overhead of this calculation
considered as 100%)
This change is