Prepare Browser Refresh Server for sharing (#50553)

Author: tmat

Directory.Build.props

@@ -49,7 +49,8 @@
     <NetCurrent>net10.0</NetCurrent>
     <NetToolMinimum Condition="'$(DotNetBuildSourceOnly)' == 'true'">$(NetCurrent)</NetToolMinimum>
     <ToolsetTargetFramework>$(SdkTargetFramework)</ToolsetTargetFramework>
-    <VisualStudioServiceTargetFramework>net8.0</VisualStudioServiceTargetFramework>
+    <VisualStudioServiceTargetFramework>net9.0</VisualStudioServiceTargetFramework>
+    <VisualStudioTargetFramework>net472</VisualStudioTargetFramework>
 
     <!-- We used to have scenarios where the MSBuild host (VSMac) had an older .NET, but don't any more. -->
     <ResolverTargetFramework>$(SdkTargetFramework)</ResolverTargetFramework>

eng/Versions.props

@@ -82,7 +82,7 @@
     <NETStandardLibraryRefPackageVersion>2.1.0</NETStandardLibraryRefPackageVersion>
     <!-- These are minimum versions used for netfx-targeted components that run in Visual Studio because in those cases,
          Visual Studio is providing those assemblies, and we should work with whichever version it ships. -->
-    <MicrosoftBclAsyncInterfacesToolsetPackageVersion>8.0.0</MicrosoftBclAsyncInterfacesToolsetPackageVersion>
+    <MicrosoftBclAsyncInterfacesToolsetPackageVersion>9.0.0</MicrosoftBclAsyncInterfacesToolsetPackageVersion>
     <MicrosoftDeploymentDotNetReleasesToolsetPackageVersion>2.0.0-preview.1.24427.4</MicrosoftDeploymentDotNetReleasesToolsetPackageVersion>
     <MicrosoftExtensionsLoggingAbstractionsToolsetPackageVersion>9.0.0</MicrosoftExtensionsLoggingAbstractionsToolsetPackageVersion>
     <SystemBuffersToolsetPackageVersion>4.5.1</SystemBuffersToolsetPackageVersion>
@@ -91,7 +91,7 @@
     <SystemReflectionMetadataLoadContextToolsetPackageVersion>9.0.0</SystemReflectionMetadataLoadContextToolsetPackageVersion>
     <SystemReflectionMetadataToolsetPackageVersion>9.0.0</SystemReflectionMetadataToolsetPackageVersion>
     <SystemDiagnosticsDiagnosticSourceToolsetPackageVersion>9.0.0</SystemDiagnosticsDiagnosticSourceToolsetPackageVersion>
-    <SystemTextJsonToolsetPackageVersion>8.0.5</SystemTextJsonToolsetPackageVersion>
+    <SystemTextJsonToolsetPackageVersion>9.0.0</SystemTextJsonToolsetPackageVersion>
     <SystemThreadingTasksExtensionsToolsetPackageVersion>4.5.4</SystemThreadingTasksExtensionsToolsetPackageVersion>
     <SystemResourcesExtensionsToolsetPackageVersion>8.0.0</SystemResourcesExtensionsToolsetPackageVersion>
   </PropertyGroup>

sdk.slnx

@@ -318,6 +318,7 @@
     <Project Path="test/HelixTasks/HelixTasks.csproj" />
     <Project Path="test/Microsoft.AspNetCore.Watch.BrowserRefresh.Tests/Microsoft.AspNetCore.Watch.BrowserRefresh.Tests.csproj" />
     <Project Path="test/Microsoft.DotNet.Cli.Utils.Tests/Microsoft.DotNet.Cli.Utils.Tests.csproj" />
+    <Project Path="test/Microsoft.DotNet.HotReload.Client.Tests/Microsoft.DotNet.HotReload.Client.Tests.csproj" />
     <Project Path="test/Microsoft.DotNet.MSBuildSdkResolver.Tests/Microsoft.DotNet.MSBuildSdkResolver.Tests.csproj" />
     <Project Path="test/Microsoft.DotNet.PackageInstall.Tests/Microsoft.DotNet.PackageInstall.Tests.csproj" />
     <Project Path="test/Microsoft.DotNet.TemplateLocator.Tests/Microsoft.DotNet.TemplateLocator.Tests.csproj" />

src/BuiltInTools/AspireService/Models/RunSessionRequest.cs

@@ -54,10 +54,10 @@ internal class RunSessionRequest
 
     [Required]
     [JsonPropertyName("launch_configurations")]
-    public LaunchConfiguration[] LaunchConfigurations { get; set; } = Array.Empty<LaunchConfiguration>();
+    public LaunchConfiguration[] LaunchConfigurations { get; set; } = [];
 
     [JsonPropertyName("env")]
-    public EnvVar[] Environment { get; set; } = Array.Empty<EnvVar>();
+    public EnvVar[] Environment { get; set; } = [];
 
     [JsonPropertyName("args")]
     public string[]? Arguments { get; set; }
@@ -78,7 +78,7 @@ internal class RunSessionRequest
             ProjectPath = projectLaunchConfig.ProjectPath,
             Debug = string.Equals(projectLaunchConfig.LaunchMode, DebugLaunchMode, StringComparison.OrdinalIgnoreCase),
             Arguments = Arguments,
-            Environment = Environment.Select(envVar => new KeyValuePair<string, string>(envVar.Name, envVar.Value!)),
+            Environment = Environment.Select(envVar => new KeyValuePair<string, string>(envVar.Name, envVar.Value ?? "")),
             LaunchProfile = projectLaunchConfig.LaunchProfile,
             DisableLaunchProfile = projectLaunchConfig.DisableLaunchProfile
         };

src/BuiltInTools/BrowserRefresh/Microsoft.AspNetCore.Watch.BrowserRefresh.csproj

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <!--
       This assembly may be loaded .NET 6.0+ web server.
-      When updating the TFM also update minimal supported version in BrowserConnector.cs.
+      When updating the TFM also update minimal supported version in dotnet-watch.csproj and WebApplicationAppModel.cs.
     -->
     <TargetFramework>net6.0</TargetFramework>
     <StrongNameKeyId>MicrosoftAspNetCore</StrongNameKeyId>

src/BuiltInTools/HotReloadClient/DefaultHotReloadClient.cs

@@ -19,20 +19,15 @@
 
 namespace Microsoft.DotNet.HotReload
 {
-    internal sealed class DefaultHotReloadClient(ILogger logger, ILogger agentLogger, bool enableStaticAssetUpdates) : HotReloadClient(logger, agentLogger)
+    internal sealed class DefaultHotReloadClient(ILogger logger, ILogger agentLogger, string startupHookPath, bool enableStaticAssetUpdates)
+        : HotReloadClient(logger, agentLogger)
     {
+        private readonly string _namedPipeName = Guid.NewGuid().ToString("N");
+
         private Task<ImmutableArray<string>>? _capabilitiesTask;
         private NamedPipeServerStream? _pipe;
         private bool _managedCodeUpdateFailedOrCancelled;
 
-        private int _updateBatchId;
-
-        /// <summary>
-        /// Updates that were sent over to the agent while the process has been suspended.
-        /// </summary>
-        private readonly object _pendingUpdatesGate = new();
-        private Task _pendingUpdates = Task.CompletedTask;
-
         public override void Dispose()
         {
             DisposePipe();
@@ -46,17 +41,17 @@ private void DisposePipe()
         }
 
         // for testing
-        internal Task PendingUpdates
-            => _pendingUpdates;
+        internal string NamedPipeName
+            => _namedPipeName;
 
-        public override void InitiateConnection(string namedPipeName, CancellationToken cancellationToken)
+        public override void InitiateConnection(CancellationToken cancellationToken)
         {
 #if NET
             var options = PipeOptions.Asynchronous | PipeOptions.CurrentUserOnly;
 #else
             var options = PipeOptions.Asynchronous;
 #endif
-            _pipe = new NamedPipeServerStream(namedPipeName, PipeDirection.InOut, 1, PipeTransmissionMode.Byte, options);
+            _pipe = new NamedPipeServerStream(_namedPipeName, PipeDirection.InOut, 1, PipeTransmissionMode.Byte, options);
 
             // It is important to establish the connection (WaitForConnectionAsync) before we return,
             // otherwise the client wouldn't be able to connect.
@@ -67,7 +62,7 @@ async Task<ImmutableArray<string>> ConnectAsync()
             {
                 try
                 {
-                    Logger.LogDebug("Waiting for application to connect to pipe {NamedPipeName}.", namedPipeName);
+                    Logger.LogDebug("Waiting for application to connect to pipe {NamedPipeName}.", _namedPipeName);
 
                     await _pipe.WaitForConnectionAsync(cancellationToken);
 
@@ -110,6 +105,16 @@ private void RequireReadyForUpdates()
                 throw new InvalidOperationException("Pipe has been disposed.");
         }
 
+        public override void ConfigureLaunchEnvironment(IDictionary<string, string> environmentBuilder)
+        {
+            environmentBuilder[AgentEnvironmentVariables.DotNetModifiableAssemblies] = "debug";
+
+            // HotReload startup hook should be loaded before any other startup hooks:
+            environmentBuilder.InsertListItem(AgentEnvironmentVariables.DotNetStartupHooks, startupHookPath, Path.PathSeparator);
+
+            environmentBuilder[AgentEnvironmentVariables.DotNetWatchHotReloadNamedPipeName] = _namedPipeName;
+        }
+
         public override Task WaitForConnectionEstablishedAsync(CancellationToken cancellationToken)
             => GetCapabilitiesTask();
 
@@ -192,6 +197,8 @@ public async override Task<ApplyStatus> ApplyStaticAssetUpdatesAsync(ImmutableAr
                         update.IsApplicationProject),
                     ResponseLoggingLevel);
 
+                Logger.LogDebug("Sending static file update request for asset '{Url}'.", update.RelativePath);
+
                 var success = await SendAndReceiveUpdateAsync(request, isProcessSuspended, cancellationToken);
                 if (success)
                 {
@@ -206,31 +213,17 @@ public async override Task<ApplyStatus> ApplyStaticAssetUpdatesAsync(ImmutableAr
                 (appliedUpdateCount < updates.Length) ? ApplyStatus.SomeChangesApplied : ApplyStatus.AllChangesApplied;
         }
 
-        private async ValueTask<bool> SendAndReceiveUpdateAsync<TRequest>(TRequest request, bool isProcessSuspended, CancellationToken cancellationToken)
+        private ValueTask<bool> SendAndReceiveUpdateAsync<TRequest>(TRequest request, bool isProcessSuspended, CancellationToken cancellationToken)
             where TRequest : IUpdateRequest
         {
             // Should not be disposed:
             Debug.Assert(_pipe != null);
 
-            var batchId = _updateBatchId++;
-
-            if (!isProcessSuspended)
-            {
-                return await SendAndReceiveAsync(batchId, cancellationToken);
-            }
-
-            lock (_pendingUpdatesGate)
-            {
-                var previous = _pendingUpdates;
-
-                _pendingUpdates = Task.Run(async () =>
-                {
-                    await previous;
-                    await SendAndReceiveAsync(batchId, cancellationToken);
-                }, cancellationToken);
-            }
-
-            return true;
+            return SendAndReceiveUpdateAsync(
+                send: SendAndReceiveAsync,
+                isProcessSuspended,
+                suspendedResult: true,
+                cancellationToken);
 
             async ValueTask<bool> SendAndReceiveAsync(int batchId, CancellationToken cancellationToken)
             {

src/BuiltInTools/HotReloadClient/HotReloadClient.cs

@@ -24,10 +24,24 @@ internal abstract class HotReloadClient(ILogger logger, ILogger agentLogger) : I
     public readonly ILogger Logger = logger;
     public readonly ILogger AgentLogger = agentLogger;
 
+    private int _updateBatchId;
+
+    /// <summary>
+    /// Updates that were sent over to the agent while the process has been suspended.
+    /// </summary>
+    private readonly object _pendingUpdatesGate = new();
+    private Task _pendingUpdates = Task.CompletedTask;
+
+    // for testing
+    internal Task PendingUpdates
+        => _pendingUpdates;
+
+    public abstract void ConfigureLaunchEnvironment(IDictionary<string, string> environmentBuilder);
+
     /// <summary>
     /// Initiates connection with the agent in the target process.
     /// </summary>
-    public abstract void InitiateConnection(string namedPipeName, CancellationToken cancellationToken);
+    public abstract void InitiateConnection(CancellationToken cancellationToken);
 
     /// <summary>
     /// Waits until the connection with the agent is established.
@@ -84,4 +98,34 @@ public async Task<IReadOnlyList<HotReloadManagedCodeUpdate>> FilterApplicableUpd
 
         return applicableUpdates;
     }
+
+    protected async ValueTask<TResult> SendAndReceiveUpdateAsync<TResult>(
+        Func<int, CancellationToken, ValueTask<TResult>> send,
+        bool isProcessSuspended,
+        TResult suspendedResult,
+        CancellationToken cancellationToken)
+        where TResult : struct
+    {
+        var batchId = _updateBatchId++;
+
+        Task previous;
+        lock (_pendingUpdatesGate)
+        {
+            previous = _pendingUpdates;
+
+            if (isProcessSuspended)
+            {
+                _pendingUpdates = Task.Run(async () =>
+                {
+                    await previous;
+                    _ = await send(batchId, cancellationToken);
+                }, cancellationToken);
+
+                return suspendedResult;
+            }
+        }
+
+        await previous;
+        return await send(batchId, cancellationToken);
+    }
 }

src/BuiltInTools/HotReloadClient/LogEvents.cs

@@ -0,0 +1,33 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#nullable enable
+
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.DotNet.HotReload;
+
+internal readonly record struct LogEvent(EventId Id, LogLevel Level, string Message);
+
+internal static class LogEvents
+{
+    // Non-shared event ids start at 0.
+    private static int s_id = 1000;
+
+    private static LogEvent Create(LogLevel level, string message)
+        => new(new EventId(s_id++), level, message);
+
+    public static void Log(this ILogger logger, LogEvent logEvent, params object[] args)
+        => logger.Log(logEvent.Level, logEvent.Id, logEvent.Message, args);
+
+    public static readonly LogEvent UpdatesApplied = Create(LogLevel.Debug, "Updates applied: {0} out of {1}.");
+    public static readonly LogEvent Capabilities = Create(LogLevel.Debug, "Capabilities: '{1}'.");
+    public static readonly LogEvent HotReloadSucceeded = Create(LogLevel.Information, "Hot reload succeeded.");
+    public static readonly LogEvent RefreshingBrowser = Create(LogLevel.Debug, "Refreshing browser.");
+    public static readonly LogEvent ReloadingBrowser = Create(LogLevel.Debug, "Reloading browser.");
+    public static readonly LogEvent NoBrowserConnected = Create(LogLevel.Debug, "No browser is connected.");
+    public static readonly LogEvent FailedToReceiveResponseFromConnectedBrowser = Create(LogLevel.Debug, "Failed to receive response from a connected browser.");
+    public static readonly LogEvent UpdatingDiagnostics = Create(LogLevel.Debug, "Updating diagnostics.");
+    public static readonly LogEvent SendingStaticAssetUpdateRequest = Create(LogLevel.Debug, "Sending static asset update request to connected browsers: '{0}'.");
+    public static readonly LogEvent RefreshServerRunningAt = Create(LogLevel.Debug, "Refresh server running at {0}.");
+}

src/BuiltInTools/HotReloadClient/Logging/LogEvents.cs

@@ -1,9 +1,11 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.DotNet.Watch;
+namespace Microsoft.DotNet.HotReload;
 
 internal static class LoggingUtilities
 {
@@ -14,7 +16,4 @@ public static (string comonentName, string? displayName) ParseCategoryName(strin
         => categoryName.IndexOf('|') is int index && index > 0
             ? (categoryName[..index], categoryName[(index + 1)..])
             : (categoryName, null);
-
-    public static string GetPrefix(Emoji emoji)
-        => $"dotnet watch {emoji.ToDisplay()} ";
 }