fixing log counts

Author: SharePointRadi

src/OneBitSoftware.Utilities.OperationResult/Errors/IOperationError.cs

@@ -1,11 +1,23 @@
 namespace OneBitSoftware.Utilities.Errors
 {
+    using Microsoft.Extensions.Logging;
+
     public interface IOperationError
     {
         int? Code { get; set; }
 
         string? Message { get; set; }
 
         string? Details { get; set; }
+
+        /// <summary>
+        /// Defines if the error is logged or not. Used when merging <cref="OperationResult"/> instances and one of them does not have an ILogger.
+        /// </summary>
+        bool Logged { get; internal set; }
+
+        /// <summary>
+        /// Defines the log level for the error.
+        /// </summary>
+        LogLevel? LogLevel { get; set; }
     }
 }

src/OneBitSoftware.Utilities.OperationResult/Errors/OperationError.cs

@@ -1,6 +1,7 @@
 namespace OneBitSoftware.Utilities.Errors
 {
     using System.Text;
+    using Microsoft.Extensions.Logging;
 
     public class OperationError : IOperationError
     {
@@ -17,12 +18,20 @@ public OperationError(string? message = null, int? code = null, string? details
 
         public string? Details { get; set; }
 
+        /// <inheritdoc />
+        public LogLevel? LogLevel { get; set; }
+
+        /// <inheritdoc />
+        bool IOperationError.Logged { get; set; }
+
         public override string ToString()
         {
             var result = new StringBuilder();
 
             if (this.Code != null) result.AppendLine($"Code: {this.Code}");
 
+            if (this.LogLevel is not null) result.AppendLine($"Severity: {this.LogLevel}"); // TODO: maybe convert to string?
+
             if (!string.IsNullOrWhiteSpace(this.Message)) result.AppendLine($"Message: {this.Message}");
 
             if (!string.IsNullOrWhiteSpace(this.Details)) result.AppendLine($"Trace: {this.Details}");

src/OneBitSoftware.Utilities.OperationResult/OperationResult.cs

@@ -98,11 +98,10 @@ public OperationResult AppendErrors(OperationResult otherOperationResult)
                 this.AppendErrorInternal(error);
 
                 // Logs messages if the other operation result does not have a logger
-                // BUG: We don't know the severity of the message and need to assume a level.
-                // The task is to make IOperationError have info about the severity, so it can be used here
-                if (this._logger is not null && otherOperationResult._logger is null)
+                if (this._logger is not null && otherOperationResult._logger is null && !error.Logged)
                 {
-                    this._logger.Log(LogLevel.Error, error.Message);
+                    this._logger.Log(GetLogLevel(error.LogLevel), error.Message);
+                    error.Logged = true;
                 }
             }
 
@@ -159,9 +158,8 @@ public OperationResult AppendError(IOperationError error, LogLevel? logLevel = L
 
             if (this._logger != null)
             {
-#pragma warning disable CA2254 // Template should be a static expression
                 this._logger.Log(GetLogLevel(logLevel), error.Message);
-#pragma warning restore CA2254 // Template should be a static expression
+                error.Logged = true;
             }
 
             return this;
@@ -220,7 +218,6 @@ public static OperationResult FromError(string message, int? code = null, LogLev
             return result.AppendError(message, code, logLevel, details);
         }
 
-        // TODO: this method needs completing.
         protected static LogLevel GetLogLevel(LogLevel? optionalLevel) => optionalLevel ?? LogLevel.Error;
 
         /// <summary>
@@ -294,26 +291,6 @@ public OperationResult(TResult resultObject) : base()
             return this;
         }
 
-        /// <summary>
-        /// Appends an <see cref="IOperationError"/> to the internal errors collection.
-        /// </summary>
-        /// <param name="error">An instance of <see cref="IOperationError"/> to add to the internal errors collection.</param>
-        /// <param name="logLevel">The logging level.</param>
-        /// <returns>The current instance of the <see cref="OperationResult"/>.</returns>
-        public new OperationResult<TResult> AppendError(IOperationError error, LogLevel? logLevel = LogLevel.Error)
-        {
-            base.AppendErrorInternal(error);
-
-            if (this._logger != null)
-            {
-#pragma warning disable CA2254 // Template should be a static expression
-                this._logger.Log(GetLogLevel(logLevel), error.Message);
-#pragma warning restore CA2254 // Template should be a static expression
-            }
-
-            return this;
-        }
-
         /// <summary>
         /// Appends error messages from <paramref name="otherOperationResult"/> to the current instance.
         /// </summary>

src/OneBitSoftware.Utilities.OperationResult/PolymorphicOperationErrorSerializer.cs

@@ -54,7 +54,7 @@ public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions
             if (this._typeMappings.TryGetValue(value.GetType(), out var typeValue) == false) throw new InvalidOperationException($"Model of type {value.GetType()} cannot be successfully serialized.");
 
             var tempBufferWriter = new ArrayBufferWriter<byte>();
-            var tempWriter = new Utf8JsonWriter(tempBufferWriter);
+            var tempWriter = new Utf8JsonWriter(tempBufferWriter); // TODO: dispose with using var
 
             var fallbackDeserializationOptions = this.ConstructSafeFallbackOptions(options);
             JsonSerializer.Serialize(tempWriter, value, value.GetType(), fallbackDeserializationOptions);

tests/OneBitSoftware.Utilities.OperationResultTests/OperationResultAppendErrorsTests.cs

@@ -144,7 +144,23 @@ public void AppendErrors_ShouldLogOnceWhenCreatedWithALogger()
         Assert.Equal(1, testLogger.LogMessages.Count);
     }
 
+    [Fact]
+    public void AppendErrors_ShouldLogOnceWhenNestingWithALogger()
+    {
+        // Arrange
+        var testLogger = new TestLogger();
+        var operationResultWithLogger = new OperationResult(testLogger);
+        var operationResultWithLogger2 = new OperationResult(testLogger);
+        var operationResultWithLogger3 = new OperationResult(testLogger);
 
+        // Act
+        operationResultWithLogger3.AppendError("test1");
+        operationResultWithLogger2.AppendError("test2");
+        operationResultWithLogger.AppendErrors(operationResultWithLogger2);
+
+        // Assert
+        Assert.Equal(2, testLogger.LogMessages.Count);
+    }
 
     [Fact]
     public void AppendErrors_ShouldLogWhenCreatedWithNoLogger()