Fixed bug where Bool binding could unexpectedly invert its polarity (#14)

Author: orchetect

Sources/MenuBarExtraAccess/MenuBarExtraAccess.swift

@@ -96,6 +96,12 @@ struct MenuBarExtraAccess<Content: Scene>: Scene {
                 print("Status item button state observer: called with change: \(change.newValue?.description ?? "nil")")
                 #endif
 
+                // only continue if the MenuBarExtra is menu-based.
+                // window-based MenuBarExtras are handled with app-bound window observers instead.
+                guard MenuBarExtraUtils.statusItem(for: .index(index))?
+                    .isMenuBarExtraMenuBased == true
+                else { return }
+                
                 guard let newVal = change.newValue else { return }
                 let newBool = newVal != .off
                 if isMenuPresented != newBool {
@@ -108,24 +114,46 @@ struct MenuBarExtraAccess<Content: Scene>: Scene {
             }
         }
 
-        observerContainer.setupGlobalMouseDownMonitor {
-            // note that this won't fire when mouse events within the app cause the window to dismiss
-            MenuBarExtraUtils.newGlobalMouseDownEventsMonitor { event in
+        // TODO: this mouse event observer is now redundant and can be deleted in the future
+        
+        // observerContainer.setupGlobalMouseDownMonitor {
+        //     // note that this won't fire when mouse events within the app cause the window to dismiss
+        //     MenuBarExtraUtils.newGlobalMouseDownEventsMonitor { event in
+        //         #if DEBUG
+        //         print("Global mouse-down events monitor: called with event: \(event.type)")
+        //         #endif
+        //
+        //         // close window when user clicks outside of it
+        //
+        //         MenuBarExtraUtils.setPresented(for: .index(index), state: false)
+        //
+        //         #if DEBUG
+        //         print("Global mouse-down events monitor: Setting isMenuPresented to false")
+        //         #endif
+        //
+        //         isMenuPresented = false
+        //     }
+        // }
+        
+        observerContainer.setupWindowObservers(
+            index: index,
+            didBecomeKey: { window in
                 #if DEBUG
-                print("Global mouse-down events monitor: called with event: \(event.type)")
+                print("MenuBarExtra index \(index) drop-down window did become key.")
                 #endif
 
-                // close window when user clicks outside of it
-                
-                MenuBarExtraUtils.setPresented(for: .index(index), state: false)
-                
+                MenuBarExtraUtils.setKnownPresented(for: .index(index), state: true)
+                isMenuPresented = true
+            },
+            didResignKey: { window in
                 #if DEBUG
-                print("Global mouse-down events monitor: Setting isMenuPresented to false")
+                print("MenuBarExtra index \(index) drop-down window did resign as key.")
                 #endif
 
+                MenuBarExtraUtils.setKnownPresented(for: .index(index), state: false)
                 isMenuPresented = false
             }
-        }
+        )
 
         return 0
     }
@@ -135,9 +163,11 @@ struct MenuBarExtraAccess<Content: Scene>: Scene {
     private var observerContainer = ObserverContainer()
 
     private class ObserverContainer {
+        private var statusItemIntrospectionSetup: Bool = false
         private var observer: NSStatusItem.ButtonStateObserver?
         private var eventsMonitor: Any?
-        private var statusItemIntrospectionSetup: Bool = false
+        private var windowDidBecomeKeyObserver: AnyCancellable?
+        private var windowDidResignKeyObserver: AnyCancellable?
 
         init() { }
 
@@ -173,6 +203,26 @@ struct MenuBarExtraAccess<Content: Scene>: Scene {
                 eventsMonitor = block()
             }
         }
+        
+        func setupWindowObservers(
+            index: Int,
+            didBecomeKey didBecomeKeyBlock: @escaping (_ window: NSWindow) -> Void,
+            didResignKey didResignKeyBlock: @escaping (_ window: NSWindow) -> Void
+        ) {
+            // run async so that it can execute after SwiftUI sets up the NSStatusItem
+            DispatchQueue.main.async { [self] in
+                windowDidBecomeKeyObserver = MenuBarExtraUtils.newWindowObserver(
+                    index: index,
+                    for: NSWindow.didBecomeKeyNotification
+                ) { window in didBecomeKeyBlock(window) }
+                
+                windowDidResignKeyObserver = MenuBarExtraUtils.newWindowObserver(
+                    index: index,
+                    for: NSWindow.didResignKeyNotification
+                ) { window in didResignKeyBlock(window) }
+                
+            }
+        }
     }
 }
 

Sources/MenuBarExtraAccess/MenuBarExtraUtils/MenuBarExtraUtils.swift

@@ -32,6 +32,16 @@ enum MenuBarExtraUtils {
         guard let item = statusItem(for: ident) else { return }
         item.setPresented(state: state)
     }
+    
+    /// Set MenuBarExtra menu/window presentation state only when its state is reliably known.
+    static func setKnownPresented(for ident: StatusItemIdentity? = nil, state: Bool) {
+        #if DEBUG
+        print("MenuBarExtraUtils.\(#function) called for status item \(ident?.description ?? "nil") with state \(state)")
+        #endif
+        
+        guard let item = statusItem(for: ident) else { return }
+        item.setKnownPresented(state: state)
+    }
 }
 
 // MARK: - Objects and Metadata
@@ -213,6 +223,23 @@ extension MenuBarExtraUtils {
                 block(value)
             })
     }
+    
+    static func newWindowObserver(
+        index: Int,
+        for notification: Notification.Name,
+        block: @escaping (_ window: NSWindow) -> Void
+    ) -> AnyCancellable? {
+        NotificationCenter.default.publisher(for: notification)
+            .filter { output in
+                guard let window = output.object as? NSWindow else { return false }
+                guard let windowWithIndex = MenuBarExtraUtils.window(for: .index(index)) else { return false }
+                return window == windowWithIndex
+            }
+            .sink { output in
+                guard let window = output.object as? NSWindow else { return }
+                block(window)
+            }
+    }
 }
 
 // MARK: - NSStatusItem Introspection
@@ -262,7 +289,7 @@ extension NSStatusItem {
         return mirror.menuBarExtraID()
     }
 
-    fileprivate var isMenuBarExtraMenuBased: Bool {
+    var isMenuBarExtraMenuBased: Bool {
         // if window-based, target will be the internal type SwiftUI.WindowMenuBarExtraBehavior
         // if menu-based, target will be nil
         guard let behavior = button?.target

Sources/MenuBarExtraAccess/NSStatusItem Extensions.swift

@@ -44,6 +44,7 @@ extension NSStatusItem {
         togglePresented()
     }
 
+    @_disfavoredOverload
     internal func updateHighlight() {
         #if DEBUG
         print("NSStatusItem.\(#function) called")
@@ -57,6 +58,16 @@ extension NSStatusItem {
 
         button?.isHighlighted = s
     }
+    
+    /// Only call this when the state of the drop-down window is known.
+    internal func setKnownPresented(state: Bool) {
+        switch state {
+        case true:
+            button?.state = .on
+        case false:
+            button?.state = .off
+        }
+    }
 }
 
 // MARK: - KVO Observer