Allow specifying emit options (#83)

Author: jjonescz

Directory.Packages.props

@@ -6,7 +6,7 @@
     <NoWarn>$(NoWarn);NU1507</NoWarn>
     <NetCoreVersion>10.0.0-preview.5.25277.114</NetCoreVersion>
     <AspNetCoreVersion>$(NetCoreVersion)</AspNetCoreVersion>
-    <RoslynVersion>5.0.0-1.25321.102</RoslynVersion>
+    <RoslynVersion>5.0.0-1.25357.1</RoslynVersion>
     <FluentUIVersion>4.12.0</FluentUIVersion>
     <NuGetVersion>6.14.0</NuGetVersion>
   </PropertyGroup>
@@ -31,7 +31,7 @@
     <PackageVersion Include="Microsoft.Extensions.Logging" Version="$(NetCoreVersion)" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components" Version="$(FluentUIVersion)" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components.Icons" Version="$(FluentUIVersion)" />
-    <PackageVersion Include="Microsoft.Net.Compilers.Razor.Toolset" Version="10.0.0-preview.25321.102" />
+    <PackageVersion Include="Microsoft.Net.Compilers.Razor.Toolset" Version="10.0.0-preview.25353.4" />
     <PackageVersion Include="Microsoft.Net.Compilers.Toolset" Version="$(RoslynVersion)" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
     <PackageVersion Include="Microsoft.NETCore.App.Ref" Version="$(NetCoreVersion)" />

src/App/Lab/InitialCode.cs

@@ -33,7 +33,7 @@ static void Main()
             [Parameter] public int Param { get; set; }
         }
 
-        """);
+        """.ReplaceLineEndings());
 
     // https://github.com/dotnet/aspnetcore/blob/036ec9ec2ffbfe927f9eb7622dfff122c634ccbb/src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/BlazorWeb-CSharp/Components/_Imports.razor
     public static readonly InitialCode RazorImports = new("_Imports.razor", """
@@ -47,7 +47,7 @@ @using static Microsoft.AspNetCore.Components.Web.RenderMode
         @using Microsoft.AspNetCore.Components.Web.Virtualization
         @using Microsoft.JSInterop
 
-        """);
+        """.ReplaceLineEndings());
 
     public static readonly InitialCode Cshtml = new("TestPage.cshtml", """
         @page
@@ -76,7 +76,7 @@ public class Customer
             }
         }
 
-        """);
+        """.ReplaceLineEndings());
 
     // IMPORTANT: Keep in sync with `Compiler.Compile`.
     public static readonly InitialCode Configuration = new("Configuration.cs", """
@@ -91,6 +91,10 @@ public class Customer
             .WithOptimizationLevel(OptimizationLevel.Debug)
         );
 
+        Config.EmitOptions(options => options
+            .WithEmitMetadataOnly(false)
+        );
+
         """);
 
     public InitialCode(string suggestedFileName, string textTemplate)

src/App/Lab/TemplateCache.cs

@@ -1,16 +1,19 @@
 using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.Emit;
 
 namespace DotNetLab;
 
 public static class Config
 {
     private static readonly List<Func<CSharpParseOptions, CSharpParseOptions>> cSharpParseOptions = new();
     private static readonly List<Func<CSharpCompilationOptions, CSharpCompilationOptions>> cSharpCompilationOptions = new();
+    private static readonly List<Func<EmitOptions, EmitOptions>> emitOptions = new();
 
     internal static void Reset()
     {
         cSharpParseOptions.Clear();
         cSharpCompilationOptions.Clear();
+        emitOptions.Clear();
     }
 
     public static void CSharpParseOptions(Func<CSharpParseOptions, CSharpParseOptions> configure)
@@ -23,10 +26,17 @@ public static void CSharpCompilationOptions(Func<CSharpCompilationOptions, CShar
         cSharpCompilationOptions.Add(configure);
     }
 
+    public static void EmitOptions(Func<EmitOptions, EmitOptions> configure)
+    {
+        emitOptions.Add(configure);
+    }
+
     internal static CSharpParseOptions ConfigureCSharpParseOptions(CSharpParseOptions options) => Configure(options, cSharpParseOptions);
 
     internal static CSharpCompilationOptions ConfigureCSharpCompilationOptions(CSharpCompilationOptions options) => Configure(options, cSharpCompilationOptions);
 
+    internal static EmitOptions ConfigureEmitOptions(EmitOptions options) => Configure(options, emitOptions);
+
     private static T Configure<T>(T options, List<Func<T, T>> configureList)
     {
         foreach (var configure in configureList)

src/Compiler/Api.cs

@@ -5,6 +5,7 @@
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.CodeAnalysis.Diagnostics;
+using Microsoft.CodeAnalysis.Emit;
 using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.Extensions.Logging;
@@ -27,6 +28,7 @@ You can try selecting different Razor toolchain in Settings / Advanced.
         global using DotNetLab;
         global using Microsoft.CodeAnalysis;
         global using Microsoft.CodeAnalysis.CSharp;
+        global using Microsoft.CodeAnalysis.Emit;
         global using System;
         """;
 
@@ -67,6 +69,7 @@ private LiveCompilationResult CompileNoCache(
 
         var parseOptions = CreateDefaultParseOptions();
         CSharpCompilationOptions? options = null;
+        EmitOptions emitOptions = EmitOptions.Default;
 
         var references = RefAssemblyMetadata.All;
         var referenceInfos = RefAssemblies.All;
@@ -106,6 +109,7 @@ private LiveCompilationResult CompileNoCache(
             }
 
             parseOptions = Config.ConfigureCSharpParseOptions(parseOptions);
+            emitOptions = Config.ConfigureEmitOptions(emitOptions);
         }
         else
         {
@@ -640,7 +644,7 @@ CSharpCompilation getExecutableCompilation()
         MemoryStream? getEmitStream(CSharpCompilation compilation, out ImmutableArray<Diagnostic> diagnostics)
         {
             var stream = new MemoryStream();
-            var emitResult = compilation.Emit(stream);
+            var emitResult = compilation.Emit(stream, options: emitOptions);
             if (!emitResult.Success)
             {
                 diagnostics = emitResult.Diagnostics;

src/Compiler/Compiler.cs

@@ -14,7 +14,7 @@ private static ImmutableArray<PortableExecutableReference> GetAll()
         foreach (var assembly in all)
         {
             builder.Add(AssemblyMetadata.CreateFromImage(assembly.Bytes)
-                .GetReference(filePath: assembly.FileName, display: assembly.Name));
+                .GetReference(filePath: assembly.FileName, display: assembly.FileName));
         }
 
         return builder.DrainToImmutable();

src/Compiler/RefAssemblyMetadata.cs

@@ -2,6 +2,7 @@
 using Microsoft.AspNetCore.Razor.Language.Intermediate;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.Emit;
 using Microsoft.CodeAnalysis.Text;
 using System.Numerics;
 using System.Reflection.Emit;
@@ -11,6 +12,13 @@ namespace DotNetLab;
 
 public static class CodeAnalysisUtil
 {
+    private static EmitOptions DefaultEmitOptions => field ??= new EmitOptions(debugInformationFormat: DebugInformationFormat.PortablePdb);
+
+    extension(EmitOptions)
+    {
+        public static EmitOptions Default => DefaultEmitOptions;
+    }
+
     public static bool TryGetHostOutputSafe(
         this GeneratorRunResult result,
         string key,

src/Compiler/Utils/Utils.cs

@@ -139,18 +139,13 @@ public NuGetDownloader(
             var stream = new MemoryStream();
             var success = await finders.SelectAsync(async (f) =>
             {
-                bool success;
-                try
-                {
-                    success = await f.Resource.CopyNupkgToStreamAsync(
-                        info.PackageId,
-                        version,
-                        stream,
-                        cacheContext,
-                        NullLogger.Instance,
-                        CancellationToken.None);
-                }
-                catch (Newtonsoft.Json.JsonReaderException) { success = false; }
+                bool success = await f.Resource.CopyNupkgToStreamAsync(
+                    info.PackageId,
+                    version,
+                    stream,
+                    cacheContext,
+                    NullLogger.Instance,
+                    CancellationToken.None);
                 return (Success: success, f.NuGetOrg);
             })
             .FirstOrNullAsync(static t => t.Success);
@@ -245,8 +240,16 @@ public CustomHttpHandlerResourceV3Provider(NuGetDownloader nuGetDownloader)
     }
 }
 
-internal sealed class CorsClientHandler(NuGetDownloader nuGetDownloader) : HttpClientHandler
+internal sealed class CorsClientHandler : HttpClientHandler
 {
+    private readonly NuGetDownloader nuGetDownloader;
+
+    public CorsClientHandler(NuGetDownloader nuGetDownloader)
+    {
+        this.nuGetDownloader = nuGetDownloader;
+        AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate;
+    }
+
     protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
     {
         if (request.RequestUri?.AbsolutePath.EndsWith(".nupkg", StringComparison.OrdinalIgnoreCase) == true)

src/Worker/Lab/NuGetDownloader.cs

@@ -7,8 +7,9 @@ namespace DotNetLab;
 public sealed class CompilerProxyTests(ITestOutputHelper output)
 {
     [Theory]
-    [InlineData("4.12.0-2.24409.2", "4.12.0-2.24409.2 (2158b591)")]
-    [InlineData("main", "-ci (<developer build>)")]
+    [InlineData("4.12.0-2.24409.2", "4.12.0-2.24409.2 (2158b591)")] // preview version is downloaded from an AzDo feed
+    [InlineData("4.14.0", "4.14.0-3.25262.10 (8edf7bcd)")] // non-preview version is downloaded from nuget.org
+    [InlineData("main", "-ci (<developer build>)")] // a branch can be downloaded
     public async Task SpecifiedNuGetRoslynVersion(string version, string expectedDiagnostic)
     {
         var services = WorkerServices.CreateTest(new MockHttpMessageHandler(output));
@@ -25,12 +26,31 @@ await services.GetRequiredService<CompilerDependencyProvider>()
         Assert.Contains(expectedDiagnostic, diagnosticsText);
 
         // Language services should also pick up the custom compiler version.
+        // There are bunch of tests that do not assert much but they verify no type load exceptions happen.
+        // Some older versions of Roslyn are not compatible though (until we actually download the corresponding older DLLs
+        // for language services as well but we might never actually want to support that).
+
         var languageServices = await compiler.GetLanguageServicesAsync();
         await languageServices.OnDidChangeWorkspaceAsync([new("Input.cs", "Input.cs") { NewContent = "#error version" }]);
 
         var markers = await languageServices.GetDiagnosticsAsync("Input.cs");
         markers.Should().Contain(m => m.Message.Contains(expectedDiagnostic));
 
+        var loadSemanticTokens = async () =>
+        {
+            var semanticTokensJson = await languageServices.ProvideSemanticTokensAsync("Input.cs", null, false, TestContext.Current.CancellationToken);
+            semanticTokensJson.Should().NotBeNull();
+        };
+
+        if (version.StartsWith("4.12."))
+        {
+            await loadSemanticTokens.Should().ThrowAsync<TypeLoadException>();
+        }
+        else
+        {
+            await loadSemanticTokens();
+        }
+
         var codeActionsJson = await languageServices.ProvideCodeActionsAsync("Input.cs", null, TestContext.Current.CancellationToken);
         codeActionsJson.Should().NotBeNull();
     }
@@ -65,7 +85,7 @@ await services.GetRequiredService<CompilerDependencyProvider>()
             // /Input.cs(1,8): error CS8304: Compiler version: '{version} ({commit})'. Language version: 10.0.
             // #error version
             Diagnostic(ErrorCode.ERR_CompilerAndLanguageVersion, "version").WithArguments("{version} ({commit})", "10.0").WithLocation(1, 8)
-            """, diagnosticsText);
+            """.ReplaceLineEndings(), diagnosticsText);
     }
 
     [Theory]
@@ -129,6 +149,10 @@ public async Task SpecifiedRazorOptions(RazorToolchain toolchain, RazorStrategy
 
         string code = """
             <div>@Param</div>
+            @if (Param == 0)
+            {
+                <TestComponent Param="1" />
+            }
 
             @code {
                 [Parameter] public int Param { get; set; } = 42;
@@ -150,6 +174,7 @@ public async Task SpecifiedRazorOptions(RazorToolchain toolchain, RazorStrategy
         var cSharpText = await compiled.GetRequiredGlobalOutput("cs").GetTextAsync(outputFactory: null);
         output.WriteLine(cSharpText);
         Assert.Contains("class TestComponent", cSharpText);
+        Assert.Contains("AddComponentParameter", cSharpText);
 
         var htmlText = await compiled.Files.Single().Value.GetRequiredOutput("html").GetTextAsync(outputFactory: null);
         output.WriteLine(htmlText);

test/UnitTests/CompilerProxyTests.cs

@@ -0,0 +1,12 @@
+{
+  "version": "1",
+  "environments": [
+    // See https://aka.ms/remotetesting for more details
+    // about how to configure remote environments.
+    {
+      "name": "WSL Ubuntu",
+      "type": "wsl",
+      "wslDistribution": "Ubuntu"
+    }
+  ]
+}