Use MetadataUpdater.IsSupported to determine if application supports hot reload

pranavkm · pranavkm · commit 0ca7a9a3b937 · 2021-07-01T17:32:26.000-07:00
Fixes #33477
diff --git a/src/Components/Components/src/ComponentBase.cs b/src/Components/Components/src/ComponentBase.cs
@@ -102,7 +102,7 @@ protected void StateHasChanged()
                 return;
             }
 
-            if (_hasNeverRendered || ShouldRender() || _renderHandle.IsHotReloading)
+            if (_hasNeverRendered || ShouldRender() || _renderHandle.IsMetadataUpdating)
             {
                 _hasPendingQueuedRender = true;
 
diff --git a/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj b/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj
@@ -12,7 +12,6 @@
   <ItemGroup>
     <Compile Include="$(ComponentsSharedSourceRoot)src\ArrayBuilder.cs" LinkBase="RenderTree" />
     <Compile Include="$(ComponentsSharedSourceRoot)src\JsonSerializerOptionsProvider.cs" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\HotReloadFeature.cs" LinkBase="HotReload" />
     <Compile Include="$(SharedSourceRoot)LinkerFlags.cs" LinkBase="Shared" />
   </ItemGroup>
 
diff --git a/src/Components/Components/src/PublicAPI.Unshipped.txt b/src/Components/Components/src/PublicAPI.Unshipped.txt
@@ -40,7 +40,7 @@ Microsoft.AspNetCore.Components.NavigationOptions.ForceLoad.init -> void
 Microsoft.AspNetCore.Components.NavigationOptions.NavigationOptions() -> void
 Microsoft.AspNetCore.Components.NavigationOptions.ReplaceHistoryEntry.get -> bool
 Microsoft.AspNetCore.Components.NavigationOptions.ReplaceHistoryEntry.init -> void
-Microsoft.AspNetCore.Components.RenderHandle.IsHotReloading.get -> bool
+Microsoft.AspNetCore.Components.RenderHandle.IsMetadataUpdating.get -> bool
 Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.Dispose() -> void
 Microsoft.AspNetCore.Components.Routing.Router.PreferExactMatches.get -> bool
 Microsoft.AspNetCore.Components.Routing.Router.PreferExactMatches.set -> void
diff --git a/src/Components/Components/src/RenderHandle.cs b/src/Components/Components/src/RenderHandle.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Diagnostics.CodeAnalysis;
+using System.Reflection.Metadata;
 using Microsoft.AspNetCore.Components.HotReload;
 using Microsoft.AspNetCore.Components.RenderTree;
 
@@ -45,9 +46,9 @@ public Dispatcher Dispatcher
         public bool IsInitialized => _renderer is not null;
 
         /// <summary>
-        /// Gets a value that determines if the <see cref="Renderer"/> is triggering a render in response to a hot-reload change.
+        /// Gets a value that determines if the <see cref="Renderer"/> is triggering a render in response to a metadata update (hot-reload) change.
         /// </summary>
-        public bool IsHotReloading => HotReloadFeature.IsSupported && (_renderer?.IsHotReloading ?? false);
+        public bool IsMetadataUpdating => MetadataUpdater.IsSupported && (_renderer?.IsMetadataUpdating ?? false);
 
         /// <summary>
         /// Notifies the renderer that the component should be rendered.
diff --git a/src/Components/Components/src/RenderTree/RenderTreeDiffBuilder.cs b/src/Components/Components/src/RenderTree/RenderTreeDiffBuilder.cs
@@ -5,7 +5,7 @@
 
 using System;
 using System.Collections.Generic;
-using Microsoft.AspNetCore.Components.HotReload;
+using System.Reflection.Metadata;
 using Microsoft.AspNetCore.Components.Rendering;
 
 namespace Microsoft.AspNetCore.Components.RenderTree
@@ -542,7 +542,7 @@ private static void UpdateRetainedChildComponent(
             var oldParameters = new ParameterView(ParameterViewLifetime.Unbound, oldTree, oldComponentIndex);
             var newParametersLifetime = new ParameterViewLifetime(diffContext.BatchBuilder);
             var newParameters = new ParameterView(newParametersLifetime, newTree, newComponentIndex);
-            if (!newParameters.DefinitelyEquals(oldParameters) || (HotReloadFeature.IsSupported && diffContext.Renderer.IsHotReloading))
+            if (!newParameters.DefinitelyEquals(oldParameters) || (MetadataUpdater.IsSupported && diffContext.Renderer.IsMetadataUpdating))
             {
                 componentState.SetDirectParameters(newParameters);
             }
diff --git a/src/Components/Components/src/RenderTree/Renderer.cs b/src/Components/Components/src/RenderTree/Renderer.cs
@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using System.Reflection.Metadata;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Components.HotReload;
@@ -97,7 +98,7 @@ public Renderer(IServiceProvider serviceProvider, ILoggerFactory loggerFactory,
             _logger = loggerFactory.CreateLogger<Renderer>();
             _componentFactory = new ComponentFactory(componentActivator);
 
-            if (HotReloadFeature.IsSupported)
+            if (MetadataUpdater.IsSupported)
             {
                 HotReloadManager.OnDeltaApplied += RenderRootComponentsOnHotReload;
             }
@@ -121,9 +122,9 @@ private static IComponentActivator GetComponentActivatorOrDefault(IServiceProvid
         protected internal ElementReferenceContext? ElementReferenceContext { get; protected set; }
 
         /// <summary>
-        /// Gets a value that determines if the <see cref="Renderer"/> is triggering a render in response to a hot-reload change.
+        /// Gets a value that determines if the <see cref="Renderer"/> is triggering a render in response to a (metadata update) hot-reload change.
         /// </summary>
-        internal bool IsHotReloading { get; private set; }
+        internal bool IsMetadataUpdating { get; private set; }
 
         private async void RenderRootComponentsOnHotReload()
         {
@@ -138,7 +139,7 @@ await Dispatcher.InvokeAsync(() =>
                     return;
                 }
 
-                IsHotReloading = true;
+                IsMetadataUpdating = true;
                 try
                 {
                     foreach (var (componentState, initialParameters) in _rootComponents)
@@ -148,7 +149,7 @@ await Dispatcher.InvokeAsync(() =>
                 }
                 finally
                 {
-                    IsHotReloading = false;
+                    IsMetadataUpdating = false;
                 }
             });
         }
@@ -226,7 +227,7 @@ protected async Task RenderRootComponentAsync(int componentId, ParameterView ini
             // During the asynchronous rendering process we want to wait up until all components have
             // finished rendering so that we can produce the complete output.
             var componentState = GetRequiredComponentState(componentId);
-            if (HotReloadFeature.IsSupported)
+            if (MetadataUpdater.IsSupported)
             {
                 // when we're doing hot-reload, stash away the parameters used while rendering root components.
                 // We'll use this to trigger re-renders on hot reload updates.
@@ -997,7 +998,7 @@ public void Dispose()
         /// <inheritdoc />
         public async ValueTask DisposeAsync()
         {
-            if (HotReloadFeature.IsSupported)
+            if (MetadataUpdater.IsSupported)
             {
                 HotReloadManager.OnDeltaApplied -= RenderRootComponentsOnHotReload;
             }
diff --git a/src/Components/Components/src/Routing/Router.cs b/src/Components/Components/src/Routing/Router.cs
@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using System.Reflection.Metadata;
 using System.Runtime.ExceptionServices;
 using System.Threading;
 using System.Threading.Tasks;
@@ -99,7 +100,7 @@ public void Attach(RenderHandle renderHandle)
             _locationAbsolute = NavigationManager.Uri;
             NavigationManager.LocationChanged += OnLocationChanged;
 
-            if  (HotReloadFeature.IsSupported)
+            if (MetadataUpdater.IsSupported)
             {
                 HotReloadManager.OnDeltaApplied += ClearRouteCaches;
             }
@@ -143,7 +144,7 @@ public async Task SetParametersAsync(ParameterView parameters)
         public void Dispose()
         {
             NavigationManager.LocationChanged -= OnLocationChanged;
-            if (HotReloadFeature.IsSupported)
+            if (MetadataUpdater.IsSupported)
             {
                 HotReloadManager.OnDeltaApplied -= ClearRouteCaches;
             }
diff --git a/src/Components/Forms/src/EditContextDataAnnotationsExtensions.cs b/src/Components/Forms/src/EditContextDataAnnotationsExtensions.cs
@@ -63,7 +63,7 @@ public DataAnnotationsEventSubscriptions(EditContext editContext)
                 _editContext.OnFieldChanged += OnFieldChanged;
                 _editContext.OnValidationRequested += OnValidationRequested;
 
-                if (HotReloadFeature.IsSupported)
+                if (MetadataUpdater.IsSupported)
                 {
                     OnClearCache += ClearCache;
                 }
@@ -132,7 +132,7 @@ public void Dispose()
                 _editContext.OnValidationRequested -= OnValidationRequested;
                 _editContext.NotifyValidationStateChanged();
 
-                if (HotReloadFeature.IsSupported)
+                if (MetadataUpdater.IsSupported)
                 {
                     OnClearCache -= ClearCache;
                 }
diff --git a/src/Components/Forms/src/Microsoft.AspNetCore.Components.Forms.csproj b/src/Components/Forms/src/Microsoft.AspNetCore.Components.Forms.csproj
@@ -15,7 +15,6 @@
 
   <ItemGroup>
     <Reference Include="Microsoft.AspNetCore.Components" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\HotReloadFeature.cs" LinkBase="HotReload" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/Components/Shared/src/HotReloadFeature.cs b/src/Components/Shared/src/HotReloadFeature.cs
diff --git a/src/Components/Web.JS/dist/Release/blazor.server.js b/src/Components/Web.JS/dist/Release/blazor.server.js
diff --git a/src/Components/WebAssembly/WebAssembly/src/Hosting/WebAssemblyHost.cs b/src/Components/WebAssembly/WebAssembly/src/Hosting/WebAssemblyHost.cs
@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
+using System.Reflection.Metadata;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Components.HotReload;
@@ -138,7 +139,7 @@ internal async Task RunAsyncCore(CancellationToken cancellationToken, WebAssembl
 
             await manager.RestoreStateAsync(store);
 
-            if (HotReloadFeature.IsSupported)
+            if (MetadataUpdater.IsSupported)
             {
                 await WebAssemblyHotReload.InitializeAsync();
             }
diff --git a/src/Components/WebAssembly/WebAssembly/src/HotReload/HotReloadAgent.cs b/src/Components/WebAssembly/WebAssembly/src/HotReload/HotReloadAgent.cs
@@ -8,6 +8,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Reflection.Metadata;
 
 namespace Microsoft.Extensions.HotReload
 {
@@ -196,7 +197,7 @@ public void ApplyDeltas(IReadOnlyList<UpdateDelta> deltas)
                     {
                         if (TryGetModuleId(assembly) is Guid moduleId && moduleId == item.ModuleId)
                         {
-                            System.Reflection.Metadata.AssemblyExtensions.ApplyUpdate(assembly, item.MetadataDelta, item.ILDelta, ReadOnlySpan<byte>.Empty);
+                            MetadataUpdater.ApplyUpdate(assembly, item.MetadataDelta, item.ILDelta, ReadOnlySpan<byte>.Empty);
                         }
                     }
 
@@ -227,7 +228,7 @@ public void ApplyDeltas(Assembly assembly, IReadOnlyList<UpdateDelta> deltas)
 
                 foreach (var item in deltas)
                 {
-                    System.Reflection.Metadata.AssemblyExtensions.ApplyUpdate(assembly, item.MetadataDelta, item.ILDelta, ReadOnlySpan<byte>.Empty);
+                    MetadataUpdater.ApplyUpdate(assembly, item.MetadataDelta, item.ILDelta, ReadOnlySpan<byte>.Empty);
                 }
 
                 _log("Deltas applied.");
diff --git a/src/Components/WebAssembly/WebAssembly/src/HotReload/WebAssemblyHotReload.cs b/src/Components/WebAssembly/WebAssembly/src/HotReload/WebAssemblyHotReload.cs
@@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.HotReload
     public static class WebAssemblyHotReload
     {
         private static HotReloadAgent? _hotReloadAgent;
-        private static UpdateDelta[] _updateDeltas = new[]
+        private static readonly UpdateDelta[] _updateDeltas = new[]
         {
             new UpdateDelta(),
         };
diff --git a/src/Components/WebAssembly/WebAssembly/src/Microsoft.AspNetCore.Components.WebAssembly.csproj b/src/Components/WebAssembly/WebAssembly/src/Microsoft.AspNetCore.Components.WebAssembly.csproj
@@ -33,7 +33,6 @@
     <Compile Include="$(SharedSourceRoot)Components\ComponentParameter.cs" Link="Prerendering/ComponentParameter.cs" />
     <Compile Include="$(SharedSourceRoot)Components\PrerenderComponentApplicationStore.cs" />
     <Compile Include="$(SharedSourceRoot)LinkerFlags.cs" LinkBase="Shared" />
-    <Compile Include="$(ComponentsSharedSourceRoot)src\HotReloadFeature.cs" LinkBase="HotReload" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/Mvc/Mvc.Core/src/DependencyInjection/MvcCoreServiceCollectionExtensions.cs b/src/Mvc/Mvc.Core/src/DependencyInjection/MvcCoreServiceCollectionExtensions.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Buffers;
 using System.Linq;
+using System.Reflection.Metadata;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Abstractions;
@@ -61,7 +62,7 @@ public static IMvcCoreBuilder AddMvcCore(this IServiceCollection services)
             ConfigureDefaultServices(services);
             AddMvcCoreServices(services);
 
-            if (environment?.IsDevelopment() ?? false)
+            if (MetadataUpdater.IsSupported)
             {
                 services.TryAddEnumerable(
                     ServiceDescriptor.Singleton<IActionDescriptorChangeProvider, HotReloadService>());

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ protected void StateHasChanged()`
`102`	`102`	`return;`
`103`	`103`	`}`
`104`	`104`
`105`		`- if (_hasNeverRendered \|\| ShouldRender() \|\| _renderHandle.IsHotReloading)`
	`105`	`+ if (_hasNeverRendered \|\| ShouldRender() \|\| _renderHandle.IsMetadataUpdating)`
`106`	`106`	`{`
`107`	`107`	`_hasPendingQueuedRender = true;`
`108`	`108`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`using System.Collections.Generic;`
`8`	`8`	`using System.Diagnostics;`
`9`	`9`	`using System.Diagnostics.CodeAnalysis;`
	`10`	`+using System.Reflection.Metadata;`
`10`	`11`	`using System.Threading;`
`11`	`12`	`using System.Threading.Tasks;`
`12`	`13`	`using Microsoft.AspNetCore.Components.HotReload;`
`@@ -97,7 +98,7 @@ public Renderer(IServiceProvider serviceProvider, ILoggerFactory loggerFactory,`
`97`	`98`	`_logger = loggerFactory.CreateLogger<Renderer>();`
`98`	`99`	`_componentFactory = new ComponentFactory(componentActivator);`
`99`	`100`
`100`		`- if (HotReloadFeature.IsSupported)`
	`101`	`+ if (MetadataUpdater.IsSupported)`
`101`	`102`	`{`
`102`	`103`	`HotReloadManager.OnDeltaApplied += RenderRootComponentsOnHotReload;`
`103`	`104`	`}`
`@@ -121,9 +122,9 @@ private static IComponentActivator GetComponentActivatorOrDefault(IServiceProvid`
`121`	`122`	`protected internal ElementReferenceContext? ElementReferenceContext { get; protected set; }`
`122`	`123`
`123`	`124`	`/// <summary>`
`124`		`- /// Gets a value that determines if the <see cref="Renderer"/> is triggering a render in response to a hot-reload change.`
	`125`	`+ /// Gets a value that determines if the <see cref="Renderer"/> is triggering a render in response to a (metadata update) hot-reload change.`
`125`	`126`	`/// </summary>`
`126`		`- internal bool IsHotReloading { get; private set; }`
	`127`	`+ internal bool IsMetadataUpdating { get; private set; }`
`127`	`128`
`128`	`129`	`private async void RenderRootComponentsOnHotReload()`
`129`	`130`	`{`
`@@ -138,7 +139,7 @@ await Dispatcher.InvokeAsync(() =>`
`138`	`139`	`return;`
`139`	`140`	`}`
`140`	`141`
`141`		`- IsHotReloading = true;`
	`142`	`+ IsMetadataUpdating = true;`
`142`	`143`	`try`
`143`	`144`	`{`
`144`	`145`	`foreach (var (componentState, initialParameters) in _rootComponents)`
`@@ -148,7 +149,7 @@ await Dispatcher.InvokeAsync(() =>`
`148`	`149`	`}`
`149`	`150`	`finally`
`150`	`151`	`{`
`151`		`- IsHotReloading = false;`
	`152`	`+ IsMetadataUpdating = false;`
`152`	`153`	`}`
`153`	`154`	`});`
`154`	`155`	`}`
`@@ -226,7 +227,7 @@ protected async Task RenderRootComponentAsync(int componentId, ParameterView ini`
`226`	`227`	`// During the asynchronous rendering process we want to wait up until all components have`
`227`	`228`	`// finished rendering so that we can produce the complete output.`
`228`	`229`	`var componentState = GetRequiredComponentState(componentId);`
`229`		`- if (HotReloadFeature.IsSupported)`
	`230`	`+ if (MetadataUpdater.IsSupported)`
`230`	`231`	`{`
`231`	`232`	`// when we're doing hot-reload, stash away the parameters used while rendering root components.`
`232`	`233`	`// We'll use this to trigger re-renders on hot reload updates.`
`@@ -997,7 +998,7 @@ public void Dispose()`
`997`	`998`	`/// <inheritdoc />`
`998`	`999`	`public async ValueTask DisposeAsync()`
`999`	`1000`	`{`
`1000`		`- if (HotReloadFeature.IsSupported)`
	`1001`	`+ if (MetadataUpdater.IsSupported)`
`1001`	`1002`	`{`
`1002`	`1003`	`HotReloadManager.OnDeltaApplied -= RenderRootComponentsOnHotReload;`
`1003`	`1004`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using System;`
`7`	`7`	`using System.Collections.Generic;`
`8`	`8`	`using System.Reflection;`
	`9`	`+using System.Reflection.Metadata;`
`9`	`10`	`using System.Runtime.ExceptionServices;`
`10`	`11`	`using System.Threading;`
`11`	`12`	`using System.Threading.Tasks;`
`@@ -99,7 +100,7 @@ public void Attach(RenderHandle renderHandle)`
`99`	`100`	`_locationAbsolute = NavigationManager.Uri;`
`100`	`101`	`NavigationManager.LocationChanged += OnLocationChanged;`
`101`	`102`
`102`		`- if (HotReloadFeature.IsSupported)`
	`103`	`+ if (MetadataUpdater.IsSupported)`
`103`	`104`	`{`
`104`	`105`	`HotReloadManager.OnDeltaApplied += ClearRouteCaches;`
`105`	`106`	`}`
`@@ -143,7 +144,7 @@ public async Task SetParametersAsync(ParameterView parameters)`
`143`	`144`	`public void Dispose()`
`144`	`145`	`{`
`145`	`146`	`NavigationManager.LocationChanged -= OnLocationChanged;`
`146`		`- if (HotReloadFeature.IsSupported)`
	`147`	`+ if (MetadataUpdater.IsSupported)`
`147`	`148`	`{`
`148`	`149`	`HotReloadManager.OnDeltaApplied -= ClearRouteCaches;`
`149`	`150`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public DataAnnotationsEventSubscriptions(EditContext editContext)`
`63`	`63`	`_editContext.OnFieldChanged += OnFieldChanged;`
`64`	`64`	`_editContext.OnValidationRequested += OnValidationRequested;`
`65`	`65`
`66`		`- if (HotReloadFeature.IsSupported)`
	`66`	`+ if (MetadataUpdater.IsSupported)`
`67`	`67`	`{`
`68`	`68`	`OnClearCache += ClearCache;`
`69`	`69`	`}`
`@@ -132,7 +132,7 @@ public void Dispose()`
`132`	`132`	`_editContext.OnValidationRequested -= OnValidationRequested;`
`133`	`133`	`_editContext.NotifyValidationStateChanged();`
`134`	`134`
`135`		`- if (HotReloadFeature.IsSupported)`
	`135`	`+ if (MetadataUpdater.IsSupported)`
`136`	`136`	`{`
`137`	`137`	`OnClearCache -= ClearCache;`
`138`	`138`	`}`