-
Notifications
You must be signed in to change notification settings - Fork 0
feat(plugins): wire host logger factories so plugin load stops being silent #27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| using System.Globalization; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
||
| namespace GMConverter.UI.Services; | ||
|
|
||
| /// <summary> | ||
| /// Minimal file-backed <see cref="ILoggerProvider"/> used during host startup before Avalonia | ||
| /// is ready (and therefore before <see cref="UiLogSink"/> can post entries to the UI thread). | ||
| /// Plugin discovery and load failures land here so they aren't silent if a plugin fails to load | ||
| /// at startup. The log path is exposed as a static property so the rest of the app can surface | ||
| /// it (e.g. in an "About" pane) when we eventually wire that up. | ||
| /// </summary> | ||
| internal sealed class PluginLogFileProvider : ILoggerProvider | ||
| { | ||
| public static string LogPath { get; } = | ||
| Path.Join(Path.GetTempPath(), "GMConverter.Plugins.log"); | ||
|
|
||
| private static readonly object _writeLock = new(); | ||
|
|
||
| static PluginLogFileProvider() | ||
| { | ||
| try | ||
| { | ||
| File.WriteAllText( | ||
| LogPath, | ||
| FormattableString.Invariant( | ||
| $"# GMConverter plugin log | pid {Environment.ProcessId} | started {DateTimeOffset.Now:O}{Environment.NewLine}")); | ||
| } | ||
| catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or System.Security.SecurityException) | ||
| { | ||
| // Telemetry is best-effort; never propagate filesystem failures from instrumentation. | ||
| _ = ex; | ||
| } | ||
| } | ||
|
|
||
| public ILogger CreateLogger(string categoryName) | ||
| { | ||
| return new FileLogger(categoryName); | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| } | ||
|
|
||
| private sealed class FileLogger(string categoryName) : ILogger | ||
| { | ||
| public IDisposable? BeginScope<TState>(TState state) | ||
| where TState : notnull | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| public bool IsEnabled(LogLevel logLevel) | ||
| { | ||
| return logLevel >= LogLevel.Information; | ||
| } | ||
|
|
||
| public void Log<TState>( | ||
| LogLevel logLevel, | ||
| EventId eventId, | ||
| TState state, | ||
| Exception? exception, | ||
| Func<TState, Exception?, string> formatter) | ||
| { | ||
| if (!IsEnabled(logLevel)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var message = formatter(state, exception); | ||
| var line = string.Format( | ||
| CultureInfo.InvariantCulture, | ||
| "[{0:O}] [{1,-11}] {2}: {3}", | ||
| DateTimeOffset.Now, | ||
| logLevel, | ||
| categoryName, | ||
| message); | ||
|
|
||
| lock (_writeLock) | ||
| { | ||
| try | ||
| { | ||
| File.AppendAllText(LogPath, line + Environment.NewLine); | ||
| if (exception is not null) | ||
| { | ||
| File.AppendAllText(LogPath, exception.ToString() + Environment.NewLine); | ||
| } | ||
| } | ||
| catch (Exception ex) when (ex is IOException or UnauthorizedAccessException) | ||
| { | ||
| // Best-effort telemetry — filesystem failures here must never block plugin load. | ||
| _ = ex; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.