Remove duplicate exception logged to console during startup failure. (#1664)

seantleonard · web-flow · commit ef942f6334cd · 2023-09-18T18:16:21.000Z
## Why make this change? -Work done as part of structured logging overhaul. #1517 ## What is this change? - Removes one instance where an exception is logged twice: 1. once automatically by dotnet 2. second when we manually include the exception message/stacktrace in exception handling. [Remove this instance] -Adds named parameters in ilogger call while making message generation for the console more concise. ILogger logError() and other ilogger calls allow you to include a parameter for the exception. That is logged automatically in ilogger so we don't have to additionally log the exception message in the logger message manually. ## How was this tested? manual testing: before: ![DupeExceptionLoggingStartup](https://github.com/Azure/data-api-builder/assets/6414189/9feb3133-673d-47ce-96dc-ffcb69b8a4a6) after: ![NoDupeExceptionLoggingStartup](https://github.com/Azure/data-api-builder/assets/6414189/42de7c5b-3144-490e-85e6-a72127defa43) ## Sample Request(s) - put a bad entity rest path (all else okay) to trigger startup failure. i.e. `"path": " /pathName"`
diff --git a/src/Config/RuntimeConfigLoader.cs b/src/Config/RuntimeConfigLoader.cs
@@ -147,18 +147,16 @@ public static bool TryParseConfig(string json,
         }
         catch (JsonException ex)
         {
-            string errorMessage = $"Deserialization of the configuration file failed.\n" +
-                        $"Message:\n {ex.Message}\n" +
-                        $"Stack Trace:\n {ex.StackTrace}";
+            string errorMessage = "Deserialization of the configuration file failed.";
 
+            // logger can be null when called from CLI
             if (logger is null)
             {
-                // logger can be null when called from CLI
-                Console.Error.WriteLine(errorMessage);
+                Console.Error.WriteLine(errorMessage + $"\n" + $"Message:\n {ex.Message}\n" + $"Stack Trace:\n {ex.StackTrace}");
             }
             else
             {
-                logger.LogError(ex, errorMessage);
+                logger.LogError(exception: ex, message: errorMessage);
             }
 
             config = null;
diff --git a/src/Service/Program.cs b/src/Service/Program.cs
@@ -36,9 +36,11 @@ public static bool StartEngine(string[] args)
                 CreateHostBuilder(args).Build().Run();
                 return true;
             }
-            catch (Exception ex)
+            catch (Exception)
             {
-                Console.Error.WriteLine($"Unable to launch the runtime due to: {ex}");
+                // Do not log the exception here because exceptions raised during startup
+                // are already automatically written to the console.
+                Console.Error.WriteLine($"Unable to launch the runtime due to an error.");
                 return false;
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -147,18 +147,16 @@ public static bool TryParseConfig(string json,`
`147`	`147`	`}`
`148`	`148`	`catch (JsonException ex)`
`149`	`149`	`{`
`150`		`- string errorMessage = $"Deserialization of the configuration file failed.\n" +`
`151`		`- $"Message:\n {ex.Message}\n" +`
`152`		`- $"Stack Trace:\n {ex.StackTrace}";`
	`150`	`+ string errorMessage = "Deserialization of the configuration file failed.";`
`153`	`151`
	`152`	`+ // logger can be null when called from CLI`
`154`	`153`	`if (logger is null)`
`155`	`154`	`{`
`156`		`- // logger can be null when called from CLI`
`157`		`- Console.Error.WriteLine(errorMessage);`
	`155`	`+ Console.Error.WriteLine(errorMessage + $"\n" + $"Message:\n {ex.Message}\n" + $"Stack Trace:\n {ex.StackTrace}");`
`158`	`156`	`}`
`159`	`157`	`else`
`160`	`158`	`{`
`161`		`- logger.LogError(ex, errorMessage);`
	`159`	`+ logger.LogError(exception: ex, message: errorMessage);`
`162`	`160`	`}`
`163`	`161`
`164`	`162`	`config = null;`
Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,11 @@ public static bool StartEngine(string[] args)`
`36`	`36`	`CreateHostBuilder(args).Build().Run();`
`37`	`37`	`return true;`
`38`	`38`	`}`
`39`		`- catch (Exception ex)`
	`39`	`+ catch (Exception)`
`40`	`40`	`{`
`41`		`- Console.Error.WriteLine($"Unable to launch the runtime due to: {ex}");`
	`41`	`+ // Do not log the exception here because exceptions raised during startup`
	`42`	`+ // are already automatically written to the console.`
	`43`	`+ Console.Error.WriteLine($"Unable to launch the runtime due to an error.");`
`42`	`44`	`return false;`
`43`	`45`	`}`
`44`	`46`	`}`