Merge pull request #1170 from microsoft/vnext

MaggieKimani1 · web-flow · commit e0b36a7b4382 · 2023-02-21T14:56:05.000+03:00
Master refresh
diff --git a/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj b/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
@@ -42,7 +42,7 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="7.0.0" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
-    <PackageReference Include="Microsoft.OData.Edm" Version="7.14.0" />
+    <PackageReference Include="Microsoft.OData.Edm" Version="7.14.1" />
     <PackageReference Include="Microsoft.OpenApi.OData" Version="1.2.0" />
     <PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
   </ItemGroup>
diff --git a/src/Microsoft.OpenApi.Hidi/OpenApiService.cs b/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
@@ -162,7 +162,7 @@ private static async Task<OpenApiDocument> GetOpenApi(string openapi, string csd
             else
             {
                 stream = await GetStream(openapi, logger, cancellationToken);
-                var result = await ParseOpenApi(openapi, inlineExternal, logger, stream);
+                var result = await ParseOpenApi(openapi, inlineExternal, logger, stream, cancellationToken);
                 document = result.OpenApiDocument;
             }
 
@@ -253,7 +253,7 @@ public static async Task ValidateOpenApiDocument(
             {
                 using var stream = await GetStream(openapi, logger, cancellationToken);
 
-                var result = await ParseOpenApi(openapi, false, logger, stream);
+                var result = await ParseOpenApi(openapi, false, logger, stream, cancellationToken);
 
                 using (logger.BeginScope("Calculating statistics"))
                 {
@@ -275,7 +275,7 @@ public static async Task ValidateOpenApiDocument(
             }
         }
 
-        private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream)
+        private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream, CancellationToken cancellationToken)
         {
             ReadResult result;
             Stopwatch stopwatch = Stopwatch.StartNew();
@@ -290,7 +290,7 @@ private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inli
                         new Uri(openApiFile) :
                         new Uri("file://" + new FileInfo(openApiFile).DirectoryName + Path.DirectorySeparatorChar)
                 }
-                ).ReadAsync(stream);
+                ).ReadAsync(stream, cancellationToken);
 
                 logger.LogTrace("{timestamp}ms: Completed parsing.", stopwatch.ElapsedMilliseconds);
 
diff --git a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.6.1</Version>
+        <Version>1.6.2</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -54,8 +55,9 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
         /// Reads the stream input and parses it into an Open API document.
         /// </summary>
         /// <param name="input">Stream containing OpenAPI description to parse.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
         /// <returns>Instance result containing newly created OpenApiDocument and diagnostics object from the process</returns>
-        public async Task<ReadResult> ReadAsync(Stream input)
+        public async Task<ReadResult> ReadAsync(Stream input, CancellationToken cancellationToken = default)
         {
             MemoryStream bufferedStream;
             if (input is MemoryStream)
@@ -67,13 +69,14 @@ public async Task<ReadResult> ReadAsync(Stream input)
                 // Buffer stream so that OpenApiTextReaderReader can process it synchronously
                 // YamlDocument doesn't support async reading.
                 bufferedStream = new MemoryStream();
-                await input.CopyToAsync(bufferedStream);
+                await input.CopyToAsync(bufferedStream, 81920, cancellationToken);
                 bufferedStream.Position = 0;
             }
 
-            var reader = new StreamReader(bufferedStream);
-
-            return await new OpenApiTextReaderReader(_settings).ReadAsync(reader);
+            using (var reader = new StreamReader(bufferedStream))
+            {
+                return await new OpenApiTextReaderReader(_settings).ReadAsync(reader, cancellationToken);
+            }
         }
 
         /// <summary>
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs
@@ -3,6 +3,7 @@
 
 using System.IO;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -57,8 +58,9 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)
         /// Reads the content of the TextReader.  If there are references to external documents then they will be read asynchronously.
         /// </summary>
         /// <param name="input">TextReader containing OpenAPI description to parse.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
         /// <returns>A ReadResult instance that contains the resulting OpenApiDocument and a diagnostics instance.</returns>
-        public async Task<ReadResult> ReadAsync(TextReader input)
+        public async Task<ReadResult> ReadAsync(TextReader input, CancellationToken cancellationToken = default)
         {
             YamlDocument yamlDocument;
 
@@ -78,7 +80,7 @@ public async Task<ReadResult> ReadAsync(TextReader input)
                 };
             }
 
-            return await new OpenApiYamlDocumentReader(this._settings).ReadAsync(yamlDocument);
+            return await new OpenApiYamlDocumentReader(this._settings).ReadAsync(yamlDocument, cancellationToken);
         }
 
 
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs
@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Exceptions;
 using Microsoft.OpenApi.Extensions;
@@ -84,7 +85,7 @@ public OpenApiDocument Read(YamlDocument input, out OpenApiDiagnostic diagnostic
             return document;
         }
 
-        public async Task<ReadResult> ReadAsync(YamlDocument input)
+        public async Task<ReadResult> ReadAsync(YamlDocument input, CancellationToken cancellationToken = default)
         {
             var diagnostic = new OpenApiDiagnostic();
             var context = new ParsingContext(diagnostic)
@@ -101,7 +102,7 @@ public async Task<ReadResult> ReadAsync(YamlDocument input)
 
                 if (_settings.LoadExternalRefs)
                 {
-                    await LoadExternalRefs(document);
+                    await LoadExternalRefs(document, cancellationToken);
                 }
 
                 ResolveReferences(diagnostic, document);
@@ -132,15 +133,15 @@ public async Task<ReadResult> ReadAsync(YamlDocument input)
             };
         }
 
-        private async Task LoadExternalRefs(OpenApiDocument document)
+        private async Task LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken)
         {
             // 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);
-            await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document);
+            await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, cancellationToken);
         }
 
         private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument document)
diff --git a/src/Microsoft.OpenApi.Readers/Services/OpenApiWorkspaceLoader.cs b/src/Microsoft.OpenApi.Readers/Services/OpenApiWorkspaceLoader.cs
@@ -3,11 +3,11 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.Interface;
 using Microsoft.OpenApi.Services;
-using SharpYaml.Model;
 
 namespace Microsoft.OpenApi.Readers.Services
 {
@@ -24,7 +24,7 @@ public OpenApiWorkspaceLoader(OpenApiWorkspace workspace, IStreamLoader loader,
             _readerSettings = readerSettings;
         }
 
-        internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument document)
+        internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument document, CancellationToken cancellationToken)
         {
             _workspace.AddDocument(reference.ExternalResource, document);
             document.Workspace = _workspace;
@@ -43,8 +43,8 @@ internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument docume
                 if (!_workspace.Contains(item.ExternalResource))
                 {
                     var input = await _loader.LoadAsync(new Uri(item.ExternalResource, UriKind.RelativeOrAbsolute));
-                    var result = await reader.ReadAsync(input); // TODO merge _diagnositics
-                    await LoadAsync(item, result.OpenApiDocument);
+                    var result = await reader.ReadAsync(input, cancellationToken); // TODO merge diagnostics
+                    await LoadAsync(item, result.OpenApiDocument, cancellationToken);
                 }
             }
         }
diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -11,7 +11,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.6.1</Version>
+        <Version>1.6.2</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -262,7 +262,7 @@
           <PrivateAssets>all</PrivateAssets>
         </PackageReference>
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-        <PackageReference Include="FluentAssertions" Version="6.9.0">
+        <PackageReference Include="FluentAssertions" Version="6.10.0">
         </PackageReference>
         <PackageReference Include="Newtonsoft.Json" Version="13.0.2">
         </PackageReference>
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -23,12 +23,12 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="FluentAssertions" Version="6.9.0" />
+    <PackageReference Include="FluentAssertions" Version="6.10.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
     <PackageReference Include="Moq" Version="4.18.4" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
     <PackageReference Include="SharpYaml" Version="2.1.0" />
-    <PackageReference Include="Verify.Xunit" Version="19.9.2" />
+    <PackageReference Include="Verify.Xunit" Version="19.9.3" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
       <PrivateAssets>all</PrivateAssets>

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ private static async Task<OpenApiDocument> GetOpenApi(string openapi, string csd`
`162`	`162`	`else`
`163`	`163`	`{`
`164`	`164`	`stream = await GetStream(openapi, logger, cancellationToken);`
`165`		`- var result = await ParseOpenApi(openapi, inlineExternal, logger, stream);`
	`165`	`+ var result = await ParseOpenApi(openapi, inlineExternal, logger, stream, cancellationToken);`
`166`	`166`	`document = result.OpenApiDocument;`
`167`	`167`	`}`
`168`	`168`
`@@ -253,7 +253,7 @@ public static async Task ValidateOpenApiDocument(`
`253`	`253`	`{`
`254`	`254`	`using var stream = await GetStream(openapi, logger, cancellationToken);`
`255`	`255`
`256`		`- var result = await ParseOpenApi(openapi, false, logger, stream);`
	`256`	`+ var result = await ParseOpenApi(openapi, false, logger, stream, cancellationToken);`
`257`	`257`
`258`	`258`	`using (logger.BeginScope("Calculating statistics"))`
`259`	`259`	`{`
`@@ -275,7 +275,7 @@ public static async Task ValidateOpenApiDocument(`
`275`	`275`	`}`
`276`	`276`	`}`
`277`	`277`
`278`		`- private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream)`
	`278`	`+ private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream, CancellationToken cancellationToken)`
`279`	`279`	`{`
`280`	`280`	`ReadResult result;`
`281`	`281`	`Stopwatch stopwatch = Stopwatch.StartNew();`
`@@ -290,7 +290,7 @@ private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inli`
`290`	`290`	`new Uri(openApiFile) :`
`291`	`291`	`new Uri("file://" + new FileInfo(openApiFile).DirectoryName + Path.DirectorySeparatorChar)`
`292`	`292`	`}`
`293`		`- ).ReadAsync(stream);`
	`293`	`+ ).ReadAsync(stream, cancellationToken);`
`294`	`294`
`295`	`295`	`logger.LogTrace("{timestamp}ms: Completed parsing.", stopwatch.ElapsedMilliseconds);`
`296`	`296`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.Collections.Generic;`
`6`	`6`	`using System.IO;`
`7`	`7`	`using System.Linq;`
	`8`	`+using System.Threading;`
`8`	`9`	`using System.Threading.Tasks;`
`9`	`10`	`using Microsoft.OpenApi.Exceptions;`
`10`	`11`	`using Microsoft.OpenApi.Extensions;`
`@@ -84,7 +85,7 @@ public OpenApiDocument Read(YamlDocument input, out OpenApiDiagnostic diagnostic`
`84`	`85`	`return document;`
`85`	`86`	`}`
`86`	`87`
`87`		`- public async Task<ReadResult> ReadAsync(YamlDocument input)`
	`88`	`+ public async Task<ReadResult> ReadAsync(YamlDocument input, CancellationToken cancellationToken = default)`
`88`	`89`	`{`
`89`	`90`	`var diagnostic = new OpenApiDiagnostic();`
`90`	`91`	`var context = new ParsingContext(diagnostic)`
`@@ -101,7 +102,7 @@ public async Task<ReadResult> ReadAsync(YamlDocument input)`
`101`	`102`
`102`	`103`	`if (_settings.LoadExternalRefs)`
`103`	`104`	`{`
`104`		`- await LoadExternalRefs(document);`
	`105`	`+ await LoadExternalRefs(document, cancellationToken);`
`105`	`106`	`}`
`106`	`107`
`107`	`108`	`ResolveReferences(diagnostic, document);`
`@@ -132,15 +133,15 @@ public async Task<ReadResult> ReadAsync(YamlDocument input)`
`132`	`133`	`};`
`133`	`134`	`}`
`134`	`135`
`135`		`- private async Task LoadExternalRefs(OpenApiDocument document)`
	`136`	`+ private async Task LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken)`
`136`	`137`	`{`
`137`	`138`	`// Create workspace for all documents to live in.`
`138`	`139`	`var openApiWorkSpace = new OpenApiWorkspace();`
`139`	`140`
`140`	`141`	`// Load this root document into the workspace`
`141`	`142`	`var streamLoader = new DefaultStreamLoader(_settings.BaseUrl);`
`142`	`143`	`var workspaceLoader = new OpenApiWorkspaceLoader(openApiWorkSpace, _settings.CustomExternalLoader ?? streamLoader, _settings);`
`143`		`- await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document);`
	`144`	`+ await workspaceLoader.LoadAsync(new OpenApiReference() { ExternalResource = "/" }, document, cancellationToken);`
`144`	`145`	`}`
`145`	`146`
`146`	`147`	`private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument document)`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,11 @@`
`3`	`3`	`using System.IO;`
`4`	`4`	`using System.Linq;`
`5`	`5`	`using System.Text;`
	`6`	`+using System.Threading;`
`6`	`7`	`using System.Threading.Tasks;`
`7`	`8`	`using Microsoft.OpenApi.Models;`
`8`	`9`	`using Microsoft.OpenApi.Readers.Interface;`
`9`	`10`	`using Microsoft.OpenApi.Services;`
`10`		`-using SharpYaml.Model;`
`11`	`11`
`12`	`12`	`namespace Microsoft.OpenApi.Readers.Services`
`13`	`13`	`{`
`@@ -24,7 +24,7 @@ public OpenApiWorkspaceLoader(OpenApiWorkspace workspace, IStreamLoader loader,`
`24`	`24`	`_readerSettings = readerSettings;`
`25`	`25`	`}`
`26`	`26`
`27`		`- internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument document)`
	`27`	`+ internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument document, CancellationToken cancellationToken)`
`28`	`28`	`{`
`29`	`29`	`_workspace.AddDocument(reference.ExternalResource, document);`
`30`	`30`	`document.Workspace = _workspace;`
`@@ -43,8 +43,8 @@ internal async Task LoadAsync(OpenApiReference reference, OpenApiDocument docume`
`43`	`43`	`if (!_workspace.Contains(item.ExternalResource))`
`44`	`44`	`{`
`45`	`45`	`var input = await _loader.LoadAsync(new Uri(item.ExternalResource, UriKind.RelativeOrAbsolute));`
`46`		`- var result = await reader.ReadAsync(input); // TODO merge _diagnositics`
`47`		`- await LoadAsync(item, result.OpenApiDocument);`
	`46`	`+ var result = await reader.ReadAsync(input, cancellationToken); // TODO merge diagnostics`
	`47`	`+ await LoadAsync(item, result.OpenApiDocument, cancellationToken);`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`	`}`