C#: Remove progress monitor from dependency fetcher, use logger directly

Author: tamasvajk

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/AssemblyCache.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using Semmle.Util.Logging;
 
 namespace Semmle.Extraction.CSharp.DependencyFetching
 {
@@ -18,10 +19,10 @@ internal class AssemblyCache
         /// Paths to search. Directories are searched recursively. Files are added directly to the
         /// assembly cache.
         /// </param>
-        /// <param name="progressMonitor">Callback for progress.</param>
-        public AssemblyCache(IEnumerable<string> paths, IEnumerable<string> frameworkPaths, ProgressMonitor progressMonitor)
+        /// <param name="logger">Callback for progress.</param>
+        public AssemblyCache(IEnumerable<string> paths, IEnumerable<string> frameworkPaths, ILogger logger)
         {
-            this.progressMonitor = progressMonitor;
+            this.logger = logger;
             foreach (var path in paths)
             {
                 if (File.Exists(path))
@@ -32,12 +33,12 @@ public AssemblyCache(IEnumerable<string> paths, IEnumerable<string> frameworkPat
 
                 if (Directory.Exists(path))
                 {
-                    progressMonitor.LogInfo($"Finding reference DLLs in {path}...");
+                    logger.LogInfo($"Finding reference DLLs in {path}...");
                     AddReferenceDirectory(path);
                 }
                 else
                 {
-                    progressMonitor.LogInfo("AssemblyCache: Path not found: " + path);
+                    logger.LogInfo("AssemblyCache: Path not found: " + path);
                 }
             }
             IndexReferences(frameworkPaths);
@@ -63,15 +64,15 @@ private void AddReferenceDirectory(string dir)
         /// </summary>
         private void IndexReferences(IEnumerable<string> frameworkPaths)
         {
-            progressMonitor.LogInfo($"Indexing {dllsToIndex.Count} assemblies...");
+            logger.LogInfo($"Indexing {dllsToIndex.Count} assemblies...");
 
             // Read all of the files
             foreach (var filename in dllsToIndex)
             {
                 IndexReference(filename);
             }
 
-            progressMonitor.LogInfo($"Read {assemblyInfoByFileName.Count} assembly infos");
+            logger.LogInfo($"Read {assemblyInfoByFileName.Count} assembly infos");
 
             foreach (var info in assemblyInfoByFileName.Values
                 .OrderBy(info => info.Name)
@@ -88,13 +89,13 @@ private void IndexReference(string filename)
         {
             try
             {
-                progressMonitor.LogDebug($"Reading assembly info from {filename}");
+                logger.LogDebug($"Reading assembly info from {filename}");
                 var info = AssemblyInfo.ReadFromFile(filename);
                 assemblyInfoByFileName[filename] = info;
             }
             catch (AssemblyLoadException)
             {
-                progressMonitor.LogInfo($"Couldn't read assembly info from {filename}");
+                logger.LogInfo($"Couldn't read assembly info from {filename}");
             }
         }
 
@@ -168,6 +169,6 @@ public AssemblyInfo GetAssemblyInfo(string filepath)
 
         private readonly HashSet<string> failedAssemblyInfoIds = new HashSet<string>();
 
-        private readonly ProgressMonitor progressMonitor;
+        private readonly ILogger logger;
     }
 }

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/Assets.cs

@@ -5,6 +5,7 @@
 using System.Linq;
 using Newtonsoft.Json.Linq;
 using Semmle.Util;
+using Semmle.Util.Logging;
 
 namespace Semmle.Extraction.CSharp.DependencyFetching
 {
@@ -13,11 +14,11 @@ namespace Semmle.Extraction.CSharp.DependencyFetching
     /// </summary>
     internal class Assets
     {
-        private readonly ProgressMonitor progressMonitor;
+        private readonly ILogger logger;
 
-        internal Assets(ProgressMonitor progressMonitor)
+        internal Assets(ILogger logger)
         {
-            this.progressMonitor = progressMonitor;
+            this.logger = logger;
         }
 
         /// <summary>
@@ -35,7 +36,7 @@ private record class ReferenceInfo(string? Type, Dictionary<string, object>? Com
 
         /// <summary>
         /// Add the package dependencies from the assets file to dependencies.
-        /// 
+        ///
         /// Parse a part of the JSon assets file and add the paths
         /// to the dependencies required for compilation (and collect
         /// information about used packages).
@@ -60,7 +61,7 @@ private record class ReferenceInfo(string? Type, Dictionary<string, object>? Com
         ///     }
         ///   }
         /// }
-        /// 
+        ///
         /// Adds the following dependencies
         ///   Paths: {
         ///     "castle.core/4.4.1/lib/netstandard1.5/Castle.Core.dll",
@@ -85,7 +86,7 @@ private void AddPackageDependencies(JObject json, DependencyContainer dependenci
 
             if (references is null)
             {
-                progressMonitor.LogDebug("No references found in the targets section in the assets file.");
+                logger.LogDebug("No references found in the targets section in the assets file.");
                 return;
             }
 
@@ -157,7 +158,7 @@ private void AddFrameworkDependencies(JObject json, DependencyContainer dependen
 
             if (frameworks is null)
             {
-                progressMonitor.LogDebug("No framework section in assets.json.");
+                logger.LogDebug("No framework section in assets.json.");
                 return;
             }
 
@@ -171,7 +172,7 @@ private void AddFrameworkDependencies(JObject json, DependencyContainer dependen
 
             if (references is null)
             {
-                progressMonitor.LogDebug("No framework references in assets.json.");
+                logger.LogDebug("No framework references in assets.json.");
                 return;
             }
 
@@ -196,12 +197,12 @@ public bool TryParse(string json, DependencyContainer dependencies)
             }
             catch (Exception e)
             {
-                progressMonitor.LogDebug($"Failed to parse assets file (unexpected error): {e.Message}");
+                logger.LogDebug($"Failed to parse assets file (unexpected error): {e.Message}");
                 return false;
             }
         }
 
-        private static bool TryReadAllText(string path, ProgressMonitor progressMonitor, [NotNullWhen(returnValue: true)] out string? content)
+        private static bool TryReadAllText(string path, ILogger logger, [NotNullWhen(returnValue: true)] out string? content)
         {
             try
             {
@@ -210,19 +211,19 @@ private static bool TryReadAllText(string path, ProgressMonitor progressMonitor,
             }
             catch (Exception e)
             {
-                progressMonitor.LogInfo($"Failed to read assets file '{path}': {e.Message}");
+                logger.LogInfo($"Failed to read assets file '{path}': {e.Message}");
                 content = null;
                 return false;
             }
         }
 
-        public static DependencyContainer GetCompilationDependencies(ProgressMonitor progressMonitor, IEnumerable<string> assets)
+        public static DependencyContainer GetCompilationDependencies(ILogger logger, IEnumerable<string> assets)
         {
-            var parser = new Assets(progressMonitor);
+            var parser = new Assets(logger);
             var dependencies = new DependencyContainer();
             assets.ForEach(asset =>
             {
-                if (TryReadAllText(asset, progressMonitor, out var json))
+                if (TryReadAllText(asset, logger, out var json))
                 {
                     parser.TryParse(json, dependencies);
                 }