claunia/romrepomgr
1
0
Fork 0
mirror of https://github.com/claunia/romrepomgr.git synced 2025-12-16 11:14:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added Serilog for logging.

Browse Source
This commit is contained in:
Natalia Portillo
2025-07-24 16:20:22 +01:00
parent 69fb3c768b
commit 55a6af0c74
10 changed files with 176 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
Directory.Packages.props
View File

@@ -1,47 +1,50 @@
<Project ToolsVersion="15.0">
<ItemGroup>
<PackageVersion Include="Aaru.Checksums.Native" Version="6.0.0-alpha.10" />
<PackageVersion Include="AsyncFixer" Version="1.6.0" />
<PackageVersion Include="Avalonia.Controls.DataGrid" Version="11.3.2" />
<PackageVersion Include="Avalonia.Desktop" Version="11.3.2" />
<PackageVersion Include="Avalonia.Diagnostics" Version="11.3.2" />
<PackageVersion Include="Avalonia.Svg.Skia" Version="11.3.0" />
<PackageVersion Include="Avalonia.Themes.Fluent" Version="11.3.2" />
<PackageVersion Include="Avalonia" Version="11.3.2" />
<PackageVersion Include="CommunityToolkit.Mvvm" Version="8.4.0" />
<PackageVersion Include="DotNetZip" Version="1.16.0" />
<PackageVersion Include="EFCore.BulkExtensions" Version="9.0.1" />
<PackageVersion Include="ErrorProne.NET.CoreAnalyzers" Version="0.1.2" />
<PackageVersion Include="ErrorProne.NET.Structs" Version="0.1.2" />
<PackageVersion Include="InclusivenessAnalyzer" Version="1.3.0" />
<PackageVersion Include="MessageBox.Avalonia" Version="3.2.0" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.6" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Proxies" Version="9.0.6" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Sqlite.Design" Version="2.0.0-preview1-final" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.6" />
<PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.6" />
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.14.15" />
<PackageVersion Include="Microsoft.Win32.Registry" Version="5.0.0" />
<PackageVersion Include="Mono.Fuse.NETStandard" Version="1.1.0" />
<PackageVersion Include="Philips.CodeAnalysis.MaintainabilityAnalyzers" Version="1.6.3" />
<PackageVersion Include="plist-cil" Version="2.2.0" />
<PackageVersion Include="Roslynator.Analyzers" Version="4.13.1" />
<PackageVersion Include="Roslynator.CodeAnalysis.Analyzers" Version="4.13.1" />
<PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.13.1" />
<PackageVersion Include="SabreTools.Models" Version="1.5.8" />
<PackageVersion Include="SharpCompress" Version="0.39.0" />
<PackageVersion Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" />
<PackageVersion Include="System.Security.Principal.Windows" Version="5.0.0" />
<PackageVersion Include="Text.Analyzers" Version="4.14.0" />
<PackageVersion Include="winfsp.net" Version="2.1.25156" />
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
<PackageVersion Include="SabreTools.Hashing" Version="1.2.3" />
<PackageVersion Include="SabreTools.IO" Version="1.4.13" />
<PackageVersion Include="SabreTools.Matching" Version="1.3.4" />
<PackageVersion Include="SabreTools.Skippers" Version="1.1.3" />
<PackageVersion Include="System.IO.Compression" Version="4.3.0" />
<PackageVersion Include="SharpCompress" Version="0.38.0" />
<PackageVersion Include="System.Text.Encoding.CodePages" Version="8.0.0" />
<PackageVersion Include="ZstdSharp.Port" Version="0.8.1" />
<PackageVersion Include="Aaru.Checksums.Native" Version="6.0.0-alpha.10"/>
<PackageVersion Include="AsyncFixer" Version="1.6.0"/>
<PackageVersion Include="Avalonia.Controls.DataGrid" Version="11.3.2"/>
<PackageVersion Include="Avalonia.Desktop" Version="11.3.2"/>
<PackageVersion Include="Avalonia.Diagnostics" Version="11.3.2"/>
<PackageVersion Include="Avalonia.Svg.Skia" Version="11.3.0"/>
<PackageVersion Include="Avalonia.Themes.Fluent" Version="11.3.2"/>
<PackageVersion Include="Avalonia" Version="11.3.2"/>
<PackageVersion Include="CommunityToolkit.Mvvm" Version="8.4.0"/>
<PackageVersion Include="DotNetZip" Version="1.16.0"/>
<PackageVersion Include="EFCore.BulkExtensions" Version="9.0.1"/>
<PackageVersion Include="ErrorProne.NET.CoreAnalyzers" Version="0.1.2"/>
<PackageVersion Include="ErrorProne.NET.Structs" Version="0.1.2"/>
<PackageVersion Include="InclusivenessAnalyzer" Version="1.3.0"/>
<PackageVersion Include="MessageBox.Avalonia" Version="3.2.0"/>
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.6"/>
<PackageVersion Include="Microsoft.EntityFrameworkCore.Proxies" Version="9.0.6"/>
<PackageVersion Include="Microsoft.EntityFrameworkCore.Sqlite.Design" Version="2.0.0-preview1-final"/>
<PackageVersion Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.6"/>
<PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.6"/>
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.14.15"/>
<PackageVersion Include="Microsoft.Win32.Registry" Version="5.0.0"/>
<PackageVersion Include="Mono.Fuse.NETStandard" Version="1.1.0"/>
<PackageVersion Include="Philips.CodeAnalysis.MaintainabilityAnalyzers" Version="1.6.3"/>
<PackageVersion Include="plist-cil" Version="2.2.0"/>
<PackageVersion Include="Roslynator.Analyzers" Version="4.13.1"/>
<PackageVersion Include="Roslynator.CodeAnalysis.Analyzers" Version="4.13.1"/>
<PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.13.1"/>
<PackageVersion Include="SabreTools.Models" Version="1.5.8"/>
<PackageVersion Include="Serilog" Version="4.3.0"/>
<PackageVersion Include="Serilog.Extensions.Logging" Version="9.0.2"/>
<PackageVersion Include="Serilog.Sinks.Console" Version="6.0.0"/>
<PackageVersion Include="SharpCompress" Version="0.39.0"/>
<PackageVersion Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31"/>
<PackageVersion Include="System.Security.Principal.Windows" Version="5.0.0"/>
<PackageVersion Include="Text.Analyzers" Version="4.14.0"/>
<PackageVersion Include="winfsp.net" Version="2.1.25156"/>
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3"/>
<PackageVersion Include="SabreTools.Hashing" Version="1.2.3"/>
<PackageVersion Include="SabreTools.IO" Version="1.4.13"/>
<PackageVersion Include="SabreTools.Matching" Version="1.3.4"/>
<PackageVersion Include="SabreTools.Skippers" Version="1.1.3"/>
<PackageVersion Include="System.IO.Compression" Version="4.3.0"/>
<PackageVersion Include="SharpCompress" Version="0.38.0"/>
<PackageVersion Include="System.Text.Encoding.CodePages" Version="8.0.0"/>
<PackageVersion Include="ZstdSharp.Port" Version="0.8.1"/>
</ItemGroup>
</Project>

36
RomRepoMgr/Program.cs
View File

@@ -23,8 +23,10 @@
// Copyright © 2020-2024 Natalia Portillo
*******************************************************************************/
using System;
using Avalonia;
using Avalonia.Logging;
using Serilog;
namespace RomRepoMgr;
@@ -33,10 +35,40 @@ internal static class Program
// Initialization code. Don't use any Avalonia, third-party APIs or any
// SynchronizationContext-reliant code before AppMain is called: things aren't initialized
// yet and stuff might break.
public static void Main(string[] args) => BuildAvaloniaApp().StartWithClassicDesktopLifetime(args);
public static void Main(string[] args)
{
Log.Logger = new LoggerConfiguration()
#if DEBUG
.MinimumLevel.Debug()
#else
.MinimumLevel.Information()
#endif
.WriteTo.Console()
.CreateLogger();
try
{
Log.Information("Starting up");
Log.Debug("Testing debug logging");
BuildAvaloniaApp().StartWithClassicDesktopLifetime(args);
}
catch(Exception ex)
{
Log.Fatal(ex, "Application start-up failed");
}
finally
{
Log.CloseAndFlush();
}
}
// Avalonia configuration, don't remove; also used by visual designer.
public static AppBuilder BuildAvaloniaApp() => AppBuilder.Configure<App>()
.UsePlatformDetect()
.LogToTrace(LogEventLevel.Debug);
#if DEBUG
.LogToSerilog(LogEventLevel.Debug);
#else
.LogToSerilog(LogEventLevel.Information);
#endif
}

3
RomRepoMgr/RomRepoMgr.csproj
View File

@@ -31,6 +31,9 @@
<PackageReference Include="Roslynator.Analyzers"/>
<PackageReference Include="Roslynator.CodeAnalysis.Analyzers"/>
<PackageReference Include="Roslynator.Formatting.Analyzers"/>
<PackageReference Include="Serilog"/>
<PackageReference Include="Serilog.Extensions.Logging"/>
<PackageReference Include="Serilog.Sinks.Console"/>
<PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer"/>
<PackageReference Include="Text.Analyzers"/>
</ItemGroup>

49
RomRepoMgr/SerilogSink.cs Normal file
View File

@@ -0,0 +1,49 @@
#nullable enable
using System.Collections.Generic;
using Avalonia.Logging;
namespace RomRepoMgr;
public class SerilogSink(LogEventLevel minimumLevel, IList<string>? areas = null) : ILogSink
{
private readonly IList<string>? _areas = areas?.Count > 0 ? areas : null;
public bool IsEnabled(LogEventLevel level, string area) =>
level >= minimumLevel && (_areas?.Contains(area) ?? true);
public void Log(LogEventLevel level, string area, object? source, string messageTemplate)
{
if(IsEnabled(level, area))
Serilog.Log.Write(LogLevelToSerilogLevel(level),
"[{Area} {Source}] {MessageTemplate}",
area,
source,
messageTemplate);
}
public void Log(LogEventLevel level, string area, object? source, string messageTemplate,
params object?[] propertyValues)
{
if(IsEnabled(level, area))
Serilog.Log.Write(LogLevelToSerilogLevel(level),
"[{Area} {Source}] {MessageTemplate}",
propertyValues,
area,
source,
messageTemplate);
}
private static Serilog.Events.LogEventLevel LogLevelToSerilogLevel(LogEventLevel level)
{
return level switch
{
LogEventLevel.Verbose => Serilog.Events.LogEventLevel.Verbose,
LogEventLevel.Debug => Serilog.Events.LogEventLevel.Debug,
LogEventLevel.Information => Serilog.Events.LogEventLevel.Information,
LogEventLevel.Warning => Serilog.Events.LogEventLevel.Warning,
LogEventLevel.Error => Serilog.Events.LogEventLevel.Error,
LogEventLevel.Fatal => Serilog.Events.LogEventLevel.Fatal,
_ => Serilog.Events.LogEventLevel.Verbose
};
}
}

15
RomRepoMgr/SerilogSinkExtensions.cs Normal file
View File

@@ -0,0 +1,15 @@
using Avalonia;
using Avalonia.Logging;
namespace RomRepoMgr;
public static class SerilogSinkExtensions
{
public static AppBuilder LogToSerilog(this AppBuilder builder, LogEventLevel level = LogEventLevel.Warning,
params string[] areas)
{
Logger.Sink = new SerilogSink(level, areas);
return builder;
}
}

7
RomRepoMgr/ViewModels/ImportRomFolderViewModel.cs
View File

@@ -18,6 +18,7 @@ using RomRepoMgr.Database;
using RomRepoMgr.Database.Models;
using RomRepoMgr.Models;
using RomRepoMgr.Resources;
using Serilog;
namespace RomRepoMgr.ViewModels;
@@ -235,7 +236,7 @@ public sealed partial class ImportRomFolderViewModel : ViewModelBase
});
_stopwatch.Stop();
Console.WriteLine("Took " + _stopwatch.Elapsed.TotalSeconds + " seconds to process files.");
Log.Debug("Took {TotalSeconds} seconds to process files", _stopwatch.Elapsed.TotalSeconds);
_rootImporter.SaveChanges();
@@ -325,7 +326,7 @@ public sealed partial class ImportRomFolderViewModel : ViewModelBase
});
_stopwatch.Stop();
Console.WriteLine("Took " + _stopwatch.Elapsed.TotalSeconds + " seconds to process archives.");
Log.Debug("Took {TotalSeconds} seconds to process archives", _stopwatch.Elapsed.TotalSeconds);
Progress2Visible = false;
StatusMessage2Visible = false;
@@ -336,7 +337,7 @@ public sealed partial class ImportRomFolderViewModel : ViewModelBase
void CheckArchivesFinished(object sender, EventArgs e)
{
_stopwatch.Stop();
Console.WriteLine("Took {0} seconds to check archives.", _stopwatch.Elapsed.TotalSeconds);
Log.Debug("Took {TotalSeconds} seconds to check archives", _stopwatch.Elapsed.TotalSeconds);
Progress2Visible = false;
StatusMessage2Visible = false;

5
RomRepoMgr/ViewModels/MainWindowViewModel.cs
View File

@@ -44,6 +44,7 @@ using RomRepoMgr.Core.Filesystem;
using RomRepoMgr.Core.Models;
using RomRepoMgr.Resources;
using RomRepoMgr.Views;
using Serilog;
namespace RomRepoMgr.ViewModels;
@@ -270,8 +271,10 @@ public sealed partial class MainWindowViewModel : ViewModelBase
Vfs.Umounted += VfsOnUmounted;
Vfs.MountTo(result[0].Path.LocalPath);
}
catch(Exception)
catch(Exception ex)
{
Log.Error(ex, "Error mounting VFS");
if(Debugger.IsAttached) throw;
Vfs = null;

16
RomRepoMgr/ViewModels/SettingsViewModel.cs
View File

@@ -230,7 +230,7 @@ public sealed partial class SettingsViewModel : ViewModelBase
var ctx = Context.Create(result);
await ctx.Database.MigrateAsync();
}
catch(Exception)
catch
{
btnResult = await MessageBoxManager
.GetMessageBoxStandard(Localization.DatabaseFileUnusableMsgBoxTitle,
@@ -245,7 +245,7 @@ public sealed partial class SettingsViewModel : ViewModelBase
{
File.Delete(result);
}
catch(Exception)
catch
{
await MessageBoxManager
.GetMessageBoxStandard(Localization.DatabaseFileCannotDeleteTitle,
@@ -254,9 +254,13 @@ public sealed partial class SettingsViewModel : ViewModelBase
Icon.Error)
.ShowWindowDialogAsync(_view);
#pragma warning disable ERP022
return;
#pragma warning restore ERP022
}
#pragma warning disable ERP022
}
#pragma warning restore ERP022
}
else
{
@@ -273,7 +277,7 @@ public sealed partial class SettingsViewModel : ViewModelBase
{
File.Delete(result);
}
catch(Exception)
catch
{
await MessageBoxManager
.GetMessageBoxStandard(Localization.DatabaseFileCannotDeleteTitle,
@@ -282,7 +286,9 @@ public sealed partial class SettingsViewModel : ViewModelBase
Icon.Error)
.ShowWindowDialogAsync(_view);
#pragma warning disable ERP022
return;
#pragma warning restore ERP022
}
}
}
@@ -292,7 +298,7 @@ public sealed partial class SettingsViewModel : ViewModelBase
var ctx = Context.Create(result);
await ctx.Database.MigrateAsync();
}
catch(Exception)
catch
{
await MessageBoxManager
.GetMessageBoxStandard(Localization.DatabaseFileUnusableMsgBoxTitle,
@@ -301,7 +307,9 @@ public sealed partial class SettingsViewModel : ViewModelBase
Icon.Error)
.ShowWindowDialogAsync(_view);
#pragma warning disable ERP022
return;
#pragma warning restore ERP022
}
DatabasePath = result;

11
RomRepoMgr/ViewModels/SplashWindowViewModel.cs
View File

@@ -38,6 +38,7 @@ using RomRepoMgr.Core.EventArgs;
using RomRepoMgr.Core.Models;
using RomRepoMgr.Core.Workers;
using RomRepoMgr.Database;
using Serilog;
namespace RomRepoMgr.ViewModels;
@@ -119,7 +120,7 @@ public sealed partial class SplashWindowViewModel : ViewModelBase
}
catch(Exception e)
{
// TODO: Log error
Log.Error(e, "Error loading settings");
Dispatcher.UIThread.Post(FailedLoadingSettings);
}
});
@@ -148,7 +149,7 @@ public sealed partial class SplashWindowViewModel : ViewModelBase
}
catch(Exception e)
{
// TODO: Log error
Log.Error(e, "Error checking unar");
Dispatcher.UIThread.Post(FailedCheckUnAr);
}
});
@@ -180,7 +181,7 @@ public sealed partial class SplashWindowViewModel : ViewModelBase
}
catch(Exception e)
{
// TODO: Log error
Log.Error(e, "Error loading database");
Dispatcher.UIThread.Post(FailedLoadingDatabase);
}
});
@@ -210,7 +211,7 @@ public sealed partial class SplashWindowViewModel : ViewModelBase
}
catch(Exception e)
{
// TODO: Log error
Log.Error(e, "Error migrating database");
Dispatcher.UIThread.Post(FailedMigratingDatabase);
}
});
@@ -270,7 +271,7 @@ public sealed partial class SplashWindowViewModel : ViewModelBase
}
catch(Exception e)
{
// TODO: Log error
Log.Error(e, "Error loading ROM sets");
Dispatcher.UIThread.Post(FailedLoadingRomSets);
}
});

5
RomRepoMgr/ViewModels/UpdateStatsViewModel.cs
View File

@@ -23,7 +23,6 @@
// Copyright © 2020-2024 Natalia Portillo
*******************************************************************************/
using System;
using System.Collections.ObjectModel;
using System.Linq;
using System.Threading.Tasks;
@@ -187,10 +186,12 @@ public sealed partial class UpdateStatsViewModel : ViewModelBase
});
});
}
catch(Exception)
catch
#pragma warning disable PH2098
{
// Ignored
}
#pragma warning restore PH2098
pos++;
}