[GUI] Jump directly to documentation url without error modal #3974
Conversation
cservakt
added
WIP 💣
There was a problem hiding this comment.
Nice, welcome to CodeChecker! :)
I recently left a comment in another PR that summarized what I usually like to see in the summary of the patch:
#3949 (comment)
Yours is currently empty, so please fill it out.
cservakt
added
test ☑️
There was a problem hiding this comment.
You seem to have forgotten to add a newline in between the title of your commit and the message of the commit, which results in the entire summary to be in fact your title. This is the output of git log --oneline:
edit: I tried this PR out, and it works fine for me, but I lack the expertise on this part of the codebase to comment anything substantial :)
| @@ -25,18 +25,17 @@ module.exports = { | |||
|
|
|||
| "show documentation" (browser) { | |||
| const reportDetailPage = browser.page.reportDetail(); | |||
| const dialog = reportDetailPage.section.documentationDialog; | |||
| reportDetailPage.expect.element('@showDocumentationBtn').to.be.present.before(5000, false); | |||
There was a problem hiding this comment.
Seems like we try to fit lines in 79 columns in the rest of the file as well -- could you add a newline?
| @@ -313,8 +308,7 @@ import ReportTreeKind from "@/components/Report/ReportTree/ReportTreeKind"; | |||
| import { SetCleanupPlanBtn } from "@/components/Report/CleanupPlan"; | |||
|
|
|||
| import AnalysisInfoBtn from "./AnalysisInfoBtn"; | |||
| import CheckerDocumentationDialog from | |||
| "@/components/CheckerDocumentationDialog"; | |||
There was a problem hiding this comment.
Does this mean that we can just outright delete that file? Seems like only Report.vue used it.
There was a problem hiding this comment.
No, we cannot delete it. The Reports.vue also uses the CheckerDocumentationDialog.
Szelethus
changed the title
cservakt
changed the title
| @@ -73,7 +79,8 @@ export default { | |||
| index: { type: [ Number, String ], default: null }, | |||
| bus: { type: Object, default: null }, | |||
| prevStep: { type: Object, default: null }, | |||
| nextStep: { type: Object, default: null } | |||
| nextStep: { type: Object, default: null }, | |||
| docUrl: { type: String, default: "" } | |||
There was a problem hiding this comment.
This is a minor comment, but "not having some kind of information" could be represented by null like in case of the other members. docUrl could be changed accordingly in this ReportStepMessage.vue and Report.vue file tool.
Currently on the report detail page there is a red error bubble where we can click on the checker documentation button to have more information about the error. The button click triggers a modal that contains already known information and the real checker documentation URL. The modal is unnecessary and it has two steps to navigate to the effective documentation. To reduce the step numbers, there are some modifications in the Report and the ReportStepMessage components. When the report page is loaded the first thing is to create an errorChecker, then getting its documentation and passing it to ReportStepMessage via props. The ReportStepMessage component present the checker documentation button if the URL exists. The button refers to the checker error documentation without displaying a modal. When the documentation is not available, the ReportStepMessage shows the "No documentation for checker." message in the bubble.
Currently on the report detail page there is a red error bubble where we can click on the checker documentation button to have more information about the error. The button click triggers a modal that contains already known information and the real checker documentation URL.
The modal is unnecessary and it has two steps to navigate to the effective documentation. To reduce the step numbers, there are some modifications in the Report and the ReportStepMessage components.
When the report page is loaded the first thing is to create an errorChecker, then getting its documentation and passing it to ReportStepMessage via props. The ReportStepMessage component present the checker documentation button if the URL exists. The button refers to the checker error documentation without displaying a modal. When the documentation is not available, the ReportStepMessage shows the "No documentation for checker." message in the bubble.