Blazor Server - Auto reconnect on mobile browsers #32122

konradbartecki · 2021-04-23T21:42:56Z

You've read the Contributor Guide and Code of Conduct.
You've included unit or integration tests for your change, where applicable.
You've included inline docs for your change, where applicable.
There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Blazor Server - Auto reconnect on mobile browsers

On mobile devices when resuming a page after a long time this PR fixes an issue where Rejected prompt was displayed because circuit was already recycled on server.
New onConnectionRejected event
Default implementation of that event reloads the page (configurable in options)
Changed default reconnection delay from 20s to 3s
Now reconnection delay will be applied after the attempt instead of before the attempt

Addresses #32113 #26985
Possibly adresses #23340
Related #10325

…cuit was lost

…delay afterwards. Support for mobile browsers to enable page reload when circuit was lost

…eloads the page

dnfadmin · 2021-04-23T21:43:09Z

All CLA requirements met.

konradbartecki · 2021-04-23T22:45:07Z

There is an issue, when navigating away the reconnection modal is displayed for fraction of a second. I'll wait for comments how do we want to tackle that before updating this PR.

Maybe I will need to dig around

  window['Blazor']._internal.navigationManager.listenForNavigationEvents((uri: string, intercepted: boolean): Promise<void> => {
    return connection.send('OnLocationChanged', uri, intercepted);
  });

mkArtakMSFT · 2022-01-16T18:36:44Z

Sorry for taking too long to get back to you here, @konradbartecki.
@javiercn can you please review this PR and see whether this is something we'd like to take or not? Thanks!

konradbartecki · 2022-01-18T01:50:27Z

Sure, @mkArtakMSFT @javiercn, no worries, let me know if anything I can hop on a quick 15 min call with you guys if you would want me to explain it.

src/Components/Web.JS/src/Platform/Circuits/CircuitStartOptions.ts

src/Components/Web.JS/src/Platform/Circuits/DefaultReconnectionHandler.ts

SteveSandersonMS · 2022-01-18T11:01:51Z

src/Components/Web.JS/src/Platform/Circuits/DefaultReconnectionHandler.ts

 };

 class ReconnectionProcess {
-  static readonly MaximumFirstRetryInterval = 3000;


Does anyone remember why we implemented this originally?

Most likely because after connection goes down it would try to attempt the reconnection only after 20s, which is quite a long time.
So workaround that originally is there is to shorten the first reconnection attempt interval to 3s.

SteveSandersonMS · 2022-01-18T11:02:59Z

src/Components/Web.JS/src/Platform/Circuits/CircuitStartOptions.ts

 }

 export interface ReconnectionHandler {
  onConnectionDown(options: ReconnectionOptions, error?: Error): void;
  onConnectionUp(): void;
+  onConnectionRejected(options: ReconnectionOptions): void;


This seems like a pretty good idea to me. I'm not 100% sold on reloading automatically by default (we need to at least reason about why that wasn't already our default) but the ability to configure a handler for this scenario seems valuable.

Co-authored-by: Steve Sanderson <SteveSandersonMS@users.noreply.github.com>

SteveSandersonMS · 2022-01-24T10:53:38Z

src/Components/Web.JS/src/Platform/Circuits/DefaultReconnectionHandler.ts

-      const delayDuration = i == 0 && options.retryIntervalMilliseconds > ReconnectionProcess.MaximumFirstRetryInterval
-                            ? ReconnectionProcess.MaximumFirstRetryInterval
-                            : options.retryIntervalMilliseconds;
-      await this.delay(delayDuration);


Since retryIntervalMilliseconds was put back to 20000ms, I think it's also necessary to bring back this logic.

SteveSandersonMS · 2022-01-24T10:56:12Z

src/Components/Web.JS/src/Platform/Circuits/CircuitStartOptions.ts

 }

 export interface ReconnectionHandler {
  onConnectionDown(options: ReconnectionOptions, error?: Error): void;
  onConnectionUp(): void;
+  onConnectionRejected(options: ReconnectionOptions): void;


For back-compatibility, this new property needs to be added as optional

SteveSandersonMS · 2022-01-24T10:57:55Z

src/Components/Web.JS/src/Boot.Server.ts

@@ -49,6 +49,7 @@ async function boot(userOptions?: Partial<CircuitStartOptions>): Promise<void> {
    const reconnection = existingConnection || await initializeConnection(options, logger, circuit);
    if (!(await circuit.reconnect(reconnection))) {
      logger.log(LogLevel.Information, 'Reconnection attempt to the circuit was rejected by the server. This may indicate that the associated state is no longer available on the server.');
+      options.reconnectionHandler!.onConnectionRejected(options.reconnectionOptions);


I suspect we should be checking whether reconnectionHandler or onConnectionRejected are unset, and skipping the call if so. Or is there some way we know for sure that both of them are set?

Example (untested):

Suggested change

options.reconnectionHandler!.onConnectionRejected(options.reconnectionOptions);

options.reconnectionHandler?.onConnectionRejected?(options.reconnectionOptions);

ghost · 2022-02-03T12:00:47Z

Hi @konradbartecki.
It seems you haven't touched this PR for the last two weeks. To avoid accumulating old PRs, we're marking it as stale. As a result, it will be closed if no further activity occurs within 4 days of this comment. You can learn more about our Issue Management Policies here.

… comments Optional onCircuitRejected call if implemented

konradbartecki added 4 commits April 23, 2021 22:36

Support for mobile browsers to automatically reload the page when cir…

75805a7

…cuit was lost

Reconnection handler will now immediately try to reconnect and apply …

e44c828

…delay afterwards. Support for mobile browsers to enable page reload when circuit was lost

Add new onConnectionRejected event with default implementation that r…

69c4780

…eloads the page

Removed custom retry delay with a different timeout on the first attempt

bd1015f

konradbartecki requested a review from a team as a code owner April 23, 2021 21:42

ghost added area-blazor Includes: Blazor, Razor Components community-contribution Indicates that the PR has been added by a community member labels Apr 23, 2021

Fix broken tests

f2f6cdb

konradbartecki mentioned this pull request Apr 24, 2021

Better reconnection logic for Blazor Server #32113

Closed

mkArtakMSFT assigned javiercn Apr 26, 2021

konradbartecki mentioned this pull request Apr 28, 2021

Reload the browser when the circuit ID is unknown #9256

Closed

SteveSandersonMS reviewed Jan 18, 2022

View reviewed changes

src/Components/Web.JS/src/Platform/Circuits/CircuitStartOptions.ts Outdated Show resolved Hide resolved

SteveSandersonMS reviewed Jan 18, 2022

View reviewed changes

src/Components/Web.JS/src/Platform/Circuits/DefaultReconnectionHandler.ts Outdated Show resolved Hide resolved

SteveSandersonMS reviewed Jan 18, 2022

View reviewed changes

konradbartecki and others added 2 commits January 18, 2022 12:25

Remove whitespace

70647ea

Co-authored-by: Steve Sanderson <SteveSandersonMS@users.noreply.github.com>

Revert back 3s reconnection interval to 20s

29cfd30

SteveSandersonMS reviewed Jan 24, 2022

View reviewed changes

SteveSandersonMS added the pr: pending author input For automation. Specifically separate from Needs: Author Feedback label Jan 24, 2022

ghost added the stale Indicates a stale issue. These issues will be closed automatically soon. label Feb 3, 2022

ghost closed this Feb 7, 2022

konradbartecki added a commit to konradbartecki/aspnetcore that referenced this pull request Oct 23, 2022

PR dotnet#32122 - Backward compatibility according to @SteveSandersonMS…

4eddbef

… comments Optional onCircuitRejected call if implemented

konradbartecki mentioned this pull request Oct 23, 2022

Blazor Server - Auto reconnect on mobile browsers #44700

Closed

4 tasks

konradbartecki mentioned this pull request Feb 19, 2023

Improve Reconnection Experience StarbeamOne/home#69

Closed

konradbartecki mentioned this pull request Jul 8, 2024

[Blazor] Restore client-side state after failing to reconnect to the circuit #56678

Open

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Blazor Server - Auto reconnect on mobile browsers #32122

Blazor Server - Auto reconnect on mobile browsers #32122

konradbartecki commented Apr 23, 2021 •

edited

Loading

dnfadmin commented Apr 23, 2021 •

edited

Loading

konradbartecki commented Apr 23, 2021 •

edited

Loading

mkArtakMSFT commented Jan 16, 2022 •

edited

Loading

konradbartecki commented Jan 18, 2022

SteveSandersonMS Jan 18, 2022

konradbartecki Jan 18, 2022

SteveSandersonMS Jan 18, 2022

SteveSandersonMS Jan 24, 2022

SteveSandersonMS Jan 24, 2022

SteveSandersonMS Jan 24, 2022

ghost commented Feb 3, 2022

	options.reconnectionHandler!.onConnectionRejected(options.reconnectionOptions);
	options.reconnectionHandler?.onConnectionRejected?(options.reconnectionOptions);

Blazor Server - Auto reconnect on mobile browsers #32122

Blazor Server - Auto reconnect on mobile browsers #32122

Conversation

konradbartecki commented Apr 23, 2021 • edited Loading

dnfadmin commented Apr 23, 2021 • edited Loading

konradbartecki commented Apr 23, 2021 • edited Loading

mkArtakMSFT commented Jan 16, 2022 • edited Loading

konradbartecki commented Jan 18, 2022

SteveSandersonMS Jan 18, 2022

Choose a reason for hiding this comment

konradbartecki Jan 18, 2022

Choose a reason for hiding this comment

SteveSandersonMS Jan 18, 2022

Choose a reason for hiding this comment

SteveSandersonMS Jan 24, 2022

Choose a reason for hiding this comment

SteveSandersonMS Jan 24, 2022

Choose a reason for hiding this comment

SteveSandersonMS Jan 24, 2022

Choose a reason for hiding this comment

ghost commented Feb 3, 2022

konradbartecki commented Apr 23, 2021 •

edited

Loading

dnfadmin commented Apr 23, 2021 •

edited

Loading

konradbartecki commented Apr 23, 2021 •

edited

Loading

mkArtakMSFT commented Jan 16, 2022 •

edited

Loading