Introduce ActivityLog helper service for writing to IVsActivityLog

Author: DustinCampbell

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/Logging/ActivityLog.cs

@@ -0,0 +1,83 @@
+// 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 System.Collections.Immutable;
+using System.ComponentModel.Composition;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Razor;
+using Microsoft.CodeAnalysis.Razor.Utilities;
+using Microsoft.VisualStudio.Shell;
+using Microsoft.VisualStudio.Shell.Interop;
+using Microsoft.VisualStudio.Threading;
+
+namespace Microsoft.VisualStudio.Razor.Logging;
+
+[Export(typeof(ActivityLog))]
+internal sealed class ActivityLog : IDisposable
+{
+    private enum EntryType { Error, Warning, Info }
+
+    private readonly IAsyncServiceProvider _serviceProvider;
+    private readonly JoinableTaskFactory _jtf;
+
+    private readonly CancellationTokenSource _disposeTokenSource;
+    private readonly AsyncBatchingWorkQueue<(EntryType, string)> _loggingQueue;
+    private IVsActivityLog? _vsActivityLog;
+
+    public ActivityLog(
+        [Import(typeof(SAsyncServiceProvider))] IAsyncServiceProvider serviceProvider,
+        JoinableTaskContext joinableTaskContext)
+    {
+        _serviceProvider = serviceProvider;
+        _jtf = joinableTaskContext.Factory;
+
+        _disposeTokenSource = new();
+        _loggingQueue = new AsyncBatchingWorkQueue<(EntryType, string)>(TimeSpan.Zero, ProcessBatchAsync, _disposeTokenSource.Token);
+    }
+
+    public void Dispose()
+    {
+        _disposeTokenSource.Cancel();
+        _disposeTokenSource.Dispose();
+    }
+
+    private async ValueTask ProcessBatchAsync(ImmutableArray<(EntryType, string)> items, CancellationToken token)
+    {
+        await _jtf.SwitchToMainThreadAsync(token);
+
+        _vsActivityLog ??= await _serviceProvider.GetServiceAsync<SVsActivityLog, IVsActivityLog>();
+
+        foreach (var (entryType, message) in items)
+        {
+            var vsEntryType = entryType switch
+            {
+                EntryType.Error => __ACTIVITYLOG_ENTRYTYPE.ALE_ERROR,
+                EntryType.Warning => __ACTIVITYLOG_ENTRYTYPE.ALE_WARNING,
+                EntryType.Info => __ACTIVITYLOG_ENTRYTYPE.ALE_INFORMATION,
+                _ => Assumed.Unreachable<__ACTIVITYLOG_ENTRYTYPE>()
+            };
+
+            _vsActivityLog.LogEntry(
+                (uint)vsEntryType,
+                "Razor",
+                $"Info:{Environment.NewLine}{message}");
+        }
+    }
+
+    public void LogError(string message)
+    {
+        _loggingQueue.AddWork((EntryType.Error, message));
+    }
+
+    public void LogWarning(string message)
+    {
+        _loggingQueue.AddWork((EntryType.Warning, message));
+    }
+
+    public void LogInfo(string message)
+    {
+        _loggingQueue.AddWork((EntryType.Info, message));
+    }
+}