From db4652c0bee3c348cfba12ceaa0b28f30ff518f9 Mon Sep 17 00:00:00 2001 From: Nikolaj Date: Mon, 14 Sep 2020 11:49:47 +0200 Subject: [PATCH] Align fatal exception with message --- src/Umbraco.Core/Logging/ConsoleLogger.cs | 10 ++-------- src/Umbraco.Core/Logging/DebugDiagnosticsLogger.cs | 12 +++--------- src/Umbraco.Core/Logging/ILogger.cs | 11 +---------- src/Umbraco.Core/Logging/LoggerExtensions.cs | 4 ++-- src/Umbraco.Core/Logging/NullLogger.cs | 7 +------ src/Umbraco.Core/Logging/ProfilingLogger.cs | 7 ++----- .../Logging/Serilog/SerilogLogger.cs | 11 ++--------- .../Umbraco.Core/Composing/TypeFinderTests.cs | 2 +- .../Migrations/AdvancedMigrationTests.cs | 10 +++++----- src/Umbraco.Tests/Models/ContentTests.cs | 2 +- .../Persistence/NPocoTests/NPocoBulkInsertTests.cs | 2 +- src/Umbraco.Tests/Runtimes/CoreRuntimeTests.cs | 4 ++-- .../Scheduling/BackgroundTaskRunnerTests2.cs | 4 ++-- .../Services/ContentServicePerformanceTest.cs | 2 +- src/Umbraco.Tests/Services/PerformanceTests.cs | 2 +- src/Umbraco.Web/Logging/OwinLogger.cs | 2 +- 16 files changed, 28 insertions(+), 64 deletions(-) diff --git a/src/Umbraco.Core/Logging/ConsoleLogger.cs b/src/Umbraco.Core/Logging/ConsoleLogger.cs index 98ec79358c..26f119d0af 100644 --- a/src/Umbraco.Core/Logging/ConsoleLogger.cs +++ b/src/Umbraco.Core/Logging/ConsoleLogger.cs @@ -14,21 +14,15 @@ namespace Umbraco.Core.Logging public bool IsEnabled(Type reporting, LogLevel level) => true; - public void Fatal(Type reporting, Exception exception, string message) - { - Console.WriteLine("FATAL {0} - {1}", reporting.Name, message); - Console.WriteLine(exception); - } - public void Fatal(Type reporting, Exception exception) { Console.WriteLine("FATAL {0}", reporting.Name); Console.WriteLine(exception); } - public void Fatal(Type reporting, Exception exception, string messageTemplate, params object[] propertyValues) + public void LogCritical(Exception exception, string messageTemplate, params object[] propertyValues) { - Console.WriteLine("FATAL {0} - {1}", reporting.Name, _messageTemplates.Render(messageTemplate, propertyValues)); + Console.WriteLine("FATAL {0} - {1}", typeof(T).Name, _messageTemplates.Render(messageTemplate, propertyValues)); Console.WriteLine(exception); } diff --git a/src/Umbraco.Core/Logging/DebugDiagnosticsLogger.cs b/src/Umbraco.Core/Logging/DebugDiagnosticsLogger.cs index 7bc412c4dd..9fe37dd40f 100644 --- a/src/Umbraco.Core/Logging/DebugDiagnosticsLogger.cs +++ b/src/Umbraco.Core/Logging/DebugDiagnosticsLogger.cs @@ -5,7 +5,7 @@ namespace Umbraco.Core.Logging /// /// Implements on top of . /// - public class DebugDiagnosticsLogger : ILogger + public class DebugDiagnosticsLogger : ILogger { private readonly IMessageTemplates _messageTemplates; @@ -17,12 +17,6 @@ namespace Umbraco.Core.Logging public bool IsEnabled(Type reporting, LogLevel level) => true; - /// - public void Fatal(Type reporting, Exception exception, string message) - { - System.Diagnostics.Debug.WriteLine(message + Environment.NewLine + exception, reporting.FullName); - } - /// public void Fatal(Type reporting, Exception exception) { @@ -30,9 +24,9 @@ namespace Umbraco.Core.Logging } /// - public void Fatal(Type reporting, Exception exception, string messageTemplate, params object[] propertyValues) + public void LogCritical(Exception exception, string messageTemplate, params object[] propertyValues) { - System.Diagnostics.Debug.WriteLine(_messageTemplates.Render(messageTemplate, propertyValues) + Environment.NewLine + exception, reporting.FullName); + System.Diagnostics.Debug.WriteLine(_messageTemplates.Render(messageTemplate, propertyValues) + Environment.NewLine + exception, typeof(T).FullName); } /// diff --git a/src/Umbraco.Core/Logging/ILogger.cs b/src/Umbraco.Core/Logging/ILogger.cs index db550c0c6e..dfaa42f1aa 100644 --- a/src/Umbraco.Core/Logging/ILogger.cs +++ b/src/Umbraco.Core/Logging/ILogger.cs @@ -24,14 +24,6 @@ namespace Umbraco.Core.Logging /// The level. bool IsEnabled(Type reporting, LogLevel level); - /// - /// Logs a fatal message with an exception. - /// - /// The reporting type. - /// An exception. - /// A message. - void Fatal(Type reporting, Exception exception, string message); - /// /// Logs a fatal exception. /// @@ -43,11 +35,10 @@ namespace Umbraco.Core.Logging /// /// Logs a fatal message with an exception. /// - /// The reporting type. /// An exception. /// A message template. /// Property values. - void Fatal(Type reporting, Exception exception, string messageTemplate, params object[] propertyValues); + void LogCritical(Exception exception, string messageTemplate, params object[] propertyValues); /// /// Logs a fatal message. diff --git a/src/Umbraco.Core/Logging/LoggerExtensions.cs b/src/Umbraco.Core/Logging/LoggerExtensions.cs index e75e66318c..ef006edd21 100644 --- a/src/Umbraco.Core/Logging/LoggerExtensions.cs +++ b/src/Umbraco.Core/Logging/LoggerExtensions.cs @@ -170,7 +170,7 @@ namespace Umbraco.Core.Logging /// An exception. /// A message. public static void Fatal(this ILogger logger, Exception exception, string message) - => logger.Fatal(typeof(T), exception, message); + => logger.LogCritical(exception, message, new object[] { }); /// /// Logs a fatal message. @@ -181,6 +181,6 @@ namespace Umbraco.Core.Logging /// A message template. /// Property values. public static void Fatal(this ILogger logger, Exception exception, string messageTemplate, params object[] propertyValues) - => logger.Fatal(typeof(T), exception, messageTemplate, propertyValues); + => logger.LogCritical(exception, messageTemplate, propertyValues); } } diff --git a/src/Umbraco.Core/Logging/NullLogger.cs b/src/Umbraco.Core/Logging/NullLogger.cs index 1a607eea29..302fe46592 100644 --- a/src/Umbraco.Core/Logging/NullLogger.cs +++ b/src/Umbraco.Core/Logging/NullLogger.cs @@ -6,17 +6,12 @@ namespace Umbraco.Core.Logging { public bool IsEnabled(Type reporting, LogLevel level) => false; - public void Fatal(Type reporting, Exception exception, string message) - { - - } - public void Fatal(Type reporting, Exception exception) { } - public void Fatal(Type reporting, Exception exception, string messageTemplate, params object[] propertyValues) + public void LogCritical(Exception exception, string messageTemplate, params object[] propertyValues) { } diff --git a/src/Umbraco.Core/Logging/ProfilingLogger.cs b/src/Umbraco.Core/Logging/ProfilingLogger.cs index 660c37baac..9670874d65 100644 --- a/src/Umbraco.Core/Logging/ProfilingLogger.cs +++ b/src/Umbraco.Core/Logging/ProfilingLogger.cs @@ -67,14 +67,11 @@ namespace Umbraco.Core.Logging public bool IsEnabled(Type reporting, LogLevel level) => Logger.IsEnabled(reporting, level); - public void Fatal(Type reporting, Exception exception, string message) - => Logger.Fatal(reporting, exception, message); - public void Fatal(Type reporting, Exception exception) => Logger.Fatal(reporting, exception); - public void Fatal(Type reporting, Exception exception, string messageTemplate, params object[] propertyValues) - => Logger.Fatal(reporting, exception, messageTemplate, propertyValues); + public void LogCritical(Exception exception, string messageTemplate, params object[] propertyValues) + => Logger.LogCritical(exception, messageTemplate, propertyValues); public void LogCritical(string messageTemplate, params object[] propertyValues) => Logger.LogCritical(messageTemplate, propertyValues); diff --git a/src/Umbraco.Infrastructure/Logging/Serilog/SerilogLogger.cs b/src/Umbraco.Infrastructure/Logging/Serilog/SerilogLogger.cs index c9f3af7a3b..dac7e86f51 100644 --- a/src/Umbraco.Infrastructure/Logging/Serilog/SerilogLogger.cs +++ b/src/Umbraco.Infrastructure/Logging/Serilog/SerilogLogger.cs @@ -80,13 +80,6 @@ namespace Umbraco.Core.Logging.Serilog public bool IsEnabled(Type reporting, LogLevel level) => LoggerFor(reporting).IsEnabled(MapLevel(level)); - /// - public void Fatal(Type reporting, Exception exception, string message) - { - var logger = LoggerFor(reporting); - logger.Fatal(exception, message); - } - /// public void Fatal(Type reporting, Exception exception) { @@ -102,9 +95,9 @@ namespace Umbraco.Core.Logging.Serilog } /// - public void Fatal(Type reporting, Exception exception, string messageTemplate, params object[] propertyValues) + public void LogCritical(Exception exception, string messageTemplate, params object[] propertyValues) { - var logger = LoggerFor(reporting); + var logger = LoggerFor(typeof(T)); logger.Fatal(exception, messageTemplate, propertyValues); } diff --git a/src/Umbraco.Tests.UnitTests/Umbraco.Core/Composing/TypeFinderTests.cs b/src/Umbraco.Tests.UnitTests/Umbraco.Core/Composing/TypeFinderTests.cs index e0e87fb1ee..7f7a67dacc 100644 --- a/src/Umbraco.Tests.UnitTests/Umbraco.Core/Composing/TypeFinderTests.cs +++ b/src/Umbraco.Tests.UnitTests/Umbraco.Core/Composing/TypeFinderTests.cs @@ -60,7 +60,7 @@ namespace Umbraco.Tests.Composing private static IProfilingLogger GetTestProfilingLogger() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var profiler = new TestProfiler(); return new ProfilingLogger(logger, profiler); } diff --git a/src/Umbraco.Tests/Migrations/AdvancedMigrationTests.cs b/src/Umbraco.Tests/Migrations/AdvancedMigrationTests.cs index 966c4109c6..9b55362c67 100644 --- a/src/Umbraco.Tests/Migrations/AdvancedMigrationTests.cs +++ b/src/Umbraco.Tests/Migrations/AdvancedMigrationTests.cs @@ -21,7 +21,7 @@ namespace Umbraco.Tests.Migrations [Test] public void CreateTableOfTDto() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var builder = Mock.Of(); Mock.Get(builder) @@ -53,7 +53,7 @@ namespace Umbraco.Tests.Migrations [Test] public void DeleteKeysAndIndexesOfTDto() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var builder = Mock.Of(); Mock.Get(builder) @@ -87,7 +87,7 @@ namespace Umbraco.Tests.Migrations [Test] public void CreateKeysAndIndexesOfTDto() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var builder = Mock.Of(); Mock.Get(builder) @@ -124,7 +124,7 @@ namespace Umbraco.Tests.Migrations [Test] public void CreateKeysAndIndexes() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var builder = Mock.Of(); Mock.Get(builder) @@ -161,7 +161,7 @@ namespace Umbraco.Tests.Migrations [Test] public void CreateColumn() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var builder = Mock.Of(); Mock.Get(builder) diff --git a/src/Umbraco.Tests/Models/ContentTests.cs b/src/Umbraco.Tests/Models/ContentTests.cs index 31e928159b..951daad18c 100644 --- a/src/Umbraco.Tests/Models/ContentTests.cs +++ b/src/Umbraco.Tests/Models/ContentTests.cs @@ -237,7 +237,7 @@ namespace Umbraco.Tests.Models private static IProfilingLogger GetTestProfilingLogger() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var profiler = new TestProfiler(); return new ProfilingLogger(logger, profiler); } diff --git a/src/Umbraco.Tests/Persistence/NPocoTests/NPocoBulkInsertTests.cs b/src/Umbraco.Tests/Persistence/NPocoTests/NPocoBulkInsertTests.cs index 6c4a23fa00..2781737f21 100644 --- a/src/Umbraco.Tests/Persistence/NPocoTests/NPocoBulkInsertTests.cs +++ b/src/Umbraco.Tests/Persistence/NPocoTests/NPocoBulkInsertTests.cs @@ -27,7 +27,7 @@ namespace Umbraco.Tests.Persistence.NPocoTests // create the db // prob not what we want, this is not a real database, but hey, the test is ignored anyways // we'll fix this when we have proper testing infrastructure - var dbSqlServer = TestObjects.GetUmbracoSqlServerDatabase(new DebugDiagnosticsLogger(new MessageTemplates())); + var dbSqlServer = TestObjects.GetUmbracoSqlServerDatabase(new DebugDiagnosticsLogger(new MessageTemplates())); //drop the table dbSqlServer.Execute("DROP TABLE [umbracoServer]"); diff --git a/src/Umbraco.Tests/Runtimes/CoreRuntimeTests.cs b/src/Umbraco.Tests/Runtimes/CoreRuntimeTests.cs index e53e6bfb8a..25e7fbb456 100644 --- a/src/Umbraco.Tests/Runtimes/CoreRuntimeTests.cs +++ b/src/Umbraco.Tests/Runtimes/CoreRuntimeTests.cs @@ -70,7 +70,7 @@ namespace Umbraco.Tests.Runtimes Assert.IsTrue(TestComponent.Ctored); Assert.IsNotNull(TestComponent.ProfilingLogger); Assert.IsInstanceOf(TestComponent.ProfilingLogger); - Assert.IsInstanceOf(((ProfilingLogger) TestComponent.ProfilingLogger).Logger); + Assert.IsInstanceOf>(((ProfilingLogger) TestComponent.ProfilingLogger).Logger); // note: components are NOT disposed after boot @@ -88,7 +88,7 @@ namespace Umbraco.Tests.Runtimes { } - private static readonly DebugDiagnosticsLogger _logger = new DebugDiagnosticsLogger(new MessageTemplates()); + private static readonly DebugDiagnosticsLogger _logger = new DebugDiagnosticsLogger(new MessageTemplates()); private static readonly IIOHelper _ioHelper = TestHelper.IOHelper; private static readonly IProfiler _profiler = new TestProfiler(); private static readonly Configs _configs = GetConfigs(); diff --git a/src/Umbraco.Tests/Scheduling/BackgroundTaskRunnerTests2.cs b/src/Umbraco.Tests/Scheduling/BackgroundTaskRunnerTests2.cs index 01169abce2..5d1cbb4591 100644 --- a/src/Umbraco.Tests/Scheduling/BackgroundTaskRunnerTests2.cs +++ b/src/Umbraco.Tests/Scheduling/BackgroundTaskRunnerTests2.cs @@ -21,7 +21,7 @@ namespace Umbraco.Tests.Scheduling [Timeout(4000)] public async Task ThreadResumeIssue() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var runner = new BackgroundTaskRunner(new BackgroundTaskRunnerOptions { KeepAlive = true, LongRunning = true }, logger, TestHelper.GetHostingEnvironmentLifetime()); var work = new ThreadResumeIssueWorkItem(); runner.Add(work); @@ -76,7 +76,7 @@ namespace Umbraco.Tests.Scheduling [Ignore("Only runs in the debugger.")] public async Task DebuggerInterferenceIssue() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var runner = new BackgroundTaskRunner(new BackgroundTaskRunnerOptions { KeepAlive = true, LongRunning = true }, logger, TestHelper.GetHostingEnvironmentLifetime()); var taskCompleted = false; runner.TaskCompleted += (sender, args) => diff --git a/src/Umbraco.Tests/Services/ContentServicePerformanceTest.cs b/src/Umbraco.Tests/Services/ContentServicePerformanceTest.cs index d5afde6477..a47e327e20 100644 --- a/src/Umbraco.Tests/Services/ContentServicePerformanceTest.cs +++ b/src/Umbraco.Tests/Services/ContentServicePerformanceTest.cs @@ -65,7 +65,7 @@ namespace Umbraco.Tests.Services private static IProfilingLogger GetTestProfilingLogger() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var profiler = new TestProfiler(); return new ProfilingLogger(logger, profiler); } diff --git a/src/Umbraco.Tests/Services/PerformanceTests.cs b/src/Umbraco.Tests/Services/PerformanceTests.cs index 67de1c91d7..87818fd270 100644 --- a/src/Umbraco.Tests/Services/PerformanceTests.cs +++ b/src/Umbraco.Tests/Services/PerformanceTests.cs @@ -58,7 +58,7 @@ namespace Umbraco.Tests.Services private static IProfilingLogger GetTestProfilingLogger() { - var logger = new DebugDiagnosticsLogger(new MessageTemplates()); + var logger = new DebugDiagnosticsLogger(new MessageTemplates()); var profiler = new TestProfiler(); return new ProfilingLogger(logger, profiler); } diff --git a/src/Umbraco.Web/Logging/OwinLogger.cs b/src/Umbraco.Web/Logging/OwinLogger.cs index 4d1eeb1e19..dcd1a0f531 100644 --- a/src/Umbraco.Web/Logging/OwinLogger.cs +++ b/src/Umbraco.Web/Logging/OwinLogger.cs @@ -27,7 +27,7 @@ namespace Umbraco.Web.Logging switch (eventType) { case TraceEventType.Critical: - _logger.Fatal(_type.Value, exception, "[{EventType}] Event Id: {EventId}, State: {State}", eventType, eventId, state); + _logger.LogCritical(exception, "[{EventType}] Event Id: {EventId}, State: {State}", eventType, eventId, state); return true; case TraceEventType.Error: _logger.LogError(_type.Value, exception, "[{EventType}] Event Id: {EventId}, State: {State}", eventType, eventId, state);