🐛 Ensure isBusy is isolated to main thread

There was an issue where updating a configuration file (including .ini) or having an action occur that marked PHP Monitor as busy would prevent the icon from updating correctly. This happened because access to the busy boolean state variable could happen from various threads. Since adding main thread isolation to the variable, you must access `PhpEnvironments.shared.isBusy` via the main thread, therefore ensuring that the busy state that is read from the app is always synchronized and accurate whenever it is checked, making it so that going from busy to no longer busy can no longer fail. (It was possible for work in another thread to complete and fail to set the icon to "not busy" because the work was done faster than the icon could be set to busy.)
2025-08-07 03:50:08 +02:00 · 2023-10-30 19:34:36 +01:00
parent 541378f3f9
commit a62ebcff92
10 changed files with 40 additions and 61 deletions
--- a/phpmon/Common/Core/Constants.swift
+++ b/phpmon/Common/Core/Constants.swift
@ -91,6 +91,8 @@ struct Constants {
            string: "https://raw.githubusercontent.com/nicoverbruggen/homebrew-cask/master/Casks/phpmon-dev.rb"
        )!

+        // EAP URLs
+
        static let EarlyAccessCaskFile = URL(
            string: "https://phpmon.app/builds/early-access/sponsors/phpmon-eap.rb"
        )!
--- a/Version/PhpEnvironments.swift
+++ b/Version/PhpEnvironments.swift
@ -13,7 +13,7 @@ class PhpEnvironments {
    // MARK: - Initializer

    /**
-
+     Loads the currently active PHP installation upon startup. May be empty.
     */
    init() {
        self.currentInstall = ActivePhpInstallation.load()
@ -49,12 +49,10 @@ class PhpEnvironments {
    static let shared = PhpEnvironments()

    /** Whether the switcher is busy performing any actions. */
-    var isBusy: Bool = false {
+    @MainActor var isBusy: Bool = false {
        didSet {
-            Task { @MainActor in
-                MainMenu.shared.setBusyImage()
-                MainMenu.shared.rebuild()
-            }
+            MainMenu.shared.refreshIcon()
+            MainMenu.shared.rebuild()
        }
    }

--- a/phpmon/Domain/Integrations/Composer/ComposerWindow.swift
+++ b/phpmon/Domain/Integrations/Composer/ComposerWindow.swift
@ -28,8 +28,6 @@ import Foundation
        }

        PhpEnvironments.shared.isBusy = true
-        MainMenu.shared.setBusyImage()
-        MainMenu.shared.rebuild()

        window = TerminalProgressWindowController.display(
            title: "alert.composer_progress.title".localized,
@ -106,14 +104,11 @@ import Foundation

    private func removeBusyStatus() {
        PhpEnvironments.shared.isBusy = false
-        Task { @MainActor in
-            MainMenu.shared.updatePhpVersionInStatusBar()
-        }
    }

    // MARK: Alert

-    @MainActor private func presentMissingAlert() {
+    private func presentMissingAlert() {
        BetterAlert()
            .withInformation(
                title: "alert.composer_missing.title".localized,
--- a/phpmon/Domain/Menu/MainMenu+Actions.swift
+++ b/phpmon/Domain/Menu/MainMenu+Actions.swift
@ -283,7 +283,6 @@ extension MainMenu {
            return
        }

-        setBusyImage()
        PhpEnvironments.shared.isBusy = true
        PhpEnvironments.shared.delegate = self
        PhpEnvironments.shared.delegate?.switcherDidStartSwitching(to: version)
@ -298,7 +297,6 @@ extension MainMenu {
    }

    @objc func switchToPhpVersion(_ version: String) {
-        setBusyImage()
        PhpEnvironments.shared.isBusy = true
        PhpEnvironments.shared.delegate = self
        PhpEnvironments.shared.delegate?.switcherDidStartSwitching(to: version)
@ -325,7 +323,6 @@ extension MainMenu {
     */
    func switchToPhp(_ version: String) async {
        Task { @MainActor [self] in
-            setBusyImage()
            PhpEnvironments.shared.isBusy = true
            PhpEnvironments.shared.delegate = self
            PhpEnvironments.shared.delegate?.switcherDidStartSwitching(to: version)
--- a/phpmon/Domain/Menu/MainMenu+Async.swift
+++ b/phpmon/Domain/Menu/MainMenu+Async.swift
@ -45,21 +45,16 @@ extension MainMenu {
            .broadcastServicesUpdate
        ]
    ) {
-        if behaviours.contains(.reloadsPhpInstallation) {
+        if behaviours.contains(.reloadsPhpInstallation) || behaviours.contains(.setsBusyUI) {
            PhpEnvironments.shared.isBusy = true
        }

-        if behaviours.contains(.setsBusyUI) {
-            setBusyImage()
-        }
-
        Task(priority: .userInitiated) { [unowned self] in
            var error: Error?

-            do { try execute() } catch let e { error = e }
-
-            if behaviours.contains(.setsBusyUI) {
-                PhpEnvironments.shared.isBusy = false
+            do { try execute() } catch let e {
+                error = e
+                Log.err(e)
            }

            Task { @MainActor [self, error] in
@ -69,14 +64,16 @@ extension MainMenu {

                if behaviours.contains(.updatesMenuBarContents) {
                    updatePhpVersionInStatusBar()
-                } else if behaviours.contains(.setsBusyUI) {
-                    refreshIcon()
                }

                if behaviours.contains(.broadcastServicesUpdate) {
                    Task { await ServicesManager.shared.reloadServicesStatus() }
                }

+                if behaviours.contains(.setsBusyUI) {
+                    PhpEnvironments.shared.isBusy = false
+                }
+
                if error != nil {
                    return failure(error!)
                }
--- a/phpmon/Domain/Menu/MainMenu+Switcher.swift
+++ b/phpmon/Domain/Menu/MainMenu+Switcher.swift
@ -16,7 +16,9 @@ extension MainMenu {

    nonisolated func switcherDidCompleteSwitch(to version: String) {
        // Mark as no longer busy
-        PhpEnvironments.shared.isBusy = false
+        Task { @MainActor in
+            PhpEnvironments.shared.isBusy = false
+        }

        Task { // Things to do after reloading domain list data
            if Valet.installed {
--- a/phpmon/Domain/Menu/MainMenu.swift
+++ b/phpmon/Domain/Menu/MainMenu.swift
@ -87,6 +87,7 @@ class MainMenu: NSObject, NSWindowDelegate, NSMenuDelegate, PhpSwitcherDelegate
    }

    /** Updates the icon (refresh icon) and rebuilds the menu. */
+    @available(*, deprecated, message: "Use the busy status instead")
    @objc func updatePhpVersionInStatusBar() {
        refreshIcon()
        rebuild()
@ -139,7 +140,7 @@ class MainMenu: NSObject, NSWindowDelegate, NSMenuDelegate, PhpSwitcherDelegate
    @objc func reloadPhpMonitorMenuInBackground() {
        asyncExecution({
            // This automatically reloads the menu
-            Log.info("Reloading information about the PHP installation (in the background)...")
+            Log.perf("Reloading information about the PHP installation (in the background)...")
        }, behaviours: [
            .setsBusyUI,
            .reloadsPhpInstallation,
@ -150,10 +151,13 @@ class MainMenu: NSObject, NSWindowDelegate, NSMenuDelegate, PhpSwitcherDelegate

    /** Refreshes the icon with the PHP version. */
    @objc func refreshIcon() {
+
        Task { @MainActor [self] in
            if PhpEnvironments.shared.isBusy {
+                Log.perf("Refreshing icon: currently busy")
                setStatusBar(image: NSImage(named: NSImage.Name("StatusBarIcon"))!)
            } else {
+                Log.perf("Refreshing icon: no longer busy")
                if Preferences.preferences[.shouldDisplayDynamicIcon] as! Bool == false {
                    // Static icon has been requested
                    setStatusBar(image: NSImage(named: NSImage.Name("StatusBarIconStatic"))!)
@ -172,13 +176,6 @@ class MainMenu: NSObject, NSWindowDelegate, NSMenuDelegate, PhpSwitcherDelegate
        }
    }

-    /** Updates the icon to be displayed as busy. */
-    @objc func setBusyImage() {
-        Task { @MainActor [self] in
-            setStatusBar(image: NSImage(named: NSImage.Name("StatusBarIcon"))!)
-        }
-    }
-
    // MARK: - Menu Item Functionality

    @objc func openAbout() {
--- a/phpmon/Domain/Menu/StatusMenu+Items.swift
+++ b/phpmon/Domain/Menu/StatusMenu+Items.swift
@ -12,7 +12,7 @@ import Cocoa

 extension StatusMenu {

-    func addPhpVersionMenuItems() {
+    @MainActor func addPhpVersionMenuItems() {
        if PhpEnvironments.phpInstall == nil {
            addItem(HeaderView.asMenuItem(text: "⚠️ " + "mi_no_php_linked".localized, minimumWidth: 280))
            addItems([
@ -34,7 +34,7 @@ extension StatusMenu {
        ))
    }

-    func addPhpActionMenuItems() {
+    @MainActor func addPhpActionMenuItems() {
        if PhpEnvironments.shared.isBusy {
            addItem(NSMenuItem(title: "mi_busy".localized))
            return
@ -54,7 +54,7 @@ extension StatusMenu {
        self.addItem(NSMenuItem.separator())
    }

-    func addServicesManagerMenuItem() {
+    @MainActor func addServicesManagerMenuItem() {
        if PhpEnvironments.shared.isBusy {
            return
        }
@ -65,7 +65,7 @@ extension StatusMenu {
        ])
    }

-    func addSwitchToPhpMenuItems() {
+    @MainActor func addSwitchToPhpMenuItems() {
        var shortcutKey = 1
        for index in (0..<PhpEnvironments.shared.availablePhpVersions.count) {
            // Get the short and long version
@ -102,14 +102,14 @@ extension StatusMenu {
        }
    }

-    func addLiteModeMenuItem() {
+    @MainActor func addLiteModeMenuItem() {
        addItems([
            NSMenuItem.separator(),
            NSMenuItem(title: "mi_lite_mode".localized, action: #selector(MainMenu.openLiteModeInfo))
        ])
    }

-    func addPreferencesMenuItems() {
+    @MainActor func addPreferencesMenuItems() {
        addItems([
            NSMenuItem.separator(),
            NSMenuItem(title: "mi_preferences".localized,
@ -119,7 +119,7 @@ extension StatusMenu {
        ])
    }

-    func addCoreMenuItems() {
+    @MainActor func addCoreMenuItems() {
        addItems([
            NSMenuItem.separator(),
            NSMenuItem(title: "mi_about".localized,
@ -131,7 +131,7 @@ extension StatusMenu {

    // MARK: - Valet

-    func addValetMenuItems() {
+    @MainActor func addValetMenuItems() {
        addItems([
            HeaderView.asMenuItem(text: "mi_valet".localized),
            NSMenuItem(title: "mi_valet_config".localized,
@ -146,7 +146,7 @@ extension StatusMenu {

    // MARK: - PHP Configuration

-    func addConfigurationMenuItems() {
+    @MainActor func addConfigurationMenuItems() {
        addItems([
            HeaderView.asMenuItem(text: "mi_configuration".localized),
            NSMenuItem(title: "mi_php_version_manager".localized,
@ -166,7 +166,7 @@ extension StatusMenu {

    // MARK: - Composer

-    func addComposerMenuItems() {
+    @MainActor func addComposerMenuItems() {
        addItems([
            HeaderView.asMenuItem(text: "mi_composer".localized),
            NSMenuItem(
@ -187,7 +187,7 @@ extension StatusMenu {

    // MARK: - Stats

-    func addStatsMenuItem() {
+    @MainActor func addStatsMenuItem() {
        guard let install = PhpEnvironments.phpInstall else {
            Log.info("Not showing stats menu item if no PHP version is linked.")
            return
@ -214,7 +214,7 @@ extension StatusMenu {

    // MARK: - Extensions

-    func addExtensionsMenuItems() {
+    @MainActor func addExtensionsMenuItems() {
        guard let install = PhpEnvironments.phpInstall else {
            Log.info("Not showing extensions menu items if no PHP version is linked.")
            return
@ -235,7 +235,7 @@ extension StatusMenu {

    // MARK: - Presets

-    func addPresetsMenuItem() {
+    @MainActor func addPresetsMenuItem() {
        guard let presets = Preferences.custom.presets else {
            addEmptyPresetHelp()
            return
--- a/phpmon/Domain/Menu/StatusMenu.swift
+++ b/phpmon/Domain/Menu/StatusMenu.swift
@ -9,7 +9,7 @@ import Cocoa

 class StatusMenu: NSMenu {
    // swiftlint:disable cyclomatic_complexity
-    func addMenuItems() {
+    @MainActor func addMenuItems() {
        addPhpVersionMenuItems()
        addItem(NSMenuItem.separator())

--- a/Manager/UI/PhpVersionManagerView.swift
+++ b/Manager/UI/PhpVersionManagerView.swift
@ -330,18 +330,9 @@ struct PhpVersionManagerView: View {
    }

    public func setBusyStatus(_ busy: Bool) {
-        PhpEnvironments.shared.isBusy = busy
-        if busy {
-            Task { @MainActor in
-                MainMenu.shared.setBusyImage()
-                MainMenu.shared.rebuild()
-                self.status.busy = busy
-            }
-        } else {
-            Task { @MainActor in
-                MainMenu.shared.updatePhpVersionInStatusBar()
-                self.status.busy = busy
-            }
+        Task { @MainActor in
+            PhpEnvironments.shared.isBusy = busy
+            self.status.busy = busy
        }
    }