Merge pull request #22889 from michaelnebel/csharp/moredepmanlogging

C#: Add some more logging to the Dependency Manager.

Author: michaelnebel

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

@@ -295,7 +295,7 @@ private void AddNetFrameworkDlls(ISet<AssemblyLookupLocation> dllLocations, ISet
 
             string? runtimeLocation = null;
 
-            if (fileContent.IsNewProjectStructureUsed)
+            if (fileContent.IsSdkProjectStructureUsed)
             {
                 runtimeLocation = Runtime.NetCoreRuntime;
             }

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

@@ -54,7 +54,7 @@ public bool IsAspNetCoreDetected
         {
             get
             {
-                return IsNewProjectStructureUsed && UseAspNetCoreDlls;
+                return IsSdkProjectStructureUsed && UseAspNetCoreDlls;
             }
         }
 
@@ -102,13 +102,13 @@ public bool IsLegacyProjectStructureUsed
             }
         }
 
-        private bool isNewProjectStructureUsed = false;
-        public bool IsNewProjectStructureUsed
+        private bool isSdkProjectStructureUsed = false;
+        public bool IsSdkProjectStructureUsed
         {
             get
             {
                 initialize.Run();
-                return isNewProjectStructureUsed;
+                return isSdkProjectStructureUsed;
             }
         }
 
@@ -228,7 +228,7 @@ private void DoInitialize()
 
                         // Determine project structure:
                         isLegacyProjectStructureUsed = isLegacyProjectStructureUsed || MicrosoftCSharpTargets().IsMatch(line);
-                        isNewProjectStructureUsed = isNewProjectStructureUsed
+                        isSdkProjectStructureUsed = isSdkProjectStructureUsed
                             || ProjectSdk().IsMatch(line)
                             || FrameworkReference().IsMatch(line);
                         // TODO: we could also check `<Sdk Name="Microsoft.NET.Sdk" />`
@@ -240,6 +240,14 @@ private void DoInitialize()
                     logger.LogDebug($"Failed to read file {file}, exception: {ex}");
                 }
             }
+
+            logger.LogInfo("Finished reading project files.");
+            logger.LogInfo($"Legacy project structure usage detected: {isLegacyProjectStructureUsed}");
+            logger.LogInfo($"SDK project structure usage detected: {isSdkProjectStructureUsed}");
+            logger.LogInfo($"ASP.NET usage detected: {useAspNetCoreDlls}");
+            logger.LogInfo($"Windows Forms usage detected: {useWindowsForms}");
+            logger.LogInfo($"WPF usage detected: {useWpf}");
+            logger.LogInfo($"Implicit usings enabled: {useImplicitUsings}");
         }
 
         [GeneratedRegex("(?<!<!--.*)<PackageReference.*\\sInclude=\"(.*?)\".*/?>", RegexOptions.IgnoreCase | RegexOptions.Compiled | RegexOptions.Singleline)]

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

@@ -148,10 +148,9 @@ public HashSet<AssemblyLookupLocation> Restore()
                     .Where(path => IsPathInSubfolder(path, legacyPackageDirectory.DirInfo.FullName, "tools"))
                     .ToList();
 
-                if (nugetPackageDllPaths.Count > 0)
-                {
-                    logger.LogInfo($"Restored {nugetPackageDllPaths.Count} NuGet DLLs.");
-                }
+
+                logger.LogInfo($"Restored {nugetPackageDllPaths.Count} NuGet DLLs from packages.config files using the NuGet CLI.");
+
                 if (excludedPaths.Count > 0)
                 {
                     logger.LogInfo($"Excluding {excludedPaths.Count} NuGet DLLs.");
@@ -163,6 +162,13 @@ public HashSet<AssemblyLookupLocation> Restore()
                 }
 
                 nugetPackageDllPaths.ExceptWith(excludedPaths);
+
+                logger.LogInfo($"Using {nugetPackageDllPaths.Count} DLLs as dependency candidates from NuGet packages restored via the NuGet CLI based on packages.config files.");
+                foreach (var path in nugetPackageDllPaths)
+                {
+                    logger.LogDebug($"Using NuGet DLL as dependency candidate: {path}");
+                }
+
                 assemblyLookupLocations.UnionWith(nugetPackageDllPaths.Select(p => new AssemblyLookupLocation(p)));
             }
             catch (Exception exc)

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/SourceGenerators/DotnetSourceGeneratorBase.cs

@@ -39,7 +39,7 @@ protected override IEnumerable<string> Run()
                 return [];
             }
 
-            if (!fileContent.IsNewProjectStructureUsed)
+            if (!fileContent.IsSdkProjectStructureUsed)
             {
                 logger.LogInfo($"Generating source files from {FileType} files is only supported for new (SDK-style) project files");
                 return [];

csharp/extractor/Semmle.Extraction.Tests/FileContent.cs

@@ -179,7 +179,7 @@ public void TestFileContent_LegacyProjectStructure()
 
             // Execute
             var isLegacy = fileContent.IsLegacyProjectStructureUsed;
-            var isNew = fileContent.IsNewProjectStructureUsed;
+            var isNew = fileContent.IsSdkProjectStructureUsed;
 
             // Verify
             Assert.True(isLegacy);
@@ -204,7 +204,7 @@ public void TestFileContent_NewProjectStructure()
 
             // Execute
             var isLegacy = fileContent.IsLegacyProjectStructureUsed;
-            var isNew = fileContent.IsNewProjectStructureUsed;
+            var isNew = fileContent.IsSdkProjectStructureUsed;
 
             // Verify
             Assert.True(isNew);