Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Display length of shortest path in UI #3659

Open
p- opened this issue Jul 10, 2024 · 4 comments
Open

Feature request: Display length of shortest path in UI #3659

p- opened this issue Jul 10, 2024 · 4 comments
Labels
enhancement New feature or request VSCode

Comments

@p-
Copy link
Contributor

p- commented Jul 10, 2024

Is your feature request related to a problem? Please describe.

When using MRVA with a query (custom or default) that yields a lot of results it is often hard to figure out which of the results are the most promising ones. Only after clicking on "Show paths" one learns how long the paths are and likely starts looking at results with a lower path count.

Image

See also: Feature request: allow to limit results by path length in UI

Describe the solution you'd like

It would be nice if the shortest paths for all the results would be displayed in the overview. (For MRVA and maybe also for local queries).

I've hacked this together in my experimental branch and it's already helpful (but not so beautiful 😉 ) - see commit p-@20617d2.

Image

Describe alternatives you've considered

An alternative or a nice addition would be if they results were ordered with regards to their shortest path length (shortest length on top).

Additional context

See also: Feature request: allow to limit results by path length in UI

@p- p- added the enhancement New feature or request label Jul 10, 2024
@jf205 jf205 self-assigned this Jul 22, 2024
@jf205
Copy link
Contributor

jf205 commented Jul 22, 2024

Hi @p-! Thanks for creating this issue. This change looks useful and is a nice simple UI change. The copy looks fine to me. We would be happy for you to contribute this change to the extension as a pull request and someone on the team will review it. Please let us know when the PR is ready.

@jf205 jf205 removed their assignment Jul 22, 2024
p- added a commit to p-/vscode-codeql that referenced this issue Jul 24, 2024
@p-
Copy link
Contributor Author

p- commented Jul 24, 2024

Hi @jf205
Thanks!

I've created a PR: #3671

@p-
Copy link
Contributor Author

p- commented Jul 24, 2024

I've prototyped this for the local queries as well (using a badge due to size constraints). (Commit: p-@69a2677)
Image

@jf205 Should I add the change for local queries to the same PR? (it's only for MRVA at the moment)

/cc @owen-mc

@owen-mc
Copy link

owen-mc commented Jul 24, 2024

I think that looks great with the badges. Though, now that I look at it the screenshot more closely, I realise that it would make more sense (and be more consistent) if the bit that says "Path" indicated the length of the path, so you would know how long it is without expanding it. I thought it did already, but I just double checked and it doesn't. I guess I have muscle-memory to open the top path and see how long it is.

charisk pushed a commit that referenced this issue Jul 25, 2024
* feature: display length of shortest path in MRVA UI #3659

* add entry to changelog

* replace link in changelog + remove test-id
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request VSCode
Projects
None yet
Development

No branches or pull requests

3 participants