CM-40765, CM-40767 - Add loading screen, rework sidebar, make views dynamic; add clear results action (#108)

Author: MarshalX

CHANGELOG.md

@@ -2,9 +2,13 @@
 
 ## [Unreleased]
 
-## [v1.10.1]
+## [v1.11.0]
 
-- Code refactoring
+- Add extension loading screen
+- Add toolbar actions: Run All, Expand All, Collapse All, Clear Results
+- Rework extension sidebar. Now it vertically splits the screen and always shows the tree view on top
+- Rework sidebar views to be more dynamic with proper action states
+- Huge code refactoring
 
 ## [v1.10.0]
 
@@ -99,7 +103,7 @@
 
 The first stable release with the support of Secrets, SCA, TreeView, Violation Card, and more.
 
-[v1.10.1]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.10.1
+[v1.11.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.11.0
 
 [v1.10.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.10.0
 
@@ -137,4 +141,4 @@ The first stable release with the support of Secrets, SCA, TreeView, Violation C
 
 [v1.0.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.0.0
 
-[Unreleased]: https://github.com/cycodehq/vscode-extension/compare/v1.10.1...HEAD
+[Unreleased]: https://github.com/cycodehq/vscode-extension/compare/v1.11.0...HEAD

package.json

@@ -1,7 +1,7 @@
 {
   "name": "cycode",
   "displayName": "Cycode",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "publisher": "cycode",
   "description": "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.",
   "repository": {
@@ -38,7 +38,7 @@
       "view/title": [
         {
           "command": "cycode.runAllScans",
-          "when": "view =~ /^cycode./",
+          "when": "view == cycode.view.tree",
           "group": "navigation@0"
         },
         {
@@ -52,14 +52,14 @@
           "group": "navigation@1"
         },
         {
-          "command": "cycode.openMainMenu",
+          "command": "cycode.clearAllScanResults",
           "when": "view == cycode.view.tree",
-          "group": "navigation@1"
+          "group": "navigation@2"
         },
         {
           "command": "cycode.openSettings",
-          "when": "view =~ /^cycode./",
-          "group": "navigation@2"
+          "when": "view == cycode.view.tree",
+          "group": "navigation@3"
         }
       ],
       "view/item/context": [
@@ -172,10 +172,10 @@
         "icon": "$(gear)"
       },
       {
-        "command": "cycode.openMainMenu",
+        "command": "cycode.clearAllScanResults",
         "category": "Cycode",
-        "title": "Return to Home Screen",
-        "icon": "$(arrow-left)"
+        "title": "Clear all scan results",
+        "icon": "$(trash)"
       },
       {
         "command": "cycode.runAllScans",
@@ -219,28 +219,28 @@
     "views": {
       "cycode": [
         {
-          "type": "webview",
-          "id": "cycode.view.login",
-          "name": "login",
-          "when": "!cycode:auth.isAuthed && !cycode:auth.isAuthenticating"
+          "type": "tree",
+          "id": "cycode.view.tree",
+          "name": "Scan Results",
+          "when": "true"
         },
         {
           "type": "webview",
-          "id": "cycode.view.authenticating",
-          "name": "login",
-          "when": "cycode:auth.isAuthenticating"
+          "id": "cycode.view.loading",
+          "name": "Loading",
+          "when": "!cycode:cli.isInstalled"
         },
         {
           "type": "webview",
-          "id": "cycode.view.main",
-          "name": "scan",
-          "when": "cycode:auth.isAuthed && (!cycode:scan.hasAnyDetections || !cycode:treeView.isShowed)"
+          "id": "cycode.view.auth",
+          "name": "Login",
+          "when": "cycode:cli.isInstalled && !cycode:auth.isAuthed"
         },
         {
-          "type": "tree",
-          "id": "cycode.view.tree",
-          "name": "Scan Results",
-          "when": "cycode:scan.hasAnyDetections && cycode:treeView.isShowed"
+          "type": "webview",
+          "id": "cycode.view.scan",
+          "name": "Scan",
+          "when": "cycode:cli.isInstalled && cycode:auth.isAuthed"
         }
       ]
     },

src/commands/auth-command.ts

@@ -1,11 +1,8 @@
-import { validateConfig } from '../utils/config';
 import { container } from 'tsyringe';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
-export default () => {
-  if (validateConfig()) {
-    return;
-  }
+import { getCommonCommand } from './common';
 
+export default getCommonCommand(async () => {
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
-  void cycodeService.startAuth();
-};
+  await cycodeService.startAuth();
+}, false);

src/commands/clear-all-scan-results-command.ts

@@ -0,0 +1,12 @@
+import { container } from 'tsyringe';
+import { ExtensionServiceSymbol, ScanResultsServiceSymbol } from '../symbols';
+import { IExtensionService } from '../services/extension-service';
+import { IScanResultsService } from '../services/scan-results-service';
+
+export default async () => {
+  const scanResultsService = container.resolve<IScanResultsService>(ScanResultsServiceSymbol);
+  const extensionService = container.resolve<IExtensionService>(ExtensionServiceSymbol);
+
+  scanResultsService.dropAllScanResults();
+  await extensionService.refreshProviders();
+};

src/commands/common.ts

@@ -0,0 +1,21 @@
+import * as vscode from 'vscode';
+import { validateConfig } from '../utils/config';
+import { container } from 'tsyringe';
+import { IStateService } from '../services/state-service';
+import { StateServiceSymbol } from '../symbols';
+
+export const getCommonCommand = (command: (...args: never[]) => void | Promise<void>, requiredAuth = true) => {
+  return async (...args: never[]) => {
+    if (validateConfig()) {
+      return;
+    }
+
+    const stateService = container.resolve<IStateService>(StateServiceSymbol);
+    if (requiredAuth && !stateService.globalState.CliAuthed) {
+      vscode.window.showErrorMessage('Please authenticate with Cycode first');
+      return;
+    }
+
+    await command(...args);
+  };
+};

src/commands/iac-scan-command.ts

@@ -1,22 +1,17 @@
 import * as vscode from 'vscode';
 import { container } from 'tsyringe';
 import TrayNotifications from '../utils/tray-notifications';
-import { validateConfig } from '../utils/config';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
 import { CliScanType } from '../cli/models/cli-scan-type';
+import { getCommonCommand } from './common';
 
-export default () => {
+export default getCommonCommand(async () => {
   // scan the current open document if opened
-
-  if (validateConfig()) {
-    return;
-  }
-
   if (!vscode.window.activeTextEditor?.document || vscode.window.activeTextEditor.document.uri.scheme === 'output') {
     TrayNotifications.showMustBeFocusedOnFile();
     return;
   }
 
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
-  void cycodeService.startScan(CliScanType.Iac, [vscode.window.activeTextEditor.document.fileName], true);
-};
+  await cycodeService.startScan(CliScanType.Iac, [vscode.window.activeTextEditor.document.fileName], true);
+});

src/commands/iac-scan-for-current-project-command.ts

@@ -1,13 +1,9 @@
 import { container } from 'tsyringe';
-import { validateConfig } from '../utils/config';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
 import { CliScanType } from '../cli/models/cli-scan-type';
+import { getCommonCommand } from './common';
 
-export default () => {
-  if (validateConfig()) {
-    return;
-  }
-
+export default getCommonCommand(async () => {
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
-  void cycodeService.startScanForCurrentProject(CliScanType.Iac);
-};
+  await cycodeService.startScanForCurrentProject(CliScanType.Iac);
+});

src/commands/ignore-command.ts

@@ -1,15 +1,11 @@
-import { validateConfig } from '../utils/config';
 import { container } from 'tsyringe';
 import { CycodeServiceSymbol } from '../symbols';
 import { ICycodeService } from '../services/cycode-service';
 import { CliIgnoreType } from '../cli/models/cli-ignore-type';
 import { CliScanType } from '../cli/models/cli-scan-type';
+import { getCommonCommand } from './common';
 
-export default (scanType: CliScanType, ignoreType: CliIgnoreType, value: string) => {
-  if (validateConfig()) {
-    return;
-  }
-
+export default getCommonCommand(async (scanType: CliScanType, ignoreType: CliIgnoreType, value: string) => {
   const cycodeService = container.resolve<ICycodeService>(CycodeServiceSymbol);
-  void cycodeService.applyDetectionIgnore(scanType, ignoreType, value);
-};
+  await cycodeService.applyDetectionIgnore(scanType, ignoreType, value);
+});

src/commands/index.ts

@@ -11,11 +11,11 @@ import sastScanForCurrentProjectCommand from './sast-scan-for-current-project-co
 import openViolationInFileCommand from './open-violation-in-file-command';
 import openViolationPanelCommand from './open-violation-panel-command';
 import openSettingsCommand from './open-settings-command';
-import openMainMenuCommand from './open-main-menu-command';
 import onTreeViewDetectionNodeClickCommand from './on-tree-view-detection-node-click-command';
 import treeViewExpandAllCommand from './tree-view-expand-all-command';
 import treeViewCollapseAllCommand from './tree-view-collapse-all-command';
 import runAllScansCommand from './run-all-scans-command';
+import clearAllScanResultsCommand from './clear-all-scan-results-command';
 
 export enum VscodeCommands {
   SecretScanCommandId = 'cycode.secretScan',
@@ -31,7 +31,7 @@ export enum VscodeCommands {
   IgnoreCommandId = 'cycode.ignore',
 
   OpenSettingsCommandId = 'cycode.openSettings',
-  OpenMainMenuCommandId = 'cycode.openMainMenu',
+  ClearAllScanResultsCommand = 'cycode.clearAllScanResults',
 
   OpenViolationInFile = 'cycode.openViolationInFile',
   OpenViolationPanel = 'cycode.openViolationPanel',
@@ -60,7 +60,7 @@ const _VS_CODE_COMMANDS_ID_TO_CALLBACK: Record<string, (...args: never[]) => unk
   [VscodeCommands.OpenViolationInFile]: openViolationInFileCommand,
   [VscodeCommands.OpenViolationPanel]: openViolationPanelCommand,
   [VscodeCommands.OpenSettingsCommandId]: openSettingsCommand,
-  [VscodeCommands.OpenMainMenuCommandId]: openMainMenuCommand,
+  [VscodeCommands.ClearAllScanResultsCommand]: clearAllScanResultsCommand,
   [VscodeCommands.OnTreeViewDetectionNodeClickCommand]: onTreeViewDetectionNodeClickCommand,
   [VscodeCommands.TreeViewExpandAllCommand]: treeViewExpandAllCommand,
   [VscodeCommands.TreeViewCollapseAllCommand]: treeViewCollapseAllCommand,

src/commands/open-main-menu-command.ts

@@ -1,22 +1,9 @@
-import * as vscode from 'vscode';
 import { container } from 'tsyringe';
-import { validateConfig } from '../utils/config';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
 import { CliScanType } from '../cli/models/cli-scan-type';
-import { IStateService } from '../services/state-service';
-import { StateServiceSymbol } from '../symbols';
-
-export default async () => {
-  if (validateConfig()) {
-    return;
-  }
-
-  const stateService = container.resolve<IStateService>(StateServiceSymbol);
-  if (!stateService.globalState.CliAuthed) {
-    vscode.window.showErrorMessage('Please authenticate with Cycode first');
-    return;
-  }
+import { getCommonCommand } from './common';
 
+export default getCommonCommand(async () => {
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
 
   const scanPromises = [];
@@ -25,4 +12,4 @@ export default async () => {
   scanPromises.push(cycodeService.startScanForCurrentProject(CliScanType.Iac));
   scanPromises.push(cycodeService.startScanForCurrentProject(CliScanType.Sast));
   await Promise.all(scanPromises);
-};
+});

src/commands/run-all-scans-command.ts

@@ -1,22 +1,16 @@
 import * as vscode from 'vscode';
 import { container } from 'tsyringe';
 import TrayNotifications from '../utils/tray-notifications';
-import { validateConfig } from '../utils/config';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
 import { CliScanType } from '../cli/models/cli-scan-type';
+import { getCommonCommand } from './common';
 
-export default () => {
-  // scan the current open document if opened
-
-  if (validateConfig()) {
-    return;
-  }
-
+export default getCommonCommand(async () => {
   if (!vscode.window.activeTextEditor?.document || vscode.window.activeTextEditor.document.uri.scheme === 'output') {
     TrayNotifications.showMustBeFocusedOnFile();
     return;
   }
 
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
-  void cycodeService.startScan(CliScanType.Sast, [vscode.window.activeTextEditor.document.fileName], true);
-};
+  await cycodeService.startScan(CliScanType.Sast, [vscode.window.activeTextEditor.document.fileName], true);
+});

src/commands/sast-scan-command.ts

@@ -1,13 +1,9 @@
 import { container } from 'tsyringe';
-import { validateConfig } from '../utils/config';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
 import { CliScanType } from '../cli/models/cli-scan-type';
+import { getCommonCommand } from './common';
 
-export default () => {
-  if (validateConfig()) {
-    return;
-  }
-
+export default getCommonCommand(async () => {
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
-  void cycodeService.startScanForCurrentProject(CliScanType.Sast);
-};
+  await cycodeService.startScanForCurrentProject(CliScanType.Sast);
+});

src/commands/sast-scan-for-current-project-command.ts

@@ -1,13 +1,9 @@
 import { container } from 'tsyringe';
 import { CycodeService, ICycodeService } from '../services/cycode-service';
-import { validateConfig } from '../utils/config';
 import { CliScanType } from '../cli/models/cli-scan-type';
+import { getCommonCommand } from './common';
 
-export default () => {
-  if (validateConfig()) {
-    return;
-  }
-
+export default getCommonCommand(async () => {
   const cycodeService = container.resolve<ICycodeService>(CycodeService);
-  void cycodeService.startScanForCurrentProject(CliScanType.Sca);
-};
+  await cycodeService.startScanForCurrentProject(CliScanType.Sca);
+});