Coalesce idempotent refreshSession calls triggered by event handlers

On operations like workspace changes, AeroSpace receives a stampede of
accessibility events, each of which triggers a serial call to
`refreshSession()` on the main thread. Since these `refreshSession()` calls
are idempotent, we can coalesce these calls so that
multiple accessibility events can be handled by a single
`refreshSession()`.

With this change, operations like workspace switch go from
O(num_source_windows + num_dest_windows) to O(1) `refreshSession()`
calls (with similar improvements for operations like closing windows or
resizing windows).

closes nikitabobko/AeroSpace#1249
related: nikitabobko/AeroSpace#131

Author: rickyz

Sources/AppBundle/GlobalObserver.swift

@@ -11,7 +11,7 @@ class GlobalObserver {
         }
         let notifName = notification.name.rawValue
         MainActor.assumeIsolated {
-            refreshAndLayout(.globalObserver(notifName), screenIsDefinitelyUnlocked: false)
+            scheduleRefreshAndLayout(.globalObserver(notifName), screenIsDefinitelyUnlocked: false)
         }
     }
 
@@ -67,7 +67,7 @@ class GlobalObserver {
                 // Detect close button clicks for unfocused windows. Yes, kAXUIElementDestroyedNotification is that unreliable
                 //  And trigger new window detection that could be delayed due to mouseDown event
                 default:
-                    refreshAndLayout(.globalObserverLeftMouseUp, screenIsDefinitelyUnlocked: true)
+                    scheduleRefreshAndLayout(.globalObserverLeftMouseUp, screenIsDefinitelyUnlocked: true)
             }
         }
     }

Sources/AppBundle/initAppBundle.swift

@@ -23,7 +23,7 @@ import Foundation
     AXUIElementSetMessagingTimeout(AXUIElementCreateSystemWide(), 1.0)
     startUnixSocketServer()
     GlobalObserver.initObserver()
-    refreshAndLayout(.startup1, screenIsDefinitelyUnlocked: false, startup: true)
+    refreshSession(.startup1, screenIsDefinitelyUnlocked: false, startup: true, body: {})
     refreshSession(.startup2, screenIsDefinitelyUnlocked: false) {
         if serverArgs.startedAtLogin {
             _ = config.afterLoginCommand.runCmdSeq(.defaultEnv, .emptyStdin)

Sources/AppBundle/layout/refresh.swift

@@ -42,9 +42,17 @@ func refreshSession<T>(_ event: RefreshSessionEvent, screenIsDefinitelyUnlocked:
     return result
 }
 
+@MainActor private var havePendingRefresh = false
+
 @MainActor
-func refreshAndLayout(_ event: RefreshSessionEvent, screenIsDefinitelyUnlocked: Bool, startup: Bool = false) {
-    refreshSession(event, screenIsDefinitelyUnlocked: screenIsDefinitelyUnlocked, startup: startup, body: {})
+func scheduleRefreshAndLayout(_ event: RefreshSessionEvent, screenIsDefinitelyUnlocked: Bool = false) {
+    if screenIsDefinitelyUnlocked { resetClosedWindowsCache() }
+    if havePendingRefresh { return }
+    havePendingRefresh = true
+    DispatchQueue.main.async { @MainActor in
+        havePendingRefresh = false
+        refreshSession(event, screenIsDefinitelyUnlocked: false, startup: false, body: {})
+    }
 }
 
 @MainActor
@@ -81,7 +89,7 @@ func refreshObs(_ obs: AXObserver, ax: AXUIElement, notif: CFString, data: Unsaf
     check(Thread.isMainThread)
     let notif = notif as String
     MainActor.assumeIsolated {
-        refreshAndLayout(.ax(notif), screenIsDefinitelyUnlocked: false)
+        scheduleRefreshAndLayout(.ax(notif), screenIsDefinitelyUnlocked: false)
     }
 }
 

Sources/AppBundle/mouse/moveWithMouse.swift

@@ -9,7 +9,7 @@ func movedObs(_ obs: AXObserver, ax: AXUIElement, notif: CFString, data: UnsafeM
         if let windowId, let window = Window.get(byId: windowId), TrayMenuModel.shared.isEnabled {
             moveWithMouseIfTheCase(window)
         }
-        refreshAndLayout(.ax(notif), screenIsDefinitelyUnlocked: false)
+        scheduleRefreshAndLayout(.ax(notif), screenIsDefinitelyUnlocked: false)
     }
 }
 

Sources/AppBundle/mouse/resizeWithMouse.swift

@@ -9,7 +9,7 @@ func resizedObs(_ obs: AXObserver, ax: AXUIElement, notif: CFString, data: Unsaf
         if let windowId, let window = Window.get(byId: windowId), TrayMenuModel.shared.isEnabled {
             resizeWithMouseIfTheCase(window)
         }
-        refreshAndLayout(.ax(notif), screenIsDefinitelyUnlocked: false)
+        scheduleRefreshAndLayout(.ax(notif), screenIsDefinitelyUnlocked: false)
     }
 }
 
@@ -21,7 +21,7 @@ func resetManipulatedWithMouseIfPossible() {
         for workspace in Workspace.all {
             workspace.resetResizeWeightBeforeResizeRecursive()
         }
-        refreshAndLayout(.resetManipulatedWithMouse, screenIsDefinitelyUnlocked: true)
+        scheduleRefreshAndLayout(.resetManipulatedWithMouse, screenIsDefinitelyUnlocked: true)
     }
 }