pass cancellation token

MaggieKimani1 · MaggieKimani1 · commit 9389d792d4ac · 2024-11-19T16:58:07.000+03:00
diff --git a/src/Microsoft.OpenApi.Hidi/OpenApiService.cs b/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
@@ -97,7 +97,7 @@ public static async Task TransformOpenApiDocumentAsync(HidiOptions options, ILog
                 }
 
                 // Load OpenAPI document
-                var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi).ConfigureAwait(false);
+                var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi, cancellationToken).ConfigureAwait(false);
                 var document = await GetOpenApiAsync(options, format, logger, options.MetadataVersion, cancellationToken).ConfigureAwait(false);
 
                 if (options.FilterOptions != null)
@@ -586,7 +586,7 @@ private static string GetInputPathExtension(string? openapi = null, string? csdl
                     throw new ArgumentException("Please input a file path or URL");
                 }
 
-                var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi).ConfigureAwait(false);
+                var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi, cancellationToken).ConfigureAwait(false);
                 var document = await GetOpenApiAsync(options, format, logger, null, cancellationToken).ConfigureAwait(false);
 
                 using (logger.BeginScope("Creating diagram"))
@@ -748,7 +748,7 @@ internal static async Task PluginManifestAsync(HidiOptions options, ILogger logg
             }
 
             // Load OpenAPI document
-            var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi).ConfigureAwait(false);
+            var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi, cancellationToken).ConfigureAwait(false);
             var document = await GetOpenApiAsync(options, format, logger, options.MetadataVersion, cancellationToken).ConfigureAwait(false);
 
             cancellationToken.ThrowIfCancellationRequested();   
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs
@@ -48,6 +48,7 @@ public async Task<ReadResult> ReadAsync(TextReader input,
         public async Task<ReadFragmentResult<T>> ReadFragmentAsync<T>(TextReader input,
                                                                       OpenApiSpecVersion version,
                                                                       OpenApiReaderSettings settings = null) where T : IOpenApiElement
+                                                                      CancellationToken token = default) where T : IOpenApiElement
         {
             JsonNode jsonNode;
 
diff --git a/src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs b/src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
 using System.IO;
@@ -38,8 +38,9 @@ public interface IOpenApiReader
         /// <param name="input">TextReader containing OpenAPI description to parse.</param>
         /// <param name="version">Version of the OpenAPI specification that the fragment conforms to.</param>
         /// <param name="settings">The OpenApiReader settings.</param>
+        /// <param name="token"></param>
         /// <returns>Instance of newly created IOpenApiElement.</returns>
-        Task<ReadFragmentResult<T>> ReadFragmentAsync<T>(TextReader input, OpenApiSpecVersion version, OpenApiReaderSettings settings = null) where T: IOpenApiElement;
+        Task<ReadFragmentResult<T>> ReadFragmentAsync<T>(TextReader input, OpenApiSpecVersion version, OpenApiReaderSettings settings = null, CancellationToken token = default) where T : IOpenApiElement;
 
         /// <summary>
         /// Reads the JsonNode input and parses the fragment of an OpenAPI description into an Open API Element.
diff --git a/src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs b/src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using System.IO;
@@ -41,7 +41,7 @@ public async Task<ReadResult> ReadAsync(TextReader input,
             // Parse the JSON text in the TextReader into JsonNodes
             try
             {
-                jsonNode = await LoadJsonNodesAsync(input);
+                jsonNode = await LoadJsonNodesAsync(input, cancellationToken);
             }
             catch (JsonException ex)
             {
@@ -123,14 +123,15 @@ public async Task<ReadResult> ReadAsync(JsonNode jsonNode,
         /// <inheritdoc/>
         public async Task<ReadFragmentResult<T>> ReadFragmentAsync<T>(TextReader input,
                                                                       OpenApiSpecVersion version,
-                                                                      OpenApiReaderSettings settings = null) where T: IOpenApiElement
+                                                                      OpenApiReaderSettings settings = null,
+                                                                      CancellationToken token = default) where T: IOpenApiElement
         {
             JsonNode jsonNode;
 
             // Parse the JSON
             try
             {
-                jsonNode = await LoadJsonNodesAsync(input);
+                jsonNode = await LoadJsonNodesAsync(input, token);
             }
             catch (JsonException ex)
             {
@@ -182,9 +183,13 @@ public ReadFragmentResult<T> ReadFragment<T>(JsonNode input,
             };
         }
 
-        private async Task<JsonNode> LoadJsonNodesAsync(TextReader input)
+        private async Task<JsonNode> LoadJsonNodesAsync(TextReader input, CancellationToken token = default)
         {
+#if NETSTANDARD2_0
             var content = await input.ReadToEndAsync();
+#else
+    var content = await input.ReadToEndAsync(token);
+#endif            
             return JsonNode.Parse(content);
         }
 
diff --git a/src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs b/src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs
@@ -35,7 +35,7 @@ static OpenApiModelFactory()
         /// <returns></returns>
         public static async Task<ReadResult> LoadAsync(string url, OpenApiReaderSettings settings = null, CancellationToken cancellationToken = default)
         {
-            var format = await GetFormatAsync(url);
+            var format = await GetFormatAsync(url, cancellationToken);
             var stream = await GetStreamAsync(url);
             return await LoadAsync(stream, format, settings);
         }
@@ -129,7 +129,7 @@ public static async Task<ReadFragmentResult<T>> LoadAsync<T>(string url,
                                                                      OpenApiReaderSettings settings = null,
                                                                      CancellationToken cancellationToken = default) where T : IOpenApiElement
         {
-            var format = await GetFormatAsync(url);
+            var format = await GetFormatAsync(url, cancellationToken);
             settings ??= new OpenApiReaderSettings();
             var stream = await GetStreamAsync(url);
             return await LoadAsync<T>(stream, version, format, settings);
@@ -172,11 +172,15 @@ public static async Task<ReadFragmentResult<T>> LoadAsync<T>(TextReader input,
             return await OpenApiReaderRegistry.GetReader(format).ReadFragmentAsync<T>(input, version, settings);
         }
 
-        private static async Task<string> GetContentTypeAsync(string url)
+        private static async Task<string> GetContentTypeAsync(string url, CancellationToken token = default)
         {
             if (!string.IsNullOrEmpty(url))
             {
+#if NETSTANDARD2_0
                 var response = await _httpClient.GetAsync(url);
+#else
+                var response = await _httpClient.GetAsync(url, token);
+#endif
                 var mediaType = response.Content.Headers.ContentType.MediaType;
                 var contentType = mediaType.Split(";".ToCharArray(), StringSplitOptions.RemoveEmptyEntries).First();
                 return contentType;
@@ -189,8 +193,9 @@ private static async Task<string> GetContentTypeAsync(string url)
         /// Infers the OpenAPI format from the input URL.
         /// </summary>
         /// <param name="url">The input URL.</param>
+        /// <param name="token"></param>
         /// <returns>The OpenAPI format.</returns>
-        public static async Task<string> GetFormatAsync(string url)
+        public static async Task<string> GetFormatAsync(string url, CancellationToken token = default)
         {
             if (!string.IsNullOrEmpty(url))
             {
@@ -207,7 +212,7 @@ public static async Task<string> GetFormatAsync(string url)
                     }
                     else
                     {
-                        var contentType = await GetContentTypeAsync(url);
+                        var contentType = await GetContentTypeAsync(url, token);
                         return contentType.Split('/').LastOrDefault();
                     }
                 }

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public static async Task TransformOpenApiDocumentAsync(HidiOptions options, ILog`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`// Load OpenAPI document`
`100`		`- var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi).ConfigureAwait(false);`
	`100`	`+ var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi, cancellationToken).ConfigureAwait(false);`
`101`	`101`	`var document = await GetOpenApiAsync(options, format, logger, options.MetadataVersion, cancellationToken).ConfigureAwait(false);`
`102`	`102`
`103`	`103`	`if (options.FilterOptions != null)`
`@@ -586,7 +586,7 @@ private static string GetInputPathExtension(string? openapi = null, string? csdl`
`586`	`586`	`throw new ArgumentException("Please input a file path or URL");`
`587`	`587`	`}`
`588`	`588`
`589`		`- var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi).ConfigureAwait(false);`
	`589`	`+ var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi, cancellationToken).ConfigureAwait(false);`
`590`	`590`	`var document = await GetOpenApiAsync(options, format, logger, null, cancellationToken).ConfigureAwait(false);`
`591`	`591`
`592`	`592`	`using (logger.BeginScope("Creating diagram"))`
`@@ -748,7 +748,7 @@ internal static async Task PluginManifestAsync(HidiOptions options, ILogger logg`
`748`	`748`	`}`
`749`	`749`
`750`	`750`	`// Load OpenAPI document`
`751`		`- var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi).ConfigureAwait(false);`
	`751`	`+ var format = await OpenApiModelFactory.GetFormatAsync(options.OpenApi, cancellationToken).ConfigureAwait(false);`
`752`	`752`	`var document = await GetOpenApiAsync(options, format, logger, options.MetadataVersion, cancellationToken).ConfigureAwait(false);`
`753`	`753`
`754`	`754`	`cancellationToken.ThrowIfCancellationRequested();`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ public async Task<ReadResult> ReadAsync(TextReader input,`
`48`	`48`	`public async Task<ReadFragmentResult<T>> ReadFragmentAsync<T>(TextReader input,`
`49`	`49`	`OpenApiSpecVersion version,`
`50`	`50`	`OpenApiReaderSettings settings = null) where T : IOpenApiElement`
	`51`	`+ CancellationToken token = default) where T : IOpenApiElement`
`51`	`52`	`{`
`52`	`53`	`JsonNode jsonNode;`
`53`	`54`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) Microsoft Corporation. All rights reserved.`
	`1`	`+// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT license.`
`3`	`3`
`4`	`4`	`using System.IO;`
`@@ -41,7 +41,7 @@ public async Task<ReadResult> ReadAsync(TextReader input,`
`41`	`41`	`// Parse the JSON text in the TextReader into JsonNodes`
`42`	`42`	`try`
`43`	`43`	`{`
`44`		`- jsonNode = await LoadJsonNodesAsync(input);`
	`44`	`+ jsonNode = await LoadJsonNodesAsync(input, cancellationToken);`
`45`	`45`	`}`
`46`	`46`	`catch (JsonException ex)`
`47`	`47`	`{`
`@@ -123,14 +123,15 @@ public async Task<ReadResult> ReadAsync(JsonNode jsonNode,`
`123`	`123`	`/// <inheritdoc/>`
`124`	`124`	`public async Task<ReadFragmentResult<T>> ReadFragmentAsync<T>(TextReader input,`
`125`	`125`	`OpenApiSpecVersion version,`
`126`		`- OpenApiReaderSettings settings = null) where T: IOpenApiElement`
	`126`	`+ OpenApiReaderSettings settings = null,`
	`127`	`+ CancellationToken token = default) where T: IOpenApiElement`
`127`	`128`	`{`
`128`	`129`	`JsonNode jsonNode;`
`129`	`130`
`130`	`131`	`// Parse the JSON`
`131`	`132`	`try`
`132`	`133`	`{`
`133`		`- jsonNode = await LoadJsonNodesAsync(input);`
	`134`	`+ jsonNode = await LoadJsonNodesAsync(input, token);`
`134`	`135`	`}`
`135`	`136`	`catch (JsonException ex)`
`136`	`137`	`{`
`@@ -182,9 +183,13 @@ public ReadFragmentResult<T> ReadFragment<T>(JsonNode input,`
`182`	`183`	`};`
`183`	`184`	`}`
`184`	`185`
`185`		`- private async Task<JsonNode> LoadJsonNodesAsync(TextReader input)`
	`186`	`+ private async Task<JsonNode> LoadJsonNodesAsync(TextReader input, CancellationToken token = default)`
`186`	`187`	`{`
	`188`	`+#if NETSTANDARD2_0`
`187`	`189`	`var content = await input.ReadToEndAsync();`
	`190`	`+#else`
	`191`	`+ var content = await input.ReadToEndAsync(token);`
	`192`	`+#endif`
`188`	`193`	`return JsonNode.Parse(content);`
`189`	`194`	`}`
`190`	`195`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ static OpenApiModelFactory()`
`35`	`35`	`/// <returns></returns>`
`36`	`36`	`public static async Task<ReadResult> LoadAsync(string url, OpenApiReaderSettings settings = null, CancellationToken cancellationToken = default)`
`37`	`37`	`{`
`38`		`- var format = await GetFormatAsync(url);`
	`38`	`+ var format = await GetFormatAsync(url, cancellationToken);`
`39`	`39`	`var stream = await GetStreamAsync(url);`
`40`	`40`	`return await LoadAsync(stream, format, settings);`
`41`	`41`	`}`
`@@ -129,7 +129,7 @@ public static async Task<ReadFragmentResult<T>> LoadAsync<T>(string url,`
`129`	`129`	`OpenApiReaderSettings settings = null,`
`130`	`130`	`CancellationToken cancellationToken = default) where T : IOpenApiElement`
`131`	`131`	`{`
`132`		`- var format = await GetFormatAsync(url);`
	`132`	`+ var format = await GetFormatAsync(url, cancellationToken);`
`133`	`133`	`settings ??= new OpenApiReaderSettings();`
`134`	`134`	`var stream = await GetStreamAsync(url);`
`135`	`135`	`return await LoadAsync<T>(stream, version, format, settings);`
`@@ -172,11 +172,15 @@ public static async Task<ReadFragmentResult<T>> LoadAsync<T>(TextReader input,`
`172`	`172`	`return await OpenApiReaderRegistry.GetReader(format).ReadFragmentAsync<T>(input, version, settings);`
`173`	`173`	`}`
`174`	`174`
`175`		`- private static async Task<string> GetContentTypeAsync(string url)`
	`175`	`+ private static async Task<string> GetContentTypeAsync(string url, CancellationToken token = default)`
`176`	`176`	`{`
`177`	`177`	`if (!string.IsNullOrEmpty(url))`
`178`	`178`	`{`
	`179`	`+#if NETSTANDARD2_0`
`179`	`180`	`var response = await _httpClient.GetAsync(url);`
	`181`	`+#else`
	`182`	`+ var response = await _httpClient.GetAsync(url, token);`
	`183`	`+#endif`
`180`	`184`	`var mediaType = response.Content.Headers.ContentType.MediaType;`
`181`	`185`	`var contentType = mediaType.Split(";".ToCharArray(), StringSplitOptions.RemoveEmptyEntries).First();`
`182`	`186`	`return contentType;`
`@@ -189,8 +193,9 @@ private static async Task<string> GetContentTypeAsync(string url)`
`189`	`193`	`/// Infers the OpenAPI format from the input URL.`
`190`	`194`	`/// </summary>`
`191`	`195`	`/// <param name="url">The input URL.</param>`
	`196`	`+ /// <param name="token"></param>`
`192`	`197`	`/// <returns>The OpenAPI format.</returns>`
`193`		`- public static async Task<string> GetFormatAsync(string url)`
	`198`	`+ public static async Task<string> GetFormatAsync(string url, CancellationToken token = default)`
`194`	`199`	`{`
`195`	`200`	`if (!string.IsNullOrEmpty(url))`
`196`	`201`	`{`
`@@ -207,7 +212,7 @@ public static async Task<string> GetFormatAsync(string url)`
`207`	`212`	`}`
`208`	`213`	`else`
`209`	`214`	`{`
`210`		`- var contentType = await GetContentTypeAsync(url);`
	`215`	`+ var contentType = await GetContentTypeAsync(url, token);`
`211`	`216`	`return contentType.Split('/').LastOrDefault();`
`212`	`217`	`}`
`213`	`218`	`}`