Merge pull request #1211 from microsoft/mk/use-json-node-for-parsing

Use System.Text.JsonNodes for parsing

Author: MaggieKimani1

.vscode/settings.json

@@ -3,5 +3,6 @@
         "activityBar.background": "#03323C",
         "titleBar.activeBackground": "#054754",
         "titleBar.activeForeground": "#F0FCFE"
-    }
+    },
+    "omnisharp.enableRoslynAnalyzers": true
 }

src/Microsoft.OpenApi.Readers/Exceptions/OpenApiReaderException.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. 
 
 using System;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Exceptions;
 using SharpYaml.Serialization;
 
@@ -38,11 +39,10 @@ public OpenApiReaderException(string message, ParsingContext context) : base(mes
         /// </summary>
         /// <param name="message">Plain text error message for this exception.</param>
         /// <param name="node">Parsing node where error occured</param>
-        public OpenApiReaderException(string message, YamlNode node) : base(message)
+        public OpenApiReaderException(string message, JsonNode node) : base(message)
         {
             // This only includes line because using a char range causes tests to break due to CR/LF & LF differences
             // See https://tools.ietf.org/html/rfc5147 for syntax
-            Pointer = $"#line={node.Start.Line}";
         }
 
         /// <summary>

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -36,6 +36,7 @@
 
     <ItemGroup>
         <PackageReference Include="SharpYaml" Version="2.1.0" />
+        <PackageReference Include="System.Text.Json" Version="7.0.2" />
     </ItemGroup>
 
     <ItemGroup>

src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs

@@ -8,6 +8,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Text.Json.Nodes;
 
 namespace Microsoft.OpenApi.Readers
 {
@@ -49,7 +50,7 @@ public class OpenApiReaderSettings
         /// <summary>
         /// Dictionary of parsers for converting extensions into strongly typed classes
         /// </summary>
-        public Dictionary<string, Func<IOpenApiAny, OpenApiSpecVersion, IOpenApiExtension>> ExtensionParsers { get; set; } = new Dictionary<string, Func<IOpenApiAny, OpenApiSpecVersion, IOpenApiExtension>>();
+        public Dictionary<string, Func<OpenApiAny, OpenApiSpecVersion, IOpenApiExtension>> ExtensionParsers { get; set; } = new Dictionary<string, Func<OpenApiAny, OpenApiSpecVersion, IOpenApiExtension>>();
 
         /// <summary>
         /// Rules to use for validating OpenAPI specification.  If none are provided a default set of rules are applied.

src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs

@@ -1,8 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
+using System.Collections;
 using System.IO;
 using System.Linq;
+using System.Text.Json;
+using System.Text.Json.Nodes;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Interfaces;
@@ -37,12 +40,12 @@ public OpenApiTextReaderReader(OpenApiReaderSettings settings = null)
         /// <returns>Instance of newly created OpenApiDocument</returns>
         public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)
         {
-            YamlDocument yamlDocument;
+            JsonNode jsonNode;
 
-            // Parse the YAML/JSON text in the TextReader into the YamlDocument
+            // Parse the YAML/JSON text in the TextReader into Json Nodes
             try
             {
-                yamlDocument = LoadYamlDocument(input);
+                jsonNode = LoadJsonNodesFromYamlDocument(input);
             }
             catch (YamlException ex)
             {
@@ -51,7 +54,7 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)
                 return new OpenApiDocument();
             }
 
-            return new OpenApiYamlDocumentReader(this._settings).Read(yamlDocument, out diagnostic);
+            return new OpenApiYamlDocumentReader(this._settings).Read(jsonNode, out diagnostic);
         }
 
         /// <summary>
@@ -62,25 +65,25 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)
         /// <returns>A ReadResult instance that contains the resulting OpenApiDocument and a diagnostics instance.</returns>
         public async Task<ReadResult> ReadAsync(TextReader input, CancellationToken cancellationToken = default)
         {
-            YamlDocument yamlDocument;
+            JsonNode jsonNode;
 
             // Parse the YAML/JSON text in the TextReader into the YamlDocument
             try
             {
-                yamlDocument = LoadYamlDocument(input);
+                jsonNode = LoadJsonNodesFromYamlDocument(input);
             }
-            catch (YamlException ex)
+            catch (JsonException ex)
             {
                 var diagnostic = new OpenApiDiagnostic();
-                diagnostic.Errors.Add(new OpenApiError($"#line={ex.Start.Line}", ex.Message));
+                diagnostic.Errors.Add(new OpenApiError($"#line={ex.LineNumber}", ex.Message));
                 return new ReadResult
                 {
                     OpenApiDocument = null,
                     OpenApiDiagnostic = diagnostic
                 };
             }
 
-            return await new OpenApiYamlDocumentReader(this._settings).ReadAsync(yamlDocument, cancellationToken);
+            return await new OpenApiYamlDocumentReader(this._settings).ReadAsync(jsonNode, cancellationToken);
         }
 
 
@@ -93,33 +96,34 @@ public async Task<ReadResult> ReadAsync(TextReader input, CancellationToken canc
         /// <returns>Instance of newly created OpenApiDocument</returns>
         public T ReadFragment<T>(TextReader input, OpenApiSpecVersion version, out OpenApiDiagnostic diagnostic) where T : IOpenApiElement
         {
-            YamlDocument yamlDocument;
+            JsonNode jsonNode;
 
             // Parse the YAML/JSON
             try
             {
-                yamlDocument = LoadYamlDocument(input);
+                jsonNode = LoadJsonNodesFromYamlDocument(input);
             }
-            catch (YamlException ex)
+            catch (JsonException ex)
             {
                 diagnostic = new OpenApiDiagnostic();
-                diagnostic.Errors.Add(new OpenApiError($"#line={ex.Start.Line}", ex.Message));
+                diagnostic.Errors.Add(new OpenApiError($"#line={ex.LineNumber}", ex.Message));
                 return default(T);
             }
 
-            return new OpenApiYamlDocumentReader(this._settings).ReadFragment<T>(yamlDocument, version, out diagnostic);
+            return new OpenApiYamlDocumentReader(this._settings).ReadFragment<T>(jsonNode, version, out diagnostic);
         }
 
         /// <summary>
         /// Helper method to turn streams into YamlDocument
         /// </summary>
         /// <param name="input">Stream containing YAML formatted text</param>
         /// <returns>Instance of a YamlDocument</returns>
-        static YamlDocument LoadYamlDocument(TextReader input)
+        static JsonNode LoadJsonNodesFromYamlDocument(TextReader input)
         {
             var yamlStream = new YamlStream();
             yamlStream.Load(input);
-            return yamlStream.Documents.First();
+            var yamlDocument = yamlStream.Documents.First();
+            return yamlDocument.ToJsonNode();
         }
     }
 }

src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs

@@ -5,6 +5,8 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text.Json;
+using System.Text.Json.Nodes;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Exceptions;
@@ -22,7 +24,7 @@ namespace Microsoft.OpenApi.Readers
     /// <summary>
     /// Service class for converting contents of TextReader into OpenApiDocument instances
     /// </summary>
-    internal class OpenApiYamlDocumentReader : IOpenApiReader<YamlDocument, OpenApiDiagnostic>
+    internal class OpenApiYamlDocumentReader : IOpenApiReader<JsonNode, OpenApiDiagnostic>
     {
         private readonly OpenApiReaderSettings _settings;
 
@@ -41,7 +43,7 @@ public OpenApiYamlDocumentReader(OpenApiReaderSettings settings = null)
         /// <param name="input">TextReader containing OpenAPI description to parse.</param>
         /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
         /// <returns>Instance of newly created OpenApiDocument</returns>
-        public OpenApiDocument Read(YamlDocument input, out OpenApiDiagnostic diagnostic)
+        public OpenApiDocument Read(JsonNode input, out OpenApiDiagnostic diagnostic)
         {
             diagnostic = new OpenApiDiagnostic();
             var context = new ParsingContext(diagnostic)
@@ -85,7 +87,7 @@ public OpenApiDocument Read(YamlDocument input, out OpenApiDiagnostic diagnostic
             return document;
         }
 
-        public async Task<ReadResult> ReadAsync(YamlDocument input, CancellationToken cancellationToken = default)
+        public async Task<ReadResult> ReadAsync(JsonNode input, CancellationToken cancellationToken = default)
         {
             var diagnostic = new OpenApiDiagnostic();
             var context = new ParsingContext(diagnostic)
@@ -173,7 +175,7 @@ private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument doc
         /// <param name="version">Version of the OpenAPI specification that the fragment conforms to.</param>
         /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
         /// <returns>Instance of newly created OpenApiDocument</returns>
-        public T ReadFragment<T>(YamlDocument input, OpenApiSpecVersion version, out OpenApiDiagnostic diagnostic) where T : IOpenApiElement
+        public T ReadFragment<T>(JsonNode input, OpenApiSpecVersion version, out OpenApiDiagnostic diagnostic) where T : IOpenApiElement
         {
             diagnostic = new OpenApiDiagnostic();
             var context = new ParsingContext(diagnostic)

src/Microsoft.OpenApi.Readers/ParseNodes/AnyFieldMapParameter.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. 
 
 using System;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
 
@@ -13,8 +14,8 @@ internal class AnyFieldMapParameter<T>
         /// Constructor.
         /// </summary>
         public AnyFieldMapParameter(
-            Func<T, IOpenApiAny> propertyGetter,
-            Action<T, IOpenApiAny> propertySetter,
+            Func<T, OpenApiAny> propertyGetter,
+            Action<T, OpenApiAny> propertySetter,
             Func<T, OpenApiSchema> schemaGetter)
         {
             this.PropertyGetter = propertyGetter;
@@ -25,12 +26,12 @@ public AnyFieldMapParameter(
         /// <summary>
         /// Function to retrieve the value of the property.
         /// </summary>
-        public Func<T, IOpenApiAny> PropertyGetter { get; }
+        public Func<T, OpenApiAny> PropertyGetter { get; }
 
         /// <summary>
         /// Function to set the value of the property.
         /// </summary>
-        public Action<T, IOpenApiAny> PropertySetter { get; }
+        public Action<T, OpenApiAny> PropertySetter { get; }
 
         /// <summary>
         /// Function to get the schema to apply to the property.

src/Microsoft.OpenApi.Readers/ParseNodes/AnyListFieldMapParameter.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
 
@@ -14,8 +15,8 @@ internal class AnyListFieldMapParameter<T>
         /// Constructor
         /// </summary>
         public AnyListFieldMapParameter(
-            Func<T, IList<IOpenApiAny>> propertyGetter,
-            Action<T, IList<IOpenApiAny>> propertySetter,
+            Func<T, IList<OpenApiAny>> propertyGetter,
+            Action<T, IList<OpenApiAny>> propertySetter,
             Func<T, OpenApiSchema> schemaGetter)
         {
             this.PropertyGetter = propertyGetter;
@@ -26,12 +27,12 @@ public AnyListFieldMapParameter(
         /// <summary>
         /// Function to retrieve the value of the property.
         /// </summary>
-        public Func<T, IList<IOpenApiAny>> PropertyGetter { get; }
+        public Func<T, IList<OpenApiAny>> PropertyGetter { get; }
 
         /// <summary>
         /// Function to set the value of the property.
         /// </summary>
-        public Action<T, IList<IOpenApiAny>> PropertySetter { get; }
+        public Action<T, IList<OpenApiAny>> PropertySetter { get; }
 
         /// <summary>
         /// Function to get the schema to apply to the property.

src/Microsoft.OpenApi.Readers/ParseNodes/AnyMapFieldMapParameter.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -16,8 +17,8 @@ internal class AnyMapFieldMapParameter<T, U>
         /// </summary>
         public AnyMapFieldMapParameter(
             Func<T, IDictionary<string, U>> propertyMapGetter,
-            Func<U, IOpenApiAny> propertyGetter,
-            Action<U, IOpenApiAny> propertySetter,
+            Func<U, OpenApiAny> propertyGetter,
+            Action<U, OpenApiAny> propertySetter,
             Func<T, OpenApiSchema> schemaGetter)
         {
             this.PropertyMapGetter = propertyMapGetter;
@@ -34,12 +35,12 @@ public AnyMapFieldMapParameter(
         /// <summary>
         /// Function to retrieve the value of the property from an inner element.
         /// </summary>
-        public Func<U, IOpenApiAny> PropertyGetter { get; }
+        public Func<U, OpenApiAny> PropertyGetter { get; }
 
         /// <summary>
         /// Function to set the value of the property.
         /// </summary>
-        public Action<U, IOpenApiAny> PropertySetter { get; }
+        public Action<U, OpenApiAny> PropertySetter { get; }
 
         /// <summary>
         /// Function to get the schema to apply to the property.

src/Microsoft.OpenApi.Readers/ParseNodes/JsonPointerExtensions.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. 
 
 using System;
+using System.Text.Json.Nodes;
 using SharpYaml.Serialization;
 
 namespace Microsoft.OpenApi.Readers.ParseNodes
@@ -12,36 +13,29 @@ namespace Microsoft.OpenApi.Readers.ParseNodes
     public static class JsonPointerExtensions
     {
         /// <summary>
-        /// Finds the YAML node that corresponds to this JSON pointer based on the base YAML node.
+        /// Finds the JSON node that corresponds to this JSON pointer based on the base Json node.
         /// </summary>
-        public static YamlNode Find(this JsonPointer currentPointer, YamlNode baseYamlNode)
+        public static JsonNode Find(this JsonPointer currentPointer, JsonNode baseJsonNode)
         {
             if (currentPointer.Tokens.Length == 0)
             {
-                return baseYamlNode;
+                return baseJsonNode;
             }
 
             try
             {
-                var pointer = baseYamlNode;
+                var pointer = baseJsonNode;
                 foreach (var token in currentPointer.Tokens)
                 {
-                    var sequence = pointer as YamlSequenceNode;
+                    var array = pointer as JsonArray;
 
-                    if (sequence != null)
+                    if (array != null && int.TryParse(token, out var tokenValue))
                     {
-                        pointer = sequence.Children[Convert.ToInt32(token)];
+                        pointer = array[tokenValue];
                     }
-                    else
+                    else if(pointer is JsonObject map && !map.TryGetPropertyValue(token, out pointer))
                     {
-                        var map = pointer as YamlMappingNode;
-                        if (map != null)
-                        {
-                            if (!map.Children.TryGetValue(new YamlScalarNode(token), out pointer))
-                            {
-                                return null;
-                            }
-                        }
+                        return null;
                     }
                 }