feat: include extra telemetry info (#847)

Author: Strum355

package-lock.json

@@ -436,6 +436,7 @@
     "json-to-ast": "^2.1.0",
     "minimatch": "^10.0.3",
     "mustache": "^4.2.0",
+    "node-html-parser": "^7.0.1",
     "path": "^0.12.7",
     "tree-sitter-python": "^0.23.6",
     "web-tree-sitter": "^0.25.6"

package.json

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

src/caNotification.ts

@@ -24,6 +24,30 @@ interface ISource {
   dependencies: DependencyReport[];
 }
 
+export interface ResponseMetrics {
+  scanned: {
+    total: number,
+    direct: number,
+    transitive: number
+  },
+  providers: {
+    [providers: string]: {
+      [sources: string]: {
+        total: number,
+        direct: number,
+        transitive: number,
+        dependencies: number,
+        critical: number,
+        high: number,
+        medium: number,
+        low: number,
+        remediations: number,
+        recommendations: number,
+      }
+    }
+  }
+}
+
 /**
  * Implementation of IDependencyData interface.
  */
@@ -37,32 +61,45 @@ class DependencyData {
   ) { }
 }
 
-/**
- * Represents the parsed response of Red Hat Dependency Analytics (RHDA) analysis, with dependencies mapped by reference string.
- */
-interface IAnalysisResponse {
-  dependencies: Map<string, DependencyData[]>;
-}
-
-/**
- * Implementation of IAnalysisResponse interface.
- */
-class AnalysisResponse implements IAnalysisResponse {
+class AnalysisResponse {
+  metrics: ResponseMetrics = {
+    scanned: {
+      total: 0,
+      direct: 0,
+      transitive: 0
+    },
+    providers: {}
+  };
   dependencies: Map<string, DependencyData[]> = new Map<string, DependencyData[]>();
   provider: IDependencyProvider;
 
   constructor(resData: AnalysisReport, diagnosticFilePath: Uri, provider: IDependencyProvider) {
-
     this.provider = provider;
     const failedProviders: string[] = [];
     const sources: ISource[] = [];
 
     if (isDefined(resData, 'providers')) {
       Object.entries(resData.providers).map(([providerName, providerData]) => {
+        this.metrics.providers[providerName] = {};
         if (isDefined(providerData, 'status', 'ok') && providerData.status.ok) {
           if (isDefined(providerData, 'sources')) {
             Object.entries(providerData.sources).map(([sourceName, sourceData]) => {
               sources.push({ id: `${providerName}(${sourceName})`, dependencies: this.getDependencies(sourceData) });
+
+              if (isDefined(sourceData, 'summary')) {
+                this.metrics.providers[providerName][sourceName] = {
+                  dependencies: sourceData.summary.dependencies ?? 0,
+                  direct: sourceData.summary.direct ?? 0,
+                  transitive: sourceData.summary.transitive ?? 0,
+                  critical: sourceData.summary.critical ?? 0,
+                  high: sourceData.summary.high ?? 0,
+                  medium: sourceData.summary.dependencies ?? 0,
+                  low: sourceData.summary.low ?? 0,
+                  recommendations: sourceData.summary.recommendations ?? 0,
+                  remediations: sourceData.summary.remediations ?? 0,
+                  total: sourceData.summary.total ?? 0,
+                };
+              }
             });
           }
         } else {
@@ -97,6 +134,14 @@ class AnalysisResponse implements IAnalysisResponse {
         });
       });
     }
+
+    if (isDefined(resData, 'scanned')) {
+      this.metrics.scanned = {
+        direct: resData.scanned.direct ?? 0,
+        total: resData.scanned.total ?? 0,
+        transitive: resData.scanned.transitive ?? 0,
+      };
+    }
   }
 
   /**

src/dependencyAnalysis/analysis.ts

@@ -110,7 +110,7 @@ async function performDiagnostics(diagnosticFilePath: Uri, contents: string, pro
 
     diagnosticsPipeline.runDiagnostics(response.dependencies, ecosystem);
 
-    diagnosticsPipeline.reportDiagnostics();
+    diagnosticsPipeline.reportDiagnostics(response.metrics);
   } catch (error) {
     outputChannelDep.warn(`component analysis error: ${buildLogErrorMessage(error as Error)}`);
     notifications.emit('caError', {

src/dependencyAnalysis/diagnostics.ts

@@ -8,6 +8,7 @@
 import { Diagnostic, Uri } from 'vscode';
 import * as vscode from 'vscode';
 import { notifications } from './extension';
+import { ResponseMetrics } from './dependencyAnalysis/analysis';
 
 /**
  * Abstract class for implementing a diagnostics pipeline.
@@ -40,12 +41,13 @@ export abstract class AbstractDiagnosticsPipeline<T> {
     });
   }
 
-  reportDiagnostics() {
+  reportDiagnostics(metrics?: ResponseMetrics) {
     notifications.emit('caNotification', {
       done: true,
       uri: this.diagnosticFilePath,
       diagCount: this.diagnostics.length,
       vulnCount: this.vulnCount,
+      metrics,
     });
   }