Skip to content

[blazor] fix multiple calls to OnConnectionDownAsync #62518

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.

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

Conversation

pavelsavara
Copy link
Member

  • don't call CircuitHost.OnConnectionDownAsync() from CircuitHost.DisposeAsync() if it's not connected
  • don't call _circuitConnectedCounter.Add from CircuitMetrics.OnCircuitDown
  • fix unit test

Fixes #62219

image

@pavelsavara pavelsavara added this to the 10.0-preview7 milestone Jul 1, 2025
@pavelsavara pavelsavara self-assigned this Jul 1, 2025
@pavelsavara pavelsavara added the area-blazor Includes: Blazor, Razor Components label Jul 1, 2025
@pavelsavara pavelsavara marked this pull request as ready for review July 1, 2025 12:38
@pavelsavara pavelsavara requested a review from a team as a code owner July 1, 2025 12:38
Comment on lines 212 to 215
if (this.Client.Connected)
{
await OnConnectionDownAsync(CancellationToken.None);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is the right change to fix the metric issue. It's changing an existing behavior of the system that users might be relying on.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this event is called twice. That's a bug not a feature

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is causing the 2nd call?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The proper event is Hub.OnDisconnect()

CircuitHost.OnConnectionDownAsync() is called from CircuitHost.DisposeAsync() regardless if it's connected or not, creating dis-balance.

Image

Image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@javiercn does this make sense or you have another proposal for the fix ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tested the "close tab" and "navigate to non-interactive page". Both behave as expected, that is, they call the event once.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terminate it's not being fired in those cases.

  • Close tab will likely don't cause unload to fire.
  • navigate to non-interactive page
    • It takes a bit of time for the client to start the circuit disposal.
    • If for some reason it's not happening, it's also a bug.

https://github.com/dotnet/aspnetcore/blob/main/src/Components/Server/src/CircuitDisconnectMiddleware.cs#L81-L87

https://github.com/dotnet/aspnetcore/blob/main/src/Components/Server/src/Circuits/CircuitRegistry.cs#L391

If we check for the circuit to be connected it won't fire when we want to eagerly terminate the circuit.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we need to call that event from places that call circuitHost.Client.SetDisconnected() rather than relying that circuitHost.DisposeAsync() would always call it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I'm not sure that the new PauseAndDisposeCircuitHost is calling SetDisconnected()

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the calls to OnConnectionDownAsync more explicit now, instead of relying on the DisposeAsync.

@javiercn please review again.

@dotnet-policy-service dotnet-policy-service bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Jul 11, 2025
@pavelsavara pavelsavara requested a review from javiercn July 15, 2025 12:48
@pavelsavara pavelsavara removed the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Jul 16, 2025
Copy link
Member

@javiercn javiercn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than restructure the code in the current way. Isn't it simpler and safer to make OnConnectionDown "idempotent"? Keeping a flag when you run it and resetting it with OnConnectionUp.

That way we save ourselves the trouble of having to worry about when OnConnectionDown should run and the change is localized into a single file and can be easily tested.

I worry that the current approach introduces subtle behavior changes and require us to carefully consider the correctness of all the locations where we are now explicitly handling the callbacks.

@pavelsavara
Copy link
Member Author

Rather than restructure the code in the current way. Isn't it simpler and safer to make OnConnectionDown "idempotent"? Keeping a flag when you run it and resetting it with OnConnectionUp.

CircuitHost.Client.Connected could be such flag. The problem is that we don't maintain it properly in all scenarios.
I attempted to fix the PauseAndDisposeCircuitHost but I agree that this is fragile is there are other scenarios which I missed.

Also the OnConnectionDown event doesn't reset it. But should it ?

If we rather introduce a new flag, should it be bool CircuitHost.OnConnectionDownFired ?

That way we save ourselves the trouble of having to worry about when OnConnectionDown should run and the change is localized into a single file and can be easily tested.

Do you mean that we only fire OnConnectionDown on when the flag is true ? Or you mean that metrics would not be counted when the flag is down.

I worry that the current approach introduces subtle behavior changes and require us to carefully consider the correctness of all the locations where we are now explicitly handling the callbacks.

In other words, do you want to fix double-firing of OnConnectionDown for other subscribers or keep the current behavior.

Anyway, I'll give it a try with a new flag and I'll improve the fix for PauseAndDisposeCircuitHost

@pavelsavara pavelsavara requested a review from javiercn July 17, 2025 15:25
@pavelsavara pavelsavara enabled auto-merge (squash) July 18, 2025 09:58
@pavelsavara pavelsavara merged commit 366296c into dotnet:main Jul 18, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-blazor Includes: Blazor, Razor Components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Metric for connected circuits drops to zero when a client disconnects
3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy