Better error handling

Author: MaggieKimani1

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -22,6 +22,7 @@
 using Microsoft.OpenApi.Services;
 using Microsoft.OpenApi.Validations;
 using Microsoft.OpenApi.Writers;
+using System.Threading;
 
 namespace Microsoft.OpenApi.Hidi
 {
@@ -38,7 +39,8 @@ public static async Task ProcessOpenApiDocument(
             bool resolveexternal,
             string filterbyoperationids,
             string filterbytags,
-            string filterbycollection
+            string filterbycollection,
+            CancellationToken cancellationToken
            )
         {
             var logger = ConfigureLoggerInstance(loglevel);
@@ -52,7 +54,11 @@ string filterbycollection
             }
             catch (ArgumentNullException ex)
             {
-                logger.LogError(ex.Message);
+#if DEBUG
+                logger.LogCritical(ex, ex.Message);
+#else
+                logger.LogCritical(ex.Message);
+#endif
                 return;
             }
             try
@@ -64,19 +70,27 @@ string filterbycollection
             }
             catch (ArgumentException ex)
             {
-                logger.LogError(ex.Message);
+#if DEBUG
+                logger.LogCritical(ex, ex.Message);
+#else
+                logger.LogCritical(ex.Message);
+#endif
                 return;
             }
             try
             {
                 if (output.Exists)
                 {
-                    throw new IOException("The file you're writing to already exists. Please input a new file path.");
+                    throw new IOException($"The file {output} already exists. Please input a new file path.");
                 }
             }
             catch (IOException ex)
             {
-                logger.LogError(ex.Message);
+#if DEBUG  
+                logger.LogCritical(ex, ex.Message);
+#else
+                logger.LogCritical(ex.Message);
+#endif
                 return;
             }
 
@@ -91,12 +105,12 @@ string filterbycollection
                 openApiFormat = format ?? GetOpenApiFormat(csdl, logger);
                 version ??= OpenApiSpecVersion.OpenApi3_0;
 
-                stream = await GetStream(csdl, logger);
+                stream = await GetStream(csdl, logger, cancellationToken);
                 document = await ConvertCsdlToOpenApi(stream);
             }
             else
             {
-                stream = await GetStream(openapi, logger);
+                stream = await GetStream(openapi, logger, cancellationToken);
 
                 // Parsing OpenAPI file
                 stopwatch.Start();
@@ -156,7 +170,7 @@ string filterbycollection
             }
             if (!string.IsNullOrEmpty(filterbycollection))
             {
-                var fileStream = await GetStream(filterbycollection, logger);
+                var fileStream = await GetStream(filterbycollection, logger, cancellationToken);
                 var requestUrls = ParseJsonCollectionFile(fileStream, logger);
 
                 logger.LogTrace("Creating predicate based on the paths and Http methods defined in the Postman collection.");
@@ -245,7 +259,7 @@ public static OpenApiDocument FixReferences(OpenApiDocument document)
             return doc;
         }
 
-        private static async Task<Stream> GetStream(string input, ILogger logger)
+        private static async Task<Stream> GetStream(string input, ILogger logger, CancellationToken cancellationToken)
         {
             var stopwatch = new Stopwatch();
             stopwatch.Start();
@@ -263,11 +277,15 @@ private static async Task<Stream> GetStream(string input, ILogger logger)
                     {
                       DefaultRequestVersion = HttpVersion.Version20
                     };
-                    stream = await httpClient.GetStreamAsync(input);
+                    stream = await httpClient.GetStreamAsync(input, cancellationToken);
                 }
                 catch (HttpRequestException ex)
                 {
-                    logger.LogError($"Could not download the file at {input}, reason{ex}");
+#if DEBUG
+                    logger.LogCritical(ex, $"Could not download the file at {input}, reason: {ex.Message}");
+#else
+                    logger.LogCritical($"Could not download the file at {input}, reason: {ex.Message}", input, ex.Message);
+#endif
                     return null;
                 }
             }
@@ -286,7 +304,11 @@ ex is UnauthorizedAccessException ||
                     ex is SecurityException ||
                     ex is NotSupportedException)
                 {
-                    logger.LogError($"Could not open the file at {input}, reason: {ex.Message}");
+#if DEBUG
+                    logger.LogCritical(ex, $"Could not open the file at {input}, reason: {ex.Message}");
+#else
+                    logger.LogCritical($"Could not open the file at {input}, reason: {ex.Message}");
+#endif
                     return null;
                 }
             }
@@ -327,14 +349,14 @@ public static Dictionary<string, List<string>> ParseJsonCollectionFile(Stream st
             return requestUrls;
         }
 
-        internal static async Task ValidateOpenApiDocument(string openapi, LogLevel loglevel)
+        internal static async Task ValidateOpenApiDocument(string openapi, LogLevel loglevel, CancellationToken cancellationToken)
         {
             if (string.IsNullOrEmpty(openapi))
             {
                 throw new ArgumentNullException(nameof(openapi));
             }
             var logger = ConfigureLoggerInstance(loglevel);
-            var stream = await GetStream(openapi, logger);
+            var stream = await GetStream(openapi, logger, cancellationToken);
 
             OpenApiDocument document;
             logger.LogTrace("Parsing the OpenApi file");
@@ -369,16 +391,16 @@ private static OpenApiFormat GetOpenApiFormat(string input, ILogger logger)
         private static ILogger ConfigureLoggerInstance(LogLevel loglevel)
         {
             // Configure logger options
-            #if DEBUG
+#if DEBUG
             loglevel = loglevel > LogLevel.Debug ? LogLevel.Debug : loglevel;
-            #endif
+#endif
 
             var logger = LoggerFactory.Create((builder) => {
                 builder
                     .AddConsole()
-                #if DEBUG
+#if DEBUG
                     .AddDebug()
-                #endif
+#endif
                     .SetMinimumLevel(loglevel);
             }).CreateLogger<OpenApiService>();
 

src/Microsoft.OpenApi.Hidi/Program.cs

@@ -3,6 +3,7 @@
 
 using System.CommandLine;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 
@@ -55,7 +56,7 @@ static async Task<int> Main(string[] args)
                 logLevelOption
             };
 
-            validateCommand.SetHandler<string, LogLevel>(OpenApiService.ValidateOpenApiDocument, descriptionOption, logLevelOption);
+            validateCommand.SetHandler<string, LogLevel, CancellationToken>(OpenApiService.ValidateOpenApiDocument, descriptionOption, logLevelOption);
 
             var transformCommand = new Command("transform")
             {
@@ -72,7 +73,7 @@ static async Task<int> Main(string[] args)
                 resolveExternalOption,
             };
 
-            transformCommand.SetHandler<string, string, FileInfo, OpenApiSpecVersion?, OpenApiFormat?, LogLevel, bool, bool, string, string, string> (
+            transformCommand.SetHandler<string, string, FileInfo, OpenApiSpecVersion?, OpenApiFormat?, LogLevel, bool, bool, string, string, string, CancellationToken> (
                 OpenApiService.ProcessOpenApiDocument, descriptionOption, csdlOption, outputOption, versionOption, formatOption, logLevelOption, inlineOption, resolveExternalOption, filterByOperationIdsOption, filterByTagsOption, filterByCollectionOption);
 
             rootCommand.Add(transformCommand);