Merge pull request #170 from leancodepl/extra-logs

Add some extra logging and cleanup MSBuild integration

Author: Saancreed

.vscode/launch.json

@@ -9,7 +9,7 @@
             "type": "coreclr",
             "request": "launch",
             "preLaunchTask": "build",
-            "program": "${workspaceFolder}/src/LeanCode.ContractsGenerator/bin/Debug/net8.0/LeanCode.ContractsGenerator.dll",
+            "program": "${workspaceFolder}/src/LeanCode.ContractsGenerator/bin/Debug/net9.0/LeanCode.ContractsGenerator.dll",
             "args": [],
             "cwd": "${workspaceFolder}",
             "console": "internalConsole",

Directory.Build.targets

@@ -19,6 +19,8 @@
     <PackageReference Update="Microsoft.Build.Locator" Version="1.9.1" />
     <PackageReference Update="Microsoft.Build" Version="$(MsbVer)" />
     <PackageReference Update="Microsoft.Build.Framework" Version="$(MsbVer)" />
+    <PackageReference Update="Microsoft.Build.Tasks.Core" Version="$(MsbVer)" />
+    <PackageReference Update="Microsoft.Build.Utilities.Core" Version="$(MsbVer)" />
     <PackageReference Update="Microsoft.CodeAnalysis.CSharp" Version="$(CscVer)" />
     <PackageReference Update="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="$(CscVer)" />
     <PackageReference Update="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="$(CscVer)" />

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "8.0.100",
+    "version": "9.0.100",
     "allowPrerelease": true,
     "rollForward": "latestMajor"
   }

src/LeanCode.ContractsGenerator/Compilation/MSBuild/LooseAssemblyVersionLoader.cs

@@ -4,9 +4,12 @@
 #nullable disable
 
 using System.Collections.Immutable;
+using System.Runtime.InteropServices;
 using Microsoft.Build.Evaluation;
 using Microsoft.Build.Execution;
+using Microsoft.Build.Framework;
 using Microsoft.Build.Locator;
+using Microsoft.Build.Logging;
 using Microsoft.CodeAnalysis.MSBuild;
 using static Microsoft.Build.Execution.BuildRequestDataFlags;
 
@@ -15,6 +18,8 @@ namespace LeanCode.ContractsGenerator.Compilation.MSBuild;
 public static class MSBuildHelper
 {
     private static readonly string[] RestoreTarget = ["Restore"];
+    private static readonly string LoggerVerbosity = Environment.GetEnvironmentVariable("LNCD_CG_MSB_LOG");
+    private static readonly bool LogEnabled = LoggerVerbosity is { Length: > 0 };
 
     private static readonly ImmutableDictionary<string, string> GlobalProperties = ImmutableDictionary.CreateRange(
         new Dictionary<string, string>
@@ -30,19 +35,57 @@ public static class MSBuildHelper
 
     static MSBuildHelper()
     {
-        // QueryVisualStudioInstances returns Visual Studio installations on .NET Framework, and .NET Core SDK
-        // installations on .NET Core. We use the one with the most recent version.
-        var msBuildInstance = MSBuildLocator.QueryVisualStudioInstances().OrderByDescending(x => x.Version).First();
+        try
+        {
+            // QueryVisualStudioInstances returns Visual Studio installations on .NET Framework,
+            // and .NET Core SDK installations on .NET Core. We use the one with the most recent version.
+            var msBuildInstances = MSBuildLocator
+                .QueryVisualStudioInstances()
+                .OrderByDescending(x => x.Version)
+                .ToList();
+
+            if (LogEnabled)
+            {
+                Console.Error.WriteLine($"Running on {RuntimeInformation.FrameworkDescription}");
+                Console.Error.WriteLine("MSBuild instances:");
+
+                if (msBuildInstances.Count > 0)
+                {
+                    foreach (var instance in msBuildInstances)
+                    {
+                        Console.Error.WriteLine($"  {instance.Version} @ {instance.MSBuildPath}");
+                    }
+                }
+                else
+                {
+                    Console.Error.WriteLine($"  none found");
+                }
+            }
 
-        // Since we do not inherit msbuild.deps.json when referencing the SDK copy
-        // of MSBuild and because the SDK no longer ships with version matched assemblies, we
-        // register an assembly loader that will load assemblies from the msbuild path with
-        // equal or higher version numbers than requested.
-        LooseVersionAssemblyLoader.Register(msBuildInstance.MSBuildPath);
+            var msBuildInstance = msBuildInstances[0];
 
-        if (MSBuildLocator.CanRegister)
+            if (MSBuildLocator.CanRegister)
+            {
+                MSBuildLocator.RegisterInstance(msBuildInstance);
+
+                if (LogEnabled)
+                {
+                    Console.Error.WriteLine(
+                        $"MSBuild instance {msBuildInstance.Version} @ {msBuildInstance.MSBuildPath} registered."
+                    );
+                }
+            }
+            else if (LogEnabled)
+            {
+                Console.Error.WriteLine(
+                    $"Could not register found MSBuild instance {msBuildInstance.Version} @ {msBuildInstance.MSBuildPath}."
+                );
+            }
+        }
+        catch (Exception e)
         {
-            MSBuildLocator.RegisterInstance(msBuildInstance);
+            Console.Error.WriteLine(e);
+            throw;
         }
     }
 
@@ -78,6 +121,9 @@ public static int RestoreProjects(IReadOnlyCollection<string> projectPaths)
                 DisableInProcNode = true,
                 // don't ask the user for anything
                 Interactive = false,
+                Loggers = Enum.TryParse<LoggerVerbosity>(LoggerVerbosity, true, out var verbosity)
+                    ? [new ConsoleLogger(verbosity)]
+                    : [],
             }
         );
 

src/LeanCode.ContractsGenerator/Compilation/MSBuild/MSBuildHelper.cs

@@ -10,6 +10,10 @@
     <PackAsTool>true</PackAsTool>
     <ToolCommandName>dotnet-contracts-generate</ToolCommandName>
   </PropertyGroup>
+  <ItemGroup>
+    <!-- We don't actually ship affected versions, instead the versions from .NET SDK are used. -->
+    <NuGetAuditSuppress Include="https://github.com/advisories/GHSA-h4j7-5rxr-p4wc" />
+  </ItemGroup>
   <ItemGroup>
     <Protobuf Include="../../contracts.proto" GrpcServices="None" />
   </ItemGroup>
@@ -25,6 +29,8 @@
     </PackageReference>
     <PackageReference Include="Microsoft.Build" ExcludeAssets="runtime" PrivateAssets="all" />
     <PackageReference Include="Microsoft.Build.Framework" ExcludeAssets="runtime" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.Build.Tasks.Core" ExcludeAssets="runtime" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" ExcludeAssets="runtime" PrivateAssets="all" />
     <PackageReference Include="Microsoft.Build.Locator" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" />

src/LeanCode.ContractsGenerator/LeanCode.ContractsGenerator.csproj

@@ -1,3 +1,4 @@
+using System.Runtime.InteropServices;
 using CommandLine;
 using Google.Protobuf;
 using LeanCode.ContractsGenerator.Compilation;
@@ -98,6 +99,10 @@ private static async Task<int> Main(string[] args)
         {
             return await Parser
                 .Default.ParseArguments<ProjectOptions, FileOptions, PathOptions>(args)
+                .WithNotParsed(errs =>
+                {
+                    Console.Error.WriteLine($"Running on {RuntimeInformation.FrameworkDescription}");
+                })
                 .MapResult(
                     (ProjectOptions p) => HandleProjectAsync(p),
                     (FileOptions f) => HandleFileAsync(f),