Feedback - limit public API changes.

ilonatommy · ilonatommy · commit def3e5c4f9b3 · 2025-04-08T16:44:09.000+02:00
diff --git a/src/Components/Components/src/NavigationManager.cs b/src/Components/Components/src/NavigationManager.cs
@@ -61,18 +61,6 @@ public event EventHandler<NotFoundEventArgs> OnNotFound
     // The URI. Always represented an absolute URI.
     private string? _uri;
     private bool _isInitialized;
-    private const string EnableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.HttpNavigationManager.EnableThrowNavigationException";
-
-    /// <summary>
-    /// Gets a value indicating whether navigation exceptions should be thrown during navigation.
-    /// </summary>
-    /// <remarks>
-    /// This property is controlled by the AppContext switch
-    /// <c>Microsoft.AspNetCore.Components.Endpoints.HttpNavigationManager.EnableThrowNavigationException</c>.
-    /// When enabled, navigation operations may throw exceptions for debugging or testing purposes.
-    /// </remarks>
-    protected static bool ThrowNavigationException =>
-        AppContext.TryGetSwitch(EnableThrowNavigationException, out var switchValue) && switchValue;
 
     /// <summary>
     /// Gets or sets the current base URI. The <see cref="BaseUri" /> is always represented as an absolute URI in string form with trailing slash.
diff --git a/src/Components/Components/src/PublicAPI.Unshipped.txt b/src/Components/Components/src/PublicAPI.Unshipped.txt
@@ -10,9 +10,4 @@ Microsoft.AspNetCore.Components.SupplyParameterFromPersistentComponentStateAttri
 Microsoft.AspNetCore.Components.SupplyParameterFromPersistentComponentStateAttribute.SupplyParameterFromPersistentComponentStateAttribute() -> void
 Microsoft.Extensions.DependencyInjection.SupplyParameterFromPersistentComponentStateProviderServiceCollectionExtensions
 static Microsoft.AspNetCore.Components.Infrastructure.RegisterPersistentComponentStateServiceCollectionExtensions.AddPersistentServiceRegistration<TService>(Microsoft.Extensions.DependencyInjection.IServiceCollection! services, Microsoft.AspNetCore.Components.IComponentRenderMode! componentRenderMode) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
-static Microsoft.Extensions.DependencyInjection.SupplyParameterFromPersistentComponentStateProviderServiceCollectionExtensions.AddSupplyValueFromPersistentComponentStateProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
-static Microsoft.AspNetCore.Components.NavigationManager.ThrowNavigationException.get -> bool
-Microsoft.AspNetCore.Components.Routing.NavigationEventArgs
-Microsoft.AspNetCore.Components.Routing.NavigationEventArgs.Uri.get -> string!
-Microsoft.AspNetCore.Components.Routing.NavigationEventArgs.NavigationEventArgs(string! uri) -> void
-Microsoft.AspNetCore.Components.Routing.IHostEnvironmentNavigationManager.OnNavigateTo -> System.EventHandler<Microsoft.AspNetCore.Components.Routing.NavigationEventArgs!>!
+static Microsoft.Extensions.DependencyInjection.SupplyParameterFromPersistentComponentStateProviderServiceCollectionExtensions.AddSupplyValueFromPersistentComponentStateProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
diff --git a/src/Components/Components/src/Routing/IHostEnvironmentNavigationManager.cs b/src/Components/Components/src/Routing/IHostEnvironmentNavigationManager.cs
@@ -15,12 +15,4 @@ public interface IHostEnvironmentNavigationManager
     /// <param name="baseUri">The base URI.</param>
     /// <param name="uri">The absolute URI.</param>
     void Initialize(string baseUri, string uri);
-
-    /// <summary>
-    /// An event that is triggered when SSR navigation occurs.
-    /// </summary>
-    /// <remarks>
-    /// This event allows subscribers to respond to SSR navigation actions, such as updating state or performing side effects.
-    /// </remarks>
-    event EventHandler<NavigationEventArgs> OnNavigateTo;
 }
diff --git a/src/Components/Components/src/Routing/NavigationEventArgs.cs b/src/Components/Components/src/Routing/NavigationEventArgs.cs
diff --git a/src/Components/Endpoints/src/DependencyInjection/HttpNavigationManager.cs b/src/Components/Endpoints/src/DependencyInjection/HttpNavigationManager.cs
@@ -7,25 +7,24 @@ namespace Microsoft.AspNetCore.Components.Endpoints;
 
 internal sealed class HttpNavigationManager : NavigationManager, IHostEnvironmentNavigationManager
 {
-    private EventHandler<NavigationEventArgs>? _onNavigateTo;
-    public event EventHandler<NavigationEventArgs> OnNavigateTo
-    {
-        add => _onNavigateTo += value;
-        remove => _onNavigateTo -= value;
-    }
+    private const string _enableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.HttpNavigationManager.EnableThrowNavigationException";
+
+    private static bool _throwNavigationException =>
+        AppContext.TryGetSwitch(_enableThrowNavigationException, out var switchValue) && switchValue;
 
     void IHostEnvironmentNavigationManager.Initialize(string baseUri, string uri) => Initialize(baseUri, uri);
 
     protected override void NavigateToCore(string uri, NavigationOptions options)
     {
         var absoluteUriString = ToAbsoluteUri(uri).AbsoluteUri;
-        if (ThrowNavigationException)
+        if (_throwNavigationException)
         {
             throw new NavigationException(absoluteUriString);
         }
         else
         {
-            _onNavigateTo?.Invoke(this, new NavigationEventArgs(absoluteUriString));
+            Uri = absoluteUriString;
+            NotifyLocationChanged(isInterceptedLink: false);
         }
     }
 }
diff --git a/src/Components/Endpoints/src/Rendering/EndpointHtmlRenderer.cs b/src/Components/Endpoints/src/Rendering/EndpointHtmlRenderer.cs
@@ -84,10 +84,7 @@ internal async Task InitializeStandardComponentServicesAsync(
         if (navigationManager != null)
         {
             navigationManager.OnNotFound += SetNotFoundResponse;
-            if (navigationManager is IHostEnvironmentNavigationManager hostEnvironmentNavigationManager)
-            {
-                hostEnvironmentNavigationManager.OnNavigateTo += OnNavigateTo;
-            }
+            navigationManager.LocationChanged += OnNavigateTo;
         }
 
         var authenticationStateProvider = httpContext.RequestServices.GetService<AuthenticationStateProvider>();
@@ -139,9 +136,9 @@ internal async Task InitializeStandardComponentServicesAsync(
         }
     }
 
-    private void OnNavigateTo(object? sender, NavigationEventArgs args)
+    private void OnNavigateTo(object? sender, LocationChangedEventArgs args)
     {
-        _httpContext.Response.Redirect(args.Uri);
+        _httpContext.Response.Redirect(args.Location);
     }
 
     private static void InitializeResourceCollection(HttpContext httpContext)
diff --git a/src/Components/Endpoints/test/RazorComponentResultTest.cs b/src/Components/Endpoints/test/RazorComponentResultTest.cs
@@ -510,14 +510,6 @@ class FakeDataProtector : IDataProtector
 
     class FakeNavigationManager : NavigationManager, IHostEnvironmentNavigationManager
     {
-        private EventHandler<NavigationEventArgs> _onNavigateTo;
-
-        public event EventHandler<NavigationEventArgs> OnNavigateTo
-        {
-            add => _onNavigateTo += value;
-            remove => _onNavigateTo -= value;
-        }
-
         public new void Initialize(string baseUri, string uri)
             => base.Initialize(baseUri, uri);
 
diff --git a/src/Components/Server/src/Circuits/RemoteNavigationManager.cs b/src/Components/Server/src/Circuits/RemoteNavigationManager.cs
@@ -17,12 +17,9 @@ internal sealed partial class RemoteNavigationManager : NavigationManager, IHost
     private readonly ILogger<RemoteNavigationManager> _logger;
     private IJSRuntime _jsRuntime;
     private bool? _navigationLockStateBeforeJsRuntimeAttached;
-    private EventHandler<NavigationEventArgs>? _onNavigateTo;
-    public event EventHandler<NavigationEventArgs> OnNavigateTo
-    {
-        add => _onNavigateTo += value;
-        remove => _onNavigateTo -= value;
-    }
+    private const string _enableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.HttpNavigationManager.EnableThrowNavigationException";
+    private static bool _throwNavigationException =>
+        AppContext.TryGetSwitch(_enableThrowNavigationException, out var switchValue) && switchValue;
 
     public event EventHandler<Exception>? UnhandledException;
 
@@ -94,13 +91,14 @@ protected override void NavigateToCore(string uri, NavigationOptions options)
         if (_jsRuntime == null)
         {
             var absoluteUriString = ToAbsoluteUri(uri).AbsoluteUri;
-            if (ThrowNavigationException)
+            if (_throwNavigationException)
             {
                 throw new NavigationException(absoluteUriString);
             }
             else
             {
-                _onNavigateTo?.Invoke(this, new NavigationEventArgs(absoluteUriString));
+                Uri = absoluteUriString;
+                NotifyLocationChanged(isInterceptedLink: false);
             }
         }
 
@@ -142,13 +140,14 @@ public override void Refresh(bool forceReload = false)
         if (_jsRuntime == null)
         {
             var absoluteUriString = ToAbsoluteUri(Uri).AbsoluteUri;
-            if (ThrowNavigationException)
+            if (_throwNavigationException)
             {
                 throw new NavigationException(absoluteUriString);
             }
             else
             {
-                _onNavigateTo?.Invoke(this, new NavigationEventArgs(absoluteUriString));
+                Uri = absoluteUriString;
+                NotifyLocationChanged(isInterceptedLink: false);
             }
         }
 
diff --git a/src/Mvc/Mvc.TagHelpers/test/ComponentTagHelperTest.cs b/src/Mvc/Mvc.TagHelpers/test/ComponentTagHelperTest.cs
@@ -104,14 +104,6 @@ protected override void BuildRenderTree(RenderTreeBuilder builder)
 
     class MockNavigationManager : NavigationManager, IHostEnvironmentNavigationManager
     {
-        private EventHandler<NavigationEventArgs> _onNavigateTo;
-
-        public event EventHandler<NavigationEventArgs> OnNavigateTo
-        {
-            add => _onNavigateTo += value;
-            remove => _onNavigateTo -= value;
-        }
-
         public MockNavigationManager()
         {
            Initialize("https://localhost:85/subdir/", "https://localhost:85/subdir/path?query=value#hash");

Original file line number	Diff line number	Diff line change
`@@ -7,25 +7,24 @@ namespace Microsoft.AspNetCore.Components.Endpoints;`
`7`	`7`
`8`	`8`	`internal sealed class HttpNavigationManager : NavigationManager, IHostEnvironmentNavigationManager`
`9`	`9`	`{`
`10`		`- private EventHandler<NavigationEventArgs>? _onNavigateTo;`
`11`		`- public event EventHandler<NavigationEventArgs> OnNavigateTo`
`12`		`- {`
`13`		`- add => _onNavigateTo += value;`
`14`		`- remove => _onNavigateTo -= value;`
`15`		`- }`
	`10`	`+ private const string _enableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.HttpNavigationManager.EnableThrowNavigationException";`
	`11`	`+`
	`12`	`+ private static bool _throwNavigationException =>`
	`13`	`+ AppContext.TryGetSwitch(_enableThrowNavigationException, out var switchValue) && switchValue;`
`16`	`14`
`17`	`15`	`void IHostEnvironmentNavigationManager.Initialize(string baseUri, string uri) => Initialize(baseUri, uri);`
`18`	`16`
`19`	`17`	`protected override void NavigateToCore(string uri, NavigationOptions options)`
`20`	`18`	`{`
`21`	`19`	`var absoluteUriString = ToAbsoluteUri(uri).AbsoluteUri;`
`22`		`- if (ThrowNavigationException)`
	`20`	`+ if (_throwNavigationException)`
`23`	`21`	`{`
`24`	`22`	`throw new NavigationException(absoluteUriString);`
`25`	`23`	`}`
`26`	`24`	`else`
`27`	`25`	`{`
`28`		`- _onNavigateTo?.Invoke(this, new NavigationEventArgs(absoluteUriString));`
	`26`	`+ Uri = absoluteUriString;`
	`27`	`+ NotifyLocationChanged(isInterceptedLink: false);`
`29`	`28`	`}`
`30`	`29`	`}`
`31`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,10 +84,7 @@ internal async Task InitializeStandardComponentServicesAsync(`
`84`	`84`	`if (navigationManager != null)`
`85`	`85`	`{`
`86`	`86`	`navigationManager.OnNotFound += SetNotFoundResponse;`
`87`		`- if (navigationManager is IHostEnvironmentNavigationManager hostEnvironmentNavigationManager)`
`88`		`- {`
`89`		`- hostEnvironmentNavigationManager.OnNavigateTo += OnNavigateTo;`
`90`		`- }`
	`87`	`+ navigationManager.LocationChanged += OnNavigateTo;`
`91`	`88`	`}`
`92`	`89`
`93`	`90`	`var authenticationStateProvider = httpContext.RequestServices.GetService<AuthenticationStateProvider>();`
`@@ -139,9 +136,9 @@ internal async Task InitializeStandardComponentServicesAsync(`
`139`	`136`	`}`
`140`	`137`	`}`
`141`	`138`
`142`		`- private void OnNavigateTo(object? sender, NavigationEventArgs args)`
	`139`	`+ private void OnNavigateTo(object? sender, LocationChangedEventArgs args)`
`143`	`140`	`{`
`144`		`- _httpContext.Response.Redirect(args.Uri);`
	`141`	`+ _httpContext.Response.Redirect(args.Location);`
`145`	`142`	`}`
`146`	`143`
`147`	`144`	`private static void InitializeResourceCollection(HttpContext httpContext)`
Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,9 @@ internal sealed partial class RemoteNavigationManager : NavigationManager, IHost`
`17`	`17`	`private readonly ILogger<RemoteNavigationManager> _logger;`
`18`	`18`	`private IJSRuntime _jsRuntime;`
`19`	`19`	`private bool? _navigationLockStateBeforeJsRuntimeAttached;`
`20`		`- private EventHandler<NavigationEventArgs>? _onNavigateTo;`
`21`		`- public event EventHandler<NavigationEventArgs> OnNavigateTo`
`22`		`- {`
`23`		`- add => _onNavigateTo += value;`
`24`		`- remove => _onNavigateTo -= value;`
`25`		`- }`
	`20`	`+ private const string _enableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.HttpNavigationManager.EnableThrowNavigationException";`
	`21`	`+ private static bool _throwNavigationException =>`
	`22`	`+ AppContext.TryGetSwitch(_enableThrowNavigationException, out var switchValue) && switchValue;`
`26`	`23`
`27`	`24`	`public event EventHandler<Exception>? UnhandledException;`
`28`	`25`
`@@ -94,13 +91,14 @@ protected override void NavigateToCore(string uri, NavigationOptions options)`
`94`	`91`	`if (_jsRuntime == null)`
`95`	`92`	`{`
`96`	`93`	`var absoluteUriString = ToAbsoluteUri(uri).AbsoluteUri;`
`97`		`- if (ThrowNavigationException)`
	`94`	`+ if (_throwNavigationException)`
`98`	`95`	`{`
`99`	`96`	`throw new NavigationException(absoluteUriString);`
`100`	`97`	`}`
`101`	`98`	`else`
`102`	`99`	`{`
`103`		`- _onNavigateTo?.Invoke(this, new NavigationEventArgs(absoluteUriString));`
	`100`	`+ Uri = absoluteUriString;`
	`101`	`+ NotifyLocationChanged(isInterceptedLink: false);`
`104`	`102`	`}`
`105`	`103`	`}`
`106`	`104`
`@@ -142,13 +140,14 @@ public override void Refresh(bool forceReload = false)`
`142`	`140`	`if (_jsRuntime == null)`
`143`	`141`	`{`
`144`	`142`	`var absoluteUriString = ToAbsoluteUri(Uri).AbsoluteUri;`
`145`		`- if (ThrowNavigationException)`
	`143`	`+ if (_throwNavigationException)`
`146`	`144`	`{`
`147`	`145`	`throw new NavigationException(absoluteUriString);`
`148`	`146`	`}`
`149`	`147`	`else`
`150`	`148`	`{`
`151`		`- _onNavigateTo?.Invoke(this, new NavigationEventArgs(absoluteUriString));`
	`149`	`+ Uri = absoluteUriString;`
	`150`	`+ NotifyLocationChanged(isInterceptedLink: false);`
`152`	`151`	`}`
`153`	`152`	`}`
`154`	`153`
Original file line number	Diff line number	Diff line change
`@@ -104,14 +104,6 @@ protected override void BuildRenderTree(RenderTreeBuilder builder)`
`104`	`104`
`105`	`105`	`class MockNavigationManager : NavigationManager, IHostEnvironmentNavigationManager`
`106`	`106`	`{`
`107`		`- private EventHandler<NavigationEventArgs> _onNavigateTo;`
`108`		`-`
`109`		`- public event EventHandler<NavigationEventArgs> OnNavigateTo`
`110`		`- {`
`111`		`- add => _onNavigateTo += value;`
`112`		`- remove => _onNavigateTo -= value;`
`113`		`- }`
`114`		`-`
`115`	`107`	`public MockNavigationManager()`
`116`	`108`	`{`
`117`	`109`	`Initialize("https://localhost:85/subdir/", "https://localhost:85/subdir/path?query=value#hash");`