Skip to content

A Swiss Army knife for developers.

Improved logs performance & fixed build

Etienne Baudoux0faddf25e39b
diff --git a/src/app/dev/DevToys.Core/Mef/MefComposer.cs b/src/app/dev/DevToys.Core/Mef/MefComposer.cs
index aab2f8a3c..2f4c0d124 100644
--- a/src/app/dev/DevToys.Core/Mef/MefComposer.cs
+++ b/src/app/dev/DevToys.Core/Mef/MefComposer.cs
@@ -9,7 +9,7 @@ namespace DevToys.Core.Mef;
/// <summary>
/// Provides a set of methods to initialize and manage MEF.
/// </summary>
-public sealed class MefComposer : IDisposable
+public sealed partial class MefComposer : IDisposable
{
private readonly ILogger _logger;
private readonly Assembly[] _assemblies;
@@ -58,6 +58,7 @@ public sealed class MefComposer : IDisposable
return ExportProvider;
}
+ DateTime startTime = DateTime.Now;
var assemblies
= new HashSet<Assembly>(_assemblies)
{
@@ -84,7 +85,7 @@ public sealed class MefComposer : IDisposable
}
container.Compose(batch);
- _logger.LogInformation($"MEF composed.");
+ LogMefComposition((DateTime.Now - startTime).TotalMilliseconds);
ExportProvider = container;
@@ -92,4 +93,7 @@ public sealed class MefComposer : IDisposable
return ExportProvider;
}
+
+ [LoggerMessage(0, LogLevel.Information, "MEF composed in {duration} ms")]
+ partial void LogMefComposition(double duration);
}
diff --git a/src/app/dev/DevToys.MonacoEditor/CodeEditor/CodeEditorPresenter.Windows.cs b/src/app/dev/DevToys.MonacoEditor/CodeEditor/CodeEditorPresenter.Windows.cs
index e4992e853..4bce657f3 100644
--- a/src/app/dev/DevToys.MonacoEditor/CodeEditor/CodeEditorPresenter.Windows.cs
+++ b/src/app/dev/DevToys.MonacoEditor/CodeEditor/CodeEditorPresenter.Windows.cs
@@ -12,6 +12,7 @@ using Uno.Logging;
using Windows.Foundation;
using Microsoft.UI.Dispatching;
using Microsoft.UI.Xaml;
+using System.Runtime.CompilerServices;
namespace DevToys.MonacoEditor;
@@ -48,14 +49,14 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
public string Value { get; set; }
}
- private readonly ILogger? _debugLogger;
- private readonly ILogger? _informationLogger;
- private readonly ILogger? _errorLogger;
+ private readonly ILogger? _logger;
private readonly WebView2 _webView = new();
public CodeEditorPresenter()
{
+ _logger = this.Log();
+
// make the WebView2 transparent.
Environment.SetEnvironmentVariable("WEBVIEW2_DEFAULT_BACKGROUND_COLOR", "00FFFFFF");
@@ -64,11 +65,6 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
this.Visibility = Visibility.Collapsed;
_webView.AllowFocusOnInteraction = true;
_webView.CoreWebView2Initialized += WebView_CoreWebView2Initialized;
-
- ILogger logger = this.Log();
- _debugLogger = logger.IsEnabled(LogLevel.Debug) ? logger : null;
- _informationLogger = logger.IsEnabled(LogLevel.Information) ? logger : null;
- _errorLogger = logger.IsEnabled(LogLevel.Error) ? logger : null;
}
/// <inheritdoc />
@@ -122,15 +118,15 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
try
{
- _informationLogger?.Info($"{nameof(LaunchAsync)}: Creating Monaco Editor");
+ LogCreatingMonacoEditor();
await _webView.ExecuteScriptAsync("createMonacoEditor(\"https://devtoys.local/\", document.getElementById('container'));");
- _informationLogger?.Info($"{nameof(LaunchAsync)}: Monaco Editor created successfully");
+ LogMonacoEditorCreated();
}
catch (Exception e)
{
- _errorLogger?.Error($"{nameof(LaunchAsync)} failed", e);
+ LogMonacoEditorFailedToBeCreated(e);
}
this.Visibility = Visibility.Visible;
@@ -144,7 +140,7 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
public async Task InjectDotNetObjectToWebPageAsync<T>(string name, T pObject)
{
- _debugLogger?.Debug($"{nameof(InjectDotNetObjectToWebPageAsync)}: Trying to inject .NET object in web page - {name}");
+ LogInjectingDotNetObject(name);
var sb = new StringBuilder();
sb.AppendLine($"EditorContext.getEditorForElement(document.getElementById('container')).{name} = {{");
@@ -224,11 +220,11 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
try
{
await _webView.ExecuteScriptAsync($"{sb}").AsTask();
- _debugLogger?.Debug($"{nameof(InjectDotNetObjectToWebPageAsync)}: '{name}' injected successfully.");
+ LogDotNetObjectInjected(name);
}
catch (Exception ex)
{
- _errorLogger?.Error($"{nameof(InjectDotNetObjectToWebPageAsync)} failed - {name}", ex);
+ LogDotNetObjectInjectionFailed(name, ex);
}
async void Handler(WebView2 _, CoreWebView2WebMessageReceivedEventArgs e)
@@ -295,7 +291,7 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
}
catch (Exception ex)
{
- _errorLogger?.Error($"{nameof(InjectDotNetObjectToWebPageAsync)}-CALLBACK: Exception in {name}.{method.Name}: {ex.Message}");
+ LogDotNetObjectInjectionCallbackMethodFailed(name, method.Name, ex);
string json = JsonConvert.SerializeObject(ex, new JsonSerializerSettings() { Error = (_, e) => e.ErrorContext.Handled = true });
await _webView.ExecuteScriptAsync($@"EditorContext.getEditorForElement(document.getElementById('container')).{name}._callbacks.get({methodMessage.Id}).reject(JSON.parse({json})); EditorContext.getEditorForElement(document.getElementById('container')).{name}._callbacks.delete({methodMessage.Id});");
}
@@ -330,7 +326,7 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
}
catch (Exception ex)
{
- _errorLogger?.Error($"{nameof(InjectDotNetObjectToWebPageAsync)}-CALLBACK: Exception in {name}.{property.Name}: {ex.Message}");
+ LogDotNetObjectInjectionCallbackPropertyFailed(name, property.Name, ex);
string json = JsonConvert.SerializeObject(ex, new JsonSerializerSettings() { Error = (_, e) => e.ErrorContext.Handled = true });
await _webView.ExecuteScriptAsync($@"EditorContext.getEditorForElement(document.getElementById('container')).{name}._callbacks.get({propertyMessage.Id}).reject(JSON.parse({json})); EditorContext.getEditorForElement(document.getElementById('container')).{name}._callbacks.delete({propertyMessage.Id});");
}
@@ -363,7 +359,7 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
}}
}})();";
- _debugLogger?.Debug($"Invoke Script: {script}");
+ LogInvokingJavaScript(script);
try
{
@@ -375,13 +371,13 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
return await _webView.ExecuteScriptAsync(script);
});
- _debugLogger?.Debug($"Invoke Script result: {result}");
+ LogInvokedJavaScriptSuccessfully(result);
return result;
}
catch (Exception e)
{
- _errorLogger?.Error("Invoke Script failed", e);
+ LogFailedToInvokeJavaScript(e);
throw;
}
@@ -394,6 +390,39 @@ public sealed partial class CodeEditorPresenter : UserControl, ICodeEditorPresen
_webView.CoreWebView2.DOMContentLoaded += (wv, args) => DOMContentLoaded?.Invoke(this, args);
_webView.CoreWebView2.NavigationCompleted += (wv, args) => NavigationCompleted?.Invoke(this, args);
}
+
+ [LoggerMessage(0, LogLevel.Information, "{caller}: Creating Monaco Editor...")]
+ partial void LogCreatingMonacoEditor([CallerMemberName] string? caller = null);
+
+ [LoggerMessage(1, LogLevel.Information, "{caller}: Monaco Editor has been created successfully.")]
+ partial void LogMonacoEditorCreated([CallerMemberName] string? caller = null);
+
+ [LoggerMessage(2, LogLevel.Error, "{caller}: Failed to create the Monaco Editor.")]
+ partial void LogMonacoEditorFailedToBeCreated(Exception exception, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(3, LogLevel.Debug, "{caller}: Trying to inject .NET object '{name}' in web page...")]
+ partial void LogInjectingDotNetObject(string name, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(4, LogLevel.Debug, "{caller}: .NET object '{name}' injected successfully.")]
+ partial void LogDotNetObjectInjected(string name, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(5, LogLevel.Error, "{caller}: Failed to inject .NET object '{name}'.")]
+ partial void LogDotNetObjectInjectionFailed(string name, Exception exception, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(6, LogLevel.Error, "{caller}-CALLBACK: Exception in {name}.{methodName}.")]
+ partial void LogDotNetObjectInjectionCallbackMethodFailed(string name, string methodName, Exception exception, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(7, LogLevel.Error, "{caller}-CALLBACK: Exception in {name}.{propertyName}.")]
+ partial void LogDotNetObjectInjectionCallbackPropertyFailed(string name, string propertyName, Exception exception, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(8, LogLevel.Debug, "{caller}: Invoking JavaScript: {script}")]
+ partial void LogInvokingJavaScript(string script, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(9, LogLevel.Debug, "{caller}: JavaScript invoked successfully: {result}")]
+ partial void LogInvokedJavaScriptSuccessfully(string result, [CallerMemberName] string? caller = null);
+
+ [LoggerMessage(10, LogLevel.Error, "{caller}: Failed to invoke JavaScript.")]
+ partial void LogFailedToInvokeJavaScript(Exception exception, [CallerMemberName] string? caller = null);
}
#endif
diff --git a/src/app/dev/DevToys.MonacoEditor/WebInterop/Logger/DebugLogger.cs b/src/app/dev/DevToys.MonacoEditor/WebInterop/Logger/DebugLogger.cs
index 73eae6f78..457623d32 100644
--- a/src/app/dev/DevToys.MonacoEditor/WebInterop/Logger/DebugLogger.cs
+++ b/src/app/dev/DevToys.MonacoEditor/WebInterop/Logger/DebugLogger.cs
@@ -7,17 +7,18 @@ namespace DevToys.MonacoEditor.WebInterop;
[AllowForWeb]
internal sealed partial class DebugLogger
{
- private readonly ILogger? _debugLogger;
+ private readonly ILogger? _logger;
public DebugLogger()
{
- ILogger logger = this.Log();
- _debugLogger = logger.IsEnabled(LogLevel.Debug) ? logger : null;
+ _logger = this.Log();
}
public void Log(string message)
{
- Console.WriteLine(message);
- _debugLogger?.LogInformation(message);
+ LogMessage(message);
}
+
+ [LoggerMessage(0, LogLevel.Information, "{message}")]
+ partial void LogMessage(string message);
}
diff --git a/src/app/dev/DevToys.UI.Framework/DevToys.UI.Framework.csproj b/src/app/dev/DevToys.UI.Framework/DevToys.UI.Framework.csproj
index 0981a4750..3b7f5a9e9 100644
--- a/src/app/dev/DevToys.UI.Framework/DevToys.UI.Framework.csproj
+++ b/src/app/dev/DevToys.UI.Framework/DevToys.UI.Framework.csproj
@@ -77,7 +77,7 @@
<PackageReference Include="Microsoft.WindowsAppSDK" />
<PackageReference Include="Microsoft.Windows.CsWin32" />
<PackageReference Include="Microsoft.Windows.SDK.BuildTools" />
- <PackageReference Include="Uno.Microsoft.Xaml.Behaviors.WinUI.Managed" />
+ <PackageReference Include="Microsoft.Xaml.Behaviors.WinUI.Managed" />
</ItemGroup>
</When>
</Choose>
diff --git a/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs b/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs
index 7311b3206..2a4165242 100644
--- a/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs
+++ b/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs
@@ -8,27 +8,28 @@ using DevToys.Core.Logging;
using DevToys.Core.Mef;
using DevToys.Tools;
using Microsoft.Extensions.Logging;
-using Uno.Extensions;
namespace DevToys.CLI;
-internal class Program
+internal partial class Program
{
private static readonly ILoggerFactory loggerFactory;
+ private static readonly ILogger logger;
static Program()
{
+ DateTime startTime = DateTime.Now;
loggerFactory
= LoggerFactory.Create(builder =>
{
builder
.AddFilter("Microsoft", LogLevel.Warning)
.AddFilter("System", LogLevel.Warning)
- .AddFile(new FileStorage()) // To save logs on local hard drive.
- .AddDebug();
+ .AddFile(new FileStorage()); // To save logs on local hard drive.
// Exclude logs below this level
#if DEBUG
+ builder.AddDebug();
builder.SetMinimumLevel(LogLevel.Trace);
#else
builder.SetMinimumLevel(LogLevel.Information);
@@ -36,7 +37,10 @@ internal class Program
});
global::Uno.Extensions.LogExtensionPoint.AmbientLoggerFactory = loggerFactory;
- loggerFactory.Log().LogInformation("App is starting...");
+
+ logger = new Logger<Program>(loggerFactory);
+ LogLoggerInitialization(logger, (DateTime.Now - startTime).TotalMilliseconds);
+ LogAppStarting(logger);
}
private static void Main(string[] args)
@@ -48,7 +52,7 @@ internal class Program
MainAsync(args).GetAwaiter().GetResult();
- loggerFactory.Log().LogInformation("App is shutting down...");
+ LogAppShuttingDown(logger);
loggerFactory.Dispose();
}
@@ -114,11 +118,11 @@ internal class Program
}
// Invoke the command line tool.
- ILogger logger = loggerFactory.CreateLogger(commandLineTool.Value.GetType());
- logger.LogInformation($"Invoking '{command.CommandDefinition.Name}' command...");
+ ILogger logger = loggerFactory.CreateLogger(commandLineTool.Value.GetType().FullName!);
+ LogInvokingCommand(logger, command.CommandDefinition.Name);
int exitCode = await commandLineTool.Value.InvokeAsync(logger, context.GetCancellationToken());
- logger.LogInformation($"Exit code: {exitCode}");
+ LogExitCode(logger, exitCode);
context.ExitCode = exitCode;
});
@@ -156,4 +160,19 @@ internal class Program
return true;
}
+
+ [LoggerMessage(0, LogLevel.Information, "Logger initialized in {duration} ms")]
+ static partial void LogLoggerInitialization(ILogger logger, double duration);
+
+ [LoggerMessage(1, LogLevel.Information, "App is starting...")]
+ static partial void LogAppStarting(ILogger logger);
+
+ [LoggerMessage(2, LogLevel.Information, "App is shutting down...")]
+ static partial void LogAppShuttingDown(ILogger logger);
+
+ [LoggerMessage(3, LogLevel.Information, "Invoking '{CommandName}' command...")]
+ static partial void LogInvokingCommand(ILogger logger, string commandName);
+
+ [LoggerMessage(4, LogLevel.Information, "Exit code: {ExitCode}")]
+ static partial void LogExitCode(ILogger logger, int exitCode);
}
diff --git a/src/app/dev/shared/App.xaml.cs b/src/app/dev/shared/App.xaml.cs
index 04a4df5d0..9416cf5ae 100644
--- a/src/app/dev/shared/App.xaml.cs
+++ b/src/app/dev/shared/App.xaml.cs
@@ -1,5 +1,4 @@
-using System.IO;
-using DevToys.Api;
+using DevToys.Api;
using DevToys.Api.Core.Theme;
using DevToys.Core.Logging;
using DevToys.Core.Mef;
@@ -43,9 +42,11 @@ public sealed partial class App : Application
{
this.InitializeComponent();
+ DateTime startTime = DateTime.Now;
_loggerFactory = InitializeLogging();
_logger = this.Log();
- _logger.LogInformation("App is starting...");
+ LogLoggerInitialization((DateTime.Now - startTime).TotalMilliseconds);
+ LogAppStarting();
this.UnhandledException += OnUnhandledException;
@@ -128,7 +129,7 @@ public sealed partial class App : Application
private void MainWindow_Closed(BackdropWindow sender, EventArgs args)
{
- _logger.LogInformation("App is shutting down...");
+ LogAppShuttingDown();
_loggerFactory.Dispose();
Guard.IsNotNull(MainWindow);
@@ -161,11 +162,7 @@ public sealed partial class App : Application
private void OnUnhandledException(object sender, UnhandledExceptionEventArgs e)
{
- if (_logger.IsEnabled(LogLevel.Error))
- {
- _logger.Error($"Unhandled exception !!!", e.Exception);
- }
-
+ LogUnhandledException(e.Exception);
_loggerFactory.Dispose();
// TODO:
@@ -253,6 +250,19 @@ public sealed partial class App : Application
#if HAS_UNO
global::Uno.UI.Adapter.Microsoft.Extensions.Logging.LoggingAdapter.Initialize();
#endif
+
return factory;
}
+
+ [LoggerMessage(0, LogLevel.Information, "App is starting...")]
+ partial void LogAppStarting();
+
+ [LoggerMessage(1, LogLevel.Information, "App is shutting down...")]
+ partial void LogAppShuttingDown();
+
+ [LoggerMessage(2, LogLevel.Error, "Unhandled exception !!! (╯°□°)╯︵ ┻━┻")]
+ partial void LogUnhandledException(Exception exception);
+
+ [LoggerMessage(3, LogLevel.Information, "Logger initialized in {duration} ms")]
+ partial void LogLoggerInitialization(double duration);
}
diff --git a/src/build/Build.cs b/src/build/Build.cs
index a4053adba..28b453588 100644
--- a/src/build/Build.cs
+++ b/src/build/Build.cs
@@ -175,7 +175,7 @@ class Build : NukeBuild
.SetRuntime(dotnetParameters.RuntimeIdentifier)
.SetPlatform(dotnetParameters.Platform)
.SetSelfContained(true)
- .SetPublishSingleFile(true)
+ .SetPublishSingleFile(false)
.SetPublishReadyToRun(true)
// TODO: Enable trimming. There are some things we will need to workaround to enable it.
// Trimming makes that we can't do COM invokes like User32.dll using DllImport.