chore: improve UX for CA error messages (#799)

Author: Strum355

src/caNotification.ts

@@ -6,12 +6,12 @@ import { applySettingNameMappings } from './utils';
 /**
  * Interface representing the data structure for a Component Analysis (CA) Notification.
  */
-interface CANotificationData {
-  errorMessage: string | null;
-  done: boolean | null;
-  uri: Uri | null;
-  diagCount: number | null;
-  vulnCount: Map<string, number> | null;
+export interface CANotificationData {
+  uri: Uri;
+  errorMessage?: string | null;
+  done?: boolean | null;
+  diagCount?: number | null;
+  vulnCount?: Map<string, number> | null;
 }
 
 /**

src/config.ts

@@ -72,7 +72,7 @@ class Config {
    * @returns The RHDA configuration settings.
    * @private
    */
-  private getRhdaConfig(): any {
+  private getRhdaConfig(): vscode.WorkspaceConfiguration {
     return vscode.workspace.getConfiguration('redHatDependencyAnalytics');
   }
 

src/dependencyAnalysis/analysis.ts

@@ -12,13 +12,16 @@ import { isDefined } from '../utils';
 import { IDependencyProvider } from '../dependencyAnalysis/collector';
 import { Uri } from 'vscode';
 import { notifications, outputChannelDep } from '../extension';
+import { Source } from '@trustification/exhort-api-spec/model/v4/Source';
+import { DependencyReport } from '@trustification/exhort-api-spec/model/v4/DependencyReport';
+import { Issue } from '@trustification/exhort-api-spec/model/v4/Issue';
 
 /**
  * Represents a source object with an ID and dependencies array.
  */
 interface ISource {
   id: string;
-  dependencies: any[];
+  dependencies: DependencyReport[];
 }
 
 /**
@@ -83,7 +86,7 @@ class AnalysisResponse implements IAnalysisResponse {
             const issuesCount: number = isDefined(d, 'issues') ? d.issues.length : 0;
 
             const dd = issuesCount
-              ? new DependencyData(source.id, issuesCount, '', this.getRemediation(d.issues[0]), this.getHighestSeverity(d))
+              ? new DependencyData(source.id, issuesCount, '', this.getRemediation(d.issues![0]), this.getHighestSeverity(d))
               : new DependencyData(source.id, issuesCount, this.getRecommendation(d), '', this.getHighestSeverity(d));
 
             const resolvedRef = this.provider.resolveDependencyFromReference(d.ref);
@@ -102,7 +105,7 @@ class AnalysisResponse implements IAnalysisResponse {
    * @returns An array of dependencies or empty array if none exists.
    * @private
    */
-  private getDependencies(sourceData: any): any[] {
+  private getDependencies(sourceData: Source): DependencyReport[] {
     return isDefined(sourceData, 'dependencies') ? sourceData.dependencies : [];
   }
 
@@ -112,7 +115,7 @@ class AnalysisResponse implements IAnalysisResponse {
    * @returns The highest severity level or NONE if none exists.
    * @private
    */
-  private getHighestSeverity(dependency: any): string {
+  private getHighestSeverity(dependency: DependencyReport): string {
     return isDefined(dependency, 'highestVulnerability', 'severity') ? dependency.highestVulnerability.severity : 'NONE';
   }
 
@@ -122,7 +125,7 @@ class AnalysisResponse implements IAnalysisResponse {
    * @returns The remediation reference or empty string if none exists.
    * @private
    */
-  private getRemediation(issue: any): string {
+  private getRemediation(issue: Issue): string {
     return isDefined(issue, 'remediation', 'trustedContent', 'ref') ? this.provider.resolveDependencyFromReference(issue.remediation.trustedContent.ref.split('?')[0]) : '';
   }
 
@@ -132,7 +135,7 @@ class AnalysisResponse implements IAnalysisResponse {
    * @returns The recommendation reference or empty string if none exists.
    * @private
    */
-  private getRecommendation(dependency: any): string {
+  private getRecommendation(dependency: DependencyReport): string {
     return isDefined(dependency, 'recommendation') ? this.provider.resolveDependencyFromReference(dependency.recommendation.split('?')[0]) : '';
   }
 }

src/dependencyReportPanel.ts

@@ -113,7 +113,6 @@ export class DependencyReportPanel {
     DependencyReportPanel.data = null;
     while (this._disposables.length) {
       const x = this._disposables.pop();
-      /* istanbul ignore else */
       if (x) {
         x.dispose();
       }

src/exhortServices.ts

@@ -4,14 +4,18 @@ import * as vscode from 'vscode';
 import exhort, { ImageRef, Options, parseImageRef } from '@trustification/exhort-javascript-api';
 
 import { IImageRef, IOptions } from './imageAnalysis';
+import { AnalysisReport } from '@trustification/exhort-api-spec/model/v4/AnalysisReport';
 
 /**
  * Executes RHDA image analysis using the provided images and options.
  * @param images - The images to analyze.
  * @param options - The options for running image analysis.
- * @returns A Promise resolving to the analysis response in HTML format.
+ * @returns A Promise resolving to the analysis response in HTML or object format.
  */
-async function imageAnalysisService(images: IImageRef[], html: boolean, options: IOptions): Promise<any> {
+async function imageAnalysisService(images: IImageRef[], html: false, options: IOptions): Promise<{ [key: string]: AnalysisReport }>;
+async function imageAnalysisService(images: IImageRef[], html: true, options: IOptions): Promise<string>;
+
+async function imageAnalysisService(images: IImageRef[], html: boolean, options: IOptions): Promise<string | { [key: string]: AnalysisReport }> {
   return await exhort.imageAnalysis(images.map(img => {
     if (img.platform) {
       return `${img.image}^^${img.platform}`;

src/extension.ts

@@ -9,7 +9,7 @@ import { generateRHDAReport } from './rhda';
 import { globalConfig } from './config';
 import { StatusMessages, PromptText } from './constants';
 import { caStatusBarProvider } from './caStatusBarProvider';
-import { CANotification } from './caNotification';
+import { CANotification, CANotificationData } from './caNotification';
 import { DepOutputChannel } from './depOutputChannel';
 import { record, startUp, TelemetryActions } from './redhatTelemetry';
 import { applySettingNameMappings, buildErrorMessage } from './utils';
@@ -27,6 +27,7 @@ export const notifications = new EventEmitter();
  */
 export async function activate(context: vscode.ExtensionContext) {
   outputChannelDep = new DepOutputChannel();
+  outputChannelDep.info(`starting RHDA extension ${context.extension.packageJSON['version']}`);
 
   globalConfig.linkToSecretStorage(context);
 
@@ -40,10 +41,11 @@ export async function activate(context: vscode.ExtensionContext) {
 
   const fileHandler = new AnalysisMatcher();
   context.subscriptions.push(vscode.workspace.onDidSaveTextDocument((doc) => fileHandler.handle(doc)));
+  // Anecdotaly, some extension(s) may cause did-open events for files that aren't actually open in the editor,
+  // so this will trigger CA for files not actually open.
   context.subscriptions.push(vscode.workspace.onDidOpenTextDocument((doc) => fileHandler.handle(doc)));
   context.subscriptions.push(vscode.workspace.onDidCloseTextDocument(doc => clearCodeActionsMap(doc.uri)));
-  // iterate all open docs, as theres no "did open doc" event for these
-  // TODO: why is pom.xml not being picked up as background file
+  // Iterate all open docs, as there is (in general) no did-open event for these.
   for (const doc of vscode.workspace.textDocuments) {
     fileHandler.handle(doc);
   }
@@ -111,7 +113,7 @@ export async function activate(context: vscode.ExtensionContext) {
     }
   };
 
-  notifications.on('caNotification', respData => {
+  notifications.on('caNotification', (respData: CANotificationData) => {
     const notification = new CANotification(respData);
     caStatusBarProvider.showSummary(notification.statusText(), notification.origin());
     if (notification.hasWarning()) {
@@ -120,12 +122,12 @@ export async function activate(context: vscode.ExtensionContext) {
     }
   });
 
-  notifications.on('caError', errorData => {
+  notifications.on('caError', (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(notification.errorMsg());
+    vscode.window.showWarningMessage(`RHDA error while analyzing ${errorData.uri.fsPath}: ${notification.errorMsg()}`);
 
     // Record telemetry event
     record(context, TelemetryActions.componentAnalysisFailed, { manifest: path.basename(notification.origin().fsPath), fileName: path.basename(notification.origin().fsPath), error: notification.errorMsg() });

src/imageAnalysis/analysis.ts

@@ -112,7 +112,7 @@ class AnalysisResponse implements IAnalysisResponse {
    * @returns The total number of issues.
    * @private
    */
-  private getTotalIssues(summary: any): number {
+  private getTotalIssues(summary: SourceSummary): number {
     return isDefined(summary, 'total') ? summary.total : 0;
   }
 
@@ -122,7 +122,7 @@ class AnalysisResponse implements IAnalysisResponse {
    * @returns The highest severity level.
    * @private
    */
-  private getHighestSeverity(summary: any): string {
+  private getHighestSeverity(summary: SourceSummary): string {
     let highestSeverity = 'NONE';
 
     if (isDefined(summary, 'critical') && summary.critical > 0) {
@@ -160,7 +160,6 @@ class AnalysisResponse implements IAnalysisResponse {
  * @returns A Promise resolving to an AnalysisResponse object.
  */
 async function executeImageAnalysis(diagnosticFilePath: Uri, images: IImage[]): Promise<AnalysisResponse> {
-
   // Define configuration options for the component analysis request
   const options: IOptions = {
     'RHDA_TOKEN': globalConfig.telemetryId ?? '',