Setup two-step plugin loading sequence (Closes #1244) (#1251)

Author: AlexMacocian

Daybreak.Shared/Services/Plugins/IPluginsService.cs

@@ -8,7 +8,9 @@ public interface IPluginsService
 
     IEnumerable<AvailablePlugin> GetCurrentlyLoadedPlugins();
 
-    void LoadPlugins();
+    void UpdateLoadedPlugins(IReadOnlyList<AvailablePlugin> loadedPlugins);
+
+    IReadOnlyList<AvailablePlugin> LoadPlugins();
 
     IEnumerable<AvailablePlugin> GetAvailablePlugins();
 

Daybreak/Launch/Launcher.Bootstrap.cs

@@ -28,6 +28,7 @@ private static ServiceProvider SetupBootstrap()
 
     private static void BootstrapPluginsService(IServiceCollection services)
     {
+        services.AddDaybreakOptions<PluginsServiceOptions>();
         services.AddSingleton<IPluginsService, PluginsService>();
     }
 

Daybreak/Launch/Launcher.cs

@@ -35,9 +35,7 @@ private static void LaunchSequence(string[] args, IServiceProvider bootstrap)
         scopedLogger.LogDebug("Starting Daybreak Launcher...");
         var builder = CreateMainBuilder(args);
         var pluginsService = bootstrap.GetRequiredService<IPluginsService>();
-        pluginsService.LoadPlugins();
-
-        var loadedPlugins = pluginsService.GetCurrentlyLoadedPlugins();
+        var loadedPlugins = pluginsService.LoadPlugins();
         var configurations = loadedPlugins.Select<AvailablePlugin, (string, PluginConfigurationBase?, AvailablePlugin?)>(p => (p.Name, p.Configuration, (AvailablePlugin?)p))
             .Prepend(("Daybreak Core", new ProjectConfiguration(), default)).ToList();
 
@@ -54,8 +52,6 @@ private static void LaunchSequence(string[] args, IServiceProvider bootstrap)
         }
 
         builder.Services.AddSingleton<IReadOnlyDictionary<string, MenuCategory>>(menuEntryProducer.categories.AsReadOnly());
-        builder.Services.AddSingleton(pluginsService);
-
         var mainApp = CreateMainApp(builder);
         foreach(var (pluginName, configuration, plugin) in configurations)
         {
@@ -68,6 +64,10 @@ private static void LaunchSequence(string[] args, IServiceProvider bootstrap)
             RegisterThemes(bootstrap, configuration, scopedLogger);
         }
 
+        scopedLogger.LogInformation("Registering loaded plugins");
+        var finalPluginService = mainApp.Services.GetRequiredService<IPluginsService>();
+        finalPluginService.UpdateLoadedPlugins(loadedPlugins);
+
         var theme = mainApp.Services.GetRequiredService<GameScreenshotsTheme>();
         Theme.Themes.Add(theme);
         var keyboardHook = mainApp.Services.GetRequiredService<IKeyboardHookService>();

Daybreak/Services/Plugins/PluginsService.cs

@@ -78,7 +78,12 @@ public void SaveEnabledPlugins(IEnumerable<AvailablePlugin> availablePlugins)
         this.optionsProvider.SaveOption(options);
     }
 
-    public void LoadPlugins()
+    public void UpdateLoadedPlugins(IReadOnlyList<AvailablePlugin> loadedPlugins)
+    {
+        this.loadedPlugins.ClearAnd().AddRange(loadedPlugins);
+    }
+
+    public IReadOnlyList<AvailablePlugin> LoadPlugins()
     {
         this.pluginsSemaphore.Wait();
         var scopedLogger = this.logger.CreateScopedLogger();
@@ -105,9 +110,11 @@ public void LoadPlugins()
         catch (Exception e)
         {
             scopedLogger.LogError(e, "Caught exception while loading plugins");
+            this.pluginsSemaphore.Release();
             throw;
         }
 
+        var loadedPlugins = new List<AvailablePlugin>();
         foreach (var result in results)
         {
             var pluginScopedLogger = this.logger.CreateScopedLogger(flowIdentifier: result.PluginEntry?.Name ?? string.Empty);
@@ -119,35 +126,33 @@ public void LoadPlugins()
                 if (assembly is null)
                 {
                     // Exclude the plugin from the enabled list if it failed to load
-                    this.DisablePlugin(result);
                     continue;
                 }
 
                 var entryPoint = assembly.GetTypes().FirstOrDefault(t => t.IsSubclassOf(typeof(PluginConfigurationBase)));
                 if (entryPoint is null)
                 {
                     pluginScopedLogger.LogError($"Assembly loaded but unable to find entry point. The plugin will not start");
-                    this.DisablePlugin(result);
                     continue;
                 }
 
                 var pluginConfig = Activator.CreateInstance(entryPoint)?.As<PluginConfigurationBase>();
                 if (pluginConfig is null)
                 {
                     pluginScopedLogger.LogError($"Assembly loaded but unable to create entry point. The plugin will not start");
-                    this.DisablePlugin(result);
                     continue;
                 }
 
-                this.loadedPlugins.Add(new AvailablePlugin { Name = result.PluginEntry?.Name ?? string.Empty, Path = result.PluginEntry?.Path ?? string.Empty, Enabled = true, Configuration = pluginConfig });
+                loadedPlugins.Add(new AvailablePlugin { Name = result.PluginEntry?.Name ?? string.Empty, Path = result.PluginEntry?.Path ?? string.Empty, Enabled = true, Configuration = pluginConfig });
             }
-            catch(Exception e)
+            catch (Exception e)
             {
                 pluginScopedLogger.LogError(e, $"Encountered exception while loading plugin");
             }
         }
 
         this.pluginsSemaphore.Release();
+        return loadedPlugins;
     }
 
     public async Task<bool> AddPlugin(string pathToPlugin)