feat: add CoalesceOptions.PreventAspNetBrowserRefresh

Author: ascott18

CHANGELOG.md

@@ -1,5 +1,6 @@
 # 6.0.4
 - AuditLogging: Stored procedure cache was not being correctly persisted to avoid redundant `SELECT OBJECT_DEFINITION` queries.
+- Added `CoalesceOptions.PreventAspNetBrowserRefresh()` utility method to block unwanted `aspnetcore-browser-refresh.js` script.
 
 # 6.0.3
 - `c-select` now correctly respects the `filter` prop for enum collections.

docs/topics/startup.md

@@ -124,6 +124,20 @@ Defaults to `true`.
 
 Coalesce provides several helper extension methods to simplify common application setup tasks:
 
+<Prop def="public static void CoalesceOptions.PreventAspNetBrowserRefresh()" />
+
+Prevents ASP.NET Core from injecting the browser refresh script during development. This script, `aspnetcore-browser-refresh.js`, is redundant with Vite's HMR and attempts to refresh your whole browser whenever a C# file changes.
+
+Call this method at the very start of your `Program.cs`, before creating the `WebApplicationBuilder`:
+
+``` c#
+// Program.cs
+CoalesceOptions.PreventAspNetBrowserRefresh();
+
+var builder = WebApplication.CreateBuilder(args);
+// ... rest of your configuration
+```
+
 <Prop def="public static IApplicationBuilder UseViteStaticFiles(this IApplicationBuilder app, ViteStaticFilesOptions? options = null)" />
 
 Configures static file middleware with optimizations for Vite build output. This middleware:

src/IntelliTect.Coalesce/Application/CoalesceOptions.cs

@@ -1,13 +1,43 @@
 using IntelliTect.Coalesce.DataAnnotations;
 using IntelliTect.Coalesce.Models;
 using Microsoft.AspNetCore.Mvc.Filters;
+using Microsoft.AspNetCore.Hosting;
 using System;
 using System.ComponentModel.DataAnnotations;
 
 namespace IntelliTect.Coalesce;
 
 public class CoalesceOptions
 {
+    /// <summary>
+    /// Excludes the browser refresh hosting startup assembly from being loaded.
+    /// This prevents the undesirable "aspnetcore-browser-refresh.js" script from being injected.
+    /// Call this method at the very start of your Program.cs, before creating the WebApplicationBuilder.
+    /// <see href="https://github.com/dotnet/aspnetcore/issues/45213#issuecomment-3488619651">See here for more details.</see>
+    /// </summary>
+    public static void PreventAspNetBrowserRefresh()
+    {
+        const string key = "ASPNETCORE_" + WebHostDefaults.HostingStartupExcludeAssembliesKey;
+        const string assemblyToExclude = "Microsoft.AspNetCore.Watch.BrowserRefresh";
+
+        var existing = Environment.GetEnvironmentVariable(key);
+
+        if (string.IsNullOrWhiteSpace(existing))
+        {
+            Environment.SetEnvironmentVariable(key, assemblyToExclude);
+        }
+        else if (!existing.Contains(assemblyToExclude))
+        {
+            Environment.SetEnvironmentVariable(key, $"{existing};{assemblyToExclude}");
+        }
+
+        var hostingStartupAssemblies = Environment.GetEnvironmentVariable("ASPNETCORE_" + WebHostDefaults.HostingStartupAssembliesKey);
+        if (!string.IsNullOrWhiteSpace(hostingStartupAssemblies) && hostingStartupAssemblies.Contains(assemblyToExclude))
+        {
+            Console.WriteLine($"CoalesceOptions.DisableBrowserRefresh: {assemblyToExclude} has been suppressed.");
+        }
+    }
+
     /// <summary>
     /// Determines whether API controllers will return the <see cref="Exception.Message"/> 
     /// of unhandled exceptions or not. 

templates/Coalesce.Vue.Template/content/Coalesce.Starter.Vue.Web/Program.cs

@@ -36,6 +36,8 @@
 #endif
 #endif
 
+CoalesceOptions.PreventAspNetBrowserRefresh();
+
 var builder = WebApplication.CreateBuilder(new WebApplicationOptions
 {
     Args = args,

templates/Coalesce.Vue.Template/content/Coalesce.Starter.Vue.Web/Properties/launchSettings.json

@@ -3,10 +3,6 @@
     "Kestrel": {
       "commandName": "Project",
       "launchBrowser": true,
-      
-      // Disables injection of MSFT's undesirable JS that force-refreshes the page when C# files are changed.
-      "hotReloadEnabled": false,
-
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },