feat(templates): improve Boilerplate exception handler's display error mechanism #9536 (#9537)

yasmoradi · web-flow · commit 4e3f66754915 · 2024-12-24T00:16:59.000+03:30
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/AppComponentBase.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/AppComponentBase.cs
@@ -260,6 +260,6 @@ private void HandleException(Exception exp,
         }
         parameters["ComponentType"] = GetType().FullName;
 
-        ExceptionHandler.Handle(exp, nonInterrupting: false, parameters, lineNumber, memberName, filePath);
+        ExceptionHandler.Handle(exp, displayKind: ExceptionDisplayKind.Interrupting, parameters, lineNumber, memberName, filePath);
     }
 }
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AuthManager.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AuthManager.cs
@@ -128,7 +128,7 @@ async Task RefreshTokenImplementation()
                 {
                     { "AdditionalData", "Refreshing access token failed." },
                     { "RefreshTokenRequestedBy", requestedBy }
-                }, nonInterrupting: exp is ReusedRefreshTokenException);
+                }, displayKind: exp is ReusedRefreshTokenException ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.Interrupting);
 
                 if (exp is UnauthorizedException // refresh token is also invalid.
                     || exp is ReusedRefreshTokenException && refreshToken == await storageService.GetItem("refresh_token"))
@@ -182,7 +182,7 @@ public async Task<bool> TryEnterElevatedAccessMode(CancellationToken cancellatio
         }
         catch (TooManyRequestsExceptions exp)
         {
-            exceptionHandler.Handle(exp, nonInterrupting: true); // Let's show prompt anyway.
+            exceptionHandler.Handle(exp, displayKind: ExceptionDisplayKind.NonInterrupting); // Let's show prompt anyway.
         }
 
         var token = await promptService.Show(localizer[AppStrings.EnterElevatedAccessToken], title: "Boilerplate", otpInput: true);
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientExceptionHandlerBase.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientExceptionHandlerBase.cs
@@ -12,7 +12,7 @@ public abstract partial class ClientExceptionHandlerBase : SharedExceptionHandle
     [AutoInject] protected readonly ILogger<ClientExceptionHandlerBase> Logger = default!;
 
     public void Handle(Exception exception,
-        bool nonInterrupting = false,
+        ExceptionDisplayKind displayKind = ExceptionDisplayKind.Interrupting,
         Dictionary<string, object?>? parameters = null,
         [CallerLineNumber] int lineNumber = 0,
         [CallerMemberName] string memberName = "",
@@ -25,11 +25,11 @@ public void Handle(Exception exception,
         parameters[nameof(lineNumber)] = lineNumber;
         parameters["exceptionId"] = Guid.NewGuid(); // This will remain consistent across different registered loggers, such as Sentry, Application Insights, etc.
 
-        Handle(exception, nonInterrupting, parameters.ToDictionary(i => i.Key, i => i.Value ?? string.Empty));
+        Handle(exception, displayKind, parameters.ToDictionary(i => i.Key, i => i.Value ?? string.Empty));
     }
 
     protected virtual void Handle(Exception exception,
-        bool nonInterrupting,
+        ExceptionDisplayKind displayKind,
         Dictionary<string, object> parameters)
     {
         var isDevEnv = AppEnvironment.IsDev();
@@ -50,16 +50,15 @@ protected virtual void Handle(Exception exception,
 
         string exceptionMessageToShow = GetExceptionMessageToShow(exception);
 
-        if (nonInterrupting)
+        if (displayKind is ExceptionDisplayKind.NonInterrupting)
         {
             SnackBarService.Error("Boilerplate", exceptionMessageToShow);
         }
-        else
+        else if (displayKind is ExceptionDisplayKind.Interrupting)
         {
             MessageBoxService.Show(exceptionMessageToShow, Localizer[nameof(AppStrings.Error)]);
         }
-
-        if (isDevEnv)
+        else if (displayKind is ExceptionDisplayKind.None && isDevEnv)
         {
             Debugger.Break();
         }
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/Contracts/IExceptionHandler.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/Contracts/IExceptionHandler.cs
@@ -2,10 +2,26 @@
 
 namespace Boilerplate.Client.Core.Services.Contracts;
 
+public enum ExceptionDisplayKind
+{
+    /// <summary>
+    /// No error message is shown to the user.
+    /// </summary>
+    None,
+    /// <summary>
+    /// Requires the user to acknowledge the error (e.g., by tapping "OK").
+    /// </summary>
+    Interrupting,
+    /// <summary>
+    /// Shows an auto-dismissed message (e.g., a toast notification)
+    /// </summary>
+    NonInterrupting
+}
+
 public interface IExceptionHandler
 {
-    void Handle(Exception exception, 
-        bool nonInterrupting = false,
+    void Handle(Exception exception,
+        ExceptionDisplayKind displayKind = ExceptionDisplayKind.Interrupting,
         Dictionary<string, object?>? parameters = null,
         [CallerLineNumber] int lineNumber = 0,
         [CallerMemberName] string memberName = "",
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/MauiProgram.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/MauiProgram.cs
@@ -201,7 +201,7 @@ private static void LogException(object? error, string reportedBy)
             services.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()
             {
                 { nameof(reportedBy), reportedBy }
-            }, nonInterrupting: true);
+            }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);
         }
         else
         {
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/Services/MauiExceptionHandler.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/Services/MauiExceptionHandler.cs
@@ -9,13 +9,13 @@ namespace Boilerplate.Client.Maui.Services;
 /// </summary>
 public partial class MauiExceptionHandler : ClientExceptionHandlerBase
 {
-    protected override void Handle(Exception exception, bool nonInterrupting, Dictionary<string, object> parameters)
+    protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)
     {
         exception = UnWrapException(exception);
 
         if (IgnoreException(exception))
             return;
 
-        base.Handle(exception, nonInterrupting, parameters);
+        base.Handle(exception, displayKind, parameters);
     }
 }
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Program.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Program.cs
@@ -80,7 +80,7 @@ private static void LogException(object? error, string reportedBy, WebAssemblyHo
             services.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()
             {
                 { nameof(reportedBy), reportedBy }
-            }, nonInterrupting: true);
+            }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);
         }
         else
         {
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Services/WebExceptionHandler.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Services/WebExceptionHandler.cs
@@ -2,13 +2,13 @@
 
 public partial class WebExceptionHandler : ClientExceptionHandlerBase
 {
-    protected override void Handle(Exception exception, bool nonInterrupting, Dictionary<string, object> parameters)
+    protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)
     {
         exception = UnWrapException(exception);
 
         if (IgnoreException(exception))
             return;
 
-        base.Handle(exception, nonInterrupting, parameters);
+        base.Handle(exception, displayKind, parameters);
     }
 }
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Program.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Program.cs
@@ -129,7 +129,7 @@ private static void LogException(object? error, string reportedBy)
             Services.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()
             {
                 { nameof(reportedBy), reportedBy }
-            }, nonInterrupting: true);
+            }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);
         }
         else
         {
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Services/WindowsExceptionHandler.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Services/WindowsExceptionHandler.cs
@@ -2,13 +2,13 @@
 
 public partial class WindowsExceptionHandler : ClientExceptionHandlerBase
 {
-    protected override void Handle(Exception exception, bool nonInterrupting, Dictionary<string, object> parameters)
+    protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)
     {
         exception = UnWrapException(exception);
 
         if (IgnoreException(exception))
             return;
 
-        base.Handle(exception, nonInterrupting, parameters);
+        base.Handle(exception, displayKind, parameters);
     }
 }
diff --git a/src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs b/src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs
@@ -61,7 +61,7 @@ private static void LogException(object? error, string reportedBy, WebApplicatio
             scope.ServiceProvider.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()
             {
                 { nameof(reportedBy), reportedBy }
-            }, nonInterrupting: true);
+            }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);
         }
         else
         {

Original file line number	Diff line number	Diff line change
`@@ -260,6 +260,6 @@ private void HandleException(Exception exp,`
`260`	`260`	`}`
`261`	`261`	`parameters["ComponentType"] = GetType().FullName;`
`262`	`262`
`263`		`- ExceptionHandler.Handle(exp, nonInterrupting: false, parameters, lineNumber, memberName, filePath);`
	`263`	`+ ExceptionHandler.Handle(exp, displayKind: ExceptionDisplayKind.Interrupting, parameters, lineNumber, memberName, filePath);`
`264`	`264`	`}`
`265`	`265`	`}`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ async Task RefreshTokenImplementation()`
`128`	`128`	`{`
`129`	`129`	`{ "AdditionalData", "Refreshing access token failed." },`
`130`	`130`	`{ "RefreshTokenRequestedBy", requestedBy }`
`131`		`- }, nonInterrupting: exp is ReusedRefreshTokenException);`
	`131`	`+ }, displayKind: exp is ReusedRefreshTokenException ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.Interrupting);`
`132`	`132`
`133`	`133`	`if (exp is UnauthorizedException // refresh token is also invalid.`
`134`	`134`	`\|\| exp is ReusedRefreshTokenException && refreshToken == await storageService.GetItem("refresh_token"))`
`@@ -182,7 +182,7 @@ public async Task<bool> TryEnterElevatedAccessMode(CancellationToken cancellatio`
`182`	`182`	`}`
`183`	`183`	`catch (TooManyRequestsExceptions exp)`
`184`	`184`	`{`
`185`		`- exceptionHandler.Handle(exp, nonInterrupting: true); // Let's show prompt anyway.`
	`185`	`+ exceptionHandler.Handle(exp, displayKind: ExceptionDisplayKind.NonInterrupting); // Let's show prompt anyway.`
`186`	`186`	`}`
`187`	`187`
`188`	`188`	`var token = await promptService.Show(localizer[AppStrings.EnterElevatedAccessToken], title: "Boilerplate", otpInput: true);`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public abstract partial class ClientExceptionHandlerBase : SharedExceptionHandle`
`12`	`12`	`[AutoInject] protected readonly ILogger<ClientExceptionHandlerBase> Logger = default!;`
`13`	`13`
`14`	`14`	`public void Handle(Exception exception,`
`15`		`- bool nonInterrupting = false,`
	`15`	`+ ExceptionDisplayKind displayKind = ExceptionDisplayKind.Interrupting,`
`16`	`16`	`Dictionary<string, object?>? parameters = null,`
`17`	`17`	`[CallerLineNumber] int lineNumber = 0,`
`18`	`18`	`[CallerMemberName] string memberName = "",`
`@@ -25,11 +25,11 @@ public void Handle(Exception exception,`
`25`	`25`	`parameters[nameof(lineNumber)] = lineNumber;`
`26`	`26`	`parameters["exceptionId"] = Guid.NewGuid(); // This will remain consistent across different registered loggers, such as Sentry, Application Insights, etc.`
`27`	`27`
`28`		`- Handle(exception, nonInterrupting, parameters.ToDictionary(i => i.Key, i => i.Value ?? string.Empty));`
	`28`	`+ Handle(exception, displayKind, parameters.ToDictionary(i => i.Key, i => i.Value ?? string.Empty));`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`protected virtual void Handle(Exception exception,`
`32`		`- bool nonInterrupting,`
	`32`	`+ ExceptionDisplayKind displayKind,`
`33`	`33`	`Dictionary<string, object> parameters)`
`34`	`34`	`{`
`35`	`35`	`var isDevEnv = AppEnvironment.IsDev();`
`@@ -50,16 +50,15 @@ protected virtual void Handle(Exception exception,`
`50`	`50`
`51`	`51`	`string exceptionMessageToShow = GetExceptionMessageToShow(exception);`
`52`	`52`
`53`		`- if (nonInterrupting)`
	`53`	`+ if (displayKind is ExceptionDisplayKind.NonInterrupting)`
`54`	`54`	`{`
`55`	`55`	`SnackBarService.Error("Boilerplate", exceptionMessageToShow);`
`56`	`56`	`}`
`57`		`- else`
	`57`	`+ else if (displayKind is ExceptionDisplayKind.Interrupting)`
`58`	`58`	`{`
`59`	`59`	`MessageBoxService.Show(exceptionMessageToShow, Localizer[nameof(AppStrings.Error)]);`
`60`	`60`	`}`
`61`		`-`
`62`		`- if (isDevEnv)`
	`61`	`+ else if (displayKind is ExceptionDisplayKind.None && isDevEnv)`
`63`	`62`	`{`
`64`	`63`	`Debugger.Break();`
`65`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ private static void LogException(object? error, string reportedBy)`
`201`	`201`	`services.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()`
`202`	`202`	`{`
`203`	`203`	`{ nameof(reportedBy), reportedBy }`
`204`		`- }, nonInterrupting: true);`
	`204`	`+ }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);`
`205`	`205`	`}`
`206`	`206`	`else`
`207`	`207`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,13 @@ namespace Boilerplate.Client.Maui.Services;`
`9`	`9`	`/// </summary>`
`10`	`10`	`public partial class MauiExceptionHandler : ClientExceptionHandlerBase`
`11`	`11`	`{`
`12`		`- protected override void Handle(Exception exception, bool nonInterrupting, Dictionary<string, object> parameters)`
	`12`	`+ protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)`
`13`	`13`	`{`
`14`	`14`	`exception = UnWrapException(exception);`
`15`	`15`
`16`	`16`	`if (IgnoreException(exception))`
`17`	`17`	`return;`
`18`	`18`
`19`		`- base.Handle(exception, nonInterrupting, parameters);`
	`19`	`+ base.Handle(exception, displayKind, parameters);`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ private static void LogException(object? error, string reportedBy, WebAssemblyHo`
`80`	`80`	`services.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()`
`81`	`81`	`{`
`82`	`82`	`{ nameof(reportedBy), reportedBy }`
`83`		`- }, nonInterrupting: true);`
	`83`	`+ }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);`
`84`	`84`	`}`
`85`	`85`	`else`
`86`	`86`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,13 @@`
`2`	`2`
`3`	`3`	`public partial class WebExceptionHandler : ClientExceptionHandlerBase`
`4`	`4`	`{`
`5`		`- protected override void Handle(Exception exception, bool nonInterrupting, Dictionary<string, object> parameters)`
	`5`	`+ protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)`
`6`	`6`	`{`
`7`	`7`	`exception = UnWrapException(exception);`
`8`	`8`
`9`	`9`	`if (IgnoreException(exception))`
`10`	`10`	`return;`
`11`	`11`
`12`		`- base.Handle(exception, nonInterrupting, parameters);`
	`12`	`+ base.Handle(exception, displayKind, parameters);`
`13`	`13`	`}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ private static void LogException(object? error, string reportedBy)`
`129`	`129`	`Services.GetRequiredService<IExceptionHandler>().Handle(exp, parameters: new()`
`130`	`130`	`{`
`131`	`131`	`{ nameof(reportedBy), reportedBy }`
`132`		`- }, nonInterrupting: true);`
	`132`	`+ }, displayKind: AppEnvironment.IsDev() ? ExceptionDisplayKind.NonInterrupting : ExceptionDisplayKind.None);`
`133`	`133`	`}`
`134`	`134`	`else`
`135`	`135`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,13 @@`
`2`	`2`
`3`	`3`	`public partial class WindowsExceptionHandler : ClientExceptionHandlerBase`
`4`	`4`	`{`
`5`		`- protected override void Handle(Exception exception, bool nonInterrupting, Dictionary<string, object> parameters)`
	`5`	`+ protected override void Handle(Exception exception, ExceptionDisplayKind displayKind, Dictionary<string, object> parameters)`
`6`	`6`	`{`
`7`	`7`	`exception = UnWrapException(exception);`
`8`	`8`
`9`	`9`	`if (IgnoreException(exception))`
`10`	`10`	`return;`
`11`	`11`
`12`		`- base.Handle(exception, nonInterrupting, parameters);`
	`12`	`+ base.Handle(exception, displayKind, parameters);`
`13`	`13`	`}`
`14`	`14`	`}`