CM-40769 - Code refactoring of Tree View (#106)

Author: MarshalX

CODEOWNERS

@@ -1 +1 @@
-* @MarshalX @MichalBor @MaorDavidzon @artem-fedorov @elsapet @gotbadger @cfabianski
+* @MarshalX @elsapet

eslint.config.mjs

@@ -45,7 +45,7 @@ export default tseslint.config(
                     'format': ['camelCase', 'UPPER_CASE', 'PascalCase'],
                 },
             ],
-            '@typescript-eslint/no-explicit-any': 'warn', // we will make it error pretty soon
+            '@typescript-eslint/no-explicit-any': 'error',
             '@typescript-eslint/prefer-nullish-coalescing': 'off',
             // enabled someday:
             '@typescript-eslint/no-unnecessary-condition': 'off', // some of this could be useful

package.json

@@ -28,16 +28,6 @@
   "main": "./dist/extension.js",
   "contributes": {
     "menus": {
-      "commandPalette": [
-        {
-          "command": "cycode.openViolationInFileFromTreeItemContextMenu",
-          "when": "false"
-        },
-        {
-          "command": "cycode.openViolationPanelFromTreeItemContextMenu",
-          "when": "false"
-        }
-      ],
       "explorer/context": [
         {
           "when": "explorerResourceIsFolder",
@@ -60,47 +50,39 @@
       "view/item/context": [
         {
           "command": "cycode.secretScanForProject",
-          "when": "viewItem == Secret",
+          "when": "viewItem == secretScanTypeNode",
           "group": "inline"
         },
         {
           "command": "cycode.scaScan",
-          "when": "viewItem == SCA",
+          "when": "viewItem == scaScanTypeNode",
           "group": "inline"
         },
         {
           "command": "cycode.iacScanForProject",
-          "when": "viewItem == IaC",
+          "when": "viewItem == iacScanTypeNode",
           "group": "inline"
         },
         {
           "command": "cycode.sastScanForProject",
-          "when": "viewItem == SAST",
+          "when": "viewItem == sastScanTypeNode",
           "group": "inline"
         },
         {
           "command": "cycode.secretScanForProject",
-          "when": "view == cycode.view.tree && viewItem == Secret"
-        },
-        {
-          "command": "cycode.iacScanForProject",
-          "when": "view == cycode.view.tree && viewItem == IaC"
-        },
-        {
-          "command": "cycode.sastScanForProject",
-          "when": "view == cycode.view.tree && viewItem == SAST"
+          "when": "view == cycode.view.tree && viewItem == secretScanTypeNode"
         },
         {
           "command": "cycode.scaScan",
-          "when": "view == cycode.view.tree && viewItem == SCA"
+          "when": "view == cycode.view.tree && viewItem == scaScanTypeNode"
         },
         {
-          "command": "cycode.openViolationInFileFromTreeItemContextMenu",
-          "when": "view == cycode.view.tree && viewItem =~ /-file-vulnerability$/"
+          "command": "cycode.iacScanForProject",
+          "when": "view == cycode.view.tree && viewItem == iacScanTypeNode"
         },
         {
-          "command": "cycode.openViolationPanelFromTreeItemContextMenu",
-          "when": "view == cycode.view.tree && viewItem =~ /-file-vulnerability$/"
+          "command": "cycode.sastScanForProject",
+          "when": "view == cycode.view.tree && viewItem == sastScanTypeNode"
         }
       ]
     },
@@ -183,14 +165,6 @@
       {
         "command": "cycode.auth",
         "title": "Authenticate with service"
-      },
-      {
-        "command": "cycode.openViolationInFileFromTreeItemContextMenu",
-        "title": "Show violation in the file"
-      },
-      {
-        "command": "cycode.openViolationPanelFromTreeItemContextMenu",
-        "title": "Open violation details"
       }
     ],
     "viewsContainers": {

resources/severity/C.png renamed to resources/severity/Critical.png

@@ -9,10 +9,6 @@ import iacScanForCurrentProjectCommand from './iac-scan-for-current-project-comm
 import sastScanCommand from './sast-scan-command';
 import sastScanForCurrentProjectCommand from './sast-scan-for-current-project-command';
 import onTreeItemClickCommand from './on-tree-item-click-command';
-import onOpenViolationInFileFromTreeItemContextMenuCommand
-  from './on-open-violation-in-file-from-tree-item-context-menu-command';
-import onOpenViolationPanelFromTreeItemContextMenuCommand
-  from './on-open-violation-panel-from-tree-item-context-menu-command';
 import openViolationInFileCommand from './open-violation-in-file-command';
 import openViolationPanelCommand from './open-violation-panel-command';
 import openSettingsCommand from './open-settings-command';
@@ -39,8 +35,6 @@ export enum VscodeCommands {
   OpenViolationInFile = 'cycode.openViolationInFile',
   OpenViolationPanel = 'cycode.openViolationPanel',
   OnTreeItemClick = 'cycode.onTreeItemClick',
-  OpenViolationInFileFromTreeItemContextMenu = 'cycode.openViolationInFileFromTreeItemContextMenu',
-  OpenViolationPanelFromTreeItemContextMenu = 'cycode.openViolationPanelFromTreeItemContextMenu',
 }
 
 const _VS_CODE_COMMANDS_ID_TO_CALLBACK: Record<string, (...args: never[]) => unknown> = {
@@ -54,8 +48,6 @@ const _VS_CODE_COMMANDS_ID_TO_CALLBACK: Record<string, (...args: never[]) => unk
   [VscodeCommands.SastScanCommandId]: sastScanCommand,
   [VscodeCommands.SastScanForProjectCommandId]: sastScanForCurrentProjectCommand,
   [VscodeCommands.OnTreeItemClick]: onTreeItemClickCommand,
-  [VscodeCommands.OpenViolationInFileFromTreeItemContextMenu]: onOpenViolationInFileFromTreeItemContextMenuCommand,
-  [VscodeCommands.OpenViolationPanelFromTreeItemContextMenu]: onOpenViolationPanelFromTreeItemContextMenuCommand,
   [VscodeCommands.OpenViolationInFile]: openViolationInFileCommand,
   [VscodeCommands.OpenViolationPanel]: openViolationPanelCommand,
   [VscodeCommands.OpenSettingsCommandId]: openSettingsCommand,

resources/severity/H.png renamed to resources/severity/High.png

@@ -1,8 +1,9 @@
 import * as vscode from 'vscode';
 import { VscodeCommands } from './index';
-import { TreeDisplayedData } from '../providers/tree-data/types';
+import { CliScanType } from '../cli/models/cli-scan-type';
+import { DetectionBase } from '../cli/models/scan-result/detection-base';
 
-export default async (fullFilePath: string, violation: TreeDisplayedData) => {
-  await vscode.commands.executeCommand(VscodeCommands.OpenViolationInFile, fullFilePath, violation.lineNumber);
-  vscode.commands.executeCommand(VscodeCommands.OpenViolationPanel, violation.detectionType, violation.detection);
+export default async (scanType: CliScanType, detection: DetectionBase) => {
+  await vscode.commands.executeCommand(VscodeCommands.OpenViolationInFile, detection);
+  await vscode.commands.executeCommand(VscodeCommands.OpenViolationPanel, scanType, detection);
 };

resources/severity/I.png renamed to resources/severity/Info.png

@@ -1,8 +1,28 @@
 import * as vscode from 'vscode';
+import { DetectionBase } from '../cli/models/scan-result/detection-base';
+import { SecretDetection } from '../cli/models/scan-result/secret/secret-detection';
+import { ScaDetection } from '../cli/models/scan-result/sca/sca-detection';
+import { IacDetection } from '../cli/models/scan-result/iac/iac-detection';
+import { SastDetection } from '../cli/models/scan-result/sast/sast-detection';
 
-export default async (fullFilePath: string, lineNumber: number) => {
-  const vscodeLineNumber = lineNumber - 1;
-  const uri = vscode.Uri.file(fullFilePath);
+const VSCODE_LINE_NUMBER_DIFF = 1; // CLI starts counting from 0, although vscode starts from line 1.
+
+export default async (detection: DetectionBase) => {
+  let vscodeLineNumber = 0;
+  if (detection instanceof SecretDetection) {
+    // secret detection line is 0-based
+    vscodeLineNumber = detection.detectionDetails.line + 1;
+  } else if (detection instanceof ScaDetection) {
+    vscodeLineNumber = detection.detectionDetails.lineInFile;
+  } else if (detection instanceof IacDetection) {
+    vscodeLineNumber = detection.detectionDetails.lineInFile;
+  } else if (detection instanceof SastDetection) {
+    vscodeLineNumber = detection.detectionDetails.lineInFile;
+  }
+
+  vscodeLineNumber -= VSCODE_LINE_NUMBER_DIFF;
+
+  const uri = vscode.Uri.file(detection.detectionDetails.getFilepath());
   await vscode.window.showTextDocument(uri, {
     viewColumn: vscode.ViewColumn.One,
     selection: new vscode.Range(vscodeLineNumber, 0, vscodeLineNumber, 0),

resources/severity/L.png renamed to resources/severity/Low.png

@@ -5,7 +5,7 @@ import { ExtensionServiceSymbol } from '../symbols';
 import { DetectionBase } from '../cli/models/scan-result/detection-base';
 import { CliScanType } from '../cli/models/cli-scan-type';
 
-export default (detectionType: CliScanType, detection: DetectionBase) => {
+export default (scanType: CliScanType, detection: DetectionBase) => {
   const extension = container.resolve<IExtensionService>(ExtensionServiceSymbol);
-  createAndInitPanel(extension.extensionContext, detectionType, detection);
+  createAndInitPanel(extension.extensionContext, scanType, detection);
 };

resources/severity/M.png renamed to resources/severity/Medium.png

@@ -110,9 +110,6 @@ export enum ScanTypeDisplayName {
   Iac = 'Infrastructure As Code',
 }
 
-export const SEVERITY_PRIORITIES_FIRST_LETTERS: readonly string[] = ['C', 'H', 'M', 'L', 'I'];
-export const SEVERITY_PRIORITIES: readonly string[] = ['Critical', 'High', 'Medium', 'Low', 'Info'];
-
 const _SCAN_TYPE_TO_DISPLAY_NAME: Record<string, string> = {
   [CliScanType.Secret]: ScanTypeDisplayName.Secrets,
   [CliScanType.Sca]: ScanTypeDisplayName.Sca,

src/commands/index.ts

@@ -1,18 +1,23 @@
 import * as vscode from 'vscode';
-import { TreeView } from './types';
 import { TreeDataProvider } from './provider';
-import { TreeItem } from './item';
+import { BaseNode } from './nodes/base-node';
+
+export interface TreeView {
+  provider: TreeDataProvider;
+  view: vscode.TreeView<BaseNode>;
+}
 
 export const createTreeView = (context: vscode.ExtensionContext): TreeView => {
   const provider = new TreeDataProvider();
-  const view = vscode.window.createTreeView(TreeItem.viewType, {
+  const view = vscode.window.createTreeView(TreeDataProvider.viewType, {
     treeDataProvider: provider,
-    canSelectMany: true,
+    showCollapseAll: true,
+    canSelectMany: false,
   });
 
   context.subscriptions.push(
     vscode.window.registerTreeDataProvider(
-      TreeItem.viewType,
+      TreeDataProvider.viewType,
       provider,
     ),
   );