[Add] Serilog logging and replace console.writeline with logger state…

…ments
STARIONGROUP · Dec 29, 2021 · 02fa5ef · 02fa5ef
1 parent 01b8ba4
commit 02fa5ef
Show file tree

Hide file tree

Showing 24 changed files with 111 additions and 38 deletions.
diff --git a/ReqifViewer.Infrastructure/ReqifViewer.Infrastructure.csproj b/ReqifViewer.Infrastructure/ReqifViewer.Infrastructure.csproj
@@ -12,9 +12,9 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="DevExpress.Xpo" Version="20.1.8" />
     <PackageReference Include="Microsoft.AspNetCore.Components" Version="5.0.13" />
     <PackageReference Include="Microsoft.AspNetCore.WebUtilities" Version="2.2.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.0" />
     <PackageReference Include="ReqIFSharp" Version="5.0.0-rc4" />
   </ItemGroup>
 

diff --git a/ReqifViewer.Infrastructure/Services/ReqIFLoaderService.cs b/ReqifViewer.Infrastructure/Services/ReqIFLoaderService.cs
@@ -23,10 +23,14 @@ namespace ReqifViewer.Infrastructure.Services
     using System;
     using System.Collections.Concurrent;
     using System.Collections.Generic;
+    using System.Diagnostics;
     using System.IO;
     using System.Threading;
     using System.Threading.Tasks;
 
+    using Microsoft.Extensions.Logging;
+    using Microsoft.Extensions.Logging.Abstractions;
+
     using ReqIFSharp;
 
     /// <summary>
@@ -35,8 +39,27 @@ namespace ReqifViewer.Infrastructure.Services
     /// </summary>
     public class ReqIFLoaderService : IReqIFLoaderService
     {
+        /// <summary>
+        /// the <see cref="Stream"/> that holds a copy of the stream the reqif was loaded from
+        /// </summary>
         private Stream sourceStream;
 
+        /// <summary>
+        /// The <see cref="ILogger"/> used to log
+        /// </summary>
+        private readonly ILogger<ReqIFLoaderService> logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ReqIFLoaderService"/>
+        /// </summary>
+        /// <param name="logger">
+        /// The (injected) logger
+        /// </param>
+        public ReqIFLoaderService(ILogger<ReqIFLoaderService> logger = null)
+        {
+            this.logger = logger ?? NullLogger<ReqIFLoaderService>.Instance;
+        }
+
         /// <summary>
         /// a thread safe cache where the data associated to an <see cref="ExternalObject"/> is stored
         /// </summary>
@@ -88,13 +111,17 @@ public async Task Load(Stream reqIFStream, CancellationToken token)
 
             var deserializationStream = new MemoryStream();
 
+            this.logger.LogDebug("copying the reqif stream to the deserialization stream for deserialization");
+
             reqIFStream.Seek(0, SeekOrigin.Begin);
             await reqIFStream.CopyToAsync(deserializationStream, token);
             if (deserializationStream.Position != 0)
             {
                 deserializationStream.Seek(0, SeekOrigin.Begin);
             }
 
+            this.logger.LogDebug("copying the reqif stream to the source stream for safe keeping");
+
             reqIFStream.Seek(0, SeekOrigin.Begin);
             await reqIFStream.CopyToAsync(this.sourceStream, token);
             if (this.sourceStream.Position != 0)
@@ -105,8 +132,12 @@ public async Task Load(Stream reqIFStream, CancellationToken token)
             IEnumerable<ReqIF> result = null;
 
             var reqIfDeserializer = new ReqIFDeserializer();
+
+            var sw = Stopwatch.StartNew();
+            this.logger.LogDebug("starting deserialization");
             result = await reqIfDeserializer.DeserializeAsync(deserializationStream, token);
-
+            this.logger.LogDebug("deserialization finished in {time} [ms]", sw.ElapsedMilliseconds);
+
             await deserializationStream.DisposeAsync();
 
             this.ReqIFData = result;
@@ -138,6 +169,8 @@ public async Task<string> QueryData(ExternalObject externalObject, CancellationT
 
             if (externalObjectDataCache.TryGetValue(externalObject, out var result))
             {
+                this.logger.LogDebug("External Object {uri} retrieved from Cache", externalObject.Uri);
+
                 return result;
             }
 
@@ -149,21 +182,26 @@ public async Task<string> QueryData(ExternalObject externalObject, CancellationT
 
             result = $"data:{externalObject.MimeType};base64,{Convert.ToBase64String(targetStream.ToArray())}";
 
-            this.externalObjectDataCache.TryAdd(externalObject, result);
-
+            if (this.externalObjectDataCache.TryAdd(externalObject, result))
+            {
+                this.logger.LogDebug("External Object {uri} added to Cache", externalObject.Uri);
+            }
+
             return result;
         }
 
         /// <summary>
         /// Resets the <see cref="ReqIFLoaderService"/> by clearing <see cref="ReqIFData"/> and
-        /// <see cref="SourceStream"/>
+        /// <see cref="sourceStream"/>
         /// </summary>
         public void Reset()
         {
             this.sourceStream = null;
             this.ReqIFData = null;
             this.externalObjectDataCache.Clear();
 
+            this.logger.LogDebug("loader service reset");
+
             ReqIfChanged?.Invoke(this, null);
         }
 

diff --git a/reqifviewer/Components/AttributeDefinitionsComponent.razor b/reqifviewer/Components/AttributeDefinitionsComponent.razor
@@ -16,6 +16,7 @@
 
 @using ReqIFSharp;
 @using ReqifViewer.Infrastructure.ReqIFExtensions
+@using Serilog;
 
 <RadzenDataGrid Data="@this.AttributeDefinitions" AllowFiltering="true" AllowColumnResize="true" TItem="AttributeDefinition">
     <Columns>
@@ -54,7 +55,7 @@
     /// The unique identifier of the container reqif document
     /// </summary>
     private string reqifIdentifier;
-    
+
     protected override void OnParametersSet()
     {
         var attributeDefinition = this.AttributeDefinitions.FirstOrDefault();
@@ -65,7 +66,7 @@
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<AttributeDefinitionsComponent>().Error(e, "OnParametersSet Failed");
         }
     }
 }
diff --git a/reqifviewer/Components/AttributeValuesComponent.razor b/reqifviewer/Components/AttributeValuesComponent.razor
@@ -17,6 +17,7 @@
 @using ReqIFSharp;
 @using System.Text
 @using ReqifViewer.Infrastructure.ReqIFExtensions
+@using Serilog
 
 <RadzenFieldset AllowCollapse="true" Style="margin-bottom: 10px;">
 
@@ -124,9 +125,9 @@
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<AttributeValuesComponent>().Error(e, "QueryAttributeDefinitionUrl Failed");
         }
 
         return result;
     }
-    }
+}
diff --git a/reqifviewer/Components/SpecObjectComponent.razor b/reqifviewer/Components/SpecObjectComponent.razor
@@ -16,8 +16,8 @@
 
 @using System.Globalization
 @using System.Text
-
 @using ReqIFSharp
+@using Serilog
 
 <RadzenFieldset AllowCollapse="true" Style="margin-bottom: 10px;">
 
@@ -129,7 +129,7 @@
             }
             catch (Exception e)
             {
-                Console.WriteLine(e);
+                Log.ForContext<SpecObjectComponent>().Error(e, "QuerySpecObjectTypeUrl Failed");
             }
 
             return result;

diff --git a/reqifviewer/Components/SpecificationsComponent.razor b/reqifviewer/Components/SpecificationsComponent.razor
@@ -16,6 +16,7 @@
 
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqIFSharp
+@using Serilog
 
 <RadzenDataGrid PageSize="10" AllowPaging="true" AllowSorting="true" AllowFiltering="true" AllowColumnResize="true" Data="@this.Specifications" TItem="Specification">
     <Columns>
@@ -60,7 +61,7 @@
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<SpecificationsComponent>().Error(e, "OnParametersSet Failed");
         }
     }
 }
diff --git a/reqifviewer/Pages/AttributeDefinition/AttributeDefinitionDetailsPage.razor b/reqifviewer/Pages/AttributeDefinition/AttributeDefinitionDetailsPage.razor
@@ -17,10 +17,10 @@
 @page "/reqif/{ReqIF}/spectype/{SpecType}/attributedefinition/{Identifier}"
 
 @using System.Globalization
-
 @using ReqIFSharp
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqifViewer.Infrastructure.Services
+@using Serilog; 
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -143,7 +143,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<AttributeDefinitionDetailsPage>().Error(e, "QuerySpecObjectTypeUrl Failed");
         }
         finally
         {

diff --git a/reqifviewer/Pages/DataTypeDefinition/DataTypeDefinitionDetailsPage.razor b/reqifviewer/Pages/DataTypeDefinition/DataTypeDefinitionDetailsPage.razor
@@ -19,6 +19,7 @@
 @using ReqIFSharp
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqifViewer.Infrastructure.Services
+@using Serilog;
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -198,7 +199,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<DataTypeDefinitionDetailsPage>().Error(e, "LoadData Failed");
         }
         finally
         {

diff --git a/reqifviewer/Pages/DataTypeDefinition/DataTypeDefinitionPage.razor b/reqifviewer/Pages/DataTypeDefinition/DataTypeDefinitionPage.razor
@@ -19,6 +19,7 @@
 @using ReqIFSharp
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqifViewer.Infrastructure.Services
+@using Serilog 
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -114,7 +115,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<DataTypeDefinitionPage>().Error(e, "LoadData Failed");
         }
         finally
         {

diff --git a/reqifviewer/Pages/ExternalObjects/ExternalObjectDetailsPage.razor b/reqifviewer/Pages/ExternalObjects/ExternalObjectDetailsPage.razor
@@ -20,6 +20,7 @@
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqifViewer.Infrastructure.Services
 @using System.Threading
+@using Serilog
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -80,7 +81,7 @@ else
 
         await this.LoadData();
     }
-    
+
     /// <summary>
     /// Load the data into view-models
     /// </summary>
@@ -102,7 +103,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<ExternalObjectDetailsPage>().Error(e, "LoadData Failed");
         }
         finally
         {
@@ -121,7 +122,5 @@ else
         }
 
         return "";
-
     }
-
 }
diff --git a/reqifviewer/Pages/ExternalObjects/ExternalObjectPage.razor b/reqifviewer/Pages/ExternalObjects/ExternalObjectPage.razor
@@ -19,6 +19,7 @@
 @using ReqIFSharp
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqifViewer.Infrastructure.Services
+@using Serilog 
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -110,7 +111,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<ExternalObjectPage>().Error(e, "LoadData Failed");
         }
         finally
         {

diff --git a/reqifviewer/Pages/Index/IndexPage.razor b/reqifviewer/Pages/Index/IndexPage.razor
@@ -22,6 +22,7 @@
 @using System.Threading
 @using ReqIFSharp
 @using ReqifViewer.Infrastructure.Services
+@using Serilog;
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -113,10 +114,14 @@ else
         if (this.reqIfLoaderService.ReqIFData == null || !this.reqIfLoaderService.ReqIFData.Any())
         {
             this.reqIfs = null;
+
+            Log.ForContext<IndexPage>().Debug("no ReqIF loaded");
         }
         else
         {
             this.reqIfs = this.reqIfLoaderService.ReqIFData;
+
+            Log.ForContext<IndexPage>().Debug("a Total of {amount} ReqIF loaded", this.reqIfs.Count());
         }
     }
 
@@ -143,7 +148,7 @@ else
 
         this.reqifisAvailable = true;
 
-        Console.WriteLine($"IndexPage: file read into stream in {sw.ElapsedMilliseconds} [ms]");
+        Log.ForContext<IndexPage>().Information("file read into stream in {time} [ms]" , sw.ElapsedMilliseconds);
     }
 
     /// <summary>
@@ -176,15 +181,15 @@ else
             await this.reqIfLoaderService.Load(this.reqifStream, this.cancellationTokenSource.Token);
             this.reqIfs = this.reqIfLoaderService.ReqIFData;
 
-            Console.WriteLine($"IndexPage: a total  of {this.reqIfs.Count()} ReqIF objects deserialized in {sw.ElapsedMilliseconds} [ms]");
+            Log.ForContext<IndexPage>().Information("a total of {amount} ReqIF objects deserialized in {time} [ms]", this.reqIfs.Count(), sw.ElapsedMilliseconds);
         }
         catch (TaskCanceledException)
         {
-            Console.WriteLine("IndexPage: Load was cancelled");
+            Log.ForContext<IndexPage>().Information("Load was cancelled");
         }
         catch (Exception e)
         {
-            Console.WriteLine($"IndexPage: {e}");
+            Log.ForContext<IndexPage>().Error(e, "load reqif failed");
         }
         finally
         {

diff --git a/reqifviewer/Pages/ReqIF/ReqIFStatistics.razor b/reqifviewer/Pages/ReqIF/ReqIFStatistics.razor
@@ -20,6 +20,7 @@
 @using ReqIFSharp
 @using ReqifViewer.Infrastructure.ReqIFExtensions
 @using ReqifViewer.Infrastructure.Services
+@using Serilog
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -280,7 +281,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<ReqIFStatistics>().Error(e, "OnParametersSet Failed");
         }
         finally
         {

diff --git a/reqifviewer/Pages/SpecObject/SpecObjectDetailsPage.razor b/reqifviewer/Pages/SpecObject/SpecObjectDetailsPage.razor
@@ -21,6 +21,7 @@
 @using ReqifViewer.Infrastructure.Services
 @using reqifviewer.Components
 @using System.Threading
+@using Serilog
 
 @inject IReqIFLoaderService reqIfLoaderService
 
@@ -184,7 +185,7 @@ else
         }
         catch (Exception e)
         {
-            Console.WriteLine(e);
+            Log.ForContext<SpecObjectDetailsPage>().Error(e, "LoadData Failed");
         }
         finally
         {