From 19be77ed49041cdce211ccf4ae124b73f86c7ed4 Mon Sep 17 00:00:00 2001
From: Shaun Walker <shaun.walker@siliqon.com>
Date: Mon, 22 Nov 2021 16:11:44 -0500
Subject: [PATCH] refactored ErrorBoundary implementation to support logging

---
 Oqtane.Client/Modules/HtmlText/Edit.razor     |   6 +-
 Oqtane.Client/Modules/HtmlText/Index.razor    |  14 +-
 .../Resources/Modules/HtmlText/Edit.resx      |   5 +-
 .../Resources/Modules/HtmlText/Index.resx     | 119 ++++++-------
 .../Resources/UI/ModuleInstance.resx          |   4 +-
 Oqtane.Client/UI/ModuleInstance.razor         | 156 ++++++++++--------
 6 files changed, 161 insertions(+), 143 deletions(-)

diff --git a/Oqtane.Client/Modules/HtmlText/Edit.razor b/Oqtane.Client/Modules/HtmlText/Edit.razor
index bc94cebc..5fc59bfc 100644
--- a/Oqtane.Client/Modules/HtmlText/Edit.razor
+++ b/Oqtane.Client/Modules/HtmlText/Edit.razor
@@ -65,8 +65,8 @@
         }
         catch (Exception ex)
         {
-            await logger.LogError(ex, "An Error Occurred Loading Html/Text Content. " + ex.Message);
-            AddModuleMessage(ex.Message, MessageType.Error);
+            await logger.LogError(ex, "Error Loading Content {Error}", ex.Message);
+            AddModuleMessage(Localizer["Error.Content.Load"], MessageType.Error);
         }
     }
 
@@ -91,7 +91,7 @@
                 await HtmlTextService.AddHtmlTextAsync(htmltext);
             }
 
-            await logger.LogInformation("Html/Text Content Saved {HtmlText}", htmltext);
+            await logger.LogInformation("Content Saved {HtmlText}", htmltext);
             NavigationManager.NavigateTo(NavigateUrl());
         }
         catch (Exception ex)
diff --git a/Oqtane.Client/Modules/HtmlText/Index.razor b/Oqtane.Client/Modules/HtmlText/Index.razor
index 57a95cef..4428d033 100644
--- a/Oqtane.Client/Modules/HtmlText/Index.razor
+++ b/Oqtane.Client/Modules/HtmlText/Index.razor
@@ -15,16 +15,16 @@
 }
 
 @code {
-    public override List<Resource> Resources => new List<Resource>()
+	public override List<Resource> Resources => new List<Resource>()
     {
         new Resource { ResourceType = ResourceType.Stylesheet, Url = ModulePath() + "Module.css" }
     };
 
-    private string content = "";
+	private string content = "";
 
-    protected override async Task OnParametersSetAsync()
-    {
-        try
+	protected override async Task OnParametersSetAsync()
+	{
+		try
         {
             var htmltext = await HtmlTextService.GetHtmlTextAsync(ModuleState.ModuleId);
             if (htmltext != null)
@@ -35,8 +35,8 @@
         }
         catch (Exception ex)
         {
-            await logger.LogError(ex, "An Error Occurred Loading Html/Text Content. " + ex.Message);
-            AddModuleMessage(ex.Message, MessageType.Error);
+			await logger.LogError(ex, "Error Loading Content {Error}", ex.Message);
+            AddModuleMessage(Localizer["Error.Content.Load"], MessageType.Error);
         }
     }
 }
\ No newline at end of file
diff --git a/Oqtane.Client/Resources/Modules/HtmlText/Edit.resx b/Oqtane.Client/Resources/Modules/HtmlText/Edit.resx
index 0439bfae..e2eed7a2 100644
--- a/Oqtane.Client/Resources/Modules/HtmlText/Edit.resx
+++ b/Oqtane.Client/Resources/Modules/HtmlText/Edit.resx
@@ -117,7 +117,10 @@
   <resheader name="writer">
     <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </resheader>
+  <data name="Error.Content.Load" xml:space="preserve">
+    <value>An Error Occurred Loading Content</value>
+  </data>
   <data name="Error.Content.Save" xml:space="preserve">
-    <value>Error Saving Content</value>
+    <value>An Error Occurred Saving Content</value>
   </data>
 </root>
\ No newline at end of file
diff --git a/Oqtane.Client/Resources/Modules/HtmlText/Index.resx b/Oqtane.Client/Resources/Modules/HtmlText/Index.resx
index 7c534702..1e0f92e6 100644
--- a/Oqtane.Client/Resources/Modules/HtmlText/Index.resx
+++ b/Oqtane.Client/Resources/Modules/HtmlText/Index.resx
@@ -1,65 +1,65 @@
 <?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
-            Microsoft ResX Schema 
+    Microsoft ResX Schema 
+    
+    Version 2.0
+    
+    The primary goals of this format is to allow a simple XML format 
+    that is mostly human readable. The generation and parsing of the 
+    various data types are done through the TypeConverter classes 
+    associated with the data types.
+    
+    Example:
+    
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+                
+    There are any number of "resheader" rows that contain simple 
+    name/value pairs.
+    
+    Each data row contains a name, and value. The row also contains a 
+    type or mimetype. Type corresponds to a .NET class that support 
+    text/value conversion through the TypeConverter architecture. 
+    Classes that don't support this are serialized and stored with the 
+    mimetype set.
+    
+    The mimetype is used for serialized objects, and tells the 
+    ResXResourceReader how to depersist the object. This is currently not 
+    extensible. For a given mimetype the value must be set accordingly:
+    
+    Note - application/x-microsoft.net.object.binary.base64 is the format 
+    that the ResXResourceWriter will generate, however the reader can 
+    read any of the formats listed below.
+    
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+    
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
 
-            Version 2.0
-
-            The primary goals of this format is to allow a simple XML format 
-            that is mostly human readable. The generation and parsing of the 
-            various data types are done through the TypeConverter classes 
-            associated with the data types.
-
-            Example:
-
-            ... ado.net/XML headers & schema ...
-            <resheader name="resmimetype">text/microsoft-resx</resheader>
-            <resheader name="version">2.0</resheader>
-            <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
-            <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
-            <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
-            <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
-            <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
-                <value>[base64 mime encoded serialized .NET Framework object]</value>
-            </data>
-            <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
-                <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
-                <comment>This is a comment</comment>
-            </data>
-
-            There are any number of "resheader" rows that contain simple 
-            name/value pairs.
-
-            Each data row contains a name, and value. The row also contains a 
-            type or mimetype. Type corresponds to a .NET class that support 
-            text/value conversion through the TypeConverter architecture. 
-            Classes that don't support this are serialized and stored with the 
-            mimetype set.
-
-            The mimetype is used for serialized objects, and tells the 
-            ResXResourceReader how to depersist the object. This is currently not 
-            extensible. For a given mimetype the value must be set accordingly:
-
-            Note - application/x-microsoft.net.object.binary.base64 is the format 
-            that the ResXResourceWriter will generate, however the reader can 
-            read any of the formats listed below.
-
-            mimetype: application/x-microsoft.net.object.binary.base64
-            value   : The object must be serialized with 
-                    : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
-                    : and then encoded with base64 encoding.
-
-            mimetype: application/x-microsoft.net.object.soap.base64
-            value   : The object must be serialized with 
-                    : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
-                    : and then encoded with base64 encoding.
-
-            mimetype: application/x-microsoft.net.object.bytearray.base64
-            value   : The object must be serialized into a byte array 
-                    : using a System.ComponentModel.TypeConverter
-                    : and then encoded with base64 encoding.
-            -->
-  <xsd:schema xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="root">
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array 
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
     <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
     <xsd:element name="root" msdata:IsDataSet="true">
       <xsd:complexType>
@@ -120,4 +120,7 @@
   <data name="Edit.Action" xml:space="preserve">
     <value>Edit</value>
   </data>
+  <data name="Error.Content.Load" xml:space="preserve">
+    <value>An Error Occurred Loading Content</value>
+  </data>
 </root>
\ No newline at end of file
diff --git a/Oqtane.Client/Resources/UI/ModuleInstance.resx b/Oqtane.Client/Resources/UI/ModuleInstance.resx
index a10f61d6..fc0994f2 100644
--- a/Oqtane.Client/Resources/UI/ModuleInstance.resx
+++ b/Oqtane.Client/Resources/UI/ModuleInstance.resx
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -124,6 +124,6 @@
     <value>Module Type Is Invalid For {0}</value>
   </data>
   <data name="Error.Module.Exception" xml:space="preserve">
-      <value>Program error in module {0}</value>
+      <value>An Unexpected Error Has Occurred</value>
   </data>
 </root>
\ No newline at end of file
diff --git a/Oqtane.Client/UI/ModuleInstance.razor b/Oqtane.Client/UI/ModuleInstance.razor
index f2bff75d..273892b9 100644
--- a/Oqtane.Client/UI/ModuleInstance.razor
+++ b/Oqtane.Client/UI/ModuleInstance.razor
@@ -1,92 +1,104 @@
 @namespace Oqtane.UI
 @inject IStringLocalizer<ModuleInstance> Localizer
+@inject ILogService LoggingService
+@inherits ErrorBoundary
 
-<ErrorBoundary>
-    <ErrorContent>
-        <ModuleMessage Message="@ErrorMessage(context)" Type="@MessageType.Error"/>
-    </ErrorContent>
-    <ChildContent>
-        <ModuleMessage Message="@_message" Type="@_messageType"/>
-        @if (ModuleType != null)
+@if (CurrentException is null)
+{
+    <ModuleMessage Message="@_message" Type="@_messageType"/>
+    @if (ModuleType != null)
+    {
+        <DynamicComponent Type="@ModuleType" Parameters="@ModuleParameters"></DynamicComponent>
+        @if (_progressIndicator)
         {
-            <DynamicComponent Type="@ModuleType" Parameters="@ModuleParameters"></DynamicComponent>
-            @if (_progressIndicator)
-            {
-                <div class="app-progress-indicator"></div>
-            }
+            <div class="app-progress-indicator"></div>
         }
-    </ChildContent>
-</ErrorBoundary>
+    }
+}
+else 
+{
+	@if (!string.IsNullOrEmpty(_error))
+	{
+		<ModuleMessage Message="@_error" Type="@MessageType.Error"/>
+	}
+}
 
 @code {
-    private string _message;
-    private MessageType _messageType;
-    private bool _progressIndicator = false;
+	private string _message;
+	private string _error;
+	private MessageType _messageType;
+	private bool _progressIndicator = false;
 
-    private Type ModuleType { get; set; }
-    private IDictionary<string, object> ModuleParameters { get; set; }
+	private Type ModuleType { get; set; }
+	private IDictionary<string, object> ModuleParameters { get; set; }
 
-    [CascadingParameter]
-    protected PageState PageState { get; set; }
+	[CascadingParameter]
+	protected PageState PageState { get; set; }
 
-    [CascadingParameter]
-    private Module ModuleState { get; set; }
+	[CascadingParameter]
+	private Module ModuleState { get; set; }
 
-    private ModuleMessage ModuleMessage { get; set; }
+	private ModuleMessage ModuleMessage { get; set; }
 
-    private RenderFragment DynamicComponent { get; set; }
+	protected override void OnParametersSet()
+	{
+		_message = "";
+		if (!string.IsNullOrEmpty(ModuleState.ModuleType))
+		{
+			ModuleType = Type.GetType(ModuleState.ModuleType);
+			if (ModuleType != null)
+			{
+				ModuleParameters = new Dictionary<string, object> { { "ModuleInstance", this } };
+				return;
+			}
+			// module does not exist with typename specified
+			_message = string.Format(Localizer["Error.Module.InvalidName"], Utilities.GetTypeNameLastSegment(ModuleState.ModuleType, 0));
+			_messageType = MessageType.Error;
+		}
+		else
+		{
+			_message = string.Format(Localizer["Error.Module.InvalidType"], ModuleState.ModuleDefinitionName);
+			_messageType = MessageType.Error;
+		}
+	}
 
-    protected override void OnParametersSet()
-    {
-        _message = "";
-        if (!string.IsNullOrEmpty(ModuleState.ModuleType))
-        {
-            ModuleType = Type.GetType(ModuleState.ModuleType);
-            if (ModuleType != null)
-            {
-                ModuleParameters = new Dictionary<string, object> { { "ModuleInstance", this } };
-                return;
-            }
-    // module does not exist with typename specified
-            _message = string.Format(Localizer["Error.Module.InvalidName"], Utilities.GetTypeNameLastSegment(ModuleState.ModuleType, 0));
-            _messageType = MessageType.Error;
-        }
-        else
-        {
-            _message = string.Format(Localizer["Error.Module.InvalidType"], ModuleState.ModuleDefinitionName);
-            _messageType = MessageType.Error;
-        }
-    }
+	public void AddModuleMessage(string message, MessageType type)
+	{
+		_message = message;
+		_messageType = type;
+		_progressIndicator = false;
+		StateHasChanged();
+	}
 
-    public void AddModuleMessage(string message, MessageType type)
-    {
-        _message = message;
-        _messageType = type;
-        _progressIndicator = false;
-        StateHasChanged();
-    }
+	public void ShowProgressIndicator()
+	{
+		_progressIndicator = true;
+		StateHasChanged();
+	}
 
-    public void ShowProgressIndicator()
-    {
-        _progressIndicator = true;
-        StateHasChanged();
-    }
+	public void HideProgressIndicator()
+	{
+		_progressIndicator = false;
+		StateHasChanged();
+	}
 
-    public void HideProgressIndicator()
-    {
-        _progressIndicator = false;
-        StateHasChanged();
-    }
+	protected override async Task OnErrorAsync(Exception exception)
+	{
+		// retrieve friendly localized error
+		_error =  Localizer["Error.Module.Exception"];
+		// log error
+		int? userId = (PageState.User != null) ? PageState.User.UserId : null;
+		string category = GetType().AssemblyQualifiedName;
+		string feature = Utilities.GetTypeNameLastSegment(category, 1);
+		await LoggingService.Log(null, ModuleState.PageId, ModuleState.ModuleId, userId, category, feature, LogFunction.Other, LogLevel.Error, exception, "An Unexpected Error Has Occurred In {ModuleDefinitionName}: {Error}", ModuleState.ModuleDefinitionName, exception.Message);
+		await base.OnErrorAsync(exception);
+		return;
+	}
 
-
-    private string ErrorMessage(Exception context)
-    {
-        var message = string.Format(Localizer["Error.Module.Exception"], ModuleState.ModuleDefinitionName);
-        if (UserSecurity.IsAuthorized(PageState.User, RoleNames.Host))
-        {
-            return $"{message}<br />{context}";
-        }
-        return message;
+	public new void Recover()
+	{
+		_error = "";
+		base.Recover();
     }
 
 }