feat(templates): initial implementation for Boilerplate's isOnline wi…

…thout signalR #9202 (#9210)
bitfoundation · Nov 12, 2024 · 42040e6 · 42040e6
1 parent e484cf7
commit 42040e6
Show file tree

Hide file tree

Showing 15 changed files with 24 additions and 39 deletions.
diff --git a/...erplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/AppComponentBase.cs b/...erplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/AppComponentBase.cs
@@ -7,7 +7,7 @@ public partial class AppComponentBase : ComponentBase, IAsyncDisposable
     /// <summary>
     /// <inheritdoc cref="Parameters.IsOnline"/>
     /// </summary>
-    [CascadingParameter(Name = Parameters.IsOnline)] protected bool IsOnline { get; set; }
+    [CascadingParameter(Name = Parameters.IsOnline)] protected bool? IsOnline { get; set; }
     [CascadingParameter] protected Task<AuthenticationState> AuthenticationStateTask { get; set; } = default!;
 
     [AutoInject] protected IJSRuntime JSRuntime = default!;

diff --git a/...ate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/ClientAppCoordinator.cs b/...ate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/ClientAppCoordinator.cs
@@ -188,14 +188,12 @@ private async Task ConnectSignalR()
 
     private async Task HubConnectionConnected(string? connectionId)
     {
-        TelemetryContext.IsOnline = true;
         PubSubService.Publish(ClientPubSubMessages.IS_ONLINE_CHANGED, true);
         logger.LogInformation("SignalR connection {ConnectionId} established.", connectionId);
     }
 
     private async Task HubConnectionDisconnected(Exception? exception)
     {
-        TelemetryContext.IsOnline = false;
         PubSubService.Publish(ClientPubSubMessages.IS_ONLINE_CHANGED, false);
 
         if (exception is null)

diff --git a/...t.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/RootContainer.razor.cs b/...t.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/RootContainer.razor.cs
@@ -7,7 +7,7 @@ public partial class RootContainer
     /// <summary>
     /// <inheritdoc cref="Parameters.IsOnline"/>
     /// </summary>
-    [Parameter] public bool IsOnline { get; set; }
+    [Parameter] public bool? IsOnline { get; set; }
     [Parameter] public BitDir? CurrentDir { get; set; }
     [Parameter] public string? CurrentUrl { get; set; }
     [Parameter] public bool? IsAuthenticated { get; set; }

diff --git a/.../Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/RootLayout.razor.cs b/.../Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/RootLayout.razor.cs
@@ -11,18 +11,7 @@ public partial class RootLayout : IDisposable
     /// <summary>
     /// <inheritdoc cref="Parameters.IsOnline"/>
     /// </summary>
-    private bool isOnline
-        //#if (signalR == true)
-            = false;
-        //#else
-            //#if (IsInsideProjectTemplate == true)
-            /*
-            //#endif
-           = true;
-            //#if (IsInsideProjectTemplate == true)
-            */
-            //#endif
-        //#endif
+    private bool? isOnline = null;
     private bool? isAuthenticated;
 
     /// <summary>
@@ -39,6 +28,7 @@ private bool isOnline
     [AutoInject] private PubSubService pubSubService = default!;
     [AutoInject] private AuthenticationManager authManager = default!;
     [AutoInject] private IExceptionHandler exceptionHandler = default!;
+    [AutoInject] private ITelemetryContext telemetryContext = default!;
     [AutoInject] private NavigationManager navigationManager = default!;
     [AutoInject] private IPrerenderStateService prerenderStateService = default!;
 
@@ -70,13 +60,12 @@ protected override async Task OnInitializedAsync()
                 StateHasChanged();
             }));
 
-            //#if (signalR == true)
             unsubscribers.Add(pubSubService.Subscribe(ClientPubSubMessages.IS_ONLINE_CHANGED, async payload =>
             {
                 isOnline = (bool)payload!;
+                telemetryContext.IsOnline = isOnline is true;
                 await InvokeAsync(StateHasChanged);
             }));
-            //#endif
 
             isAuthenticated = await prerenderStateService.GetValue(async () => (await AuthenticationStateTask).User.IsAuthenticated());
 

diff --git a/...plate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/UserMenu.razor b/...plate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/UserMenu.razor
@@ -14,7 +14,7 @@
                         Size=@BitPersonaSize.Size32
                         PrimaryText="@user.DisplayName"
                         Classes="@(new() { DetailsContainer="persona-details" })"
-                        Presence="@(IsOnline ? BitPersonaPresence.Online : BitPersonaPresence.Offline)" />
+                        Presence="@(IsOnline is null ? BitPersonaPresence.None : IsOnline is true ? BitPersonaPresence.Online : BitPersonaPresence.Offline)" />
             <BitIcon IconName="@BitIconName.ChevronDown" Size="BitSize.Small" Color="BitColor.Info" Class="menu-chevron" />
         </Template>
         <Body>
@@ -28,7 +28,7 @@
                                     Size="BitPersonaSize.Size48"
                                     PrimaryText="@user.DisplayName"
                                     SecondaryText="@(user.Email ?? user.PhoneNumber)"
-                                    Presence="@(IsOnline ? BitPersonaPresence.Online : BitPersonaPresence.Offline)">
+                                    Presence="@(IsOnline is null ? BitPersonaPresence.None : IsOnline is true ? BitPersonaPresence.Online : BitPersonaPresence.Offline)">
                             <ImageOverlayTemplate>
                                 <span>@Localizer[nameof(AppStrings.Edit)]</span>
                             </ImageOverlayTemplate>

diff --git a/.../Client/Boilerplate.Client.Core/Components/Pages/Authorized/Settings/ProfileSection.razor b/.../Client/Boilerplate.Client.Core/Components/Pages/Authorized/Settings/ProfileSection.razor
@@ -32,7 +32,7 @@
                                         ImageUrl="@imageUrl"
                                         PrimaryText="@User?.FullName"
                                         Size=@BitPersonaSize.Size72
-                                        Presence="@(IsOnline ? BitPersonaPresence.Online : BitPersonaPresence.Offline)" />
+                                        Presence="@(IsOnline is null ? BitPersonaPresence.None : IsOnline is true ? BitPersonaPresence.Online : BitPersonaPresence.Offline)" />
                             <BitText Color="BitColor.Primary">
                                 @Localizer[nameof(AppStrings.UploadNewProfileImage)]
                             </BitText>

diff --git a/...Client/Boilerplate.Client.Core/Components/Pages/Authorized/Settings/SessionsSection.razor b/...Client/Boilerplate.Client.Core/Components/Pages/Authorized/Settings/SessionsSection.razor
@@ -12,7 +12,7 @@
                             Size="BitPersonaSize.Size48"
                             Styles="@(new() { Image = "width:50%;height:50%" })"
                             ImageInitials="✓"
-                            Presence="@(IsOnline ? BitPersonaPresence.Online : BitPersonaPresence.Offline)"
+                            Presence="@(IsOnline is null ? BitPersonaPresence.None : IsOnline is true ? BitPersonaPresence.Online : BitPersonaPresence.Offline)"
                             ImageUrl="@($"/_content/Boilerplate.Client.Core/images/os/{GetImageUrl(currentSession.Device)}")" />
             </BitCard>
         }

diff --git a/...s/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Parameters.cs b/...s/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Parameters.cs
@@ -15,8 +15,9 @@ public class Parameters
 
     /// <summary>
     /// Determines the connection status, with default behavior based on SignalR connection status.
-    /// If SignalR is not added to the project during initial project creation, this value will always be true by default.
+    /// If SignalR is not added to the project during initial project creation, this value will always be null by default.
     /// Alternatively, you can implement custom logic to control this value.
+    /// true => Online, false => Offline, null => Unknown
     /// </summary>
     public const string IsOnline = nameof(IsOnline);
 }
diff --git a/...rplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AppTelemetryContext.cs b/...rplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AppTelemetryContext.cs
@@ -25,7 +25,5 @@ public class AppTelemetryContext : ITelemetryContext
 
     public string? Environment { get; set; } = AppEnvironment.Current;
 
-    //#if (signalR == true)
     public bool IsOnline { get; set; }
-    //#endif
 }
diff --git a/...plate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientPubSubMessages.cs b/...plate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientPubSubMessages.cs
@@ -10,14 +10,11 @@ public static partial class ClientPubSubMessages
     public const string OPEN_NAV_PANEL = nameof(OPEN_NAV_PANEL);
     public const string CULTURE_CHANGED = nameof(CULTURE_CHANGED);
     public const string PROFILE_UPDATED = nameof(PROFILE_UPDATED);
+    public const string IS_ONLINE_CHANGED = nameof(IS_ONLINE_CHANGED);
     public const string PAGE_TITLE_CHANGED = nameof(PAGE_TITLE_CHANGED);
     public const string ROUTE_DATA_UPDATED = nameof(ROUTE_DATA_UPDATED);
     public const string UPDATE_IDENTITY_HEADER_BACK_LINK = nameof(UPDATE_IDENTITY_HEADER_BACK_LINK);
     public const string IDENTITY_HEADER_BACK_LINK_CLICKED = nameof(IDENTITY_HEADER_BACK_LINK_CLICKED);
 
-    //#if (signalR == true)
-    public const string IS_ONLINE_CHANGED = nameof(IS_ONLINE_CHANGED);
-    //#endif
-
     public const string SHOW_DIAGNOSTIC_MODAL = nameof(SHOW_DIAGNOSTIC_MODAL);
 }
diff --git a/...it.Boilerplate/src/Client/Boilerplate.Client.Core/Services/Contracts/ITelemetryContext.cs b/...it.Boilerplate/src/Client/Boilerplate.Client.Core/Services/Contracts/ITelemetryContext.cs
@@ -44,9 +44,7 @@ public static ITelemetryContext? Current
 
     public string? Environment { get; set; }
 
-    //#if (signalR == true)
     public bool IsOnline { get; set; }
-    //#endif
 
     public Dictionary<string, object?> ToDictionary(Dictionary<string, object?>? additionalParameters = null)
     {
@@ -61,9 +59,7 @@ public static ITelemetryContext? Current
             { nameof(TimeZone), TimeZone },
             { nameof(Culture), Culture },
             { nameof(Environment), Environment },
-            //#if (signalR == true)
             { nameof(IsOnline), IsOnline }
-            //#endif
         };
 
         if (AppPlatform.IsBlazorHybrid)

diff --git a/...Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/ExceptionDelegatingHandler.cs b/...Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/ExceptionDelegatingHandler.cs
@@ -1,8 +1,12 @@
-using System.Net;
+//+:cnd:noEmit
+using System.Net;
 
 namespace Boilerplate.Client.Core.Services.HttpMessageHandlers;
 
 public partial class ExceptionDelegatingHandler(IStringLocalizer<AppStrings> localizer,
+    //#if (signalR != true)
+    PubSubService pubSubService,
+    //#endif
     JsonSerializerOptions jsonSerializerOptions, 
     HttpMessageHandler handler)
     : DelegatingHandler(handler)
@@ -57,5 +61,11 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
         {
             throw new ServerConnectionException(localizer[nameof(AppStrings.ServerConnectionException)], exp);
         }
+        //#if (signalR != true)
+        finally
+        {
+            pubSubService.Publish(ClientPubSubMessages.IS_ONLINE_CHANGED, serverCommunicationSuccess);
+        }
+        //#endif
     }
 }
diff --git a/...rplate/src/Client/Boilerplate.Client.Maui/Services/MauiAppInsightsTelemetryInitializer.cs b/...rplate/src/Client/Boilerplate.Client.Maui/Services/MauiAppInsightsTelemetryInitializer.cs
@@ -20,9 +20,7 @@ public void Initialize(ITelemetry telemetry)
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.UserAgent)] = ITelemetryContext.Current.UserAgent;
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.TimeZone)] = ITelemetryContext.Current.TimeZone;
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.Culture)] = ITelemetryContext.Current.Culture;
-            //#if (signalR == true)
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.IsOnline)] = ITelemetryContext.Current.IsOnline.ToString().ToLowerInvariant();
-            //#endif
         }
 
         telemetry.Context.Session.IsFirst = VersionTracking.IsFirstLaunchEver;

diff --git a/.../src/Client/Boilerplate.Client.Windows/Services/WindowsAppInsightsTelemetryInitializer.cs b/.../src/Client/Boilerplate.Client.Windows/Services/WindowsAppInsightsTelemetryInitializer.cs
@@ -20,9 +20,7 @@ public void Initialize(ITelemetry telemetry)
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.UserAgent)] = ITelemetryContext.Current.UserAgent;
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.TimeZone)] = ITelemetryContext.Current.TimeZone;
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.Culture)] = ITelemetryContext.Current.Culture;
-            //#if (signalR == true)
             telemetry.Context.GlobalProperties[nameof(ITelemetryContext.IsOnline)] = ITelemetryContext.Current.IsOnline.ToString().ToLowerInvariant();
-            //#endif
         }
     }
 }
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props b/src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props
@@ -63,7 +63,7 @@
         <!--/-:msbuild-conditional:noEmit -->
         <PackageVersion Include="Humanizer" Version="2.14.1" />
         <PackageVersion Include="QRCoder" Version="1.6.0" />
-        <PackageVersion Include="Magick.NET-Q16-AnyCPU" Version="14.0.0" />
+        <PackageVersion Include="Magick.NET-Q16-AnyCPU" Version="14.1.0" />
         <PackageVersion Include="FluentEmail.Smtp" Version="3.0.2" />
         <PackageVersion Include="FluentStorage" Version="5.6.0" />
         <PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.10" />