Keep path in invalid project exceptions

When dotnet#1004 moved the standard XML reading approach to be stream-based rather than file-based, the exceptions thrown on malformed XML changed--System.Xml no longer knows the path, so it isn't included in the XmlException. That caused MSBuild to fail to report the location of the XML error in a nice way as it had done before. Almost every case where we constructed a BuildEventFileInfo object already had access to the full path, so I added a constructor that accepted that as an argument and overrides the possibly-empty path returned from XmlException.SourceUri. Fixes dotnet#1286.
rainersigwald · Oct 31, 2016 · 97a2294 · 97a2294
1 parent fd25bc9
commit 97a2294
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/Shared/BuildEventFileInfo.cs b/src/Shared/BuildEventFileInfo.cs
@@ -97,6 +97,16 @@ internal BuildEventFileInfo(XmlException e)
             _endColumn = 0;
         }
 
+        /// <summary>
+        /// Creates an instance of this class using the information in the given XmlException and file location.
+        /// </summary>
+        internal BuildEventFileInfo(string file, XmlException e) : this(e)
+        {
+            ErrorUtilities.VerifyThrowArgumentNull(file, nameof(file));
+
+            _file = file;
+        }
+
         #endregion
 
         #region Properties

diff --git a/src/XMakeBuildEngine/Construction/ProjectRootElement.cs b/src/XMakeBuildEngine/Construction/ProjectRootElement.cs
@@ -2059,7 +2059,7 @@ private XmlDocumentWithLocation LoadDocument(string fullPath, bool preserveForma
 
                     if (xmlException != null)
                     {
-                        fileInfo = new BuildEventFileInfo(xmlException);
+                        fileInfo = new BuildEventFileInfo(fullPath, xmlException);
                     }
                     else
                     {

diff --git a/src/XMakeBuildEngine/Definition/Toolset.cs b/src/XMakeBuildEngine/Definition/Toolset.cs
@@ -1046,7 +1046,7 @@ private void LoadAndRegisterFromTasksFile(string searchPath, string[] defaultTas
                 catch (XmlException e)
                 {
                     // handle XML errors in the default tasks file
-                    ProjectFileErrorUtilities.VerifyThrowInvalidProjectFile(false, new BuildEventFileInfo(e), taskFileError, e.Message);
+                    ProjectFileErrorUtilities.VerifyThrowInvalidProjectFile(false, new BuildEventFileInfo(defaultTasksFile, e), taskFileError, e.Message);
                 }
                 catch (Exception e) when (ExceptionHandling.IsIoRelatedException(e))
                 {