Improve module enable/disable IPC and sorting reliability (#44734)

shuaiyuanxx · Copilot · web-flow · commit e314485e8503 · 2026-01-15T15:29:46.000+08:00
## Summary of the Pull Request - Refactored the runner logic for handling individual module enable/disable updates. Instead of receiving the entire settings.json via IPC, it now processes only single-module state updates, which avoids race conditions and fixes a bug where modules could end up being skipped. - Fixed an issue where the sort order option could be deselected — it is now enforced as a mutually exclusive choice. - Fixed a potential race condition when updating the AppList control’s sorting.  ## PR Checklist - [x] Closes: #44697  - [x] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [x] **Tests:** Added/updated and all pass - [x] **Localization:** All end-user-facing strings can be localized - [ ] **Dev docs:** Added/updated - [ ] **New binaries:** Added on the required places - [ ] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [ ] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx  ## Detailed Description of the Pull Request / Additional comments  ## Validation Steps Performed --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
diff --git a/src/runner/general_settings.cpp b/src/runner/general_settings.cpp
@@ -193,6 +193,102 @@ GeneralSettings get_general_settings()
     return settings;
 }
 
+void apply_module_status_update(const json::JsonObject& module_config, bool save)
+{
+    Logger::info(L"apply_module_status_update: {}", std::wstring{ module_config.ToString() });
+
+    // Expected format: {"ModuleName": true/false} - only one module per update
+    auto iter = module_config.First();
+    if (!iter.HasCurrent())
+    {
+        Logger::warn(L"apply_module_status_update: Empty module config");
+        return;
+    }
+
+    const auto& element = iter.Current();
+    const auto value = element.Value();
+    if (value.ValueType() != json::JsonValueType::Boolean)
+    {
+        Logger::warn(L"apply_module_status_update: Invalid value type for module status");
+        return;
+    }
+
+    const std::wstring name{ element.Key().c_str() };
+    if (modules().find(name) == modules().end())
+    {
+        Logger::warn(L"apply_module_status_update: Module {} not found", name);
+        return;
+    }
+
+    PowertoyModule& powertoy = modules().at(name);
+    const bool module_inst_enabled = powertoy->is_enabled();
+    bool target_enabled = value.GetBoolean();
+
+    auto gpo_rule = powertoy->gpo_policy_enabled_configuration();
+    if (gpo_rule == powertoys_gpo::gpo_rule_configured_enabled || gpo_rule == powertoys_gpo::gpo_rule_configured_disabled)
+    {
+        // Apply the GPO Rule.
+        target_enabled = gpo_rule == powertoys_gpo::gpo_rule_configured_enabled;
+    }
+
+    if (module_inst_enabled == target_enabled)
+    {
+        Logger::info(L"apply_module_status_update: Module {} already in target state {}", name, target_enabled);
+        return;
+    }
+
+    if (target_enabled)
+    {
+        Logger::info(L"apply_module_status_update: Enabling powertoy {}", name);
+        powertoy->enable();
+        auto& hkmng = HotkeyConflictDetector::HotkeyConflictManager::GetInstance();
+        hkmng.EnableHotkeyByModule(name);
+
+        // Trigger AI capability detection when ImageResizer is enabled
+        if (name == L"Image Resizer")
+        {
+            Logger::info(L"ImageResizer enabled, triggering AI capability detection");
+            DetectAiCapabilitiesAsync(true);  // Skip settings check since we know it's being enabled
+        }
+    }
+    else
+    {
+        Logger::info(L"apply_module_status_update: Disabling powertoy {}", name);
+        powertoy->disable();
+        auto& hkmng = HotkeyConflictDetector::HotkeyConflictManager::GetInstance();
+        hkmng.DisableHotkeyByModule(name);
+    }
+    // Sync the hotkey state with the module state, so it can be removed for disabled modules.
+    powertoy.UpdateHotkeyEx();
+
+    if (save)
+    {
+        // Load existing settings and only update the specific module's enabled state
+        json::JsonObject current_settings = PTSettingsHelper::load_general_settings();
+        
+        json::JsonObject enabled;
+        if (current_settings.HasKey(L"enabled"))
+        {
+            enabled = current_settings.GetNamedObject(L"enabled");
+        }
+        
+        // Check if the saved state is different from the requested state
+        bool current_saved = enabled.HasKey(name) ? enabled.GetNamedBoolean(name, true) : true;
+        
+        if (current_saved != target_enabled)
+        {
+            // Update only this module's enabled state
+            enabled.SetNamedValue(name, json::value(target_enabled));
+            current_settings.SetNamedValue(L"enabled", enabled);
+            
+            PTSettingsHelper::save_general_settings(current_settings);
+            
+            GeneralSettings settings_for_trace = get_general_settings();
+            Trace::SettingsChanged(settings_for_trace);
+        }
+    }
+}
+
 void apply_general_settings(const json::JsonObject& general_configs, bool save)
 {
     std::wstring old_settings_json_string;
diff --git a/src/runner/general_settings.h b/src/runner/general_settings.h
@@ -38,4 +38,5 @@ struct GeneralSettings
 json::JsonObject load_general_settings();
 GeneralSettings get_general_settings();
 void apply_general_settings(const json::JsonObject& general_configs, bool save = true);
+void apply_module_status_update(const json::JsonObject& module_config, bool save = true);
 void start_enabled_powertoys();
diff --git a/src/runner/settings_window.cpp b/src/runner/settings_window.cpp
@@ -215,6 +215,12 @@ void dispatch_received_json(const std::wstring& json_to_parse)
             //         current_settings_ipc->send(settings_string);
             // }
         }
+        else if (name == L"module_status")
+        {
+            // Handle single module enable/disable update
+            // Expected format: {"module_status": {"ModuleName": true/false}}
+            apply_module_status_update(value.GetObjectW());
+        }
         else if (name == L"powertoys")
         {
             dispatch_json_config_to_modules(value.GetObjectW());
diff --git a/src/settings-ui/QuickAccess.UI/QuickAccessXAML/Flyout/AppsListPage.xaml.cs b/src/settings-ui/QuickAccess.UI/QuickAccessXAML/Flyout/AppsListPage.xaml.cs
@@ -51,6 +51,7 @@ private void SortAlphabetical_Click(object sender, RoutedEventArgs e)
         if (ViewModel != null)
         {
             ViewModel.DashboardSortOrder = DashboardSortOrder.Alphabetical;
+            ((ToggleMenuFlyoutItem)sender).IsChecked = true;
         }
     }
 
@@ -59,6 +60,7 @@ private void SortByStatus_Click(object sender, RoutedEventArgs e)
         if (ViewModel != null)
         {
             ViewModel.DashboardSortOrder = DashboardSortOrder.ByStatus;
+            ((ToggleMenuFlyoutItem)sender).IsChecked = true;
         }
     }
 }
diff --git a/src/settings-ui/QuickAccess.UI/Services/IQuickAccessCoordinator.cs b/src/settings-ui/QuickAccess.UI/Services/IQuickAccessCoordinator.cs
@@ -3,7 +3,9 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Threading.Tasks;
+
 using ManagedCommon;
+using Microsoft.PowerToys.Settings.UI.Library;
 
 namespace Microsoft.PowerToys.QuickAccess.Services;
 
@@ -19,10 +21,10 @@ public interface IQuickAccessCoordinator
 
     Task<bool> ShowDocumentationAsync();
 
-    void NotifyUserSettingsInteraction();
-
     bool UpdateModuleEnabled(ModuleType moduleType, bool isEnabled);
 
+    void SendSortOrderUpdate(GeneralSettings generalSettings);
+
     void ReportBug();
 
     void OnModuleLaunched(ModuleType moduleType);
diff --git a/src/settings-ui/QuickAccess.UI/Services/QuickAccessCoordinator.cs b/src/settings-ui/QuickAccess.UI/Services/QuickAccessCoordinator.cs
@@ -55,37 +55,8 @@ public Task<bool> ShowDocumentationAsync()
         return Task.FromResult(false);
     }
 
-    public void NotifyUserSettingsInteraction()
-    {
-        Logger.LogDebug("QuickAccessCoordinator.NotifyUserSettingsInteraction invoked.");
-    }
-
     public bool UpdateModuleEnabled(ModuleType moduleType, bool isEnabled)
-    {
-        GeneralSettings? updatedSettings = null;
-        lock (_generalSettingsLock)
-        {
-            var repository = SettingsRepository<GeneralSettings>.GetInstance(_settingsUtils);
-            var generalSettings = repository.SettingsConfig;
-            var current = ModuleHelper.GetIsModuleEnabled(generalSettings, moduleType);
-            if (current == isEnabled)
-            {
-                return false;
-            }
-
-            ModuleHelper.SetIsModuleEnabled(generalSettings, moduleType, isEnabled);
-            _settingsUtils.SaveSettings(generalSettings.ToJsonString());
-            Logger.LogInfo($"QuickAccess updated module '{moduleType}' enabled state to {isEnabled}.");
-            updatedSettings = generalSettings;
-        }
-
-        if (updatedSettings != null)
-        {
-            SendGeneralSettingsUpdate(updatedSettings);
-        }
-
-        return true;
-    }
+        => TrySendIpcMessage($"{{\"module_status\": {{\"{ModuleHelper.GetModuleKey(moduleType)}\": {isEnabled.ToString().ToLowerInvariant()}}}}}", "module status update");
 
     public void ReportBug()
     {
@@ -131,20 +102,10 @@ private void OnIpcMessageReceived(string message)
         Logger.LogDebug($"QuickAccessCoordinator received IPC payload: {message}");
     }
 
-    private void SendGeneralSettingsUpdate(GeneralSettings updatedSettings)
+    public void SendSortOrderUpdate(GeneralSettings generalSettings)
     {
-        string payload;
-        try
-        {
-            payload = new OutGoingGeneralSettings(updatedSettings).ToString();
-        }
-        catch (Exception ex)
-        {
-            Logger.LogError("QuickAccessCoordinator: failed to serialize general settings payload.", ex);
-            return;
-        }
-
-        TrySendIpcMessage(payload, "general settings update");
+        var outgoing = new OutGoingGeneralSettings(generalSettings);
+        TrySendIpcMessage(outgoing.ToString(), "sort order update");
     }
 
     private bool TrySendIpcMessage(string payload, string operationDescription)
diff --git a/src/settings-ui/QuickAccess.UI/ViewModels/AllAppsViewModel.cs b/src/settings-ui/QuickAccess.UI/ViewModels/AllAppsViewModel.cs
@@ -22,6 +22,7 @@ namespace Microsoft.PowerToys.QuickAccess.ViewModels;
 
 public sealed class AllAppsViewModel : Observable
 {
+    private readonly object _sortLock = new object();
     private readonly IQuickAccessCoordinator _coordinator;
     private readonly ISettingsRepository<GeneralSettings> _settingsRepository;
     private readonly SettingsUtils _settingsUtils;
@@ -30,6 +31,9 @@ public sealed class AllAppsViewModel : Observable
     private readonly List<FlyoutMenuItem> _allFlyoutMenuItems = new();
     private GeneralSettings _generalSettings;
 
+    // Flag to prevent toggle operations during sorting to avoid race conditions.
+    private bool _isSorting;
+
     public ObservableCollection<FlyoutMenuItem> FlyoutMenuItems { get; }
 
     public DashboardSortOrder DashboardSortOrder
@@ -40,9 +44,9 @@ public DashboardSortOrder DashboardSortOrder
             if (_generalSettings.DashboardSortOrder != value)
             {
                 _generalSettings.DashboardSortOrder = value;
-                _settingsUtils.SaveSettings(_generalSettings.ToJsonString(), _generalSettings.GetModuleName());
+                _coordinator.SendSortOrderUpdate(_generalSettings);
                 OnPropertyChanged();
-                RefreshFlyoutMenuItems();
+                SortFlyoutMenuItems();
             }
         }
     }
@@ -54,7 +58,6 @@ public AllAppsViewModel(IQuickAccessCoordinator coordinator)
         _settingsUtils = SettingsUtils.Default;
         _settingsRepository = SettingsRepository<GeneralSettings>.GetInstance(_settingsUtils);
         _generalSettings = _settingsRepository.SettingsConfig;
-        _generalSettings.AddEnabledModuleChangeNotification(ModuleEnabledChangedOnSettingsPage);
         _settingsRepository.SettingsChanged += OnSettingsChanged;
 
         _resourceLoader = Helpers.ResourceLoaderInstance.ResourceLoader;
@@ -87,7 +90,6 @@ private void OnSettingsChanged(GeneralSettings newSettings)
         _dispatcherQueue.TryEnqueue(() =>
         {
             _generalSettings = newSettings;
-            _generalSettings.AddEnabledModuleChangeNotification(ModuleEnabledChangedOnSettingsPage);
             OnPropertyChanged(nameof(DashboardSortOrder));
             RefreshFlyoutMenuItems();
         });
@@ -120,48 +122,73 @@ private void RefreshFlyoutMenuItems()
             }
         }
 
-        var sortedItems = DashboardSortOrder switch
-        {
-            DashboardSortOrder.ByStatus => _allFlyoutMenuItems.OrderByDescending(x => x.IsEnabled).ThenBy(x => x.Label).ToList(),
-            _ => _allFlyoutMenuItems.OrderBy(x => x.Label).ToList(),
-        };
+        SortFlyoutMenuItems();
+    }
 
-        if (FlyoutMenuItems.Count == 0)
+    private void SortFlyoutMenuItems()
+    {
+        if (_isSorting)
         {
-            foreach (var item in sortedItems)
-            {
-                FlyoutMenuItems.Add(item);
-            }
-
             return;
         }
 
-        for (int i = 0; i < sortedItems.Count; i++)
+        lock (_sortLock)
         {
-            var item = sortedItems[i];
-            var oldIndex = FlyoutMenuItems.IndexOf(item);
-
-            if (oldIndex != -1 && oldIndex != i)
+            _isSorting = true;
+            try
             {
-                FlyoutMenuItems.Move(oldIndex, i);
+                var sortedItems = DashboardSortOrder switch
+                {
+                    DashboardSortOrder.ByStatus => _allFlyoutMenuItems.OrderByDescending(x => x.IsEnabled).ThenBy(x => x.Label).ToList(),
+                    _ => _allFlyoutMenuItems.OrderBy(x => x.Label).ToList(),
+                };
+
+                if (FlyoutMenuItems.Count == 0)
+                {
+                    foreach (var item in sortedItems)
+                    {
+                        FlyoutMenuItems.Add(item);
+                    }
+
+                    return;
+                }
+
+                for (int i = 0; i < sortedItems.Count; i++)
+                {
+                    var item = sortedItems[i];
+                    var oldIndex = FlyoutMenuItems.IndexOf(item);
+
+                    if (oldIndex != -1 && oldIndex != i)
+                    {
+                        FlyoutMenuItems.Move(oldIndex, i);
+                    }
+                }
+            }
+            finally
+            {
+                // Use dispatcher to reset flag after UI updates complete
+                _dispatcherQueue.TryEnqueue(DispatcherQueuePriority.Low, () =>
+                {
+                    _isSorting = false;
+                });
             }
         }
     }
 
     private void EnabledChangedOnUI(ModuleListItem item)
     {
         var flyoutItem = (FlyoutMenuItem)item;
-        if (_coordinator.UpdateModuleEnabled(flyoutItem.Tag, flyoutItem.IsEnabled))
-        {
-            _coordinator.NotifyUserSettingsInteraction();
+        var isEnabled = flyoutItem.IsEnabled;
 
-            // Trigger re-sort immediately when status changes on UI
-            RefreshFlyoutMenuItems();
+        // Ignore toggle operations during sorting to prevent race conditions.
+        // Revert the toggle state since UI already changed due to TwoWay binding.
+        if (_isSorting)
+        {
+            flyoutItem.UpdateStatus(!isEnabled);
+            return;
         }
-    }
 
-    private void ModuleEnabledChangedOnSettingsPage()
-    {
-        RefreshFlyoutMenuItems();
+        _coordinator.UpdateModuleEnabled(flyoutItem.Tag, flyoutItem.IsEnabled);
+        SortFlyoutMenuItems();
     }
 }
diff --git a/src/settings-ui/Settings.UI.Library/Helpers/ModuleHelper.cs b/src/settings-ui/Settings.UI.Library/Helpers/ModuleHelper.cs
diff --git a/src/settings-ui/Settings.UI/SettingsXAML/Views/DashboardPage.xaml.cs b/src/settings-ui/Settings.UI/SettingsXAML/Views/DashboardPage.xaml.cs
diff --git a/src/settings-ui/Settings.UI/ViewModels/DashboardViewModel.cs b/src/settings-ui/Settings.UI/ViewModels/DashboardViewModel.cs

Original file line number	Diff line number	Diff line change
`@@ -215,6 +215,12 @@ void dispatch_received_json(const std::wstring& json_to_parse)`
`215`	`215`	`// current_settings_ipc->send(settings_string);`
`216`	`216`	`// }`
`217`	`217`	`}`
	`218`	`+ else if (name == L"module_status")`
	`219`	`+ {`
	`220`	`+ // Handle single module enable/disable update`
	`221`	`+ // Expected format: {"module_status": {"ModuleName": true/false}}`
	`222`	`+ apply_module_status_update(value.GetObjectW());`
	`223`	`+ }`
`218`	`224`	`else if (name == L"powertoys")`
`219`	`225`	`{`
`220`	`226`	`dispatch_json_config_to_modules(value.GetObjectW());`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ private void SortAlphabetical_Click(object sender, RoutedEventArgs e)`
`51`	`51`	`if (ViewModel != null)`
`52`	`52`	`{`
`53`	`53`	`ViewModel.DashboardSortOrder = DashboardSortOrder.Alphabetical;`
	`54`	`+ ((ToggleMenuFlyoutItem)sender).IsChecked = true;`
`54`	`55`	`}`
`55`	`56`	`}`
`56`	`57`
`@@ -59,6 +60,7 @@ private void SortByStatus_Click(object sender, RoutedEventArgs e)`
`59`	`60`	`if (ViewModel != null)`
`60`	`61`	`{`
`61`	`62`	`ViewModel.DashboardSortOrder = DashboardSortOrder.ByStatus;`
	`63`	`+ ((ToggleMenuFlyoutItem)sender).IsChecked = true;`
`62`	`64`	`}`
`63`	`65`	`}`
`64`	`66`	`}`