Improve UI for issues where startColumn == endColumn

SonarQube Server / Community Build
1

Tested with Community Build v25.1.0.102122 and dotnet-sonarscanner 9.0.2

Please improve the rendering in the UI for issues that have startColumn == endColumn during detection.

Issue as displayed in VS

devenv_2024-12-13_11-06-46
devenv_2024-12-13_11-06-46758×351 13.1 KB

Issues.json scan result 
      "results": [
        {
          "ruleId": "IDE0055",
          "level": "note",
          "message": "Fix formatting",
          "locations": [
            {
              "resultFile": {
                "uri": "file:///D:/downloads/SonarQubeSarifRepro/SonarQubeSarifRepro/Program.cs",
                "region": {
                  "startLine": 7,
                  "startColumn": 15,
                  "endLine": 7,
                  "endColumn": 15
                }
              }
            }
          ],
          "properties": {
            "warningLevel": 1
          }
        }
      ],

What the rendering in the UI currently looks like for these type of issues:

image
image1082×675 37 KB

What it actually should look like:
(Manually changed endColumn to startColumn + 1 in Issues.json)

image
image1086×710 37.2 KB

5

Hello @jwfx, thank you for the report.
I was not able to fully reproduce the issue. For me the issue appears at least on the correct line.

Screenshot 2025-02-10 at 15.36.42
Screenshot 2025-02-10 at 15.36.421648×1088 101 KB

However since even in my example it is not clear where is the issue and I admit that I could have screwed up somewhere while hacking the conditions to reproduce the bug, I created a ticket to improve this behavior. SONAR-24333

Meanwhile if you could try to reproduce this bug on the latest Community Build (specifically the fact that issue appears on top of the file instead of the correct line) it would be helpful to know that this behavior was not fixed by some side effect.

Anyway my team will take a look at this issue when we’ll have time for it.

7

Hi @viktor.vorona

I’ve pushed a minimal repro to GitHub:

When I run RunSonarQubeScan.cmd (add your token and url) the result looks like this:

image
image1075×357 15.3 KB

Tested with:

  • Community Build v25.2.0.102705
  • dotnet-sonarscanner 9.1.0
1 Like
9

Hey @jwfx,

Thank you very much for the repro, thats awesome! It actually made it clear to me that there is another issue on how dotnet sonarscanner works. Basically when the issue has startcolumn == endcolumn and startline == endline this information is not populated when the data comes to Frontend.

So to sum up there are 2 problems:

  1. Frontend is not doing the best job on handling startcolumn==endcolumn cases (it looks like it highlighting the whole line - see my screenshot). My squad will handle this issue and you can check the ticket I share for tracking if you want.
  2. It seems like dotnet-sonarscanner ignores region field of Issues.json if startColumn==endColumn. I will ping the squad that owns this part and let them fix that issue.

I would like to appreciate again the time you spent on creating the reproducer, I am pretty sure that I would not notice the second issue without your repro.

Best regards,
Viktor

13

Hi @viktor.vorona,

thank you for spending the time looking into this.

I suppose issue 1. is handled in SONAR-24333?

Is point 2. tracked somewhere publicly?

Asking, so I can start stalking future changelogs. :wink:

1 Like
14

@jwfx, for issue 1 - yes,
For issue 2 we still need to dig a bit deeper to understand what exact component is ignoring this information in the following chain: scanner → analysis processing → endpoint to get the issues, once we discover the exact component that causing it we will create a ticket and assign it to the correct team and update this thread with a link to created ticket.

2 Likes
16

Hello @jwfx,

First, I would like to thank you for providing a full reproducer! That was very helpful!

I was able to pin down the issue, and it is coming from the C# Analyzer plugin.
We consider any issues with the start location and end location being same as a file level issue.

I have created a ticket in our backlog.
Unfortunately, I cannot share it with you as our backlog is private at the moment.

Have a nice day!

1 Like
21

Any chance the related issues could receive somewhat higher priority? SONAR-24333 is getting bounced around between versions like a ping pong ball. :wink:

23

Hello @jwfx,

The ticket on our side is not yet planned.
I will bring it to the attention of the team so might pull it up from our backlog in a near future.

We will come back to this thread once the ticket is resolved.

1 Like
24

We implemented the ticket: https://github.com/SonarSource/sonar-dotnet-enterprise/pull/1119

Please note, that we needed to fix the location and make it one character wide. If we do not do this, the whole line is underlined. Because we don’t know the length of the line, we opted for expanding the location one character to the left if possible and only for the first column we expand to the right. The leads to a small problem in the UI. See the PR for more details.

It would be nice if the UI could handle zero length positions, so we could remove that workaround.

I created NET-2115 as a follow up for us, once SONAR-24333 is implemented.

2 Likes