feat: make testing opt-in per plugin

Dalamud/Configuration/Internal/DalamudConfiguration.cs

@@ -337,6 +337,11 @@ namespace Dalamud.Configuration.Internal
         /// </summary>
         public string LastFeedbackContactDetails { get; set; } = string.Empty;
 
+        /// <summary>
+        /// Gets or sets a list of plugins that testing builds should be downloaded for.
+        /// </summary>
+        public List<PluginTestingOptIn>? PluginTestingOptIns { get; set; }
+
         /// <summary>
         /// Load a configuration from the provided path.
         /// </summary>

Dalamud/Configuration/Internal/PluginTestingOptIn.cs

@@ -0,0 +1,24 @@
+namespace Dalamud.Configuration.Internal;
+
+public record PluginTestingOptIn
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginTestingOptIn"/> class.
+    /// </summary>
+    /// <param name="internalName">The internal name of the plugin.</param>
+    public PluginTestingOptIn(string internalName)
+    {
+        this.InternalName = internalName;
+        this.Branch = "testing-live"; // TODO: make these do something, needs work in plogon
+    }
+
+    /// <summary>
+    /// Gets the internal name of the plugin to test.
+    /// </summary>
+    public string InternalName { get; private set; }
+
+    /// <summary>
+    /// Gets the testing branch to use.
+    /// </summary>
+    public string Branch { get; private set; }
+}

Dalamud/Interface/Internal/Windows/PluginImageCache.cs

@@ -513,7 +513,7 @@ namespace Dalamud.Interface.Internal.Windows
                 isThirdParty = true;
             }
 
-            var useTesting = PluginManager.UseTesting(manifest);
+            var useTesting = Service<PluginManager>.Get().UseTesting(manifest);
             var url = this.GetPluginIconUrl(manifest, isThirdParty, useTesting);
 
             if (url.IsNullOrEmpty())
@@ -599,7 +599,7 @@ namespace Dalamud.Interface.Internal.Windows
                 isThirdParty = true;
             }
 
-            var useTesting = PluginManager.UseTesting(manifest);
+            var useTesting = Service<PluginManager>.Get().UseTesting(manifest);
             var urls = this.GetPluginImageUrls(manifest, isThirdParty, useTesting);
             urls = urls?.Where(x => !string.IsNullOrEmpty(x)).ToList();
             if (urls?.Any() != true)

Dalamud/Interface/Internal/Windows/PluginInstaller/PluginInstallerWindow.cs

@@ -1637,7 +1637,7 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
             var notifications = Service<NotificationManager>.Get();
             var pluginManager = Service<PluginManager>.Get();
 
-            var useTesting = PluginManager.UseTesting(manifest);
+            var useTesting = pluginManager.UseTesting(manifest);
             var wasSeen = this.WasPluginSeen(manifest.InternalName);
 
             var isOutdated = manifest.DalamudApiLevel < PluginManager.DalamudApiLevel;
@@ -1653,7 +1653,7 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
             var label = manifest.Name;
 
             // Testing
-            if (useTesting)
+            if (useTesting || manifest.IsTestingExclusive)
             {
                 label += Locs.PluginTitleMod_TestingVersion;
             }
@@ -1710,7 +1710,7 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
                         this.installStatus = OperationStatus.InProgress;
                         this.loadingIndicatorKind = LoadingIndicatorKind.Installing;
 
-                        Task.Run(() => pluginManager.InstallPluginAsync(manifest, useTesting, PluginLoadReason.Installer))
+                        Task.Run(() => pluginManager.InstallPluginAsync(manifest, useTesting || manifest.IsTestingExclusive, PluginLoadReason.Installer))
                             .ContinueWith(task =>
                             {
                                 // There is no need to set as Complete for an individual plugin installation
@@ -1803,6 +1803,8 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
             var configuration = Service<DalamudConfiguration>.Get();
             var commandManager = Service<CommandManager>.Get();
 
+            var testingOptIn = 
+                configuration.PluginTestingOptIns?.FirstOrDefault(x => x.InternalName == plugin.Manifest.InternalName);
             var trouble = false;
 
             // Name
@@ -1820,6 +1822,11 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
                 label += Locs.PluginTitleMod_TestingVersion;
             }
 
+            if (plugin.Manifest.IsAvailableForTesting && configuration.DoPluginTest && testingOptIn == null)
+            {
+                label += Locs.PluginTitleMod_TestingAvailable;
+            }
+
             // Freshly installed
             if (showInstalled)
             {
@@ -1904,7 +1911,7 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
             ImGui.PushID($"installed{index}{plugin.Manifest.InternalName}");
             var hasChangelog = !plugin.Manifest.Changelog.IsNullOrEmpty();
 
-            if (this.DrawPluginCollapsingHeader(label, plugin, plugin.Manifest, plugin.Manifest.IsThirdParty, trouble, availablePluginUpdate != default, false, false, () => this.DrawInstalledPluginContextMenu(plugin), index))
+            if (this.DrawPluginCollapsingHeader(label, plugin, plugin.Manifest, plugin.Manifest.IsThirdParty, trouble, availablePluginUpdate != default, false, false, () => this.DrawInstalledPluginContextMenu(plugin, testingOptIn), index))
             {
                 if (!this.WasPluginSeen(plugin.Manifest.InternalName))
                     configuration.SeenPluginInternalName.Add(plugin.Manifest.InternalName);
@@ -2038,13 +2045,35 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
             ImGui.PopStyleColor(2);
         }
 
-        private void DrawInstalledPluginContextMenu(LocalPlugin plugin)
+        private void DrawInstalledPluginContextMenu(LocalPlugin plugin, PluginTestingOptIn? optIn)
         {
             var pluginManager = Service<PluginManager>.Get();
+            var configuration = Service<DalamudConfiguration>.Get();
 
             if (ImGui.BeginPopupContextItem("InstalledItemContextMenu"))
             {
-                if (ImGui.Selectable(Locs.PluginContext_DeletePluginConfigReload))
+                var repoManifest = this.pluginListAvailable.FirstOrDefault(x => x.InternalName == plugin.Manifest.InternalName);
+                if (repoManifest?.IsTestingExclusive == true)
+                    ImGui.BeginDisabled();
+
+                if (ImGui.MenuItem(Locs.PluginContext_TestingOptIn, string.Empty, optIn != null))
+                {
+                    if (optIn != null)
+                    {
+                        configuration.PluginTestingOptIns!.Remove(optIn);
+                    }
+                    else
+                    {
+                        configuration.PluginTestingOptIns!.Add(new PluginTestingOptIn(plugin.Manifest.InternalName));
+                    }
+
+                    configuration.Save();
+                }
+
+                if (repoManifest?.IsTestingExclusive == true)
+                    ImGui.EndDisabled();
+
+                if (ImGui.MenuItem(Locs.PluginContext_DeletePluginConfigReload))
                 {
                     Log.Debug($"Deleting config for {plugin.Manifest.InternalName}");
 
@@ -2751,6 +2780,8 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
 
             public static string PluginTitleMod_TestingVersion => Loc.Localize("InstallerTestingVersion", " (testing version)");
 
+            public static string PluginTitleMod_TestingAvailable => Loc.Localize("InstallerTestingAvailable", " (available for testing)");
+
             public static string PluginTitleMod_DevPlugin => Loc.Localize("InstallerDevPlugin", " (dev plugin)");
 
             public static string PluginTitleMod_UpdateFailed => Loc.Localize("InstallerUpdateFailed", " (update failed)");
@@ -2773,6 +2804,8 @@ namespace Dalamud.Interface.Internal.Windows.PluginInstaller
 
             #region Plugin context menu
 
+            public static string PluginContext_TestingOptIn => Loc.Localize("InstallerTestingOptIn", "Receive plugin testing versions");
+
             public static string PluginContext_MarkAllSeen => Loc.Localize("InstallerMarkAllSeen", "Mark all as seen");
 
             public static string PluginContext_HidePlugin => Loc.Localize("InstallerHidePlugin", "Hide from installer");

Dalamud/Plugin/Internal/PluginManager.cs

@@ -118,11 +118,13 @@ Thanks and have fun!";
             throw new InvalidDataException("Couldn't deserialize banned plugins manifest.");
         }
 
-        this.openInstallerWindowPluginChangelogsLink = Service<ChatGui>.Get().AddChatLinkHandler("Dalamud", 1003, (i, m) =>
+        this.openInstallerWindowPluginChangelogsLink = Service<ChatGui>.Get().AddChatLinkHandler("Dalamud", 1003, (_, _) =>
         {
             Service<DalamudInterface>.GetNullable()?.OpenPluginInstallerPluginChangelogs();
         });
 
+        this.configuration.PluginTestingOptIns ??= new List<PluginTestingOptIn>();
+
         this.ApplyPatches();
     }
 
@@ -186,6 +188,23 @@ Thanks and have fun!";
     /// </summary>
     public bool LoadBannedPlugins { get; set; }
 
+    /// <summary>
+    /// Gets a value indicating whether the given repo manifest should be visible to the user.
+    /// </summary>
+    /// <param name="manifest">Repo manifest.</param>
+    /// <returns>If the manifest is visible.</returns>
+    public static bool IsManifestVisible(RemotePluginManifest manifest)
+    {
+        var configuration = Service<DalamudConfiguration>.Get();
+
+        // Hidden by user
+        if (configuration.HiddenPluginInternalName.Contains(manifest.InternalName))
+            return false;
+
+        // Hidden by manifest
+        return !manifest.IsHide;
+    }
+
     /// <summary>
     /// Print to chat any plugin updates and whether they were successful.
     /// </summary>
@@ -236,11 +255,12 @@ Thanks and have fun!";
     /// </summary>
     /// <param name="manifest">Manifest to check.</param>
     /// <returns>A value indicating whether testing should be used.</returns>
-    public static bool UseTesting(PluginManifest manifest)
+    public bool UseTesting(PluginManifest manifest)
     {
-        var configuration = Service<DalamudConfiguration>.Get();
+        if (!this.configuration.DoPluginTest)
+            return false;
 
-        if (!configuration.DoPluginTest)
+        if (this.configuration.PluginTestingOptIns!.All(x => x.InternalName != manifest.InternalName))
             return false;
 
         if (manifest.IsTestingExclusive)
@@ -258,25 +278,6 @@ Thanks and have fun!";
         return false;
     }
 
-    /// <summary>
-    /// Gets a value indicating whether the given repo manifest should be visible to the user.
-    /// </summary>
-    /// <param name="manifest">Repo manifest.</param>
-    /// <returns>If the manifest is visible.</returns>
-    public static bool IsManifestVisible(RemotePluginManifest manifest)
-    {
-        var configuration = Service<DalamudConfiguration>.Get();
-
-        // Hidden by user
-        if (configuration.HiddenPluginInternalName.Contains(manifest.InternalName))
-            return false;
-
-        return true; // TODO temporary
-
-        // Hidden by manifest
-        return !manifest.IsHide;
-    }
-
     /// <inheritdoc/>
     public void Dispose()
     {
@@ -687,6 +688,13 @@ Thanks and have fun!";
     {
         Log.Debug($"Installing plugin {repoManifest.Name} (testing={useTesting})");
 
+        // Ensure that we have a testing opt-in for this plugin if we are installing a testing version
+        if (useTesting && this.configuration.PluginTestingOptIns!.All(x => x.InternalName != repoManifest.InternalName))
+        {
+            this.configuration.PluginTestingOptIns.Add(new PluginTestingOptIn(repoManifest.InternalName));
+            this.configuration.Save();
+        }
+
         var downloadUrl = useTesting ? repoManifest.DownloadLinkTesting : repoManifest.DownloadLinkInstall;
         var version = useTesting ? repoManifest.TestingAssemblyVersion : repoManifest.AssemblyVersion;
 
@@ -961,6 +969,7 @@ Thanks and have fun!";
                                 versionDir.Delete(true);
                                 continue;
                             }
+
                             var dllFile = new FileInfo(Path.Combine(versionDir.FullName, $"{pluginDir.Name}.dll"));
                             if (!dllFile.Exists)
                             {
@@ -1008,6 +1017,7 @@ Thanks and have fun!";
     /// <summary>
     /// Update all non-dev plugins.
     /// </summary>
+    /// <param name="ignoreDisabled">Ignore disabled plugins.</param>
     /// <param name="dryRun">Perform a dry run, don't install anything.</param>
     /// <returns>Success or failure and a list of updated plugin metadata.</returns>
     public async Task<List<PluginUpdateStatus>> UpdatePluginsAsync(bool ignoreDisabled, bool dryRun)
@@ -1265,7 +1275,7 @@ Thanks and have fun!";
                               .Where(remoteManifest => remoteManifest.DalamudApiLevel == DalamudApiLevel)
                               .Select(remoteManifest =>
                               {
-                                  var useTesting = UseTesting(remoteManifest);
+                                  var useTesting = this.UseTesting(remoteManifest);
                                   var candidateVersion = useTesting
                                                              ? remoteManifest.TestingAssemblyVersion
                                                              : remoteManifest.AssemblyVersion;

Dalamud/Plugin/Internal/Types/LocalPluginManifest.cs

@@ -50,6 +50,11 @@ internal record LocalPluginManifest : PluginManifest
     /// </summary>
     public Version EffectiveVersion => this.Testing && this.TestingAssemblyVersion != null ? this.TestingAssemblyVersion : this.AssemblyVersion;
 
+    /// <summary>
+    /// Gets a value indicating whether this plugin is eligible for testing.
+    /// </summary>
+    public bool IsAvailableForTesting => this.TestingAssemblyVersion != null && this.TestingAssemblyVersion > this.AssemblyVersion;
+
     /// <summary>
     /// Save a plugin manifest to file.
     /// </summary>