C#: Improve log messages in standalone extractor

Author: tamasvajk

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

@@ -21,17 +21,18 @@ internal class AssemblyCache
         /// <param name="progressMonitor">Callback for progress.</param>
         public AssemblyCache(IEnumerable<string> paths, IEnumerable<string> frameworkPaths, ProgressMonitor progressMonitor)
         {
+            this.progressMonitor = progressMonitor;
             foreach (var path in paths)
             {
                 if (File.Exists(path))
                 {
-                    pendingDllsToIndex.Enqueue(path);
+                    dllsToIndex.Add(path);
                     continue;
                 }
 
                 if (Directory.Exists(path))
                 {
-                    progressMonitor.FindingFiles(path);
+                    progressMonitor.LogInfo($"Finding reference DLLs in {path}...");
                     AddReferenceDirectory(path);
                 }
                 else
@@ -52,7 +53,7 @@ private void AddReferenceDirectory(string dir)
         {
             foreach (var dll in new DirectoryInfo(dir).EnumerateFiles("*.dll", SearchOption.AllDirectories))
             {
-                pendingDllsToIndex.Enqueue(dll.FullName);
+                dllsToIndex.Add(dll.FullName);
             }
         }
 
@@ -62,12 +63,16 @@ private void AddReferenceDirectory(string dir)
         /// </summary>
         private void IndexReferences(IEnumerable<string> frameworkPaths)
         {
+            progressMonitor.LogInfo($"Indexing {dllsToIndex.Count} assemblies...");
+
             // Read all of the files
-            foreach (var filename in pendingDllsToIndex)
+            foreach (var filename in dllsToIndex)
             {
                 IndexReference(filename);
             }
 
+            progressMonitor.LogInfo($"Read {assemblyInfoByFileName.Count} assembly infos");
+
             foreach (var info in assemblyInfoByFileName.Values
                 .OrderBy(info => info.Name)
                 .OrderAssemblyInfosByPreference(frameworkPaths))
@@ -83,25 +88,16 @@ private void IndexReference(string filename)
         {
             try
             {
+                progressMonitor.LogDebug($"Reading assembly info from {filename}");
                 var info = AssemblyInfo.ReadFromFile(filename);
                 assemblyInfoByFileName[filename] = info;
             }
             catch (AssemblyLoadException)
             {
-                failedAssemblyInfoFileNames.Add(filename);
+                progressMonitor.LogInfo($"Couldn't read assembly info from {filename}");
             }
         }
 
-        /// <summary>
-        /// The number of DLLs which are assemblies.
-        /// </summary>
-        public int AssemblyCount => assemblyInfoByFileName.Count;
-
-        /// <summary>
-        /// The number of DLLs which weren't assemblies. (E.g. C++).
-        /// </summary>
-        public int NonAssemblyCount => failedAssemblyInfoFileNames.Count;
-
         /// <summary>
         /// Given an assembly id, determine its full info.
         /// </summary>
@@ -113,8 +109,7 @@ public AssemblyInfo ResolveReference(string id)
             if (failedAssemblyInfoIds.Contains(id))
                 throw new AssemblyLoadException();
 
-            string assemblyName;
-            (id, assemblyName) = AssemblyInfo.ComputeSanitizedAssemblyInfo(id);
+            (id, var assemblyName) = AssemblyInfo.ComputeSanitizedAssemblyInfo(id);
 
             // Look up the id in our references map.
             if (assemblyInfoById.TryGetValue(id, out var result))
@@ -164,17 +159,15 @@ public AssemblyInfo GetAssemblyInfo(string filepath)
             throw new AssemblyLoadException();
         }
 
-        private readonly Queue<string> pendingDllsToIndex = new Queue<string>();
+        private readonly List<string> dllsToIndex = new List<string>();
 
         private readonly Dictionary<string, AssemblyInfo> assemblyInfoByFileName = new Dictionary<string, AssemblyInfo>();
 
-        // List of DLLs which are not assemblies.
-        // We probably don't need to keep this
-        private readonly List<string> failedAssemblyInfoFileNames = new List<string>();
-
         // Map from assembly id (in various formats) to the full info.
         private readonly Dictionary<string, AssemblyInfo> assemblyInfoById = new Dictionary<string, AssemblyInfo>();
 
         private readonly HashSet<string> failedAssemblyInfoIds = new HashSet<string>();
+
+        private readonly ProgressMonitor progressMonitor;
     }
 }

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

@@ -120,21 +120,6 @@ private AssemblyInfo(string filename, string name, Version version, string cultu
             NetCoreVersion = netCoreVersion;
         }
 
-        /// <summary>
-        /// Get AssemblyInfo from a loaded Assembly.
-        /// </summary>
-        /// <param name="assembly">The assembly.</param>
-        /// <returns>Info about the assembly.</returns>
-        public static AssemblyInfo MakeFromAssembly(Assembly assembly)
-        {
-            if (assembly.FullName is null)
-            {
-                throw new InvalidOperationException("Assembly with empty full name is not expected.");
-            }
-
-            return new AssemblyInfo(assembly.FullName, assembly.Location);
-        }
-
         /// <summary>
         /// Returns the id and name of the assembly that would be created from the received id.
         /// </summary>