Skip to content

Flip switch for controlling navigation flow on SSR #62358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 17, 2025
Merged

Flip switch for controlling navigation flow on SSR #62358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
873923f
Flip.
ilonatommy Jun 16, 2025
f2493a9
Update templates.
ilonatommy Jun 16, 2025
1c0f1d7
Missing rename.
ilonatommy Jun 16, 2025
48b88db
Fix new default value.
ilonatommy Jun 16, 2025
bedb668
Feedback: use sdk for setting the switch.
ilonatommy Jun 16, 2025
03e77f7
With Blazor prefix it's easier to detect where this switch belongs.
ilonatommy Jun 16, 2025
67d086b
Move the property.
ilonatommy Jun 16, 2025
92c39c4
Revert miscommit.
ilonatommy Jun 16, 2025
0432cc0
Update client csproj.
ilonatommy Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Components/Endpoints/src/DependencyInjection/HttpNavigationManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ namespace Microsoft.AspNetCore.Components.Endpoints;

internal sealed class HttpNavigationManager : NavigationManager, IHostEnvironmentNavigationManager
{
private const string _enableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.NavigationManager.EnableThrowNavigationException";
private const string _disableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.NavigationManager.DisableThrowNavigationException";

[FeatureSwitchDefinition(_enableThrowNavigationException)]
[FeatureSwitchDefinition(_disableThrowNavigationException)]
private static bool _throwNavigationException =>
AppContext.TryGetSwitch(_enableThrowNavigationException, out var switchValue) && switchValue;
!AppContext.TryGetSwitch(_disableThrowNavigationException, out var switchValue) || !switchValue;

private Func<string, Task>? _onNavigateTo;

Expand Down
6 changes: 3 additions & 3 deletions src/Components/Endpoints/test/EndpointHtmlRendererTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -846,9 +846,9 @@ public async Task Rendering_ComponentWithJsInteropThrows()
[Theory]
[InlineData(true)]
[InlineData(false)]
public async Task UriHelperRedirect_ThrowsInvalidOperationException_WhenResponseHasAlreadyStarted(bool expectException)
public async Task UriHelperRedirect_ThrowsInvalidOperationException_WhenResponseHasAlreadyStarted(bool allowException)
{
AppContext.SetSwitch("Microsoft.AspNetCore.Components.Endpoints.NavigationManager.EnableThrowNavigationException", isEnabled: expectException);
AppContext.SetSwitch("Microsoft.AspNetCore.Components.Endpoints.NavigationManager.DisableThrowNavigationException", isEnabled: !allowException);
// Arrange
var ctx = new DefaultHttpContext();
ctx.Request.Scheme = "http";
Expand All @@ -864,7 +864,7 @@ public async Task UriHelperRedirect_ThrowsInvalidOperationException_WhenResponse
string redirectUri = "http://localhost/redirect";

// Act
if (expectException)
if (allowException)
{
var exception = await Assert.ThrowsAsync<InvalidOperationException>(async () => await renderer.PrerenderComponentAsync(
httpContext,
Expand Down
6 changes: 3 additions & 3 deletions src/Components/Server/src/Circuits/RemoteNavigationManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ internal sealed partial class RemoteNavigationManager : NavigationManager, IHost
private readonly ILogger<RemoteNavigationManager> _logger;
private IJSRuntime _jsRuntime;
private bool? _navigationLockStateBeforeJsRuntimeAttached;
private const string _enableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.NavigationManager.EnableThrowNavigationException";
private const string _disableThrowNavigationException = "Microsoft.AspNetCore.Components.Endpoints.NavigationManager.DisableThrowNavigationException";

[FeatureSwitchDefinition(_enableThrowNavigationException)]
[FeatureSwitchDefinition(_disableThrowNavigationException)]
private static bool _throwNavigationException =>
AppContext.TryGetSwitch(_enableThrowNavigationException, out var switchValue) && switchValue;
!AppContext.TryGetSwitch(_disableThrowNavigationException, out var switchValue) || !switchValue;
private Func<string, Task>? _onNavigateTo;

public event EventHandler<Exception>? UnhandledException;
Expand Down
2 changes: 1 addition & 1 deletion src/Components/test/E2ETest/ServerRenderingTests/InteractivityTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1405,7 +1405,7 @@ public void CanPersistMultiplePrerenderedStateDeclaratively_Auto_PersistsOnWebAs
[InlineData(false)]
public void NavigatesWithInteractivityByRequestRedirection(bool controlFlowByException)
{
AppContext.SetSwitch("Microsoft.AspNetCore.Components.Endpoints.NavigationManager.EnableThrowNavigationException", isEnabled: controlFlowByException);
AppContext.SetSwitch("Microsoft.AspNetCore.Components.Endpoints.NavigationManager.DisableThrowNavigationException", isEnabled: !controlFlowByException);
Navigate($"{ServerPathBase}/routing/ssr-navigate-to");
Browser.Equal("Click submit to navigate to home", () => Browser.Exists(By.Id("test-info")).Text);
Browser.Click(By.Id("redirectButton"));
Expand Down
2 changes: 1 addition & 1 deletion src/Components/test/E2ETest/ServerRenderingTests/NoInteractivityTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public void CanUseServerAuthenticationStateByDefault()
[InlineData(false, true)]
public void NavigatesWithoutInteractivityByRequestRedirection(bool controlFlowByException, bool isStreaming)
{
AppContext.SetSwitch("Microsoft.AspNetCore.Components.Endpoints.NavigationManager.EnableThrowNavigationException", isEnabled: controlFlowByException);
AppContext.SetSwitch("Microsoft.AspNetCore.Components.Endpoints.NavigationManager.DisableThrowNavigationException", isEnabled: !controlFlowByException);
string streaming = isStreaming ? $"streaming-" : "";
Navigate($"{ServerPathBase}/routing/ssr-{streaming}navigate-to");
Browser.Equal("Click submit to navigate to home", () => Browser.Exists(By.Id("test-info")).Text);
Expand Down
1 change: 1 addition & 0 deletions src/ProjectTemplates/Web.ProjectTemplates/BlazorWeb-CSharp.Client.csproj.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<StaticWebAssetProjectMode>Default</StaticWebAssetProjectMode>
<RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">BlazorWeb-CSharp.Client</RootNamespace>
<AssemblyName Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">`$(AssemblyName.Replace(' ', '_'))</AssemblyName>
<BlazorDisableThrowNavigationException>true</BlazorDisableThrowNavigationException>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions src/ProjectTemplates/Web.ProjectTemplates/BlazorWeb-CSharp.csproj.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<NoDefaultLaunchSettingsFile Condition="'$(ExcludeLaunchSettings)' == 'True'">True</NoDefaultLaunchSettingsFile>
<RootNamespace Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">BlazorWeb-CSharp</RootNamespace>
<AssemblyName Condition="'$(name)' != '$(name{-VALUE-FORMS-}safe_namespace)'">`$(AssemblyName.Replace(' ', '_'))</AssemblyName>
<BlazorDisableThrowNavigationException>true</BlazorDisableThrowNavigationException>
</PropertyGroup>

<!--#if (IndividualLocalAuth && !UseLocalDB) -->
Expand Down
Loading