Merge pull request #15 from Microsoft/line-info-detect

Adding detection of JSON.Net version for line info handling

Author: Jacob Viau

src/Microsoft.VisualStudio.Jdt.Tests/Microsoft.VisualStudio.Jdt.Tests.csproj

@@ -9,7 +9,7 @@
   <ItemGroup>
     <PackageReference Include="MicroBuild.NonShipping" Version="2.0.40" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0-preview-20170425-07" />
-    <PackageReference Include="Newtonsoft.Json" Version="10.0.2" />
+    <PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
     <PackageReference Include="xunit" Version="2.2.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
   </ItemGroup>

src/Microsoft.VisualStudio.Jdt/JdtExtensions.cs

@@ -55,7 +55,7 @@ internal static JObject CloneWithLineInfo(this JObject objectToClone)
         {
             var loadSettings = new JsonLoadSettings()
             {
-                LineInfoHandling = LineInfoHandling.Load
+                LineInfoHandling = JdtUtilities.GetLineInfoHandling()
             };
 
             using (var objectReader = objectToClone.CreateReader())

src/Microsoft.VisualStudio.Jdt/JdtUtilities.cs

@@ -3,6 +3,11 @@
 
 namespace Microsoft.VisualStudio.Jdt
 {
+    using System;
+    using System.Diagnostics;
+    using System.Reflection;
+    using Newtonsoft.Json.Linq;
+
     /// <summary>
     /// Utilities class for handling JSON files
     /// </summary>
@@ -13,6 +18,12 @@ public static class JdtUtilities
         /// </summary>
         internal const string JdtSyntaxPrefix = "@jdt.";
 
+        /// <summary>
+        /// The cached line info handling to use, based on Newtonsoft.Json version
+        /// https://github.com/JamesNK/Newtonsoft.Json/issues/1249
+        /// </summary>
+        private static LineInfoHandling? lineInfoHandling = null;
+
         /// <summary>
         /// Wheter the given key corresponds to a JDT verb
         /// </summary>
@@ -36,5 +47,43 @@ public static string GetJdtSyntax(string key)
             // If it is a JDT verb, remove the prefix
             return IsJdtSyntax(key) ? key.Substring(JdtSyntaxPrefix.Length) : null;
         }
+
+        /// <summary>
+        /// Gets the <see cref="LineInfoHandling"/> depending on the Newtonsoft version
+        /// This is due to a bug in previous versions of JSON.Net that loaded line info on ignore and vice-versa
+        /// See https://github.com/JamesNK/Newtonsoft.Json/pull/1250
+        /// </summary>
+        /// <returns>The correct line info handling</returns>
+        internal static LineInfoHandling GetLineInfoHandling()
+        {
+            if (lineInfoHandling == null)
+            {
+                try
+                {
+                    string newtonsoftLocation = typeof(JObject).GetTypeInfo().Assembly.Location;
+                    FileVersionInfo fileVersion = FileVersionInfo.GetVersionInfo(newtonsoftLocation);
+
+                    // The version the line ending bug was fixed in. We want to target a lower
+                    // version of Newtonsoft to give consumers more flexibility in what version
+                    // they consume theirselves. However, we still want line endings to work in
+                    // both new and old versions.
+                    if (new Version(fileVersion.ProductVersion) < new Version("10.0.2"))
+                    {
+                        lineInfoHandling = LineInfoHandling.Ignore;
+                    }
+                    else
+                    {
+                        lineInfoHandling = LineInfoHandling.Load;
+                    }
+                }
+                catch (Exception e) when (!e.IsCriticalException())
+                {
+                    // we will default to the "correct" value in the instance of any issues.
+                    lineInfoHandling = LineInfoHandling.Load;
+                }
+            }
+
+            return lineInfoHandling.Value;
+        }
     }
 }

src/Microsoft.VisualStudio.Jdt/JsonTransformation.cs

@@ -162,7 +162,7 @@ private void SetTransform(Stream transformStream)
             this.loadSettings = new JsonLoadSettings()
             {
                 CommentHandling = CommentHandling.Ignore,
-                LineInfoHandling = LineInfoHandling.Load
+                LineInfoHandling = JdtUtilities.GetLineInfoHandling()
             };
 
             using (StreamReader transformStreamReader = new StreamReader(transformStream))

src/Microsoft.VisualStudio.Jdt/Microsoft.VisualStudio.Jdt.csproj

@@ -21,7 +21,12 @@
 
   <ItemGroup>
     <PackageReference Include="MicroBuild.VisualStudio" Version="2.0.40" PrivateAssets="all" />
-    <PackageReference Include="Newtonsoft.Json" Version="10.0.2" />
+    <PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'netstandard1.5'">
+    <PackageReference Include="System.Diagnostics.FileVersionInfo" Version="4.3.0" />
+    <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
   </ItemGroup>
 
   <ItemGroup>
@@ -39,4 +44,4 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+</Project>

src/Microsoft.VisualStudio.Jdt/Processors/Attributes/JdtAttributeExtensions.cs

@@ -5,46 +5,26 @@ namespace Microsoft.VisualStudio.Jdt
 {
     using System;
     using System.Collections.Generic;
-    using System.ComponentModel;
     using System.Linq;
-    using System.Reflection;
 
     /// <summary>
     /// Implements extensions for <see cref="JdtAttributes"/>
     /// </summary>
     internal static class JdtAttributeExtensions
     {
-        /// <summary>
-        /// Gets the description (name) of the attribute
-        /// </summary>
-        /// <param name="attribute">The attribute</param>
-        /// <returns>The name of the attribute</returns>
-        internal static string GetDescription(this JdtAttributes attribute)
-        {
-            var type = attribute.GetType();
-            var typeInfo = type.GetTypeInfo();
-            var name = Enum.GetName(type, attribute);
-            var description = typeInfo.GetField(name)
-                .GetCustomAttributes(false)
-                .OfType<DescriptionAttribute>()
-                .SingleOrDefault();
-
-            if (description == null)
-            {
-                throw new NotImplementedException(attribute.ToString() + " does not have a corresponding name");
-            }
-
-            return description.Description;
-        }
-
         /// <summary>
         /// Get the full name of an attribute, with the JDT prefix
         /// </summary>
         /// <param name="attribute">The attribute</param>
         /// <returns>A string with the full name of the requested attribute</returns>
         internal static string FullName(this JdtAttributes attribute)
         {
-            return JdtUtilities.JdtSyntaxPrefix + attribute.GetDescription();
+            if (attribute == JdtAttributes.None)
+            {
+                return JdtUtilities.JdtSyntaxPrefix;
+            }
+
+            return JdtUtilities.JdtSyntaxPrefix + Enum.GetName(typeof(JdtAttributes), attribute).ToLower();
         }
 
         /// <summary>

src/Microsoft.VisualStudio.Jdt/Processors/Attributes/JdtAttributeValidator.cs

@@ -5,7 +5,6 @@ namespace Microsoft.VisualStudio.Jdt
 {
     using System;
     using System.Collections.Generic;
-    using System.ComponentModel;
     using System.Linq;
     using Newtonsoft.Json.Linq;
 
@@ -17,19 +16,16 @@ internal enum JdtAttributes
         /// <summary>
         /// Represents an non existant attribute
         /// </summary>
-        [Description(null)]
         None = 0,
 
         /// <summary>
         /// The JDT path attribute
         /// </summary>
-        [Description("path")]
         Path,
 
         /// <summary>
         /// The JDT path attribute
         /// </summary>
-        [Description("value")]
         Value,
     }