Improve logging for GetArchetypeData

FacadeFor3e/ExecuteProcessExceptionBuilder.cs

@@ -19,7 +19,7 @@ internal static ExecuteProcessException BuildForProcessError(ExecuteProcessResul
             if (isReadDataError)
                 {
                 errorMessages.Insert(0, 
-                    "An error occurred while the transaction service populated the data object(s). Among other things this can mean:\r\n"
+                    "An error occurred while the transaction service populated the data object(s). Amongst other things this can mean:\r\n"
                     + "- An invalid attribute was specified that doesn't exist on the object\r\n"
                     + "- An invalid child object was specified that doesn't exist on the object\r\n"
                     + "- If multiple child objects were used then the order they were specified in was wrong\r\n"

FacadeFor3e/ExecuteProcessResult.cs

@@ -58,7 +58,7 @@ public Guid ProcessId
         /// <remarks>Can be one of
         ///     <c>Success</c> (the process completed),
         ///     <c>Failure</c> (an error occurred), or
-        ///     <c>Interface</c> (the process is still running)</remarks>
+        ///     <c>Interface</c> (the process has not finished running and is stopped at a UI step)</remarks>
         public string ExecutionResult
             {
             get
@@ -251,22 +251,24 @@ internal AttributeError(XmlElement attributeElement)
         /// <summary>
         /// Generates a string description from a list of <see cref="DataErrors">DataError</see>
         /// </summary>
-        /// <param name="dataErrors"></param>
-        /// <returns></returns>
-        public static string RenderDataErrors(IEnumerable<DataError> dataErrors)
+        /// <param name="dataErrors">A collection of data errors returned from running a process</param>
+        /// <returns>A string containing a description of each of the data errors specified, or null if the data errors collection is empty</returns>
+        public static string? RenderDataErrors(IEnumerable<DataError> dataErrors)
             {
+            if (dataErrors == null)
+                throw new ArgumentNullException(nameof(dataErrors));
             var sb = new StringBuilder();
-            bool isSubsequentRecord = false;
-            foreach (var item in dataErrors)
+            using (var enumerator = dataErrors.GetEnumerator())
                 {
-                if (isSubsequentRecord)
+                if (!enumerator.MoveNext())
+                    return null;
+                AppendDataErrorInfo(enumerator.Current!, sb, 0);
+                while (enumerator.MoveNext())
                     {
                     sb.AppendLine();
+                    AppendDataErrorInfo(enumerator.Current!, sb, 0);
                     }
-                AppendDataErrorInfo(item, sb, 0);
-                isSubsequentRecord = true;
                 }
-
             return sb.ToString();
             }
 

FacadeFor3e/FacadeFor3e.csproj

@@ -5,7 +5,7 @@
     <PackageId>FacadeFor3E</PackageId>
     <Authors>J Saffron Consulting</Authors>
     <Product>FacadeFor3E</Product>
-    <Version>2.1.0</Version>
+    <Version>2.1.1</Version>
     <Description>A library that makes using the 3E transaction service a little easier.</Description>
     <Copyright>Copyright © J Saffron Consulting Ltd 2014 - 2023</Copyright>
     <RepositoryUrl>https://github.com/JonSaffron/FacadeFor3e</RepositoryUrl>

FacadeFor3e/GetArchetypeData.cs

@@ -85,31 +85,36 @@ public XmlDocument GetData(XmlDocument xoql)
 
             if (response == null)
                 {
-                // if no rows returned, then return something useful
+                // when no rows are returned, then return something useful
                 var result = new XmlDocument();
                 result.AppendChild(result.CreateElement("Data"));
+                this._transactionServices.LogForDebug("no results returned from xoql query");
                 return result;
                 }
 
             if (response.StartsWith("<Data>") && response.EndsWith("</Data>"))
                 {
                 var result = new XmlDocument();
                 result.LoadXml(response);
+                string responseFormatted = result.PrettyPrintXml();
+                this._transactionServices.LogForDebug(responseFormatted);
                 return result;
                 }
 
+            this._transactionServices.LogForError(response);
             throw new InvalidOperationException("An invalid response was received from the web server:\r\n" + response);
             }
 
         private string? CallTransactionService(XmlDocument xoql)
             {
-            var ts = this._transactionServices.GetSoapClient();
+            OutputToConsoleDetailsOfTheJob(xoql);
+            this._transactionServices.LogForDebug(xoql.PrettyPrintXml());
+
             // deliberately only passing through the document element, not the xml declaration on any leading or following comments
             // this is because the 3E transaction service is intolerant of anything but the simplest xml
             // ReSharper disable once PossibleNullReferenceException
             var request = xoql.DocumentElement!.OuterXml;
-            OutputToConsoleDetailsOfTheJob(xoql);
-
+            var ts = this._transactionServices.GetSoapClient();
             var result = ts.GetArchetypeData(request); // if no rows are returned, then result will be null
             return result;
             }
@@ -121,7 +126,7 @@ private void OutputToConsoleDetailsOfTheJob(XmlDocument xoql)
             xnm.AddNamespace("ns", "http://elite.com/schemas/query");
             XmlElement? arch = (XmlElement?) xoql.SelectSingleNode("ns:SELECT/ns:OQL_CONTEXT/ns:NODEMAP[@ID='Node#1']", xnm);
             var archetype = arch?.GetAttribute("QueryID");
-            var jobSpecifics = $"Getting data for {archetype ?? "unknown"}";
+            var jobSpecifics = $"Getting data from {archetype ?? "unknown"}";
             this._transactionServices.LogDetailsOfTheJob(jobSpecifics);
             }
         }

FacadeFor3e/ReleaseHistory.md

@@ -1,4 +1,9 @@
-2.1.0
+2.1.1
+-----
+Improve logging for GetArchetypeData calls
+Fix potential null reference error in RenderDataErrors
+
+2.1.0
 -----
 Improve functionality for attaching files (this is a change to the interface)