Make SubmoduleStatusProvider DI-friendly (#11271)

GitCommands/ServiceContainerRegistry.cs

@@ -0,0 +1,12 @@
+using System.ComponentModel.Design;
+using GitCommands.Submodules;
+
+namespace GitCommands;
+
+public static class ServiceContainerRegistry
+{
+    public static void RegisterServices(ServiceContainer serviceContainer)
+    {
+        serviceContainer.AddService<ISubmoduleStatusProvider>(new SubmoduleStatusProvider());
+    }
+}

GitCommands/Submodules/SubmoduleStatusProvider.cs

@@ -12,6 +12,7 @@ public interface ISubmoduleStatusProvider : IDisposable
     {
         event EventHandler StatusUpdating;
         event EventHandler<SubmoduleStatusEventArgs> StatusUpdated;
+
         void Init();
 
         /// <summary>
@@ -31,19 +32,16 @@ public interface ISubmoduleStatusProvider : IDisposable
         Task UpdateSubmodulesStatusAsync(string workingDirectory, IReadOnlyList<GitItemStatus>? gitStatus, bool forceUpdate = false);
     }
 
-    public sealed class SubmoduleStatusProvider : ISubmoduleStatusProvider
+    internal sealed class SubmoduleStatusProvider : ISubmoduleStatusProvider
     {
         // Throttle updates triggered from status updates
         private const int MinRefreshInterval = 15;
 
         private readonly CancellationTokenSequence _submodulesStructureSequence = new();
         private readonly CancellationTokenSequence _submodulesStatusSequence = new();
+        private readonly Dictionary<string, SubmoduleInfo> _submoduleInfos = new();
         private DateTime _previousSubmoduleUpdateTime;
         private SubmoduleInfoResult? _submoduleInfoResult;
-        private readonly Dictionary<string, SubmoduleInfo> _submoduleInfos = new();
-
-        // Singleton accessor
-        public static SubmoduleStatusProvider Default { get; } = new();
 
         // Invoked when status update is requested (use to clear/lock UI)
         public event EventHandler? StatusUpdating;

GitExtensions/ServiceContainerRegistry.cs

@@ -21,6 +21,7 @@ public static void RegisterServices(ServiceContainer serviceContainer)
         serviceContainer.AddService<IAppTitleGenerator>(new AppTitleGenerator(repositoryDescriptionProvider));
         serviceContainer.AddService<ILinkFactory>(new LinkFactory());
 
+        GitCommands.ServiceContainerRegistry.RegisterServices(serviceContainer);
         GitUI.ServiceContainerRegistry.RegisterServices(serviceContainer);
     }
 }

GitUI/CommandsDialogs/FormBrowse.cs

@@ -302,7 +302,7 @@ internal FormBrowse(GitUICommands commands, BrowseArguments args, ISettingsSourc
             _controller = new FormBrowseController(new GitGpgController(() => Module));
             _commitDataManager = new CommitDataManager(() => Module);
 
-            _submoduleStatusProvider = SubmoduleStatusProvider.Default;
+            _submoduleStatusProvider = commands.GetRequiredService<ISubmoduleStatusProvider>();
             _submoduleStatusProvider.StatusUpdating += SubmoduleStatusProvider_StatusUpdating;
             _submoduleStatusProvider.StatusUpdated += SubmoduleStatusProvider_StatusUpdated;
 

GitUI/LeftPanel/SubmoduleTree.cs

@@ -9,14 +9,24 @@ namespace GitUI.LeftPanel
 {
     internal sealed class SubmoduleTree : Tree
     {
+        private readonly ISubmoduleStatusProvider _submoduleStatusProvider;
         private SubmoduleStatusEventArgs? _currentSubmoduleInfo;
         private Nodes? _currentNodes = null;
 
-        public SubmoduleTree(TreeNode treeNode, IGitUICommandsSource uiCommands)
-            : base(treeNode, uiCommands)
+        public SubmoduleTree(TreeNode treeNode, IGitUICommandsSource commandsSource)
+            : base(treeNode, commandsSource)
         {
-            SubmoduleStatusProvider.Default.StatusUpdating += Provider_StatusUpdating;
-            SubmoduleStatusProvider.Default.StatusUpdated += Provider_StatusUpdated;
+            _submoduleStatusProvider = UICommands.GetRequiredService<ISubmoduleStatusProvider>();
+            _submoduleStatusProvider.StatusUpdating += Provider_StatusUpdating;
+            _submoduleStatusProvider.StatusUpdated += Provider_StatusUpdated;
+        }
+
+        public override void Dispose()
+        {
+            base.Dispose();
+
+            _submoduleStatusProvider.StatusUpdating -= Provider_StatusUpdating;
+            _submoduleStatusProvider.StatusUpdated -= Provider_StatusUpdated;
         }
 
         private void Provider_StatusUpdating(object sender, EventArgs e)

IntegrationTests/UI.IntegrationTests/CommandsDialogs/FormBrowse.LeftPanelTests.Submodules.cs

@@ -70,10 +70,13 @@ public void SetUp()
             _repo2Module = submodules.ElementAt(0);
             _repo3Module = submodules.ElementAt(1);
 
-            // Use the singleton provider, which is also used by the left panel, so we can synchronize on updates
-            _provider = SubmoduleStatusProvider.Default;
+            _provider = new SubmoduleStatusProvider();
 
-            _commands = new GitUICommands(GlobalServiceContainer.CreateDefaultMockServiceContainer(), _repo1Module);
+            IServiceContainer serviceContainer = GlobalServiceContainer.CreateDefaultMockServiceContainer();
+            serviceContainer.RemoveService<ISubmoduleStatusProvider>();
+            serviceContainer.AddService(_provider);
+
+            _commands = new GitUICommands(serviceContainer, _repo1Module);
         }
 
         [TearDown]

IntegrationTests/UI.IntegrationTests/GlobalServiceContainer.cs

@@ -1,6 +1,7 @@
 using System.ComponentModel;
 using System.ComponentModel.Design;
 using GitCommands;
+using GitCommands.Submodules;
 using GitUI;
 using GitUI.Hotkey;
 using GitUI.ScriptsEngine;
@@ -27,6 +28,8 @@ public static ServiceContainer CreateDefaultMockServiceContainer()
             serviceContainer.AddService(Substitute.For<IHotkeySettingsManager>());
             serviceContainer.AddService(Substitute.For<IHotkeySettingsLoader>());
 
+            serviceContainer.AddService(Substitute.For<ISubmoduleStatusProvider>());
+
             return serviceContainer;
         }
     }