BinlogNamer

Author: RikkiGibson

SpellingExclusions.dic

@@ -3,3 +3,5 @@ awaitable
 Refactorings
 Infos
 cref
+binlog
+Namer

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/BinlogNamer.cs

@@ -0,0 +1,49 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Composition;
+using Microsoft.CodeAnalysis.Host.Mef;
+using Microsoft.CodeAnalysis.Options;
+using Microsoft.Extensions.Logging;
+using Microsoft.VisualStudio.Composition;
+
+namespace Microsoft.CodeAnalysis.LanguageServer.HostWorkspace;
+
+[Export(typeof(BinlogNamer)), Shared]
+internal sealed class BinlogNamer
+{
+    /// <summary>
+    /// The suffix to use for the binary log name; incremented each time we have a new build. Should be incremented with <see cref="Interlocked.Increment(ref int)"/>.
+    /// </summary>
+    private int _binaryLogNumericSuffix;
+
+    /// <summary>
+    /// A GUID put into all binary log file names, so that way one session doesn't accidentally overwrite the logs from a prior session.
+    /// </summary>
+    private readonly Guid _binaryLogGuidSuffix = Guid.NewGuid();
+
+    private readonly IGlobalOptionService _globalOptionService;
+    private readonly ILogger _logger;
+
+    [ImportingConstructor]
+    [Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
+    public BinlogNamer(IGlobalOptionService globalOptionService, ILoggerFactory loggerFactory)
+    {
+        _globalOptionService = globalOptionService;
+        _logger = loggerFactory.CreateLogger<BinlogNamer>();
+    }
+
+    internal string? GetMSBuildBinaryLogPath()
+    {
+        if (_globalOptionService.GetOption(LanguageServerProjectSystemOptionsStorage.BinaryLogPath) is not string binaryLogDirectory)
+            return null;
+
+        var numericSuffix = Interlocked.Increment(ref _binaryLogNumericSuffix);
+        var binaryLogPath = Path.Combine(binaryLogDirectory, $"LanguageServerDesignTimeBuild-{_binaryLogGuidSuffix}-{numericSuffix}.binlog");
+
+        _logger.LogInformation($"Logging design-time builds to {binaryLogPath}");
+
+        return binaryLogPath;
+    }
+}

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

@@ -29,16 +29,6 @@ namespace Microsoft.CodeAnalysis.LanguageServer.HostWorkspace;
 
 internal abstract class LanguageServerProjectLoader
 {
-    /// <summary>
-    /// The suffix to use for the binary log name; incremented each time we have a new build. Should be incremented with <see cref="Interlocked.Increment(ref int)"/>.
-    /// </summary>
-    private int _binaryLogNumericSuffix;
-
-    /// <summary>
-    /// A GUID put into all binary log file names, so that way one session doesn't accidentally overwrite the logs from a prior session.
-    /// </summary>
-    private readonly Guid _binaryLogGuidSuffix = Guid.NewGuid();
-
     protected readonly AsyncBatchingWorkQueue<ProjectToLoad> ProjectsToLoadAndReload;
 
     protected readonly ProjectSystemProjectFactory ProjectFactory;
@@ -49,6 +39,7 @@ internal abstract class LanguageServerProjectLoader
     protected readonly ILoggerFactory LoggerFactory;
     private readonly ILogger _logger;
     private readonly ProjectLoadTelemetryReporter _projectLoadTelemetryReporter;
+    private readonly BinlogNamer _binlogNamer;
     private readonly ProjectFileExtensionRegistry _projectFileExtensionRegistry;
     protected readonly ImmutableDictionary<string, string> AdditionalProperties;
 
@@ -69,7 +60,8 @@ protected LanguageServerProjectLoader(
         ILoggerFactory loggerFactory,
         IAsynchronousOperationListenerProvider listenerProvider,
         ProjectLoadTelemetryReporter projectLoadTelemetry,
-        ServerConfigurationFactory serverConfigurationFactory)
+        ServerConfigurationFactory serverConfigurationFactory,
+        BinlogNamer binlogNamer)
     {
         ProjectFactory = projectFactory;
         _targetFrameworkManager = targetFrameworkManager;
@@ -79,7 +71,7 @@ protected LanguageServerProjectLoader(
         LoggerFactory = loggerFactory;
         _logger = loggerFactory.CreateLogger(nameof(LanguageServerProjectLoader));
         _projectLoadTelemetryReporter = projectLoadTelemetry;
-
+        _binlogNamer = binlogNamer;
         var workspace = projectFactory.Workspace;
         _projectFileExtensionRegistry = new ProjectFileExtensionRegistry(workspace.CurrentSolution.Services, new DiagnosticReporter(workspace));
         var razorDesignTimePath = serverConfigurationFactory.ServerConfiguration?.RazorDesignTimePath;
@@ -117,7 +109,7 @@ private async ValueTask LoadOrReloadProjectsAsync(ImmutableSegmentedList<Project
 
         // TODO: support configuration switching
 
-        var binaryLogPath = GetMSBuildBinaryLogPath();
+        var binaryLogPath = _binlogNamer.GetMSBuildBinaryLogPath();
 
         await using var buildHostProcessManager = new BuildHostProcessManager(globalMSBuildProperties: AdditionalProperties, binaryLogPath: binaryLogPath, loggerFactory: LoggerFactory);
         var toastErrorReporter = new ToastErrorReporter();
@@ -154,19 +146,6 @@ private async ValueTask LoadOrReloadProjectsAsync(ImmutableSegmentedList<Project
         }
     }
 
-    private string? GetMSBuildBinaryLogPath()
-    {
-        if (_globalOptionService.GetOption(LanguageServerProjectSystemOptionsStorage.BinaryLogPath) is not string binaryLogDirectory)
-            return null;
-
-        var numericSuffix = Interlocked.Increment(ref _binaryLogNumericSuffix);
-        var binaryLogPath = Path.Combine(binaryLogDirectory, $"LanguageServerDesignTimeBuild-{_binaryLogGuidSuffix}-{numericSuffix}.binlog");
-
-        _logger.LogInformation($"Logging design-time builds to {binaryLogPath}");
-
-        return binaryLogPath;
-    }
-
     /// <returns>True if the project needs a NuGet restore, false otherwise.</returns>
     private async Task<bool> LoadOrReloadProjectAsync(ProjectToLoad projectToLoad, ToastErrorReporter toastErrorReporter, BuildHostProcessManager buildHostProcessManager, CancellationToken cancellationToken)
     {

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectSystem.cs

@@ -41,7 +41,8 @@ public LanguageServerProjectSystem(
         ILoggerFactory loggerFactory,
         IAsynchronousOperationListenerProvider listenerProvider,
         ProjectLoadTelemetryReporter projectLoadTelemetry,
-        ServerConfigurationFactory serverConfigurationFactory)
+        ServerConfigurationFactory serverConfigurationFactory,
+        BinlogNamer binlogNamer)
             : base(
                 workspaceFactory.ProjectSystemProjectFactory,
                 workspaceFactory.TargetFrameworkManager,
@@ -51,7 +52,8 @@ public LanguageServerProjectSystem(
                 loggerFactory,
                 listenerProvider,
                 projectLoadTelemetry,
-                serverConfigurationFactory)
+                serverConfigurationFactory,
+                binlogNamer)
     {
         _logger = loggerFactory.CreateLogger(nameof(LanguageServerProjectSystem));
     }