community-plugins icon indicating copy to clipboard operation
community-plugins copied to clipboard

🚀 Feature: [SonarQube Plugin] Enhancement to support tabular list of sonarqube views

Open veerendervoskula opened this issue 1 year ago • 9 comments

🔖 Feature description

Components that's currently have sonarqube setup can see code quality insights for their software at component level. But if teams or leaders wishes to see aggregated views of this information they must go through each component individually.

🎤 Context

This feature is to provide tabular lists of sonarqube views at team, system and domain levels for each component part of that grouping. This tabular component uses existing sonarqube card component functionality to extract various subcomponents like as bugs, vulnerabilities, quality gates, and so on into their own components, allowing subcomponents to be used in multiple views. Iterating over the existing sonarQubeApi.GetFindingSummary is used to retrieve code quality metric insights data for all the components.

✌️ Possible Implementation

We have done these changes and would like to contribute and appreciate if you could accept that and found useful.

👀 Have you spent some time to check if this feature request has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

veerendervoskula avatar May 13 '24 09:05 veerendervoskula

Hi @veerendervoskula, the SonarQube plugin has been moved to the Community Plugins repo, I'll move this issue there for you 👍

awanlin avatar May 13 '24 12:05 awanlin

it sounds like a good idea @veerendervoskula. Would you like to be assigned to the issue?

vinzscam avatar May 15 '24 10:05 vinzscam

Hi @vinzscam, yes please

veerendervoskula avatar May 16 '24 15:05 veerendervoskula

Hi @vinzscam , could you please reassign it to my colleague @SaachiNayyer ? She will be contributing to this. Thanks.

veerendervoskula avatar Jun 19 '24 08:06 veerendervoskula

For some reason I can't seem to assign @SaachiNayyer but they are working on it 👍

awanlin avatar Jul 04 '24 17:07 awanlin

For some reason I can't seem to assign @SaachiNayyer but they are working on it 👍

I think we need an interaction from @SaachiNayyer in this issue in order to assign her. GitHub 🤷‍♂️

vinzscam avatar Jul 05 '24 20:07 vinzscam

Ah, that makes sense, thanks for pointing that out @vinzscam 👍

awanlin avatar Jul 08 '24 11:07 awanlin

Hi All I am working on the issue and hopefully will submit a revised PR after addressing comments , later this week. Thanks

SaachiNayyer avatar Jul 08 '24 12:07 SaachiNayyer

Thanks @SaachiNayyer, I've assigned this issue to you. Also, screen shots would be really helpful. Also, with this feature it should ideally be additive meaning the exiting UI and features should work as is still and this would be new additions to it 👍

awanlin avatar Jul 08 '24 13:07 awanlin

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 28 '24 18:09 github-actions[bot]

For anybody interested, this was actually implemented in https://github.com/backstage/community-plugins/pull/557 (August 2024) and ended up in plugin-sonarqube 0.8.0. @awanlin it would be nice to fix the state of this issue.

The functionality is not very well documented though and needs additional integration code (loading entities, getting the findings from the API, merging both) in order to use SonarQubeTable in entity pages. I also found a bug (wrong component key in the annotation of one entity leads to error in loading of findings for all entities) and some paper cuts (the table only supports Component entities, the layout could be more compact, error shown when no annotation is found mentions "DX-Hub annotation" which seems confusing etc.). I'd be willing to create a followup issue and a PR to fix the loading and some of those papercuts.

mhitkaohp avatar May 14 '25 07:05 mhitkaohp

Completed by https://github.com/backstage/community-plugins/pull/557

awanlin avatar May 14 '25 12:05 awanlin

Hi @mhitkaohp, I've updated the state of this issue, feel free to open a PR for the other items you mentioned 👍

awanlin avatar May 14 '25 12:05 awanlin