feat(templates): improve server-side exception handling in Boilerplate bitfoundation#10196 (bitfoundation#10199)

Author: ysmoradi

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Program.Services.cs

@@ -35,6 +35,7 @@ public static void ConfigureServices(this WebAssemblyHostBuilder builder)
             return httpClient;
         });
         services.AddKeyedScoped<HttpMessageHandler, HttpClientHandler>("PrimaryHttpMessageHandler");
+        services.AddScoped<IExceptionHandler, WebClientExceptionHandler>();
 
         services.AddTransient<IPrerenderStateService, WebClientPrerenderStateService>();
     }
@@ -45,8 +46,7 @@ public static void AddClientWebProjectServices(this IServiceCollection services,
         // The following services work both in blazor web assembly and server side for pre-rendering and blazor server.
 
         services.AddScoped<IBitDeviceCoordinator, WebDeviceCoordinator>();
-        services.AddScoped<IExceptionHandler, WebExceptionHandler>();
-        services.AddScoped<IStorageService, BrowserStorageService>();
+        services.AddScoped<IStorageService, WebStorageService>();
         //#if (notification == true)
         services.AddScoped<IPushNotificationService, WebPushNotificationService>();
         //#endif

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Services/WebExceptionHandler.cs src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Services/WebClientExceptionHandler.cs

@@ -1,6 +1,6 @@
 namespace Boilerplate.Client.Web.Services;
 
-public partial class WebExceptionHandler : ClientExceptionHandlerBase
+public partial class WebClientExceptionHandler : ClientExceptionHandlerBase
 {
     protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)
     {

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Services/BrowserStorageService.cs src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Services/WebStorageService.cs

@@ -2,7 +2,7 @@
 
 namespace Boilerplate.Client.Web.Services;
 
-public partial class BrowserStorageService : IStorageService
+public partial class WebStorageService : IStorageService
 {
     [AutoInject] private SessionStorage sessionStorage;
     [AutoInject] private LocalStorage localStorage;

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs

@@ -101,6 +101,7 @@ public static void AddServerApiProjectServices(this WebApplicationBuilder builde
                 var builder = policy.AddPolicy<AppResponseCachePolicy>();
             }, excludeDefaultPolicy: true);
         });
+        services.AddDistributedMemoryCache();
 
         services.AddHttpContextAccessor();
 

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/appsettings.json

@@ -158,7 +158,7 @@
         "BlazorMode": "BlazorServer",
         "BlazorMode_Comment": "BlazorServer, BlazorWebAssembly and BlazorAuto.",
         "PrerenderEnabled": false,
-        "PrerenderEnabled_Comment": "for apps with Prerender enabled, follow the instructions in the service-worker.published.js file"
+        "PrerenderEnabled_Comment": "for apps with Prerender enabled, follow the instructions in the Client.Web/wwwroot/service-worker.published.js file"
     },
     "ServerSideHttpClientBaseAddress": null,
     "ServerSideHttpClientBaseAddress_Comment": "Read ServerWebSettings.ServerSideHttpClientBaseAddress comments",

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Services.cs

@@ -48,6 +48,7 @@ public static void AddServerWebProjectServices(this WebApplicationBuilder builde
                 var builder = policy.AddPolicy<AppResponseCachePolicy>();
             }, excludeDefaultPolicy: true);
         });
+        services.AddDistributedMemoryCache();
 
         services.AddHttpContextAccessor();
 
@@ -107,8 +108,9 @@ private static void AddBlazor(WebApplicationBuilder builder)
         var configuration = builder.Configuration;
 
         services.AddTransient<IAntiforgery, NoOpAntiforgery>();
-        services.AddScoped<IAuthTokenProvider, ServerSideAuthTokenProvider>();
         services.AddTransient<IPrerenderStateService, WebServerPrerenderStateService>();
+        services.AddScoped<IExceptionHandler, WebServerExceptionHandler>();
+        services.AddScoped<IAuthTokenProvider, ServerSideAuthTokenProvider>();
         services.AddScoped(sp =>
         {
             // This HTTP client is utilized during pre-rendering and within Blazor Auto/Server sessions for API calls. 

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Services/WebServerExceptionHandler.cs

@@ -0,0 +1,26 @@
+using System.Net;
+using Boilerplate.Client.Core.Services;
+using Boilerplate.Client.Core.Services.Contracts;
+
+namespace Boilerplate.Server.Web.Services;
+
+public partial class WebServerExceptionHandler : ClientExceptionHandlerBase
+{
+    [AutoInject] IHttpContextAccessor httpContextAccessor = default!;
+
+    protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)
+    {
+        if (httpContextAccessor.HttpContext is not null && httpContextAccessor.HttpContext.Response.HasStarted is false)
+        {
+            // This method is invoked for exceptions occurring in Blazor Server and during pre-rendering.
+            // While setting a status code is not meaningful in Blazor Server or streaming pre-rendering 
+            // (since the response has already started), we can still set response codes for non-streaming pre-rendering scenarios.  
+            // A key factor that disables streaming during pre-rendering is response caching (see AppResponseCachePolicy.cs's AppResponseCachePolicy__DisableStreamPrerendering).  
+            // By setting the status code here, we ensure that a faulted response is not cached.
+            var statusCode = (int)(exception is RestException restExp ? restExp.StatusCode : HttpStatusCode.InternalServerError);
+            httpContextAccessor.HttpContext.Response.StatusCode = statusCode;
+        }
+
+        base.Handle(exception, displayKind, parameters);
+    }
+}

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/appsettings.json

@@ -118,7 +118,7 @@
         "BlazorMode": "BlazorServer",
         "BlazorMode_Comment": "BlazorServer, BlazorWebAssembly and BlazorAuto.",
         "PrerenderEnabled": false,
-        "PrerenderEnabled_Comment": "for apps with Prerender enabled, follow the instructions in the service-worker.published.js file"
+        "PrerenderEnabled_Comment": "for apps with Prerender enabled, follow the instructions in the Client.Web/wwwroot/service-worker.published.js file"
     },
     "ServerSideHttpClientBaseAddress": null,
     "ServerSideHttpClientBaseAddress_Comment": "Read ServerWebSettings.ServerSideHttpClientBaseAddress comments",