Merge pull request #6 from NLog/snakefoot-master3

reduce code complexity, removed some duplicate code
NLog · Aug 2, 2018 · a561546 · a561546
2 parents bfea328 + a4a80db
commit a561546
Showing 1 changed file with 53 additions and 15 deletions.
diff --git a/src/NLog.Extensions.Logging/Logging/NLogLogger.cs b/src/NLog.Extensions.Logging/Logging/NLogLogger.cs
@@ -87,26 +87,19 @@ 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 = ConvertToMessageParameterList(messageProperties);
 
-            if ((messageParameters?.HasOriginalMessage ?? false) && (messageParameters.HasComplexParameters || (_options.ParseMessageTemplates && messageParameters.Count > 0)))
+            if (NeedMessageTemplateParser(messageParameters))
             {
-                // 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;
-                    }
+                    SetExtraProperties(eventInfo, extraProperties);
                     return eventInfo;
                 }
 
@@ -116,6 +109,39 @@ private LogEventInfo TryParseMessageTemplate(LogLevel nLogLogLevel, IReadOnlyLis
             return null;    // Parsing not needed
         }
 
+        /// <summary>
+        ///  NLog MessageTemplate Parser must be used?
+        /// </summary>
+        private bool NeedMessageTemplateParser(NLogMessageParameterList messageParameters)
+        {
+            return (messageParameters?.HasOriginalMessage ?? false) && (messageParameters.HasComplexParameters || (_options.ParseMessageTemplates && messageParameters.Count > 0));
+        }
+
+        /// <summary>
+        /// Convert IReadOnlyList to <see cref="NLogMessageParameterList"/>
+        /// </summary>
+        /// <param name="messageProperties"></param>
+        /// <returns></returns>
+        private NLogMessageParameterList ConvertToMessageParameterList(IReadOnlyList<KeyValuePair<string, object>> messageProperties)
+        {
+            return (messageProperties != null && _options.CaptureMessageTemplates)
+                ? NLogMessageParameterList.TryParse(messageProperties)
+                : null;
+        }
+
+        /// <summary>
+        /// Set extra property on <paramref name="eventInfo"/>
+        /// </summary>
+        private static void SetExtraProperties(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 +259,7 @@ private static object[] CreateStructuredLogEventInfoParameters(NLogMessageParame
 
                 if (extraProperty)
                 {
-                    extraProperties = extraProperties ?? new List<MessageTemplateParameter>();
-                    extraProperties.Add(messageParameters[i]);
+                    extraProperties = AddProperty(messageParameters, extraProperties, messageParameters[i]);
                 }
             }
 
@@ -262,14 +287,27 @@ private static object[] CreatePositionalLogEventInfoParameters(NLogMessageParame
                 }
                 else
                 {
-                    extraProperties = extraProperties ?? new List<MessageTemplateParameter>();
-                    extraProperties.Add(messageParameters[i]);
+                    extraProperties = AddProperty(messageParameters, 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> AddProperty(List<MessageTemplateParameter> extraProperties, MessageTemplateParameter item)
+        {
+            extraProperties = extraProperties ?? new List<MessageTemplateParameter>();
+            extraProperties.Add(item);
+            return extraProperties;
+        }
+
         /// <summary>
         /// Find max index of the parameters
         /// </summary>