CM-43066 - Add the "Ignore this violation" button for violation card of SCA (#122)

MarshalX · web-flow · commit 2d227bede1fd · 2024-12-19T10:50:13.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [v1.14.0]
+
+- Add the "Ignore this violation" button for violation card of SCA
+- Add support of `.gitignore` files for a file excluding from scans
+
 ## [v1.13.1]
 
 - Improve suggested AI fix rendering in violation cards
@@ -130,6 +135,8 @@
 
 The first stable release with the support of Secrets, SCA, TreeView, Violation Card, and more.
 
+[v1.14.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.14.0
+
 [v1.13.1]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.13.1
 
 [v1.13.0]: https://github.com/cycodehq/vscode-extension/releases/tag/v1.13.0
@@ -178,4 +185,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.13.1...HEAD
+[Unreleased]: https://github.com/cycodehq/vscode-extension/compare/v1.14.0...HEAD
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "cycode",
   "displayName": "Cycode",
-  "version": "1.13.1",
+  "version": "1.14.0",
   "publisher": "cycode",
   "description": "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.",
   "repository": {
diff --git a/src/cli/constants.ts b/src/cli/constants.ts
@@ -12,6 +12,7 @@ export enum CliCommands {
 export enum CommandParameters {
   OutputFormatJson = '--output=json',
   ByRule = '--by-rule',
+  ByCve = '--by-cve',
   ByValue = '--by-value',
   ByPath = '--by-path',
   UserAgent = '--user-agent',
diff --git a/src/cli/models/cli-ignore-type.ts b/src/cli/models/cli-ignore-type.ts
@@ -2,4 +2,5 @@ export enum CliIgnoreType {
   Value,
   Path,
   Rule,
+  Cve,
 }
diff --git a/src/cli/models/scan-result/sca/sca-detection-details-alert.ts b/src/cli/models/scan-result/sca/sca-detection-details-alert.ts
@@ -4,4 +4,5 @@ export class ScaDetectionDetailsAlert {
   description: string;
   vulnerableRequirements?: string;
   firstPatchedVersion?: string;
+  cveIdentifier?: string;
 }
diff --git a/src/cli/models/scan-result/secret/secret-detection-details.ts b/src/cli/models/scan-result/secret/secret-detection-details.ts
@@ -17,7 +17,7 @@ export class SecretDetectionDetails extends ScanDetectionDetailsBase {
   customRemediationGuidelines?: string;
   policyDisplayName?: string;
   @Exclude({ toPlainOnly: true })
-  detectedValue?: string | null; // this field is used and exist only in IDE
+  detectedValue?: string; // this field is used and exist only in IDE
 
   public getFilepath(): string {
     return `${this.filePath}${this.fileName}`;
diff --git a/src/constants.ts b/src/constants.ts
@@ -128,7 +128,7 @@ export const getScanTypeDisplayName = (scanType: string): string => {
   return _SCAN_TYPE_TO_DISPLAY_NAME[scanType];
 };
 
-export const REQUIRED_CLI_VERSION = '2.1.0';
+export const REQUIRED_CLI_VERSION = '2.2.0';
 
 export const CLI_GITHUB = {
   OWNER: 'cycodehq',
diff --git a/src/services/cli-download-service.ts b/src/services/cli-download-service.ts
@@ -237,7 +237,7 @@ export class CliDownloadService implements ICliDownloadService {
 
   async getExecutableAsset(): Promise<GitHubReleaseAsset | undefined> {
     const releaseInfo = await this.getGitHubLatestRelease();
-    if (releaseInfo == undefined) {
+    if (releaseInfo?.assets == undefined) {
       this.logger.warn('Failed to get latest release info');
       return undefined;
     }
@@ -304,7 +304,7 @@ export class CliDownloadService implements ICliDownloadService {
 
   async getRemoteChecksumFile(forceRefresh = false): Promise<string | undefined> {
     const releaseInfo = await this.getGitHubLatestRelease(forceRefresh);
-    if (releaseInfo == undefined) {
+    if (releaseInfo?.assets == undefined) {
       this.logger.warn('Failed to get latest release info');
       return undefined;
     }
diff --git a/src/services/cli-service.ts b/src/services/cli-service.ts
@@ -185,6 +185,8 @@ export class CliService implements ICliService {
         return CommandParameters.ByPath;
       case CliIgnoreType.Path:
         return CommandParameters.ByRule;
+      case CliIgnoreType.Cve:
+        return CommandParameters.ByCve;
       default:
         throw new Error('Invalid CliIgnoreType');
     }
diff --git a/src/services/cycode-service.ts b/src/services/cycode-service.ts
@@ -54,7 +54,7 @@ export class CycodeService implements ICycodeService {
         } catch (error: unknown) {
           captureException(error);
           if (error instanceof Error) {
-            this.logger.error(`Error during progress: ${error.message}`);
+            this.logger.error(`Error during progress: ${error.message}. FN: ${fn}`);
             vscode.window.showErrorMessage(`Cycode error: ${error.message}`);
           }
         } finally {
diff --git a/src/ui/panels/violation/card/sca.ts b/src/ui/panels/violation/card/sca.ts
@@ -51,5 +51,9 @@ export default `
     <div class="section-header">Cycode Guidelines</div>
     <div class="cycode-guidelines-text">None</div>
   </section>
+
+  <section class="hr section-footer">
+    <button class="ignore-btn">Ignore this violation</button>
+  </section>
 </section>
 `;
diff --git a/src/ui/panels/violation/renderer/sca.ts b/src/ui/panels/violation/renderer/sca.ts
@@ -15,11 +15,17 @@ const _resetDomState = () => {
 
   hideElement('cycode-guidelines');
   ge('cycode-guidelines-text').innerText = 'None';
+
+  hideElement('ignore-btn');
 };
 
 const renderDetection = detection => {
   _resetDomState();
 
+  ge('ignore-btn').onclick = () => {
+    vscode.postMessage({ command: 'ignoreScaByCve', uniqueDetectionId });
+  };
+
   ge('severity-icon').src = severityIcons[detection.severity];
   ge('package').innerText = detection.detectionDetails.packageName;
   ge('version').innerText = detection.detectionDetails.packageVersion;
@@ -28,7 +34,11 @@ const renderDetection = detection => {
   if (detection.detectionDetails.alert) {
     // if package vulnerability
     ge('title').innerText = detection.detectionDetails.alert.summary;
-    
+
+    if (detection.detectionDetails.alert.cveIdentifier) {
+      showElement('ignore-btn');
+    }
+
     const cwe = renderCweCveLink(detection.detectionDetails.vulnerabilityId);
     const severity = detection.severity;
     ge('short-details').innerHTML = severity + ' | ' + cwe;
diff --git a/src/ui/panels/violation/violation-panel.ts b/src/ui/panels/violation/violation-panel.ts
@@ -12,6 +12,7 @@ import { CliIgnoreType } from '../../../cli/models/cli-ignore-type';
 import { CliScanType } from '../../../cli/models/cli-scan-type';
 import { ILoggerService } from '../../../services/logger-service';
 import { ICycodeService } from '../../../services/cycode-service';
+import { ScaDetection } from '../../../cli/models/scan-result/sca/sca-detection';
 
 const _SEVERITY_NAMES: readonly string[] = ['Critical', 'High', 'Medium', 'Low', 'Info'];
 
@@ -61,9 +62,29 @@ const _sendDetectionToRender = async (scanType: CliScanType, detection: Detectio
   }
 };
 
+interface _CommandMappingAction {
+  scanType: CliScanType;
+  ignoreType: CliIgnoreType;
+  getIgnoreValue: (detection: DetectionBase) => string | undefined;
+}
+
+const _ignoreCommandMapping: Record<string, _CommandMappingAction> = {
+  ignoreSecretByValue: {
+    scanType: CliScanType.Secret,
+    ignoreType: CliIgnoreType.Value,
+    getIgnoreValue: (detection: DetectionBase) => (detection as SecretDetection).detectionDetails.detectedValue,
+  },
+  ignoreScaByCve: {
+    scanType: CliScanType.Sca,
+    ignoreType: CliIgnoreType.Cve,
+    getIgnoreValue: (detection: DetectionBase) => (detection as ScaDetection).detectionDetails.alert?.cveIdentifier,
+  },
+};
+
 const _ignoreCommandHandler = async (message: Record<string, string>) => {
-  if (message.command !== 'ignoreSecretByValue' || !message.uniqueDetectionId) {
-    // TODO(MarshalX): implement other ignore commands
+  const logger = container.resolve<ILoggerService>(LoggerServiceSymbol);
+  if (!message.uniqueDetectionId) {
+    logger.error('Unique detection id is missing in ignore command');
     return;
   }
 
@@ -73,13 +94,15 @@ const _ignoreCommandHandler = async (message: Record<string, string>) => {
     return;
   }
 
-  removePanel(CliScanType.Secret);
+  const commandInfo = _ignoreCommandMapping[message.command];
+  if (!commandInfo) {
+    logger.error('Unknown ignore command');
+    return;
+  }
 
+  removePanel(commandInfo.scanType);
   await vscode.commands.executeCommand(
-    VscodeCommands.IgnoreCommandId,
-    CliScanType.Secret,
-    CliIgnoreType.Value,
-    (detection as SecretDetection).detectionDetails.detectedValue,
+    VscodeCommands.IgnoreCommandId, commandInfo.scanType, commandInfo.ignoreType, commandInfo.getIgnoreValue(detection),
   );
 };
 
@@ -150,18 +173,16 @@ const _getAiRemediationHandler = async (panel: vscode.WebviewPanel, uniqueDetect
 
 const _getOnDidReceiveMessage = (panel: vscode.WebviewPanel, onLoadResolve: (value: boolean) => void) => {
   return async (message: Record<string, string>) => {
-    switch (message.command) {
-      case 'ready':
-        _readyCommandHandler(onLoadResolve);
-        break;
-      case 'ignoreSecretByValue':
-        await _ignoreCommandHandler(message);
-        break;
-      case 'getAiRemediation':
-        await _getAiRemediationHandler(panel, message.uniqueDetectionId);
-        break;
-      default:
-        break;
+    if (!message.command) {
+      return;
+    }
+
+    if (message.command == 'getAiRemediation') {
+      await _getAiRemediationHandler(panel, message.uniqueDetectionId);
+    } else if (message.command == 'ready') {
+      _readyCommandHandler(onLoadResolve);
+    } else if (message.command.startsWith('ignore')) {
+      await _ignoreCommandHandler(message);
     }
   };
 };

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "cycode",`
`3`	`3`	`"displayName": "Cycode",`
`4`		`- "version": "1.13.1",`
	`4`	`+ "version": "1.14.0",`
`5`	`5`	`"publisher": "cycode",`
`6`	`6`	`"description": "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.",`
`7`	`7`	`"repository": {`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@ export enum CliIgnoreType {`
`2`	`2`	`Value,`
`3`	`3`	`Path,`
`4`	`4`	`Rule,`
	`5`	`+ Cve,`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ export class ScaDetectionDetailsAlert {`
`4`	`4`	`description: string;`
`5`	`5`	`vulnerableRequirements?: string;`
`6`	`6`	`firstPatchedVersion?: string;`
	`7`	`+ cveIdentifier?: string;`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -185,6 +185,8 @@ export class CliService implements ICliService {`
`185`	`185`	`return CommandParameters.ByPath;`
`186`	`186`	`case CliIgnoreType.Path:`
`187`	`187`	`return CommandParameters.ByRule;`
	`188`	`+ case CliIgnoreType.Cve:`
	`189`	`+ return CommandParameters.ByCve;`
`188`	`190`	`default:`
`189`	`191`	`throw new Error('Invalid CliIgnoreType');`
`190`	`192`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ export class CycodeService implements ICycodeService {`
`54`	`54`	`} catch (error: unknown) {`
`55`	`55`	`captureException(error);`
`56`	`56`	`if (error instanceof Error) {`
`57`		- this.logger.error(`Error during progress: ${error.message}`);
	`57`	+ this.logger.error(`Error during progress: ${error.message}. FN: ${fn}`);
`58`	`58`	vscode.window.showErrorMessage(`Cycode error: ${error.message}`);
`59`	`59`	`}`
`60`	`60`	`} finally {`