Code refactoring

MaggieKimani1 · MaggieKimani1 · commit 298b3e91a62e · 2024-02-19T13:09:23.000+03:00
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs
@@ -10,6 +10,7 @@
 using Microsoft.OpenApi.Reader;
 using SharpYaml.Serialization;
 using System.Linq;
+using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Readers
 {
@@ -41,7 +42,7 @@ public async Task<ReadResult> ReadAsync(TextReader input,
                 };
             }
 
-            return await ReadAsync(jsonNode, settings, cancellationToken);
+            return await ReadAsync(jsonNode, settings, cancellationToken: cancellationToken);
         }
 
         /// <inheritdoc/>
@@ -81,9 +82,9 @@ static JsonNode LoadJsonNodesFromYamlDocument(TextReader input)
         }
 
         /// <inheritdoc/>        
-        public async Task<ReadResult> ReadAsync(JsonNode jsonNode, OpenApiReaderSettings settings, CancellationToken cancellationToken = default)
+        public async Task<ReadResult> ReadAsync(JsonNode jsonNode, OpenApiReaderSettings settings, string format = null, CancellationToken cancellationToken = default)
         {
-            return await OpenApiReaderRegistry.DefaultReader.ReadAsync(jsonNode, settings, cancellationToken);
+            return await OpenApiReaderRegistry.DefaultReader.ReadAsync(jsonNode, settings, OpenApiConstants.Yaml, cancellationToken);
         }
 
         /// <inheritdoc/>
diff --git a/src/Microsoft.OpenApi.Workbench/MainModel.cs b/src/Microsoft.OpenApi.Workbench/MainModel.cs
@@ -246,8 +246,9 @@ internal async Task ParseDocument()
                         settings.BaseUrl = new("file://" + Path.GetDirectoryName(_inputFile) + "/");
                     }
                 }
-                var readResult = await new OpenApiStreamReader(settings
-                ).ReadAsync(stream);
+
+                var format = OpenApiModelFactory.GetFormat(_inputFile);
+                var readResult = await OpenApiDocument.LoadAsync(stream, format);
                 var document = readResult.OpenApiDocument;
                 var context = readResult.OpenApiDiagnostic;
 
diff --git a/src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs b/src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs
@@ -29,8 +29,9 @@ public interface IOpenApiReader
         /// <param name="jsonNode">The JsonNode input.</param>
         /// <param name="settings">The Reader settings to be used during parsing.</param>
         /// <param name="cancellationToken">Propagates notifications that operations should be cancelled.</param>
+        /// <param name="format">The OpenAPI format.</param>
         /// <returns></returns>
-        Task<ReadResult> ReadAsync(JsonNode jsonNode, OpenApiReaderSettings settings, CancellationToken cancellationToken = default);
+        Task<ReadResult> ReadAsync(JsonNode jsonNode, OpenApiReaderSettings settings, string format = null, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Reads the TextReader input and parses the fragment of an OpenAPI description into an Open API Element.
diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
@@ -636,8 +636,8 @@ public static ReadResult Load(string url, OpenApiReaderSettings settings = null)
         /// <param name="settings">The OpenApi reader settings.</param>
         /// <returns></returns>
         public static ReadResult Load(Stream stream,
-                                           string format,
-                                           OpenApiReaderSettings settings = null)
+                                      string format,
+                                      OpenApiReaderSettings settings = null)
         {
             return OpenApiModelFactory.Load(stream, format, settings);
         }
diff --git a/src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs b/src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs
@@ -54,25 +54,28 @@ public async Task<ReadResult> ReadAsync(TextReader input,
                 };
             }
 
-            return await ReadAsync(jsonNode, settings, cancellationToken);            
+            return await ReadAsync(jsonNode, settings, cancellationToken: cancellationToken);            
         }
 
         /// <summary>
         /// Parses the JsonNode input into an Open API document.
         /// </summary>
         /// <param name="jsonNode">The JsonNode input.</param>
         /// <param name="settings">The Reader settings to be used during parsing.</param>
+        /// <param name="format">The OpenAPI format.</param>
         /// <param name="cancellationToken">Propagates notifications that operations should be cancelled.</param>
         /// <returns></returns>
-        public async Task<ReadResult> ReadAsync(JsonNode jsonNode,
+        public async Task<ReadResult> ReadAsync(JsonNode jsonNode,                                                
                                                 OpenApiReaderSettings settings,
+                                                string format = null,
                                                 CancellationToken cancellationToken = default)
         {
             var diagnostic = new OpenApiDiagnostic();
             var context = new ParsingContext(diagnostic)
             {
                 ExtensionParsers = settings.ExtensionParsers,
-                BaseUrl = settings.BaseUrl
+                BaseUrl = settings.BaseUrl,
+                DefaultContentType = settings.DefaultContentType
             };
 
             OpenApiDocument document = null;
@@ -83,7 +86,7 @@ public async Task<ReadResult> ReadAsync(JsonNode jsonNode,
 
                 if (settings.LoadExternalRefs)
                 {
-                    var diagnosticExternalRefs = await LoadExternalRefs(document, cancellationToken, settings);
+                    var diagnosticExternalRefs = await LoadExternalRefs(document, cancellationToken, settings, format);
                     // Merge diagnostics of external reference
                     if (diagnosticExternalRefs != null)
                     {
@@ -208,15 +211,15 @@ private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument doc
             }
         }
 
-        private async Task<OpenApiDiagnostic> LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken, OpenApiReaderSettings settings)
+        private async Task<OpenApiDiagnostic> LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken, OpenApiReaderSettings settings, string format = null)
         {
             // Create workspace for all documents to live in.
             var openApiWorkSpace = new OpenApiWorkspace();
 
             // Load this root document into the workspace
             var streamLoader = new DefaultStreamLoader(settings.BaseUrl);
             var workspaceLoader = new OpenApiWorkspaceLoader(openApiWorkSpace, settings.CustomExternalLoader ?? streamLoader, settings);
-            return await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, OpenApiConstants.Json, null, cancellationToken);
+            return await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, format ?? OpenApiConstants.Json, null, cancellationToken);
         }
     }
 }
diff --git a/src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs b/src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs
@@ -5,6 +5,7 @@
 using System.IO;
 using System.Linq;
 using System.Net.Http;
+using System.Runtime;
 using System.Security;
 using System.Threading;
 using System.Threading.Tasks;
@@ -47,7 +48,15 @@ public static ReadResult Load(Stream stream,
                                       string format,
                                       OpenApiReaderSettings settings = null)
         {
-            return LoadAsync(stream, format, settings).GetAwaiter().GetResult();
+            settings ??= new OpenApiReaderSettings();
+
+            var result = LoadAsync(stream, format, settings).GetAwaiter().GetResult();
+            if (!settings.LeaveStreamOpen)
+            {
+                stream.Dispose();
+            }
+
+            return result;
         }
 
         /// <summary>
diff --git a/src/Microsoft.OpenApi/Reader/Services/OpenApiWorkspaceLoader.cs b/src/Microsoft.OpenApi/Reader/Services/OpenApiWorkspaceLoader.cs
@@ -34,8 +34,6 @@ internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference,
             var collectorWalker = new OpenApiWalker(referenceCollector);
             collectorWalker.Walk(document);
 
-            var reader = OpenApiReaderRegistry.GetReader(format);
-
             diagnostic ??= new();
 
             // Walk references
@@ -45,7 +43,7 @@ internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference,
                 if (!_workspace.Contains(item.ExternalResource))
                 {
                     var input = await _loader.LoadAsync(new(item.ExternalResource, UriKind.RelativeOrAbsolute));
-                    var result = await reader.ReadAsync(input, _readerSettings, cancellationToken);
+                    var result = await OpenApiDocument.LoadAsync(input, format, _readerSettings, cancellationToken);
                     // Merge diagnostics
                     if (result.OpenApiDiagnostic != null)
                     {

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`using Microsoft.OpenApi.Reader;`
`11`	`11`	`using SharpYaml.Serialization;`
`12`	`12`	`using System.Linq;`
	`13`	`+using Microsoft.OpenApi.Models;`
`13`	`14`
`14`	`15`	`namespace Microsoft.OpenApi.Readers`
`15`	`16`	`{`
`@@ -41,7 +42,7 @@ public async Task<ReadResult> ReadAsync(TextReader input,`
`41`	`42`	`};`
`42`	`43`	`}`
`43`	`44`
`44`		`- return await ReadAsync(jsonNode, settings, cancellationToken);`
	`45`	`+ return await ReadAsync(jsonNode, settings, cancellationToken: cancellationToken);`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`/// <inheritdoc/>`
`@@ -81,9 +82,9 @@ static JsonNode LoadJsonNodesFromYamlDocument(TextReader input)`
`81`	`82`	`}`
`82`	`83`
`83`	`84`	`/// <inheritdoc/>`
`84`		`- public async Task<ReadResult> ReadAsync(JsonNode jsonNode, OpenApiReaderSettings settings, CancellationToken cancellationToken = default)`
	`85`	`+ public async Task<ReadResult> ReadAsync(JsonNode jsonNode, OpenApiReaderSettings settings, string format = null, CancellationToken cancellationToken = default)`
`85`	`86`	`{`
`86`		`- return await OpenApiReaderRegistry.DefaultReader.ReadAsync(jsonNode, settings, cancellationToken);`
	`87`	`+ return await OpenApiReaderRegistry.DefaultReader.ReadAsync(jsonNode, settings, OpenApiConstants.Yaml, cancellationToken);`
`87`	`88`	`}`
`88`	`89`
`89`	`90`	`/// <inheritdoc/>`
Original file line number	Diff line number	Diff line change
`@@ -246,8 +246,9 @@ internal async Task ParseDocument()`
`246`	`246`	`settings.BaseUrl = new("file://" + Path.GetDirectoryName(_inputFile) + "/");`
`247`	`247`	`}`
`248`	`248`	`}`
`249`		`- var readResult = await new OpenApiStreamReader(settings`
`250`		`- ).ReadAsync(stream);`
	`249`	`+`
	`250`	`+ var format = OpenApiModelFactory.GetFormat(_inputFile);`
	`251`	`+ var readResult = await OpenApiDocument.LoadAsync(stream, format);`
`251`	`252`	`var document = readResult.OpenApiDocument;`
`252`	`253`	`var context = readResult.OpenApiDiagnostic;`
`253`	`254`
Original file line number	Diff line number	Diff line change
`@@ -636,8 +636,8 @@ public static ReadResult Load(string url, OpenApiReaderSettings settings = null)`
`636`	`636`	`/// <param name="settings">The OpenApi reader settings.</param>`
`637`	`637`	`/// <returns></returns>`
`638`	`638`	`public static ReadResult Load(Stream stream,`
`639`		`- string format,`
`640`		`- OpenApiReaderSettings settings = null)`
	`639`	`+ string format,`
	`640`	`+ OpenApiReaderSettings settings = null)`
`641`	`641`	`{`
`642`	`642`	`return OpenApiModelFactory.Load(stream, format, settings);`
`643`	`643`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,25 +54,28 @@ public async Task<ReadResult> ReadAsync(TextReader input,`
`54`	`54`	`};`
`55`	`55`	`}`
`56`	`56`
`57`		`- return await ReadAsync(jsonNode, settings, cancellationToken);`
	`57`	`+ return await ReadAsync(jsonNode, settings, cancellationToken: cancellationToken);`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`/// <summary>`
`61`	`61`	`/// Parses the JsonNode input into an Open API document.`
`62`	`62`	`/// </summary>`
`63`	`63`	`/// <param name="jsonNode">The JsonNode input.</param>`
`64`	`64`	`/// <param name="settings">The Reader settings to be used during parsing.</param>`
	`65`	`+ /// <param name="format">The OpenAPI format.</param>`
`65`	`66`	`/// <param name="cancellationToken">Propagates notifications that operations should be cancelled.</param>`
`66`	`67`	`/// <returns></returns>`
`67`		`- public async Task<ReadResult> ReadAsync(JsonNode jsonNode,`
	`68`	`+ public async Task<ReadResult> ReadAsync(JsonNode jsonNode,`
`68`	`69`	`OpenApiReaderSettings settings,`
	`70`	`+ string format = null,`
`69`	`71`	`CancellationToken cancellationToken = default)`
`70`	`72`	`{`
`71`	`73`	`var diagnostic = new OpenApiDiagnostic();`
`72`	`74`	`var context = new ParsingContext(diagnostic)`
`73`	`75`	`{`
`74`	`76`	`ExtensionParsers = settings.ExtensionParsers,`
`75`		`- BaseUrl = settings.BaseUrl`
	`77`	`+ BaseUrl = settings.BaseUrl,`
	`78`	`+ DefaultContentType = settings.DefaultContentType`
`76`	`79`	`};`
`77`	`80`
`78`	`81`	`OpenApiDocument document = null;`
`@@ -83,7 +86,7 @@ public async Task<ReadResult> ReadAsync(JsonNode jsonNode,`
`83`	`86`
`84`	`87`	`if (settings.LoadExternalRefs)`
`85`	`88`	`{`
`86`		`- var diagnosticExternalRefs = await LoadExternalRefs(document, cancellationToken, settings);`
	`89`	`+ var diagnosticExternalRefs = await LoadExternalRefs(document, cancellationToken, settings, format);`
`87`	`90`	`// Merge diagnostics of external reference`
`88`	`91`	`if (diagnosticExternalRefs != null)`
`89`	`92`	`{`
`@@ -208,15 +211,15 @@ private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument doc`
`208`	`211`	`}`
`209`	`212`	`}`
`210`	`213`
`211`		`- private async Task<OpenApiDiagnostic> LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken, OpenApiReaderSettings settings)`
	`214`	`+ private async Task<OpenApiDiagnostic> LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken, OpenApiReaderSettings settings, string format = null)`
`212`	`215`	`{`
`213`	`216`	`// Create workspace for all documents to live in.`
`214`	`217`	`var openApiWorkSpace = new OpenApiWorkspace();`
`215`	`218`
`216`	`219`	`// Load this root document into the workspace`
`217`	`220`	`var streamLoader = new DefaultStreamLoader(settings.BaseUrl);`
`218`	`221`	`var workspaceLoader = new OpenApiWorkspaceLoader(openApiWorkSpace, settings.CustomExternalLoader ?? streamLoader, settings);`
`219`		`- return await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, OpenApiConstants.Json, null, cancellationToken);`
	`222`	`+ return await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, format ?? OpenApiConstants.Json, null, cancellationToken);`
`220`	`223`	`}`
`221`	`224`	`}`
`222`	`225`	`}`