Skip to content

Commit b711794

Browse files
authored
Merge pull request #1379 from SimonCropp/CancellationToken
cleanup CancellationToken
2 parents cee58fd + 35851e0 commit b711794

File tree

4 files changed

+28
-28
lines changed

4 files changed

+28
-28
lines changed

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ internal static class OpenApiService
4141
/// <summary>
4242
/// Implementation of the transform command
4343
/// </summary>
44-
public static async Task TransformOpenApiDocument(HidiOptions options, ILogger logger, CancellationToken cancellationToken)
44+
public static async Task TransformOpenApiDocument(HidiOptions options, ILogger logger, CancellationToken cancellationToken = default)
4545
{
4646
if (string.IsNullOrEmpty(options.OpenApi) && string.IsNullOrEmpty(options.Csdl) && string.IsNullOrEmpty(options.FilterOptions?.FilterByApiManifest))
4747
{
@@ -85,7 +85,7 @@ public static async Task TransformOpenApiDocument(HidiOptions options, ILogger l
8585
}
8686

8787
// Load OpenAPI document
88-
OpenApiDocument document = await GetOpenApi(options, logger, cancellationToken, options.MetadataVersion).ConfigureAwait(false);
88+
OpenApiDocument document = await GetOpenApi(options, logger, options.MetadataVersion, cancellationToken).ConfigureAwait(false);
8989

9090
if (options.FilterOptions != null)
9191
{
@@ -116,7 +116,7 @@ public static async Task TransformOpenApiDocument(HidiOptions options, ILogger l
116116
}
117117
}
118118

119-
private static async Task<ApiDependency?> FindApiDependency(string? apiManifestPath, ILogger logger, CancellationToken cancellationToken)
119+
private static async Task<ApiDependency?> FindApiDependency(string? apiManifestPath, ILogger logger, CancellationToken cancellationToken = default)
120120
{
121121
ApiDependency? apiDependency = null;
122122
// If API Manifest is provided, load it, use it get the OpenAPI path
@@ -212,7 +212,7 @@ private static void WriteOpenApi(HidiOptions options, OpenApiFormat openApiForma
212212
}
213213

214214
// Get OpenAPI document either from OpenAPI or CSDL
215-
private static async Task<OpenApiDocument> GetOpenApi(HidiOptions options, ILogger logger, CancellationToken cancellationToken, string? metadataVersion = null)
215+
private static async Task<OpenApiDocument> GetOpenApi(HidiOptions options, ILogger logger, string? metadataVersion = null, CancellationToken cancellationToken = default)
216216
{
217217

218218
OpenApiDocument document;
@@ -326,7 +326,7 @@ private static Stream ApplyFilterToCsdl(Stream csdlStream, string entitySetOrSin
326326
public static async Task ValidateOpenApiDocument(
327327
string openApi,
328328
ILogger logger,
329-
CancellationToken cancellationToken)
329+
CancellationToken cancellationToken = default)
330330
{
331331
if (string.IsNullOrEmpty(openApi))
332332
{
@@ -361,7 +361,7 @@ public static async Task ValidateOpenApiDocument(
361361
}
362362
}
363363

364-
private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream, CancellationToken cancellationToken)
364+
private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream, CancellationToken cancellationToken = default)
365365
{
366366
ReadResult result;
367367
Stopwatch stopwatch = Stopwatch.StartNew();
@@ -480,7 +480,7 @@ private static Dictionary<string, List<string>> EnumerateJsonDocument(JsonElemen
480480
/// <summary>
481481
/// Reads stream from file system or makes HTTP request depending on the input string
482482
/// </summary>
483-
private static async Task<Stream> GetStream(string input, ILogger logger, CancellationToken cancellationToken)
483+
private static async Task<Stream> GetStream(string input, ILogger logger, CancellationToken cancellationToken = default)
484484
{
485485
Stream stream;
486486
using (logger.BeginScope("Reading input stream"))
@@ -556,7 +556,7 @@ private static string GetInputPathExtension(string? openapi = null, string? csdl
556556
return extension;
557557
}
558558

559-
internal static async Task<string?> ShowOpenApiDocument(HidiOptions options, ILogger logger, CancellationToken cancellationToken)
559+
internal static async Task<string?> ShowOpenApiDocument(HidiOptions options, ILogger logger, CancellationToken cancellationToken = default)
560560
{
561561
try
562562
{
@@ -565,7 +565,7 @@ private static string GetInputPathExtension(string? openapi = null, string? csdl
565565
throw new ArgumentException("Please input a file path or URL");
566566
}
567567

568-
var document = await GetOpenApi(options, logger, cancellationToken).ConfigureAwait(false);
568+
var document = await GetOpenApi(options, logger, null, cancellationToken).ConfigureAwait(false);
569569

570570
using (logger.BeginScope("Creating diagram"))
571571
{
@@ -716,7 +716,7 @@ internal static void WriteTreeDocumentAsHtml(string sourceUrl, OpenApiDocument d
716716
writer.WriteLine("</html");
717717
}
718718

719-
internal static async Task PluginManifest(HidiOptions options, ILogger logger, CancellationToken cancellationToken)
719+
internal static async Task PluginManifest(HidiOptions options, ILogger logger, CancellationToken cancellationToken = default)
720720
{
721721
// If ApiManifest is provided, set the referenced OpenAPI document
722722
var apiDependency = await FindApiDependency(options.FilterOptions?.FilterByApiManifest, logger, cancellationToken).ConfigureAwait(false);
@@ -726,7 +726,7 @@ internal static async Task PluginManifest(HidiOptions options, ILogger logger, C
726726
}
727727

728728
// Load OpenAPI document
729-
OpenApiDocument document = await GetOpenApi(options, logger, cancellationToken, options.MetadataVersion).ConfigureAwait(false);
729+
OpenApiDocument document = await GetOpenApi(options, logger, options.MetadataVersion, cancellationToken).ConfigureAwait(false);
730730

731731
cancellationToken.ThrowIfCancellationRequested();
732732

src/Microsoft.OpenApi.Readers/OpenApiYamlDocumentReader.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,15 +139,15 @@ public async Task<ReadResult> ReadAsync(YamlDocument input, CancellationToken ca
139139
};
140140
}
141141

142-
private async Task<OpenApiDiagnostic> LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken)
142+
private async Task<OpenApiDiagnostic> LoadExternalRefs(OpenApiDocument document, CancellationToken cancellationToken = default)
143143
{
144144
// Create workspace for all documents to live in.
145145
var openApiWorkSpace = new OpenApiWorkspace();
146146

147147
// Load this root document into the workspace
148148
var streamLoader = new DefaultStreamLoader(_settings.BaseUrl);
149149
var workspaceLoader = new OpenApiWorkspaceLoader(openApiWorkSpace, _settings.CustomExternalLoader ?? streamLoader, _settings);
150-
return await workspaceLoader.LoadAsync(new OpenApiReference { ExternalResource = "/" }, document, cancellationToken);
150+
return await workspaceLoader.LoadAsync(new OpenApiReference { ExternalResource = "/" }, document, null, cancellationToken);
151151
}
152152

153153
private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument document)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public OpenApiWorkspaceLoader(OpenApiWorkspace workspace, IStreamLoader loader,
2020
_readerSettings = readerSettings;
2121
}
2222

23-
internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference, OpenApiDocument document, CancellationToken cancellationToken, OpenApiDiagnostic diagnostic = null)
23+
internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference, OpenApiDocument document, OpenApiDiagnostic diagnostic = null, CancellationToken cancellationToken = default)
2424
{
2525
_workspace.AddDocument(reference.ExternalResource, document);
2626
document.Workspace = _workspace;
@@ -52,7 +52,7 @@ internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference, Ope
5252
}
5353
if (result.OpenApiDocument != null)
5454
{
55-
var loadDiagnostic = await LoadAsync(item, result.OpenApiDocument, cancellationToken, diagnostic);
55+
var loadDiagnostic = await LoadAsync(item, result.OpenApiDocument, diagnostic, cancellationToken);
5656
diagnostic = loadDiagnostic;
5757
}
5858
}

test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ public async Task ShowCommandGeneratesMermaidMarkdownFileWithMermaidDiagram()
141141
Output = new FileInfo("sample.md")
142142
};
143143

144-
await OpenApiService.ShowOpenApiDocument(options, _logger, new CancellationToken());
144+
await OpenApiService.ShowOpenApiDocument(options, _logger);
145145

146146
var output = await File.ReadAllTextAsync(options.Output.FullName);
147147
Assert.Contains("graph LR", output, StringComparison.Ordinal);
@@ -154,7 +154,7 @@ public async Task ShowCommandGeneratesMermaidHtmlFileWithMermaidDiagram()
154154
{
155155
OpenApi = Path.Combine("UtilityFiles", "SampleOpenApi.yml")
156156
};
157-
var filePath = await OpenApiService.ShowOpenApiDocument(options, _logger, new CancellationToken());
157+
var filePath = await OpenApiService.ShowOpenApiDocument(options, _logger);
158158
Assert.True(File.Exists(filePath));
159159
}
160160

@@ -169,7 +169,7 @@ public async Task ShowCommandGeneratesMermaidMarkdownFileFromCsdlWithMermaidDiag
169169
};
170170

171171
// create a dummy ILogger instance for testing
172-
await OpenApiService.ShowOpenApiDocument(options, _logger, new CancellationToken());
172+
await OpenApiService.ShowOpenApiDocument(options, _logger);
173173

174174
var output = await File.ReadAllTextAsync(options.Output.FullName);
175175
Assert.Contains("graph LR", output, StringComparison.Ordinal);
@@ -179,29 +179,29 @@ public async Task ShowCommandGeneratesMermaidMarkdownFileFromCsdlWithMermaidDiag
179179
public async Task ThrowIfOpenApiUrlIsNotProvidedWhenValidating()
180180
{
181181
await Assert.ThrowsAsync<ArgumentNullException>(async () =>
182-
await OpenApiService.ValidateOpenApiDocument("", _logger, new CancellationToken()));
182+
await OpenApiService.ValidateOpenApiDocument("", _logger));
183183
}
184184

185185

186186
[Fact]
187187
public async Task ThrowIfURLIsNotResolvableWhenValidating()
188188
{
189189
await Assert.ThrowsAsync<InvalidOperationException>(async () =>
190-
await OpenApiService.ValidateOpenApiDocument("https://example.org/itdoesnmatter", _logger, new CancellationToken()));
190+
await OpenApiService.ValidateOpenApiDocument("https://example.org/itdoesnmatter", _logger));
191191
}
192192

193193
[Fact]
194194
public async Task ThrowIfFileDoesNotExistWhenValidating()
195195
{
196196
await Assert.ThrowsAsync<InvalidOperationException>(async () =>
197-
await OpenApiService.ValidateOpenApiDocument("aFileThatBetterNotExist.fake", _logger, new CancellationToken()));
197+
await OpenApiService.ValidateOpenApiDocument("aFileThatBetterNotExist.fake", _logger));
198198
}
199199

200200
[Fact]
201201
public async Task ValidateCommandProcessesOpenApi()
202202
{
203203
// create a dummy ILogger instance for testing
204-
await OpenApiService.ValidateOpenApiDocument(Path.Combine("UtilityFiles", "SampleOpenApi.yml"), _logger, new CancellationToken());
204+
await OpenApiService.ValidateOpenApiDocument(Path.Combine("UtilityFiles", "SampleOpenApi.yml"), _logger);
205205

206206
Assert.True(true);
207207
}
@@ -220,7 +220,7 @@ public async Task TransformCommandConvertsOpenApi()
220220
InlineExternal = false,
221221
};
222222
// create a dummy ILogger instance for testing
223-
await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
223+
await OpenApiService.TransformOpenApiDocument(options, _logger);
224224

225225
var output = await File.ReadAllTextAsync("sample.json");
226226
Assert.NotEmpty(output);
@@ -239,7 +239,7 @@ public async Task TransformCommandConvertsOpenApiWithDefaultOutputName()
239239
InlineExternal = false,
240240
};
241241
// create a dummy ILogger instance for testing
242-
await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
242+
await OpenApiService.TransformOpenApiDocument(options, _logger);
243243

244244
var output = await File.ReadAllTextAsync("output.yml");
245245
Assert.NotEmpty(output);
@@ -257,7 +257,7 @@ public async Task TransformCommandConvertsCsdlWithDefaultOutputName()
257257
InlineExternal = false,
258258
};
259259
// create a dummy ILogger instance for testing
260-
await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
260+
await OpenApiService.TransformOpenApiDocument(options, _logger);
261261

262262
var output = await File.ReadAllTextAsync("output.yml");
263263
Assert.NotEmpty(output);
@@ -277,7 +277,7 @@ public async Task TransformCommandConvertsOpenApiWithDefaultOutputNameAndSwitchF
277277
InlineExternal = false,
278278
};
279279
// create a dummy ILogger instance for testing
280-
await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
280+
await OpenApiService.TransformOpenApiDocument(options, _logger);
281281

282282
var output = await File.ReadAllTextAsync("output.yml");
283283
Assert.NotEmpty(output);
@@ -294,7 +294,7 @@ public async Task ThrowTransformCommandIfOpenApiAndCsdlAreEmpty()
294294
InlineExternal = false,
295295
};
296296
await Assert.ThrowsAsync<ArgumentException>(async () =>
297-
await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken()));
297+
await OpenApiService.TransformOpenApiDocument(options, _logger));
298298

299299
}
300300

@@ -314,7 +314,7 @@ public async Task TransformToPowerShellCompliantOpenApi()
314314
SettingsConfig = SettingsUtilities.GetConfiguration(settingsPath)
315315
};
316316
// create a dummy ILogger instance for testing
317-
await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
317+
await OpenApiService.TransformOpenApiDocument(options, _logger);
318318

319319
var output = await File.ReadAllTextAsync("output.yml");
320320
Assert.NotEmpty(output);

0 commit comments

Comments
 (0)