feat: add 'ignore for this file' in notifications

Author: Strum355

src/config.ts

@@ -201,6 +201,16 @@ class Config {
     // process.env['VSCEXT_EXHORT_SNYK_TOKEN'] = token;
   }
 
+  /**
+   * Adds a path to the workspace-local redHatDependencyAnalytics.exclude list.
+   * @param path The path to add 
+   */
+  async addFileToExcludeList(path: string) {
+    const original = vscode.workspace.getConfiguration('redHatDependencyAnalytics').inspect('exclude');
+    const newValues = [...((original?.workspaceValue as string[] | undefined) || []), path];
+    await vscode.workspace.getConfiguration('redHatDependencyAnalytics').update('exclude', newValues);
+  }
+
   /**
    * Authorizes the RHDA (Red Hat Dependency Analytics) service.
    * @param context The extension context for authorization.

src/constants.ts

@@ -21,6 +21,7 @@ export enum StatusMessages {
 export enum PromptText {
   FULL_STACK_PROMPT_TEXT = `Open Red Hat Dependency Analytics Report`,
   LSP_FAILURE_TEXT = `Open the output window`,
+  IGNORE_FILE = 'Ignore this file',
 }
 
 export enum Titles {

src/extension.ts

@@ -105,10 +105,13 @@ export async function activate(context: vscode.ExtensionContext) {
 
   const showVulnerabilityFoundPrompt = async (msg: string, filePath: vscode.Uri) => {
     const fileName = path.basename(filePath.fsPath);
-    const selection = await vscode.window.showWarningMessage(`${msg}`, PromptText.FULL_STACK_PROMPT_TEXT);
+    const selection = await vscode.window.showWarningMessage(`${msg}`, PromptText.FULL_STACK_PROMPT_TEXT as string, PromptText.IGNORE_FILE);
     if (selection === PromptText.FULL_STACK_PROMPT_TEXT) {
       record(context, TelemetryActions.vulnerabilityReportPopupOpened, { manifest: fileName, fileName: fileName });
       vscode.commands.executeCommand(commands.STACK_ANALYSIS_COMMAND, filePath.fsPath);
+    } else if (selection === PromptText.IGNORE_FILE) {
+      outputChannelDep.info(`Added "${filePath.fsPath}" to workspace exclude list`);
+      await globalConfig.addFileToExcludeList(filePath.fsPath);
     } else {
       record(context, TelemetryActions.vulnerabilityReportPopupIgnored, { manifest: fileName, fileName: fileName });
     }
@@ -123,12 +126,16 @@ export async function activate(context: vscode.ExtensionContext) {
     }
   });
 
-  notifications.on('caError', (errorData: CANotificationData) => {
+  notifications.on('caError', async (errorData: CANotificationData) => {
     const notification = new CANotification(errorData);
     caStatusBarProvider.setError();
 
     // Since CA is an automated feature, only warning message will be shown on failure
-    vscode.window.showWarningMessage(`RHDA error while analyzing ${errorData.uri.fsPath}: ${notification.errorMsg()}`);
+    const selection = await vscode.window.showWarningMessage(`RHDA error while analyzing ${errorData.uri.fsPath}: ${notification.errorMsg()}`, PromptText.IGNORE_FILE);
+    if (selection === PromptText.IGNORE_FILE) {
+      outputChannelDep.info(`Added "${errorData.uri.fsPath}" to workspace exclude list`);
+      await globalConfig.addFileToExcludeList(errorData.uri.fsPath);
+    }
 
     // Record telemetry event
     record(context, TelemetryActions.componentAnalysisFailed, { manifest: path.basename(notification.origin().fsPath), fileName: path.basename(notification.origin().fsPath), error: notification.errorMsg() });
@@ -151,6 +158,7 @@ export async function activate(context: vscode.ExtensionContext) {
 
   vscode.workspace.onDidChangeConfiguration(() => {
     globalConfig.loadData();
+    outputChannelDep.debug(`configuration updated`);
   });
 }
 
@@ -221,7 +229,12 @@ function registerStackAnalysisCommands(context: vscode.ExtensionContext) {
       record(context, TelemetryActions.vulnerabilityReportDone, { manifest: fileName, fileName: fileName });
     } catch (error) {
       const message = applySettingNameMappings((error as Error).message);
-      vscode.window.showErrorMessage(`RHDA error while analyzing ${filePath}: ${message}`);
+      const selection = await vscode.window.showErrorMessage(`RHDA error while analyzing ${filePath}: ${message}`, PromptText.IGNORE_FILE);
+      if (selection === PromptText.IGNORE_FILE) {
+        outputChannelDep.info(`Added "${filePath}" to workspace exclude list`);
+        await globalConfig.addFileToExcludeList(filePath);
+      }
+
       outputChannelDep.error(buildLogErrorMessage((error as Error)));
       record(context, TelemetryActions.vulnerabilityReportFailed, { manifest: fileName, fileName: fileName, error: message });
     }