fix: adds a cancellation token argument to external document loading

Author: baywet

src/Microsoft.OpenApi/Interfaces/IStreamLoader.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Models;
 
@@ -17,7 +18,8 @@ public interface IStreamLoader
         /// Use Uri to locate data and convert into an input object.
         /// </summary>
         /// <param name="uri">Identifier of some source of an OpenAPI Description</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>A data object that can be processed by a reader to generate an <see cref="OpenApiDocument"/></returns>
-        Task<Stream> LoadAsync(Uri uri);
+        Task<Stream> LoadAsync(Uri uri, CancellationToken cancellationToken = default);
     }
 }

src/Microsoft.OpenApi/Reader/Services/DefaultStreamLoader.cs

@@ -4,6 +4,7 @@
 using System;
 using System.IO;
 using System.Net.Http;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -27,13 +28,8 @@ public DefaultStreamLoader(Uri baseUrl)
             this.baseUrl = baseUrl;
         }
 
-        /// <summary>
-        /// Use Uri to locate data and convert into an input object.
-        /// </summary>
-        /// <param name="uri">Identifier of some source of an OpenAPI Description</param>
-        /// <returns>A data object that can be processed by a reader to generate an <see cref="OpenApiDocument"/></returns>
-        /// <exception cref="ArgumentException"></exception>
-        public async Task<Stream> LoadAsync(Uri uri)
+        /// <inheritdoc/>
+        public async Task<Stream> LoadAsync(Uri uri, CancellationToken cancellationToken = default)
         {
             Uri absoluteUri;
             absoluteUri = baseUrl.AbsoluteUri.Equals(OpenApiConstants.BaseRegistryUri) ? new Uri(Directory.GetCurrentDirectory() + uri) 
@@ -45,7 +41,11 @@ public async Task<Stream> LoadAsync(Uri uri)
                     return File.OpenRead(absoluteUri.AbsolutePath);
                 case "http":
                 case "https":
-                    return await _httpClient.GetStreamAsync(absoluteUri);
+#if NET5_0_OR_GREATER
+                    return await _httpClient.GetStreamAsync(absoluteUri, cancellationToken).ConfigureAwait(false);
+#else
+                    return await _httpClient.GetStreamAsync(absoluteUri).ConfigureAwait(false);
+#endif
                 default:
                     throw new ArgumentException("Unsupported scheme");
             }

src/Microsoft.OpenApi/Reader/Services/OpenApiWorkspaceLoader.cs

@@ -45,16 +45,16 @@ internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference,
                 // If not already in workspace, load it and process references
                 if (!_workspace.Contains(item.ExternalResource))
                 {
-                    var input = await _loader.LoadAsync(new(item.ExternalResource, UriKind.RelativeOrAbsolute));
-                    var result = await OpenApiDocument.LoadAsync(input, format, _readerSettings, cancellationToken);
+                    var input = await _loader.LoadAsync(new(item.ExternalResource, UriKind.RelativeOrAbsolute), cancellationToken).ConfigureAwait(false);
+                    var result = await OpenApiDocument.LoadAsync(input, format, _readerSettings, cancellationToken).ConfigureAwait(false);
                     // Merge diagnostics
                     if (result.Diagnostic != null)
                     {
                         diagnostic.AppendDiagnostic(result.Diagnostic, item.ExternalResource);
                     }
                     if (result.Document != null)
                     {
-                        var loadDiagnostic = await LoadAsync(item, result.Document, format, diagnostic, cancellationToken);
+                        var loadDiagnostic = await LoadAsync(item, result.Document, format, diagnostic, cancellationToken).ConfigureAwait(false);
                         diagnostic = loadDiagnostic;
                     }
                 }

test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiDiagnosticTests.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System.Threading;
 using System.Threading.Tasks;
 using System;
 using Microsoft.OpenApi.Models;
@@ -64,7 +65,7 @@ public Stream Load(Uri uri)
             return null;
         }
 
-        public Task<Stream> LoadAsync(Uri uri)
+        public Task<Stream> LoadAsync(Uri uri, CancellationToken cancellationToken = default)
         {
             var path = new Uri(new("http://example.org/OpenApiReaderTests/Samples/OpenApiDiagnosticReportMerged/"), uri).AbsolutePath;
             path = path[1..]; // remove leading slash

test/Microsoft.OpenApi.Readers.Tests/OpenApiWorkspaceTests/OpenApiWorkspaceStreamTests.cs

@@ -1,5 +1,6 @@
 using System;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
@@ -80,7 +81,7 @@ public Stream Load(Uri uri)
             return null;
         }
 
-        public Task<Stream> LoadAsync(Uri uri)
+        public Task<Stream> LoadAsync(Uri uri, CancellationToken cancellationToken = default)
         {
             return Task.FromResult<Stream>(null);
         }
@@ -93,7 +94,7 @@ public Stream Load(Uri uri)
             return null;
         }
 
-        public Task<Stream> LoadAsync(Uri uri)
+        public Task<Stream> LoadAsync(Uri uri, CancellationToken cancellationToken = default)
         {
             var path = new Uri(new("http://example.org/V3Tests/Samples/OpenApiWorkspace/"), uri).AbsolutePath;
             path = path[1..]; // remove leading slash