Move report generation out of AnalysisDetails #577
Merged
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
The access to metrics from a Pull Request analysis is exposed through an `AnalysisDetails` instance, which also provides the ability to extract a formatted report. As a number of the metrics used in the summary report need to be retrieved through various additional DAOs, and as the resolution of URLs for links and images requiring access to core Sonarqube configuration, `AnalysisDetails` holds references to a high number of classes from Sonarqube's core. Some of those core Sonarqube classes are also referenced directly in some decorators which don't make use of the summary report but need equivalent metrics to those shown in the summary which means some searching logic is duplicated across the plugin. This change pulls the report generation into a `ReportGenerator` class, with the report being an interim set of collected metrics that each decorator can extract required information, or generate a formatted report from.
|
Kudos, SonarCloud Quality Gate passed! |
Karql
reviewed
Mar 21, 2023
| dashboardUrl, | ||
| coverage, | ||
| analysisSummary.getDashboardUrl(), | ||
| analysisSummary.getNewCoverage(), |
There was a problem hiding this comment.
Hi @Karql! Rather than placing similar comments at different points in the project, could you raise an issue stating the problem and replication steps, and provide any links to changes you believe have caused the issue at that point? This way other people have visibility of the issue being reported, and can follow any discussion on it.
There was a problem hiding this comment.
Sorry I wanted to link these places together but forgot to past link to issue here.
Full details can be found here: #285
I edited my comments to be more specific.
I didn't want to annoy you 😉
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.
The access to metrics from a Pull Request analysis is exposed through an
AnalysisDetailsinstance, which also provides the ability to extract aformatted report. As a number of the metrics used in the summary report
need to be retrieved through various additional DAOs, and as the
resolution of URLs for links and images requiring access to core
Sonarqube configuration,
AnalysisDetailsholds references to a highnumber of classes from Sonarqube's core. Some of those core Sonarqube
classes are also referenced directly in some decorators which don't make
use of the summary report but need equivalent metrics to those shown in
the summary which means some searching logic is duplicated across the
plugin.
This change pulls the report generation into a
ReportGeneratorclass,with the report being an interim set of collected metrics that each
decorator can extract required information, or generate a formatted
report from.