HellionChat/HellionChat/SelfTests/ConfigMigrationV27Step.cs

using Dalamud.Bindings.ImGui;
using Dalamud.Plugin.SelfTest;

namespace HellionChat.SelfTests;

// Pins the post-migration shape of the config. By /xlperf time the schema gate
// has stamped Config.Version and the 2.0.0 reset has run, so the fields below
// must carry valid values here. This probe never rewrites config; the reset
// itself is load-time.
internal sealed class ConfigMigrationV27Step : ISelfTestStep
{
    public ConfigMigrationV27Step(Plugin plugin)
    {
        _ = plugin;
    }

    public string Name => "Hellion Chat - Config migration";

    public SelfTestStepResult RunStep()
    {
        // Against LatestVersion, not a literal: this read 27 and went red the
        // moment the schema moved to 28, reporting a migration failure where the
        // only thing that had happened was a new migration step being added.
        if (Plugin.Config.Version != Configuration.LatestVersion)
        {
            ImGui.Text(
                $"Config.Version is {Plugin.Config.Version}, expected {Configuration.LatestVersion}"
            );
            return SelfTestStepResult.Fail;
        }

        // v27 replaces the config rather than migrating it, and CreateFresh
        // hands back an empty tab list. The seeding in LoadAsync is what fills
        // it, and it runs in a different method than the reset does -- if that
        // ordering ever breaks, every user comes out of the update with no tabs
        // at all and nothing else in the plugin would notice.
        if (Plugin.Config.Tabs.Count == 0)
        {
            ImGui.Text(
                "No tabs at all. The v27 reset empties the list and LoadAsync is what "
                    + "seeds the presets back -- reaching this point empty means it did not."
            );
            return SelfTestStepResult.Fail;
        }

        // What v26 exists to prevent: a tab whose name came from a conversation
        // partner but is not marked as such, because screenshot mode reads that
        // mark to decide whether the name may be shown. Anything still holding a
        // tell binding or the temp flag should have been marked on load.
        foreach (var tab in Plugin.Config.Tabs)
        {
            var looksLikeAPartner = tab.IsTempTab || tab.TellTarget?.IsSet() == true;
            if (!looksLikeAPartner || tab.NameCameFromPartner)
                continue;

            ImGui.Text(
                $"Tab '{tab.Name}' carries a tell binding but is not marked partner-named "
                    + "— the v26 migration did not reach it, and screenshot mode will show it"
            );
            return SelfTestStepResult.Fail;
        }

        // The state the v24 migration exists to prevent: filter on, failsafe on,
        // nothing picked. Under the corrected rule that combination stores no
        // messages at all, so reaching /xlperf in it means the migration did not
        // run.
        if (
            Privacy.StorageRule.ShouldDisableFilterOnV24(
                Plugin.Config.PrivacyFilterEnabled,
                Plugin.Config.PrivacyPersistUnknownChannels,
                Plugin.Config.PrivacyPersistChannels.Count
            )
        )
        {
            ImGui.Text("Privacy filter is on with no channels picked — v24 migration did not run");
            return SelfTestStepResult.Fail;
        }

        if (Plugin.Config.MaxParallelPopouts <= 0)
        {
            ImGui.Text(
                $"Config.MaxParallelPopouts is {Plugin.Config.MaxParallelPopouts}, must be > 0"
            );
            return SelfTestStepResult.Fail;
        }

        if (Plugin.Config.SidebarAutoSwitchThresholdPx <= 0)
        {
            ImGui.Text(
                $"Config.SidebarAutoSwitchThresholdPx is {Plugin.Config.SidebarAutoSwitchThresholdPx}, must be > 0"
            );
            return SelfTestStepResult.Fail;
        }

        if (!Enum.IsDefined(Plugin.Config.TellAutoOpenMode))
        {
            ImGui.Text($"Config.TellAutoOpenMode {Plugin.Config.TellAutoOpenMode} is out of range");
            return SelfTestStepResult.Fail;
        }

        if (!Enum.IsDefined(Plugin.Config.MainWindowLayoutMode))
        {
            ImGui.Text(
                $"Config.MainWindowLayoutMode {Plugin.Config.MainWindowLayoutMode} is out of range"
            );
            return SelfTestStepResult.Fail;
        }

        // Touch-tests: declaration proves the migration emitted these with
        // defaults; reading them confirms the property is reachable.
        _ = Plugin.Config.MainWindowOpen;
        _ = Plugin.Config.SettingsWindowOpen;
        _ = Plugin.Config.ScreenshotMode;

        return SelfTestStepResult.Pass;
    }

    public void CleanUp() { }
}