Disconnect circuit on `beforeunload` event and fix display (#24592)

* Disconnect circuit on `beforeunload` event (#23224)

* Add delay before showing Reconnection UI (#24137)

* Add CSS delay before showing Reconnection UI

* rebuild yet again to try and get past the conflict

* Move reconnection delay mechanism into framework code (#24566)

Co-authored-by: SQL-MisterMagoo <mister.magoo+githubsql@gmail.com>
Co-authored-by: Steve Sanderson <SteveSandersonMS@users.noreply.github.com>

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

@@ -56,16 +56,18 @@ async function boot(userOptions?: Partial<CircuitStartOptions>): Promise<void> {
     return true;
   };
 
-  window.addEventListener(
+  let disconnectSent = false;
-    'unload',
+  const cleanup = () => {
-    () => {
+    if (!disconnectSent) {
       const data = new FormData();
       const circuitId = circuit.circuitId!;
       data.append('circuitId', circuitId);
-      navigator.sendBeacon('_blazor/disconnect', data);
+      disconnectSent = navigator.sendBeacon('_blazor/disconnect', data);
-    },
+    }
-    false
+  };
-  );
+
+  window.addEventListener('beforeunload', cleanup, { capture: false, once: true });
+  window.addEventListener('unload', cleanup, { capture: false, once: true });
 
   window['Blazor'].reconnect = reconnect;
 

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

@@ -29,6 +29,7 @@ export class DefaultReconnectDisplay implements ReconnectDisplay {
       'opacity: 0.8',
       'text-align: center',
       'font-weight: bold',
+      'transition: visibility 0s linear 500ms',
     ];
 
     this.modal.style.cssText = modalStyles.join(';');
@@ -67,6 +68,14 @@ export class DefaultReconnectDisplay implements ReconnectDisplay {
     this.button.style.display = 'none';
     this.reloadParagraph.style.display = 'none';
     this.message.textContent = 'Attempting to reconnect to the server...';
+
+    // The visibility property has a transition so it takes effect after a delay.
+    // This is to prevent it appearing momentarily when navigating away. For the
+    // transition to take effect, we have to apply the visibility asynchronously.
+    this.modal.style.visibility = 'hidden';
+    setTimeout(() => {
+      this.modal.style.visibility = 'visible';
+    }, 0);
   }
 
   hide(): void {

src/Components/Web.JS/tests/DefaultReconnectDisplay.test.ts

@@ -1,6 +1,6 @@
 import { DefaultReconnectDisplay } from "../src/Platform/Circuits/DefaultReconnectDisplay";
-import {JSDOM} from 'jsdom';
+import { JSDOM } from 'jsdom';
-import { NullLogger} from '../src/Platform/Logging/Loggers';
+import { NullLogger } from '../src/Platform/Logging/Loggers';
 
 describe('DefaultReconnectDisplay', () => {
 
@@ -14,9 +14,16 @@ describe('DefaultReconnectDisplay', () => {
         expect(element).toBeDefined();
         expect(element!.id).toBe('test-dialog-id');
         expect(element!.style.display).toBe('block');
+        expect(element!.style.visibility).toBe('hidden');
 
         expect(display.message.textContent).toBe('Attempting to reconnect to the server...');
         expect(display.button.style.display).toBe('none');
+
+        // Visibility changes asynchronously to allow animation
+        return new Promise(resolve => setTimeout(() => {
+            expect(element!.style.visibility).toBe('visible');
+            resolve();
+        }, 1));
     });
 
     it ('does not add element to the body multiple times', () => {