Merge pull request #109 from Discookie/ericsson/doc-url

Add `Go to docs` button to sidebar
Ericsson · Aug 26, 2022 · c70546d · c70546d
2 parents 6ab1f02 + 39900d7
commit c70546d
Show file tree

Hide file tree

Showing 10 changed files with 141 additions and 11 deletions.
diff --git a/src/backend/api.ts b/src/backend/api.ts
@@ -4,9 +4,9 @@ import { DiagnosticsApi, MetadataApi } from './processor';
 
 export class ExtensionApi {
     static init(ctx: ExtensionContext): void {
-        this._metadata = new MetadataApi(ctx);
         this._executorManager = new ExecutorManager(ctx);
         this._executorBridge = new ExecutorBridge(ctx);
+        this._metadata = new MetadataApi(ctx);
         this._diagnostics = new DiagnosticsApi(ctx);
     }
 

diff --git a/src/backend/executor/bridge.ts b/src/backend/executor/bridge.ts
@@ -179,6 +179,14 @@ export class ExecutorBridge implements Disposable {
         return args;
     }
 
+    public getCheckersCmdArgs(): string[] | undefined {
+        return [
+            'checkers',
+            '--details',
+            '--output', 'json',
+        ];
+    }
+
     public getLogCmdArgs(buildCommand?: string): string[] | undefined {
         if (!workspace.workspaceFolders?.length) {
             return undefined;
@@ -350,6 +358,34 @@ export class ExecutorBridge implements Disposable {
         ExtensionApi.executorManager.addToQueue(process, 'replace');
     }
 
+    public async reloadCheckerData() {
+        if (!await this.checkVersion()) {
+            return;
+        }
+
+        const ccPath = getConfigAndReplaceVariables('codechecker.executor', 'executablePath') || 'CodeChecker';
+        const commandArgs = this.getCheckersCmdArgs();
+
+        if (commandArgs === undefined) {
+            return;
+        }
+
+        const process = new ScheduledProcess(ccPath, commandArgs, { processType: ProcessType.checkers });
+
+        // TODO: Find a better way to collect full process output
+        let processOutput = '';
+
+        process.processStdout((output) => processOutput += output);
+
+        process.processStatusChange((status) => {
+            if (status === ProcessStatus.finished) {
+                ExtensionApi.metadata.parseCheckerData(processOutput);
+            }
+        });
+
+        ExtensionApi.executorManager.addToQueue(process, 'replace');
+    }
+
     public stopAnalysis() {
         ExtensionApi.executorManager.clearQueue(ProcessType.analyze);
         ExtensionApi.executorManager.clearQueue(ProcessType.log);

diff --git a/src/backend/executor/process.ts b/src/backend/executor/process.ts
@@ -15,6 +15,7 @@ export enum ProcessStatus {
 
 export enum ProcessType {
     analyze = 'CodeChecker analyze',
+    checkers = 'CodeChecker checkers',
     log = 'CodeChecker log',
     parse = 'CodeChecker parse',
     version = 'CodeChecker analyzer-version',
@@ -98,7 +99,7 @@ export class ScheduledProcess implements Disposable {
         this.processParameters = parameters ?? {};
 
         const processType = parameters?.processType ?? '';
-        const forwardDefaults: string[] = [ ProcessType.parse ];
+        const forwardDefaults: string[] = [ ProcessType.checkers, ProcessType.parse ];
 
         if (this.processParameters.forwardStdoutToLogs === undefined) {
             this.processParameters.forwardStdoutToLogs = !forwardDefaults.includes(processType);
@@ -210,8 +211,10 @@ export class ExecutorManager implements Disposable {
 
     private executionPriority = [
         ProcessType.version,
+        ProcessType.checkers,
         ProcessType.parse,
-        ProcessType.analyze
+        ProcessType.log,
+        ProcessType.analyze,
     ];
 
     /** Map of scheduled processes, indexed by its commonName.

diff --git a/src/backend/parser/metadata.ts b/src/backend/parser/metadata.ts
@@ -1,6 +1,6 @@
 import { TextDecoder } from 'util';
 import { Uri, workspace } from 'vscode';
-import { AnalyzerMetadata, CheckerMetadata, MetadataFile } from '../types';
+import { AnalyzerMetadata, CheckerData, CheckerMetadata, MetadataFile } from '../types';
 import { v1Types } from '../types/internal/metadata';
 
 export class MetadataParseError extends Error {
@@ -69,3 +69,13 @@ export async function parseMetadata(path: string): Promise<MetadataFile> {
 
     return metadataFile as MetadataFile;
 }
+
+export function parseCheckerData(data: string): CheckerData[] {
+    const parsedData = JSON.parse(data) as CheckerData[];
+
+    if (parsedData === undefined) {
+        throw new SyntaxError('Invalid output of CodeChecker checkers');
+    }
+
+    return parsedData;
+}
diff --git a/src/backend/processor/metadata.ts b/src/backend/processor/metadata.ts
@@ -11,15 +11,24 @@ import {
     workspace
 } from 'vscode';
 import * as path from 'path';
-import { parseMetadata } from '../parser';
-import { CheckerMetadata } from '../types';
+import { ExtensionApi } from '../api';
+import { parseCheckerData, parseMetadata } from '../parser';
+import { CheckerData, CheckerMetadata } from '../types';
 import { shouldShowNotifications } from '../../utils/config';
 
 export class MetadataApi implements Disposable {
     private _metadata?: CheckerMetadata;
     public get metadata(): CheckerMetadata | undefined {
         return this._metadata;
     }
+    private _checkerData: Map<string, CheckerData> = new Map();
+    /**
+     * Content based on the CodeChecker checkers command.
+     * Key: checker name, value: checker descriptor data (incl. doc URL)
+     */
+    public get checkerData(): Map<string, CheckerData>{
+        return this._checkerData;
+    }
 
     // Path to the metadata.json file
     private metadataPath?: string;
@@ -50,6 +59,7 @@ export class MetadataApi implements Disposable {
 
     private init() {
         this.updateMetadataPath();
+        ExtensionApi.executorBridge.reloadCheckerData();
     }
 
     dispose() {
@@ -200,9 +210,35 @@ export class MetadataApi implements Disposable {
         this._metadataUpdated.fire(this._metadata);
     }
 
+    parseCheckerData(checkerData: string) {
+        let parsedData;
+
+        try {
+            parsedData = parseCheckerData(checkerData);
+        } catch (err: any) {
+            console.error(err);
+
+            if (err instanceof SyntaxError) {
+                window.showErrorMessage('Failed to read CodeChecker checker data: Invalid format');
+            } else {
+                window.showErrorMessage('Failed to read CodeChecker checker data\nCheck console for more details');
+            }
+
+            return;
+        }
+
+        const dataMap = new Map();
+
+        for (const entry of parsedData) {
+            dataMap.set(`${entry.analyzer}/${entry.name}`, entry);
+        }
+
+        this._checkerData = dataMap;
+    }
+
     onConfigChanged(event: ConfigurationChangeEvent) {
         if (event.affectsConfiguration('codechecker.backend')) {
-            this.updateMetadataPath();
+            this.init();
         }
     }
 }
diff --git a/src/backend/types/checkers.ts b/src/backend/types/checkers.ts
@@ -0,0 +1,7 @@
+export interface CheckerData {
+    readonly status: 'enabled' | 'disabled' | 'unknown';
+    readonly name: string;
+    readonly analyzer: string;
+    readonly description: string;
+    readonly labels: string[];
+}
diff --git a/src/backend/types/index.ts b/src/backend/types/index.ts
@@ -1,2 +1,3 @@
 export * from './parse_result';
 export * from './metadata';
+export * from './checkers';
diff --git a/src/editor/navigation.ts b/src/editor/navigation.ts
@@ -1,4 +1,4 @@
-import { ExtensionContext, Position, Range, Uri, commands, window } from 'vscode';
+import { ExtensionContext, Position, Range, Uri, commands, env, window } from 'vscode';
 import { ExtensionApi } from '../backend/api';
 import { DiagnosticReport } from '../backend/types';
 
@@ -12,6 +12,15 @@ export class NavigationHandler {
         ctx.subscriptions.push(commands.registerCommand('codechecker.editor.jumpToStep', this.jumpToStep, this));
         ctx.subscriptions.push(commands.registerCommand('codechecker.editor.nextStep', this.nextStep, this));
         ctx.subscriptions.push(commands.registerCommand('codechecker.editor.previousStep', this.previousStep, this));
+        ctx.subscriptions.push(commands.registerCommand('codechecker.editor.openDocs', this.openDocs, this));
+    }
+
+    openDocs(docUrl: Uri | string) {
+        if (typeof docUrl === 'string') {
+            docUrl = Uri.parse(docUrl);
+        }
+
+        void env.openExternal(docUrl);
     }
 
     onDiagnosticsUpdated() {

diff --git a/src/sidebar/views/reports.ts b/src/sidebar/views/reports.ts
@@ -184,6 +184,26 @@ export class ReportsView implements TreeDataProvider<ReportTreeItem> {
             arguments: [currentFile, entryId, true]
         };
 
+        const checkerData = ExtensionApi.metadata.checkerData
+            ?.get(`${entry.analyzer_name ?? ''}/${entry.checker_name ?? ''}`);
+
+        const docUrl = checkerData?.labels
+            .find((val) => val.startsWith('doc_url:'))
+            ?.substring(8);
+
+        const goToDocsItems = [];
+
+        if (docUrl !== undefined) {
+            const goToDocsItem = new ReportTreeItem('openDocs', 'Go to checker documentation', new ThemeIcon('book'));
+            goToDocsItem.command = {
+                title: 'openDocs',
+                command: 'codechecker.editor.openDocs',
+                arguments: [docUrl]
+            };
+
+            goToDocsItems.push(goToDocsItem);
+        }
+
         let toggleStepsItem = null;
         if (isActiveReport) {
             toggleStepsItem = new ReportTreeItem(
@@ -202,6 +222,7 @@ export class ReportsView implements TreeDataProvider<ReportTreeItem> {
         let indentation = 0;
         return [
             jumpToReportItem,
+            ...goToDocsItems,
             toggleStepsItem,
             ...entry.bug_path_events.map((event, idx) => {
                 const filePath = event.file.original_path;

diff --git a/src/test/executor/executor.functional.test.ts b/src/test/executor/executor.functional.test.ts
@@ -208,7 +208,7 @@ suite('Functional Test: Backend - Executor', () => {
         await closeAllTabs();
     }).timeout(8000);
 
-    test('Stop analysis cancels current task and clears the queue', async function() {
+    test('Stop analysis cancels current long-running task and clears the queue', async function() {
         await Promise.all([
             executorBridge.analyzeFile(Uri.file(path.join(STATIC_WORKSPACE_PATH, 'file.cpp'))),
             executorBridge.analyzeFile(Uri.file(path.join(STATIC_WORKSPACE_PATH, 'file2.cpp'))),
@@ -221,8 +221,15 @@ suite('Functional Test: Backend - Executor', () => {
 
         executorBridge.stopAnalysis();
 
-        assert(executorManager['queue'].get(ProcessType.analyze)!.length === 0, 'Queue not cleared on analysis stop');
-        assert(executorManager.activeProcess === undefined, 'Running process not killed');
+        const processType = executorManager.activeProcess?.processParameters.processType;
+
+        for (const clearedProcessType of [ProcessType.analyze, ProcessType.log]) {
+            assert(
+                executorManager['queue'].get(clearedProcessType)!.length === 0,
+                'Queue not cleared on analysis stop'
+            );
+            assert(processType !== clearedProcessType, 'Running process not killed');
+        }
     });
 
     test('Duplicate tasks are removed from the queue', async function() {