[RFE] Ensure Warning information is displayed through WebUI for Analysis runs
Opened this issue · 2 comments
This issue is to help us track a small refinement to the integration of analyzer-lsp.
We want to be sure that if a user creates a custom target with badly formed rules, or if something unexpected happens during the analysis run we are able to signal to the User via the WebUI that something unexpected occurred, perhaps this would be a "Warning" and point them to a means to debug the problem.
The use case imagined is a user has syntax errors in a custom rule, the analyzer skips that custom rule as it saw something wasn't right. Assume that the analysis runs and completes successfully (as it skipped the problematic rule). We want to be sure we are not swallowing the extra information such as warnings when the user views information from the UI.
We need a way to signal to the User something "odd" occurred that is not at the level of an "error" but it is something they may need to investigate.
We discussed this in UXD call today (June 6 2023) and @jortel it was mentioned you had been thinking of this use-case and likely had a path to address it with current plans.
We saw a similar problem that inspired this use-case with work @savitharaghunathan was doing yesterday. She was running with WindUp and hit a syntax issue with a rule, she executed an analysis, the badly formed rule was skipped but no information was given back to her via UI that there was an issue with a rule that she needed to fix. This is what we want to be sure we address with the new analyzer-lsp integration.
Assume this may for practical purposes be limited to indicate a warning was seen and point to a log file in initial pass, in time it'd be nice if we can get better at the information for debugging/observability and provide all the information needed so users can debug and learn of the issues all from within our UI.
I think we also need to take into account unmatched rules and displaying those. If there is already a design/UX for this I'm sorry for not recalling