Unify logging on Microsoft.CodeAnalysis.Razor.Logging.ILogger (#10296)

Fixes #10294

This pull request removes Razor tooling's alternative logging systems
(`IErrorReporter` and `RazorLogger`) and unifies on
`Microsoft.CodeAnalysis.Razor.Logging.ILogger`. As part of this, I've
introduced a `RazorActivityLog` service that can be MEF imported in the
VS layer to write to the VS activity log. Also, I've add an
`ILoggerProvider` in the VS layer that automatically writes any warnings
and errors to the activity log.

Author: DustinCampbell

src/Razor/benchmarks/Microsoft.AspNetCore.Razor.Microbenchmarks/Logging/EmptyLoggingFactory.EmptyLogger.cs

@@ -0,0 +1,25 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+using System;
+using Microsoft.CodeAnalysis.Razor.Logging;
+
+namespace Microsoft.AspNetCore.Razor.Logging;
+
+internal sealed partial class EmptyLoggingFactory
+{
+    private sealed class EmptyLogger : ILogger
+    {
+        public static readonly EmptyLogger Instance = new();
+
+        private EmptyLogger()
+        {
+        }
+
+        public bool IsEnabled(LogLevel logLevel) => false;
+
+        public void Log(LogLevel logLevel, string message, Exception? exception)
+        {
+        }
+    }
+}

src/Razor/benchmarks/Microsoft.AspNetCore.Razor.Microbenchmarks/Logging/EmptyLoggingFactory.cs

@@ -0,0 +1,22 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+using System;
+using Microsoft.CodeAnalysis.Razor.Logging;
+
+namespace Microsoft.AspNetCore.Razor.Logging;
+
+internal sealed partial class EmptyLoggingFactory : ILoggerFactory
+{
+    public static readonly EmptyLoggingFactory Instance = new();
+
+    private EmptyLoggingFactory()
+    {
+    }
+
+    public void AddLoggerProvider(ILoggerProvider provider)
+        => throw new NotImplementedException();
+
+    public ILogger GetOrCreateLogger(string categoryName)
+        => EmptyLogger.Instance;
+}

src/Razor/benchmarks/Microsoft.AspNetCore.Razor.Microbenchmarks/ProjectSystem/ProjectSnapshotManagerBenchmarkBase.TestErrorReporter.cs

@@ -6,6 +6,7 @@
 using System.IO;
 using Microsoft.AspNetCore.Razor.Language;
 using Microsoft.AspNetCore.Razor.LanguageServer;
+using Microsoft.AspNetCore.Razor.Logging;
 using Microsoft.AspNetCore.Razor.PooledObjects;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Razor;
@@ -23,7 +24,6 @@ public abstract partial class ProjectSnapshotManagerBenchmarkBase
     internal ImmutableArray<TextLoader> TextLoaders { get; }
     protected string RepoRoot { get; }
     private protected ProjectSnapshotManagerDispatcher Dispatcher { get; }
-    private protected IErrorReporter ErrorReporter { get; }
 
     protected ProjectSnapshotManagerBenchmarkBase(int documentCount = 100)
     {
@@ -67,8 +67,7 @@ protected ProjectSnapshotManagerBenchmarkBase(int documentCount = 100)
             .Setup(x => x.GetOrCreateLogger(It.IsAny<string>()))
             .Returns(Mock.Of<ILogger>(MockBehavior.Strict));
 
-        ErrorReporter = new TestErrorReporter();
-        Dispatcher = new LSPProjectSnapshotManagerDispatcher(ErrorReporter);
+        Dispatcher = new LSPProjectSnapshotManagerDispatcher(EmptyLoggingFactory.Instance);
     }
 
     internal ProjectSnapshotManager CreateProjectSnapshotManager()

src/Razor/benchmarks/Microsoft.AspNetCore.Razor.Microbenchmarks/ProjectSystem/ProjectSnapshotManagerBenchmarkBase.cs

@@ -2,10 +2,11 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using Microsoft.CodeAnalysis.Razor;
+using Microsoft.CodeAnalysis.Razor.Logging;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
-internal class LSPProjectSnapshotManagerDispatcher(IErrorReporter errorReporter)
-    : ProjectSnapshotManagerDispatcher(errorReporter)
+internal class LSPProjectSnapshotManagerDispatcher(ILoggerFactory loggerFactory)
+    : ProjectSnapshotManagerDispatcher(loggerFactory)
 {
 }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/LSPProjectSnapshotManagerDispatcher.cs

@@ -108,8 +108,6 @@ protected override ILspServices ConstructLspServices()
         // Add the logger as a service in case anything in CLaSP pulls it out to do logging
         services.AddSingleton<ILspLogger>(_logger);
 
-        services.AddSingleton<IErrorReporter, LanguageServerErrorReporter>();
-
         if (_projectSnapshotManagerDispatcher is null)
         {
             services.AddSingleton<ProjectSnapshotManagerDispatcher, LSPProjectSnapshotManagerDispatcher>();

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/LanguageServerErrorReporter.cs

@@ -0,0 +1,17 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+namespace Microsoft.CodeAnalysis.Razor.Logging;
+
+internal static class LogLevelExtensions
+{
+    public static bool IsAtLeast(this LogLevel target, LogLevel logLevel)
+    {
+        return target >= logLevel && target != LogLevel.None;
+    }
+
+    public static bool IsAtMost(this LogLevel target, LogLevel logLevel)
+    {
+        return target <= logLevel || target == LogLevel.None;
+    }
+}

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RazorLanguageServer.cs

@@ -7,13 +7,21 @@
 using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.Razor.Logging;
 using Microsoft.VisualStudio.Threading;
 
 namespace Microsoft.CodeAnalysis.Razor;
 
-internal abstract class ProjectSnapshotManagerDispatcher(IErrorReporter errorReporter) : IDisposable
+internal abstract class ProjectSnapshotManagerDispatcher : IDisposable
 {
-    private readonly CustomScheduler _scheduler = new(errorReporter);
+    private readonly CustomScheduler _scheduler;
+    private readonly ILogger _logger;
+
+    public ProjectSnapshotManagerDispatcher(ILoggerFactory loggerFactory)
+    {
+        _logger = loggerFactory.GetOrCreateLogger<ProjectSnapshotManagerDispatcher>();
+        _scheduler = new(_logger);
+    }
 
     public TaskScheduler Scheduler => _scheduler;
     public bool IsRunningOnDispatcher => TaskScheduler.Current == _scheduler;
@@ -79,15 +87,15 @@ public void AssertRunningOnDispatcher([CallerMemberName] string? caller = null)
     private class CustomScheduler : TaskScheduler, IDisposable
     {
         private readonly AsyncQueue<Task> _taskQueue = new();
-        private readonly IErrorReporter _errorReporter;
+        private readonly ILogger _logger;
         private readonly CancellationTokenSource _disposeTokenSource;
 
         public override int MaximumConcurrencyLevel => 1;
 
-        public CustomScheduler(IErrorReporter errorReporter)
+        public CustomScheduler(ILogger logger)
         {
             _taskQueue = new();
-            _errorReporter = errorReporter;
+            _logger = logger;
             _disposeTokenSource = new();
 
             _ = Task.Run(ProcessQueueAsync);
@@ -115,7 +123,7 @@ private async Task ProcessQueueAsync()
                     catch (Exception ex)
                     {
                         // We don't want to crash our loop, so we report the exception and continue.
-                        _errorReporter.ReportError(ex);
+                        _logger.LogError(ex);
                     }
                 }
             }