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

Address grouping of incidents in webview deviation from initial sort order of issue tree view in sidebar. #325

Open
ibolton336 opened this issue Jan 30, 2025 · 0 comments
Labels
bug Something isn't working triaged/important
Milestone

Comments

@ibolton336
Copy link
Member

ibolton336 commented Jan 30, 2025

We have 2 views that show issues, the "Konveyor Issues" tree view and the "Konveyor Analysis View" and the way we group a show the incidents needs to be evaluated and harmonized between them:
Image

See this discussion: #317 (comment)

See roadmap story: https://github.com/konveyor/editor-extensions/blob/fix_relative_dir/docs/roadmap/stories/04-surface_analysis.md

Analysis data comes back it this abbreviated kind of structure (violations == issues):

  "violations": {
    "ruleName-0030": {
      "description": "An example description that can cover all of the incidents included",
      "incidents": [
        {
          "uri": "file://some/file/path",
          "message": "A specific incident message that gives more detail for this incident under this violation",
          "lineNumber": 18
        }
      ]
    }
  }

Under a particular named violation, the incidents can have the same message text. Sometimes there can be multiple groups of incidents under a violation where the message is shared. This happens particularly under a rule like "change package names from javax to jakarta".

So we need to consider:

  • Issues have a short description but no message
  • Incidents belong to an Issue and have a message
  • All of the Incidents under an Issue do NOT have to have the same message
  • Showing each Incident's message separately is a waste of space since the message can be identical
  • Where can a user ask for a solution? At minimum:
    • Per Incident
    • For a set of Incidents with the same message
    • For all Incidents under an Issue

When display grouped by File, the discussion is much the same.

Asking for a solution can also be at a File level. Lots of options here both in the File grouped view and in the Issue grouped view. The basic solution request command remains the same, just gets invoked at different layers of the Analysis views.

@sjd78 sjd78 changed the title 👻 Address grouping of incidents in webview deviation from initial sort order of issue tree view in sidebar. Address grouping of incidents in webview deviation from initial sort order of issue tree view in sidebar. Jan 30, 2025
@sjd78 sjd78 added bug Something isn't working triaged/important labels Jan 30, 2025
@sjd78 sjd78 added this to the v0.1.0 milestone Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triaged/important
Projects
Status: Todo
Development

No branches or pull requests

2 participants