NLogLogger - Move some complexity out of Log-method

NLog · Aug 3, 2018 · c2c50c9 · c2c50c9
1 parent bfea328
commit c2c50c9
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 32 deletions.
diff --git a/src/NLog.Extensions.Logging/Logging/NLogLogger.cs b/src/NLog.Extensions.Logging/Logging/NLogLogger.cs
@@ -1,9 +1,6 @@
 using System;
-using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Reflection;
 using Microsoft.Extensions.Logging;
-using NLog.Common;
 using NLog.MessageTemplates;
 
 namespace NLog.Extensions.Logging
@@ -87,26 +84,18 @@ private LogEventInfo CreateLogEventInfo(LogLevel nLogLogLevel, string formattedM
         /// </remarks>
         private LogEventInfo TryParseMessageTemplate(LogLevel nLogLogLevel, IReadOnlyList<KeyValuePair<string, object>> messageProperties, out NLogMessageParameterList messageParameters)
         {
-            messageParameters = (messageProperties != null && _options.CaptureMessageTemplates)
-                ? NLogMessageParameterList.TryParse(messageProperties)
-                : null;
+            messageParameters = TryParseMessageParameterList(messageProperties);
 
-            if ((messageParameters?.HasOriginalMessage ?? false) && (messageParameters.HasComplexParameters || (_options.ParseMessageTemplates && messageParameters.Count > 0)))
+            if (messageParameters?.HasMessageTemplateSyntax(_options.ParseMessageTemplates)==true)
             {
-                // NLog MessageTemplate Parser must be used
                 var originalMessage = messageParameters.GetOriginalMessage(messageProperties);
                 var eventInfo = new LogEventInfo(nLogLogLevel, _logger.Name, null, originalMessage, _singleItemArray);
                 var messagetTemplateParameters = eventInfo.MessageTemplateParameters;   // Forces parsing of OriginalMessage
                 if (messagetTemplateParameters.Count > 0)
                 {
                     // We have parsed the message and found parameters, now we need to do the parameter mapping
                     eventInfo.Parameters = CreateLogEventInfoParameters(messageParameters, messagetTemplateParameters, out var extraProperties);
-                    if (extraProperties?.Count > 0)
-                    {
-                        // Need to harvest additional parameters
-                        foreach (var property in extraProperties)
-                            eventInfo.Properties[property.Name] = property.Value;
-                    }
+                    AddExtraPropertiesToLogEvent(eventInfo, extraProperties);
                     return eventInfo;
                 }
 
@@ -116,6 +105,31 @@ private LogEventInfo TryParseMessageTemplate(LogLevel nLogLogLevel, IReadOnlyLis
             return null;    // Parsing not needed
         }
 
+        /// <summary>
+        /// Convert IReadOnlyList to <see cref="NLogMessageParameterList"/>
+        /// </summary>
+        /// <param name="messageProperties"></param>
+        /// <returns></returns>
+        private NLogMessageParameterList TryParseMessageParameterList(IReadOnlyList<KeyValuePair<string, object>> messageProperties)
+        {
+            return (messageProperties != null && _options.CaptureMessageTemplates)
+                ? NLogMessageParameterList.TryParse(messageProperties)
+                : null;
+        }
+
+        /// <summary>
+        /// Append extra property on <paramref name="eventInfo"/>
+        /// </summary>
+        private static void AddExtraPropertiesToLogEvent(LogEventInfo eventInfo, List<MessageTemplateParameter> extraProperties)
+        {
+            if (extraProperties?.Count > 0)
+            {
+                // Need to harvest additional parameters
+                foreach (var property in extraProperties)
+                    eventInfo.Properties[property.Name] = property.Value;
+            }
+        }
+
         private LogEventInfo TryCaptureMessageTemplate(LogLevel nLogLogLevel, string message, IReadOnlyList<KeyValuePair<string, object>> messageProperties, NLogMessageParameterList messageParameters)
         {
             if (messageParameters?.HasComplexParameters == false)
@@ -233,8 +247,7 @@ private static object[] CreateStructuredLogEventInfoParameters(NLogMessageParame
 
                 if (extraProperty)
                 {
-                    extraProperties = extraProperties ?? new List<MessageTemplateParameter>();
-                    extraProperties.Add(messageParameters[i]);
+                    extraProperties = AddExtraProperty(extraProperties, messageParameters[i]);
                 }
             }
 
@@ -262,14 +275,26 @@ private static object[] CreatePositionalLogEventInfoParameters(NLogMessageParame
                 }
                 else
                 {
-                    extraProperties = extraProperties ?? new List<MessageTemplateParameter>();
-                    extraProperties.Add(messageParameters[i]);
+                    extraProperties = AddExtraProperty(extraProperties, messageParameters[i]);
                 }
             }
 
             return paramsArray ?? new object[maxIndex + 1];
         }
 
+        /// <summary>
+        /// Add Property and init list if needed
+        /// </summary>
+        /// <param name="extraProperties"></param>
+        /// <param name="item"></param>
+        /// <returns>list with at least one item</returns>
+        private static List<MessageTemplateParameter> AddExtraProperty(List<MessageTemplateParameter> extraProperties, MessageTemplateParameter item)
+        {
+            extraProperties = extraProperties ?? new List<MessageTemplateParameter>();
+            extraProperties.Add(item);
+            return extraProperties;
+        }
+
         /// <summary>
         /// Find max index of the parameters
         /// </summary>

diff --git a/src/NLog.Extensions.Logging/Logging/NLogMessageParameterList.cs b/src/NLog.Extensions.Logging/Logging/NLogMessageParameterList.cs
@@ -44,23 +44,23 @@ public NLogMessageParameterList(IReadOnlyList<KeyValuePair<string, object>> para
         /// </remarks>
         public static NLogMessageParameterList TryParse(IReadOnlyList<KeyValuePair<string, object>> parameterList)
         {
-            if (parameterList != null)
+            if (parameterList.Count > 1 || parameterList[0].Key != NLogLogger.OriginalFormatPropertyName)
             {
-                if (parameterList.Count > 1 || parameterList[0].Key != NLogLogger.OriginalFormatPropertyName)
-                {
-                    return new NLogMessageParameterList(parameterList);
-                }
-                else if (parameterList.Count == 1)
-                {
-                    return OriginalMessageList; // Skip allocation
-                }
-                else if (parameterList.Count == 0)
-                {
-                    return EmptyList;           // Skip allocation
-                }
+                return new NLogMessageParameterList(parameterList);
+            }
+            else if (parameterList.Count == 1)
+            {
+                return OriginalMessageList; // Skip allocation
+            }
+            else
+            {
+                return EmptyList;           // Skip allocation
             }
+        }
 
-            return null;
+        public bool HasMessageTemplateSyntax(bool parseMessageTemplates)
+        {
+            return HasOriginalMessage && (HasComplexParameters || (parseMessageTemplates && Count > 0));
         }
 
         public string GetOriginalMessage(IReadOnlyList<KeyValuePair<string, object>> messageProperties)