fix compatibility system for csm and add changelog news

bonsaibauer · bonsaibauer · commit 0ffe1cd56097 · 2026-04-01T00:51:10.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ In-game changelog source: `src/CSM.TmpeSync/Services/UI/ChangelogPanel.cs` (`Cha
 ### Compatibility & Health Check
 - **Compatibility management rework**: Added a dedicated Health Check flow in Mod Options with live Host/Client and dependency diagnostics.
 - **Cities: Skylines compatibility validation**: Added explicit CS version-line checks and integrated them into diagnostics and notifier flows.
+- [Fixed] Manual Host/Client compatibility checks: stabilized probe/response delivery to prevent false "No Response" timeouts during in-session checks.
+- [Fixed] Mod Options UX: selecting the Compatibility tab now triggers the same immediate refresh as the Refresh button.
 - **Runtime UX behavior**: Improved Host/Client session handling and status rendering in Mod Options and popup panels.
 
 ### UI & Messaging
diff --git a/src/CSM.TmpeSync/Handlers/System/VersionCheckHandlers.cs b/src/CSM.TmpeSync/Handlers/System/VersionCheckHandlers.cs
@@ -37,21 +37,31 @@ protected override void Handle(VersionCheckRequest command)
 
             var clientVersion = command?.Version;
             var serverVersion = CompatibilityChecker.LocalVersion;
-            var versionsMatch = CompatibilityChecker.CompareVersions(clientVersion, serverVersion);
-            var status = versionsMatch ? "Match" : "Mismatch";
+            string comparisonStatus;
+            string comparisonSeverity;
+            var versionsMatch = CompatibilityChecker.CompareVersions(
+                clientVersion,
+                serverVersion,
+                out comparisonStatus,
+                out comparisonSeverity);
 
             Log.Info(
                 LogCategory.Network,
-                "Client version comparison | senderId={0} clientVersion={1} serverVersion={2} status={3}",
+                "Client version comparison | senderId={0} clientVersion={1} serverVersion={2} status={3} severity={4}",
                 senderId,
                 clientVersion ?? "<null>",
                 serverVersion ?? "<null>",
-                status);
+                comparisonStatus,
+                comparisonSeverity ?? "<null>");
+
+            CompatibilityChecker.HandleAutomaticServerHandshakeObservation(
+                senderId,
+                clientVersion,
+                serverVersion);
 
             if (!versionsMatch)
             {
                 VersionMismatchNotifier.NotifyServerMismatch(senderId, clientVersion, serverVersion);
-                FeatureBootstrapper.SuspendForVersionMismatch(clientVersion);
                 var shouldBroadcast = command == null || !command.IsManualCheck;
                 if (shouldBroadcast)
                 {
@@ -79,23 +89,23 @@ protected override void Handle(VersionCheckRequest command)
 
             try
             {
-                CsmBridge.SendToClient(senderId, new VersionCheckResponse
+                CsmBridge.SendToAll(new VersionCheckResponse
                 {
                     Version = serverVersion,
                     IsManualCheck = command != null && command.IsManualCheck,
                     RequestId = command?.RequestId
                 });
                 Log.Info(
                     LogCategory.Network,
-                    "Version check response sent | targetId={0} version={1} manual={2} requestId={3}",
+                    "Version check response broadcast sent | targetId={0} version={1} manual={2} requestId={3}",
                     senderId,
                     serverVersion ?? "<null>",
                     command != null && command.IsManualCheck ? "Yes" : "No",
                     command?.RequestId ?? "<null>");
             }
             catch (Exception ex)
             {
-                Log.Warn(LogCategory.Network, LogRole.General, "Failed to send version check response | targetId={0} error={1}", senderId, ex);
+                Log.Warn(LogCategory.Network, LogRole.General, "Failed to broadcast version check response | targetId={0} error={1}", senderId, ex);
             }
         }
     }
@@ -121,15 +131,23 @@ protected override void Handle(VersionCheckResponse command)
 
             var serverVersion = command?.Version;
             var localVersion = CompatibilityChecker.LocalVersion;
-            var versionsMatch = CompatibilityChecker.CompareVersions(serverVersion, localVersion);
-            var status = versionsMatch ? "Match" : "Mismatch";
+            string comparisonStatus;
+            string comparisonSeverity;
+            var versionsMatch = CompatibilityChecker.CompareVersions(
+                serverVersion,
+                localVersion,
+                out comparisonStatus,
+                out comparisonSeverity);
 
             Log.Info(
                 LogCategory.Network,
-                "Server version comparison | serverVersion={0} localVersion={1} status={2}",
+                "Server version comparison | serverVersion={0} localVersion={1} status={2} severity={3}",
                 serverVersion ?? "<null>",
                 localVersion ?? "<null>",
-                status);
+                comparisonStatus,
+                comparisonSeverity ?? "<null>");
+
+            CompatibilityChecker.HandleAutomaticClientHandshakeResult(localVersion, serverVersion);
 
             if (!versionsMatch)
             {
@@ -145,7 +163,6 @@ protected override void Handle(VersionCheckResponse command)
                     VersionMismatchNotifier.NotifyClientMismatch(serverVersion, localVersion);
                 }
 
-                FeatureBootstrapper.SuspendForVersionMismatch(serverVersion);
                 return;
             }
 
@@ -164,6 +181,12 @@ public class VersionProbeRequestHandler : CommandHandler<VersionProbeRequest>
         protected override void Handle(VersionProbeRequest command)
         {
             var senderId = CsmBridge.GetSenderId(command);
+            Log.Info(
+                LogCategory.Network,
+                "Version probe request received | senderId={0} requestId={1} hostVersion={2}",
+                senderId,
+                command?.RequestId ?? "<null>",
+                command?.HostVersion ?? "<null>");
             if (CsmBridge.IsServerInstance())
             {
                 Log.Debug(LogCategory.Network, LogRole.General, "Version probe request ignored | reason=server_instance senderId={0}", senderId);
@@ -182,6 +205,14 @@ protected override void Handle(VersionProbeRequest command)
                     ClientVersion = localVersion,
                     MatchesHost = matches
                 });
+                Log.Info(
+                    LogCategory.Network,
+                    LogRole.Client,
+                    "Version probe response sent | requestId={0} clientVersion={1} hostVersion={2} matchesHost={3}",
+                    command?.RequestId ?? "<null>",
+                    localVersion ?? "<null>",
+                    hostVersion ?? "<null>",
+                    matches ? "Yes" : "No");
             }
             catch (Exception ex)
             {
@@ -207,6 +238,14 @@ protected override void Handle(VersionProbeResponse command)
             }
 
             var senderId = CsmBridge.GetSenderId(command);
+            Log.Info(
+                LogCategory.Network,
+                LogRole.Host,
+                "Version probe response received | senderId={0} requestId={1} clientVersion={2} matchesHost={3}",
+                senderId,
+                command?.RequestId ?? "<null>",
+                command?.ClientVersion ?? "<null>",
+                command != null && command.MatchesHost ? "Yes" : "No");
             CompatibilityChecker.HandleManualHostProbeResponse(
                 senderId,
                 command?.RequestId,
diff --git a/src/CSM.TmpeSync/Handlers/System/VersionMismatchBroadcastHandler.cs b/src/CSM.TmpeSync/Handlers/System/VersionMismatchBroadcastHandler.cs
@@ -25,6 +25,7 @@ protected override void Handle(VersionMismatchBroadcast command)
             var reportedClientVersion = command?.ReportedClientVersion;
             var localVersion = CompatibilityChecker.LocalVersion;
             var matches = CompatibilityChecker.CompareVersions(serverVersion, localVersion);
+            CompatibilityChecker.HandleAutomaticClientHandshakeResult(localVersion, serverVersion);
 
             Log.Info(
                 LogCategory.Network,
@@ -39,7 +40,6 @@ protected override void Handle(VersionMismatchBroadcast command)
             if (!matches)
             {
                 VersionMismatchNotifier.NotifyClientMismatch(serverVersion, localVersion);
-                FeatureBootstrapper.SuspendForVersionMismatch(serverVersion);
             }
         }
     }
diff --git a/src/CSM.TmpeSync/Mod/FeatureBootstrapper.cs b/src/CSM.TmpeSync/Mod/FeatureBootstrapper.cs
@@ -52,10 +52,7 @@ internal static void Register()
                 _registered = true;
             }
 
-            foreach (var feature in Features)
-                EnableFeature(feature);
-
-            Log.Info(LogCategory.Synchronization, GetCurrentRole(), "Synchronization features enabled.");
+            EnableAllFeatures();
         }
 
         internal static void Unregister()
@@ -83,26 +80,55 @@ internal static void SuspendForVersionMismatch(string remoteVersion)
                 ? "mod version mismatch"
                 : string.Format("mod version mismatch (remote={0})", remoteVersion);
 
+            ApplyCompatibilityGate(enabled: false, reason: reason);
+        }
+
+        internal static void ApplyCompatibilityGate(bool enabled, string reason)
+        {
             var shouldDisable = false;
+            var shouldEnable = false;
+            var effectiveReason = string.IsNullOrEmpty(reason) ? "compatibility gate" : reason;
             lock (SyncRoot)
             {
-                if (_suspended)
-                    return;
-
-                _suspended = true;
-                _suspendReason = reason;
-
-                if (_registered)
+                if (enabled)
                 {
-                    _registered = false;
-                    shouldDisable = true;
+                    if (!_suspended)
+                        return;
+
+                    _suspended = false;
+                    _suspendReason = string.Empty;
+                    if (!_registered)
+                    {
+                        _registered = true;
+                        shouldEnable = true;
+                    }
+                }
+                else
+                {
+                    if (_suspended && !_registered && string.Equals(_suspendReason, effectiveReason, StringComparison.Ordinal))
+                        return;
+
+                    _suspended = true;
+                    _suspendReason = effectiveReason;
+                    if (_registered)
+                    {
+                        _registered = false;
+                        shouldDisable = true;
+                    }
                 }
             }
 
             if (shouldDisable)
+            {
                 DisableAllFeatures();
+                Log.Warn(LogCategory.Synchronization, GetCurrentRole(), "Synchronization suspended | reason={0}", effectiveReason);
+            }
 
-            Log.Warn(LogCategory.Synchronization, GetCurrentRole(), "Synchronization suspended | reason={0}", reason);
+            if (shouldEnable)
+            {
+                EnableAllFeatures();
+                Log.Info(LogCategory.Synchronization, GetCurrentRole(), "Synchronization resumed | reason={0}", effectiveReason);
+            }
         }
 
         internal static void GetRuntimeState(out bool isRegistered, out bool isSuspended, out string suspendReason)
@@ -121,6 +147,14 @@ private static void DisableAllFeatures()
                 DisableFeature(feature);
         }
 
+        private static void EnableAllFeatures()
+        {
+            foreach (var feature in Features)
+                EnableFeature(feature);
+
+            Log.Info(LogCategory.Synchronization, GetCurrentRole(), "Synchronization features enabled.");
+        }
+
         private static void EnableFeature(FeatureToggle feature)
         {
             if (!feature.Enabled)
diff --git a/src/CSM.TmpeSync/Mod/MyUserMod.cs b/src/CSM.TmpeSync/Mod/MyUserMod.cs
@@ -47,25 +47,37 @@ public void OnSettingsUI(UIHelperBase helper)
             generalGroup.AddButton("Show What's New", ChangelogService.ShowLatestNow);
 
             var compatibilityTab = tabStrip.AddTabPage("Compatibility");
+            var compatibilityTabIndex = tabStrip.tabCount - 1;
             var compatibilityGroup = compatibilityTab.AddGroup("Compatibility");
             var compatibilityGroupHelper = compatibilityGroup as UIHelper;
             var compatibilityContainer = compatibilityGroupHelper?.self as UIPanel;
-            if (compatibilityContainer != null)
+
+            OnButtonClicked refreshCompatibilityUi = () =>
             {
+                if (compatibilityContainer == null)
+                    return;
+
                 BuildCompatibilityUi(compatibilityContainer);
+                compatibilityContainer.Invalidate();
+            };
+
+            if (compatibilityContainer != null)
+            {
+                refreshCompatibilityUi();
             }
 
+            tabStrip.eventSelectedIndexChanged += (_, index) =>
+            {
+                if (index == compatibilityTabIndex)
+                {
+                    refreshCompatibilityUi();
+                }
+            };
+
             var compatibilityActions = compatibilityTab.AddGroup("Actions");
             compatibilityActions.AddButton(
                 "Refresh",
-                () =>
-                {
-                    if (compatibilityContainer == null)
-                        return;
-
-                    BuildCompatibilityUi(compatibilityContainer);
-                    compatibilityContainer.Invalidate();
-                });
+                refreshCompatibilityUi);
             compatibilityActions.AddButton(
                 "Copy diagnostics",
                 () =>
diff --git a/src/CSM.TmpeSync/Services/CompatibilityChecker.cs b/src/CSM.TmpeSync/Services/CompatibilityChecker.cs
diff --git a/src/CSM.TmpeSync/Services/UI/ChangelogPanel.cs b/src/CSM.TmpeSync/Services/UI/ChangelogPanel.cs

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ protected override void Handle(VersionMismatchBroadcast command)`
`25`	`25`	`var reportedClientVersion = command?.ReportedClientVersion;`
`26`	`26`	`var localVersion = CompatibilityChecker.LocalVersion;`
`27`	`27`	`var matches = CompatibilityChecker.CompareVersions(serverVersion, localVersion);`
	`28`	`+ CompatibilityChecker.HandleAutomaticClientHandshakeResult(localVersion, serverVersion);`
`28`	`29`
`29`	`30`	`Log.Info(`
`30`	`31`	`LogCategory.Network,`
`@@ -39,7 +40,6 @@ protected override void Handle(VersionMismatchBroadcast command)`
`39`	`40`	`if (!matches)`
`40`	`41`	`{`
`41`	`42`	`VersionMismatchNotifier.NotifyClientMismatch(serverVersion, localVersion);`
`42`		`- FeatureBootstrapper.SuspendForVersionMismatch(serverVersion);`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`	`}`