feat: Add SubscribableTraceListener

Refs: gitextensions#10307
mstv · May 26, 2024 · 7d46828 · 7d46828
1 parent 844050a
commit 7d46828
Show file tree

Hide file tree

Showing 26 changed files with 122 additions and 21 deletions.
diff --git a/src/app/GitCommands/ServiceContainerRegistry.cs b/src/app/GitCommands/ServiceContainerRegistry.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.Design;
 using GitCommands.Submodules;
-using GitUIPluginInterfaces;
+using GitExtUtils;
 
 namespace GitCommands;
 

diff --git a/src/app/GitExtUtils/ServiceContainerRegistry.cs b/src/app/GitExtUtils/ServiceContainerRegistry.cs
@@ -0,0 +1,11 @@
+using System.ComponentModel.Design;
+
+namespace GitExtUtils;
+
+public static class ServiceContainerRegistry
+{
+ public static void RegisterServices(ServiceContainer serviceContainer)
+ {
+ serviceContainer.AddService<ISubscribableTraceListener>(new SubscribableTraceListener());
+ }
+}
diff --git a/...inInterfaces/ServiceProviderExtensions.cs → .../GitExtUtils/ServiceProviderExtensions.cs b/...inInterfaces/ServiceProviderExtensions.cs → .../GitExtUtils/ServiceProviderExtensions.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.Design;
 
-namespace GitUIPluginInterfaces;
+namespace GitExtUtils;
 
 /// <summary>
 /// Extension methods for getting services from an <see cref="IServiceProvider" />.

diff --git a/src/app/GitExtUtils/SubscribableTraceListener.cs b/src/app/GitExtUtils/SubscribableTraceListener.cs
@@ -0,0 +1,82 @@
+using System.Diagnostics;
+using System.Text;
+
+namespace GitExtUtils;
+
+public delegate void TraceHandler(in string message);
+
+/// <summary>
+/// Provides an event for receiving the <see cref="Trace"/> output.
+/// </summary>
+public interface ISubscribableTraceListener
+{
+ event TraceHandler TraceReceived;
+}
+
+public class SubscribableTraceListener : TraceListener, ISubscribableTraceListener
+{
+ private readonly StringBuilder _trace = new();
+
+ public event TraceHandler TraceReceived;
+
+ public SubscribableTraceListener()
+ {
+ Trace.Listeners.Add(this);
+ }
+
+ protected override void Dispose(bool disposing)
+ {
+ if (disposing)
+ {
+ Trace.Listeners.Remove(this);
+ }
+
+ base.Dispose(disposing);
+ }
+
+ public override void Write(string? message)
+ {
+ lock (this)
+ {
+ _trace.Append(message);
+ }
+ }
+
+ public override void WriteLine(string? message)
+ {
+ lock (this)
+ {
+ _trace.AppendLine(message);
+ Flush();
+ }
+ }
+
+ public override void Flush()
+ {
+ lock (this)
+ {
+ base.Flush();
+ try
+ {
+ if (_trace.Length == 0)
+ {
+ return;
+ }
+
+ string message = _trace.ToString();
+#if DEBUG
+ if (message.Contains("Exception") || message.Contains("RevisionReader"))
+#endif
+ {
+ TraceReceived?.Invoke(message);
+ }
+
+ _trace.Clear();
+ }
+ catch
+ {
+ // Do not worsen things
+ }
+ }
+ }
+}
diff --git a/src/app/GitExtensions/ServiceContainerRegistry.cs b/src/app/GitExtensions/ServiceContainerRegistry.cs
@@ -3,7 +3,7 @@
 using GitCommands;
 using GitCommands.Git;
 using GitCommands.UserRepositoryHistory;
-using GitUIPluginInterfaces;
+using GitExtUtils;
 using ResourceManager;
 
 namespace GitExtensions;
@@ -12,6 +12,8 @@ internal static class ServiceContainerRegistry
 {
  public static void RegisterServices(ServiceContainer serviceContainer)
  {
+ GitExtUtils.ServiceContainerRegistry.RegisterServices(serviceContainer);
+
  FileSystem fileSystem = new();
  GitDirectoryResolver gitDirectoryResolver = new(fileSystem);
  RepositoryDescriptionProvider repositoryDescriptionProvider = new(gitDirectoryResolver);

diff --git a/src/app/GitUI/CommandsDialogs/FormBrowse.cs b/src/app/GitUI/CommandsDialogs/FormBrowse.cs
@@ -16,6 +16,7 @@
 using GitExtensions.Extensibility.Plugins;
 using GitExtensions.Extensibility.Settings;
 using GitExtensions.Extensibility.Translations;
+using GitExtUtils;
 using GitExtUtils.GitUI;
 using GitExtUtils.GitUI.Theming;
 using GitUI.Avatars;

diff --git a/src/app/GitUI/CommandsDialogs/SettingsDialog/Pages/ControlHotkeys.cs b/src/app/GitUI/CommandsDialogs/SettingsDialog/Pages/ControlHotkeys.cs
@@ -1,5 +1,5 @@
-using GitUI.Hotkey;
-using GitUIPluginInterfaces;
+using GitExtUtils;
+using GitUI.Hotkey;
 using Microsoft;
 using ResourceManager;
 using ResourceManager.Hotkey;

diff --git a/src/app/GitUI/CommandsDialogs/SettingsDialog/Pages/ScriptsSettingsPage.cs b/src/app/GitUI/CommandsDialogs/SettingsDialog/Pages/ScriptsSettingsPage.cs
@@ -4,10 +4,10 @@
 using System.Reflection;
 using GitCommands;
 using GitCommands.Utils;
+using GitExtUtils;
 using GitExtUtils.GitUI;
 using GitExtUtils.GitUI.Theming;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using Microsoft;
 using ResourceManager;
 

diff --git a/src/app/GitUI/CommandsDialogs/SettingsDialog/Pages/TextboxHotkey.cs b/src/app/GitUI/CommandsDialogs/SettingsDialog/Pages/TextboxHotkey.cs
@@ -1,5 +1,5 @@
-using GitUI.Hotkey;
-using GitUIPluginInterfaces;
+using GitExtUtils;
+using GitUI.Hotkey;
 using ResourceManager.Hotkey;
 
 namespace GitUI.CommandsDialogs.SettingsDialog.Pages

diff --git a/src/app/GitUI/CommandsDialogs/UserScriptContextMenuExtensions.cs b/src/app/GitUI/CommandsDialogs/UserScriptContextMenuExtensions.cs
@@ -1,6 +1,6 @@
-using GitUI.LeftPanel.ContextMenu;
+using GitExtUtils;
+using GitUI.LeftPanel.ContextMenu;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using ResourceManager;
 using ResourceManager.Hotkey;
 

diff --git a/src/app/GitUI/GitModuleControl.cs b/src/app/GitUI/GitModuleControl.cs
@@ -1,8 +1,8 @@
 using System.ComponentModel;
 using System.Diagnostics.CodeAnalysis;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using ResourceManager;
 
 namespace GitUI

diff --git a/src/app/GitUI/GitModuleForm.cs b/src/app/GitUI/GitModuleForm.cs
@@ -2,9 +2,9 @@
 using System.Diagnostics.CodeAnalysis;
 using GitCommands;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI.Infrastructure.Telemetry;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using ResourceManager;
 
 namespace GitUI

diff --git a/src/app/GitUI/LeftPanel/SubmoduleTree.cs b/src/app/GitUI/LeftPanel/SubmoduleTree.cs
@@ -3,8 +3,8 @@
 using GitCommands.Submodules;
 using GitExtensions.Extensibility;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI.CommandsDialogs;
-using GitUIPluginInterfaces;
 using Microsoft;
 using Microsoft.VisualStudio.Threading;
 

diff --git a/src/app/GitUI/ScriptsEngine/ScriptOptionsParser.cs b/src/app/GitUI/ScriptsEngine/ScriptOptionsParser.cs
@@ -2,6 +2,7 @@
 using GitCommands.Config;
 using GitCommands.UserRepositoryHistory;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI.UserControls.RevisionGrid;
 using GitUIPluginInterfaces;
 

diff --git a/src/app/GitUI/ScriptsEngine/ScriptsManager.ScriptRunner.cs b/src/app/GitUI/ScriptsEngine/ScriptsManager.ScriptRunner.cs
@@ -3,9 +3,9 @@
 using GitExtensions.Extensibility;
 using GitExtensions.Extensibility.Git;
 using GitExtensions.Extensibility.Plugins;
+using GitExtUtils;
 using GitUI.HelperDialogs;
 using GitUI.NBugReports;
-using GitUIPluginInterfaces;
 
 namespace GitUI.ScriptsEngine
 {

diff --git a/src/app/GitUI/ServiceContainerRegistry.cs b/src/app/GitUI/ServiceContainerRegistry.cs
@@ -1,8 +1,8 @@
 using System.ComponentModel.Design;
 using GitCommands.UserRepositoryHistory;
+using GitExtUtils;
 using GitUI.Hotkey;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using ResourceManager;
 
 namespace GitUI;

diff --git a/src/app/ResourceManager/GitExtensionsFormBase.cs b/src/app/ResourceManager/GitExtensionsFormBase.cs
@@ -5,9 +5,9 @@
 using GitExtensions.Extensibility.Git;
 using GitExtensions.Extensibility.Translations;
 using GitExtensions.Extensibility.Translations.Xliff;
+using GitExtUtils;
 using GitExtUtils.GitUI.Theming;
 using GitUI;
-using GitUIPluginInterfaces;
 using ResourceManager.Hotkey;
 using ResourceManager.Properties;
 

diff --git a/...egrationTests/UI.IntegrationTests/CommandsDialogs/FormBrowse.LeftPanelTests.Submodules.cs b/...egrationTests/UI.IntegrationTests/CommandsDialogs/FormBrowse.LeftPanelTests.Submodules.cs
@@ -4,9 +4,9 @@
 using GitCommands;
 using GitCommands.Submodules;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI;
 using GitUI.CommandsDialogs;
-using GitUIPluginInterfaces;
 
 namespace GitExtensions.UITests.CommandsDialogs
 {

diff --git a/tests/app/IntegrationTests/UI.IntegrationTests/CommandsDialogs/FormCommitTests.cs b/tests/app/IntegrationTests/UI.IntegrationTests/CommandsDialogs/FormCommitTests.cs
@@ -4,13 +4,13 @@
 using FluentAssertions;
 using GitCommands;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitExtUtils.GitUI.Theming;
 using GitUI;
 using GitUI.CommandsDialogs;
 using GitUI.Editor;
 using GitUI.ScriptsEngine;
 using GitUI.UserControls;
-using GitUIPluginInterfaces;
 using ICSharpCode.TextEditor;
 using NSubstitute;
 

diff --git a/tests/app/IntegrationTests/UI.IntegrationTests/GlobalServiceContainer.cs b/tests/app/IntegrationTests/UI.IntegrationTests/GlobalServiceContainer.cs
@@ -1,10 +1,10 @@
 using System.ComponentModel.Design;
 using GitCommands;
 using GitCommands.Submodules;
+using GitExtUtils;
 using GitUI;
 using GitUI.Hotkey;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using NSubstitute;
 using ResourceManager;
 

diff --git a/tests/app/IntegrationTests/UI.IntegrationTests/ScriptEngine/ScriptRunnerTests.cs b/tests/app/IntegrationTests/UI.IntegrationTests/ScriptEngine/ScriptRunnerTests.cs
@@ -4,6 +4,7 @@
 using FluentAssertions;
 using FluentAssertions.Specialized;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI;
 using GitUI.CommandsDialogs;
 using GitUI.NBugReports;

diff --git a/tests/app/IntegrationTests/UI.IntegrationTests/UserControls/CommitInfo/CommitInfoTests.cs b/tests/app/IntegrationTests/UI.IntegrationTests/UserControls/CommitInfo/CommitInfoTests.cs
@@ -5,6 +5,7 @@
 using GitCommands;
 using GitCommands.Git;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI;
 using GitUIPluginInterfaces;
 using NSubstitute;

diff --git a/tests/app/UnitTests/GitUI.Tests/Editor/FileViewerTextTests.cs b/tests/app/UnitTests/GitUI.Tests/Editor/FileViewerTextTests.cs
@@ -1,10 +1,10 @@
 using System.ComponentModel.Design;
 using CommonTestUtils;
 using FluentAssertions;
+using GitExtUtils;
 using GitUI;
 using GitUI.Editor;
 using GitUI.ScriptsEngine;
-using GitUIPluginInterfaces;
 using ICSharpCode.TextEditor;
 using ICSharpCode.TextEditor.Document;
 using NSubstitute;

diff --git a/tests/app/UnitTests/GitUI.Tests/Script/ScriptOptionsParserTests.cs b/tests/app/UnitTests/GitUI.Tests/Script/ScriptOptionsParserTests.cs
@@ -5,6 +5,7 @@
 using GitCommands.UserRepositoryHistory;
 using GitExtensions.Extensibility;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI;
 using GitUI.ScriptsEngine;
 using GitUIPluginInterfaces;

diff --git a/tests/app/UnitTests/GitUI.Tests/Script/ScriptsManagerScriptRunnerTests.cs b/tests/app/UnitTests/GitUI.Tests/Script/ScriptsManagerScriptRunnerTests.cs
@@ -1,5 +1,6 @@
 using FluentAssertions;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI.ScriptsEngine;
 using GitUIPluginInterfaces;
 using NSubstitute;

diff --git a/tests/app/UnitTests/GitUI.Tests/UserControls/RevisionGrid/RevisionFileNameTests.cs b/tests/app/UnitTests/GitUI.Tests/UserControls/RevisionGrid/RevisionFileNameTests.cs
@@ -2,8 +2,8 @@
 using CommonTestUtils;
 using GitCommands;
 using GitExtensions.Extensibility.Git;
+using GitExtUtils;
 using GitUI;
-using GitUIPluginInterfaces;
 using NSubstitute;
 
 namespace GitUITests.UserControls.RevisionGrid;