[hotfix] Fix logical data-race in list-windows/expandFormatVar

nikitabobko · nikitabobko · commit 60b75c474c1e · 2025-04-27T02:45:31.000+02:00
#1306 Precondtion: Use `list-windows` command in `exec-on-workspace-change` callback The race is between `list-windows` and `MacWindow.garbageCollect` This hotfix drops all possible `await` supension points from the `list-windows` command & `expandFormatVar` function Crash example: ##### AeroSpace Runtime Error ##### Please report to: https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs Please describe what you did to trigger this error Message: Windows must always have a parent. The Window was unbound at: 0 AeroSpace 0x000000010236d110 $s6Common19getStringStacktraceSSyF + 44 1 AeroSpace 0x0000000102200fb4 $s9AppBundle8TreeNodeC13unbindIfBound33_C0BD111AB6D9D19A3A8697678A2C07EFLLAA11BindingDataVSgyF + 684 2 AeroSpace 0x0000000102201260 $s9AppBundle8TreeNodeC16unbindFromParentAA11BindingDataVyF + 28 3 AeroSpace 0x00000001021fa778 $s9AppBundle9MacWindowC14garbageCollect22skipClosedWindowsCacheySb_tF + 240 4 AeroSpace 0x00000001021d4604 $s9AppBundle7refresh33_9D4CAE07A16011BB7304F8F5007BD739LLyyYaKFTY2_ + 292 5 AeroSpace 0x00000001021cff7d $s9AppBundle25runRefreshSessionBlocking_16layoutWorkspaces023optimisticallyPreLayoutH0y6Common0dE5EventO_S2btYaKFyyYaKXEfU_yyYaKXEfU_TQ6_ + 1 6 AeroSpace 0x000000010215c9b1 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TATQ0_ + 1 7 libswift_Concurrency.dylib 0x000000027085c461 $ss9TaskLocalC13withValueImpl_9operation9isolation4file4lineqd__xn_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 8 libswift_Concurrency.dylib 0x000000027085c109 $ss9TaskLocalC9withValue_9operation9isolation4file4lineqd__x_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 9 AeroSpace 0x00000001021cf251 $s9AppBundle25runRefreshSessionBlocking_16layoutWorkspaces023optimisticallyPreLayoutH0y6Common0dE5EventO_S2btYaKFyyYaKXEfU_TQ1_ + 1 10 AeroSpace 0x000000010215c9b1 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TATQ0_ + 1 11 libswift_Concurrency.dylib 0x000000027085c461 $ss9TaskLocalC13withValueImpl_9operation9isolation4file4lineqd__xn_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 12 libswift_Concurrency.dylib 0x000000027085c109 $ss9TaskLocalC9withValue_9operation9isolation4file4lineqd__x_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 13 AeroSpace 0x00000001021ce7b9 $s9AppBundle25runRefreshSessionBlocking_16layoutWorkspaces023optimisticallyPreLayoutH0y6Common0dE5EventO_S2btYaKFTQ1_ + 1 14 AeroSpace 0x00000001021cef71 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TQ1_ + 1 15 AeroSpace 0x000000010215c9b1 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TATQ0_ + 1 16 libswift_Concurrency.dylib 0x000000027089083d _ZL23completeTaskWithClosurePN5swift12AsyncContextEPNS_10SwiftErrorE + 1 Version: 0.18.3-Beta Git hash: 3af07d9 refreshSessionEvent: socketServer Date: 2025-04-26 19:13:28 +0000 Thread name: Is main thread: true axTaskLocalAppThreadToken: nil macOS version: Version 15.4 (Build 24E248) Coordinate: AppBundle/Window.swift:8:29 parent recursionDetectorDuringTermination: false cli: false Monitor count: 2 Displays have separate spaces: false Stacktrace: 0 AeroSpace 0x000000010236c73c $s6Common4dieT_4file4line6column8functionxSS_SSS2iSStlF + 2256 1 AeroSpace 0x0000000102203888 $s9AppBundle6WindowC6parentAA21NonLeafTreeNodeObject_pvg + 260 2 AeroSpace 0x00000001022028d4 $s9AppBundle8TreeNodeC11nodeMonitorAA0F0_pSgvg + 68 3 AeroSpace 0x000000010216a4b0 $sSS9AppBundleE15expandFormatVar3objs6ResultOyAA9PrimitiveOS2Ss5Error6CommonyHCg_GAA7AeroObjO_tYaKFTY0_ + 1356 4 AeroSpace 0x00000001021691c1 $sSa9AppBundleAA7AeroObjORszlE6formatys6ResultOySaySSGS2Ss5Error6CommonyHCg_GSayAI16StringInterTokenOGYaKFTQ1_ + 1 5 AeroSpace 0x000000010218f0d5 $s9AppBundle18ListWindowsCommandV3runySbAA6CmdEnvV_AA0G2IoCtYaKFTf4dnn_nTQ5_ + 1 6 AeroSpace 0x000000010218afe1 $s9AppBundle18ListWindowsCommandVAA0E0A2aDP3runySbAA6CmdEnvV_AA0G2IoCtYaKFTWTQ0_ + 1 7 AeroSpace 0x0000000102164431 $sSa9AppBundleAA7Command_pRszlE9runCmdSeqySbAA0E3EnvV_AA0E2IoCntYaKFTQ1_ + 1 8 AeroSpace 0x0000000102163d79 $s9AppBundle7CommandPAAE3runyAA9CmdResultVAA0E3EnvV_AA0E5StdinCtYaKFTQ2_ + 1 9 AeroSpace 0x00000001021e49dd $s9AppBundle13newConnection33_8AA123C1AC8B76A52844CE5C668569DDLLyy6SocketADCYaF6Common12ServerAnswerVyYaKcfU0_AHyYaYbKScMYcXEfU_TQ1_ + 1 10 AeroSpace 0x000000010215c3f5 $s9AppBundle14GlobalObserverC7onNotif33_F1205CFDC13498282252A689C79131F6LLyy10Foundation12NotificationVFZyyYaYbScMYccfU_TATQ0_ + 1 11 AeroSpace 0x00000001021c8899 $s9AppBundle10runSession__4bodyx6Common07RefreshD5EventO_AA03RunD5GuardVxyYaYbKScMYcXEtYaKlFxyYaKXEfU_xyYaKXEfU_AD12ServerAnswerV_Tg5TQ7_ + 1 12 AeroSpace 0x000000010215c9b1 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TATQ0_ + 1 13 libswift_Concurrency.dylib 0x000000027085c461 $ss9TaskLocalC13withValueImpl_9operation9isolation4file4lineqd__xn_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 14 libswift_Concurrency.dylib 0x000000027085c109 $ss9TaskLocalC9withValue_9operation9isolation4file4lineqd__x_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 15 AeroSpace 0x00000001021c5f1d $s9AppBundle10runSession__4bodyx6Common07RefreshD5EventO_AA03RunD5GuardVxyYaYbKScMYcXEtYaKlFxyYaKXEfU_AD12ServerAnswerV_Tg5TQ1_ + 1 16 AeroSpace 0x000000010215c9b1 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TATQ0_ + 1 17 libswift_Concurrency.dylib 0x000000027085c461 $ss9TaskLocalC13withValueImpl_9operation9isolation4file4lineqd__xn_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 18 libswift_Concurrency.dylib 0x000000027085c109 $ss9TaskLocalC9withValue_9operation9isolation4file4lineqd__x_qd__yYaKXEScA_pSgYiSSSutYaKlFTQ1_ + 1 19 AeroSpace 0x00000001021c327d $s9AppBundle10runSession__4bodyx6Common07RefreshD5EventO_AA03RunD5GuardVxyYaYbKScMYcXEtYaKlFAD12ServerAnswerV_Tg5TQ1_ + 1 20 AeroSpace 0x00000001021c13d5 $s9AppBundle13newConnection33_8AA123C1AC8B76A52844CE5C668569DDLLyy6SocketADCYaF6Common12ServerAnswerVyYaKcfU0_TQ1_ + 1 21 AeroSpace 0x000000010215c9b1 $s9AppBundle17runRefreshSession_26screenIsDefinitelyUnlocked33optimisticallyPreLayoutWorkspacesy6Common0dE5EventO_S2btFyyYaKcfU_TATQ0_ + 1 22 libswift_Concurrency.dylib 0x000000027089083d _ZL23completeTaskWithClosurePN5swift12AsyncContextEPNS_10SwiftErrorE + 1
diff --git a/Sources/AppBundle/command/format.swift b/Sources/AppBundle/command/format.swift
@@ -1,7 +1,7 @@
 import Common
 
 enum AeroObj {
-    case window(Window)
+    case window(window: Window, title: String)
     case workspace(Workspace)
     case app(any AbstractApp)
     case monitor(Monitor)
@@ -28,7 +28,7 @@ enum PlainInterVar: String, CaseIterable {
 
 extension [AeroObj] {
     @MainActor
-    func format(_ format: [StringInterToken]) async throws -> Result<[String], String> {
+    func format(_ format: [StringInterToken]) -> Result<[String], String> {
         var cellTable: [[Cell<String>]] = []
         for obj in self {
             var line: [Cell<String>] = []
@@ -42,7 +42,7 @@ extension [AeroObj] {
                     case .literal(let literal):
                         curCell += literal
                     case .interVar(let value):
-                        switch try await value.expandFormatVar(obj: obj) {
+                        switch value.expandFormatVar(obj: obj) {
                             case .success(let expanded): curCell += expanded.toString()
                             case .failure(let error): errors.append(error)
                         }
@@ -156,32 +156,32 @@ private struct Cell<T> {
 
 extension String {
     @MainActor
-    func expandFormatVar(obj: AeroObj) async throws -> Result<Primitive, String> {
+    func expandFormatVar(obj: AeroObj) -> Result<Primitive, String> {
         let formatVar = self.toFormatVar()
         switch (obj, formatVar) {
             case (_, .none): break
 
-            case (.window(let w), .workspace):
-                return try await w.nodeWorkspace.flatMap(AeroObj.workspace).mapAsyncMainActor(expandFormatVar) ?? .success(.string("NULL-WOKRSPACE"))
-            case (.window(let w), .monitor):
-                return try await w.nodeMonitor.flatMap(AeroObj.monitor).mapAsyncMainActor(expandFormatVar) ?? .success(.string("NULL-MONITOR"))
-            case (.window(let w), .app):
-                return try await expandFormatVar(obj: .app(w.app))
-            case (.window(_), .window): break
+            case (.window(let w, _), .workspace):
+                return w.nodeWorkspace.flatMap(AeroObj.workspace).map(expandFormatVar) ?? .success(.string("NULL-WOKRSPACE"))
+            case (.window(let w, _), .monitor):
+                return w.nodeMonitor.flatMap(AeroObj.monitor).map(expandFormatVar) ?? .success(.string("NULL-MONITOR"))
+            case (.window(let w, _), .app):
+                return expandFormatVar(obj: .app(w.app))
+            case (.window(_, _), .window): break
 
             case (.workspace(let ws), .monitor):
-                return try await expandFormatVar(obj: AeroObj.monitor(ws.workspaceMonitor))
+                return expandFormatVar(obj: AeroObj.monitor(ws.workspaceMonitor))
             case (.workspace, _): break
 
             case (.app(_), _): break
             case (.monitor(_), _): break
         }
         switch (obj, formatVar) {
-            case (.window(let w), .window(let f)):
+            case (.window(let w, let title), .window(let f)):
                 return switch f {
                     case .windowId: .success(.uint32(w.windowId))
                     case .windowIsFullscreen: .success(.bool(w.isFullscreen))
-                    case .windowTitle: .success(.string(try await w.title))
+                    case .windowTitle: .success(.string(title))
                 }
             case (.workspace(let w), .workspace(let f)):
                 return switch f {
diff --git a/Sources/AppBundle/command/formatToJson.swift b/Sources/AppBundle/command/formatToJson.swift
@@ -3,7 +3,7 @@ import Foundation
 
 extension [AeroObj] {
     @MainActor
-    func formatToJson(_ format: [StringInterToken], ignoreRightPaddingVar: Bool) async throws -> Result<String, String> {
+    func formatToJson(_ format: [StringInterToken], ignoreRightPaddingVar: Bool) -> Result<String, String> {
         var list: [[String: Primitive]] = []
         for richObj in self {
             var rawObj: [String: Primitive] = [:]
@@ -14,7 +14,7 @@ extension [AeroObj] {
                     case .literal:
                         break // should be spaces
                     case .interVar(let varName):
-                        switch try await varName.expandFormatVar(obj: richObj) {
+                        switch varName.expandFormatVar(obj: richObj) {
                             case .success(let expanded): rawObj[varName] = expanded
                             case .failure(let error): return .failure(error)
                         }
diff --git a/Sources/AppBundle/command/impl/ListAppsCommand.swift b/Sources/AppBundle/command/impl/ListAppsCommand.swift
@@ -4,7 +4,7 @@ import Common
 struct ListAppsCommand: Command {
     let args: ListAppsCmdArgs
 
-    func run(_ env: CmdEnv, _ io: CmdIo) async throws -> Bool {
+    func run(_ env: CmdEnv, _ io: CmdIo) -> Bool {
         var result = Array(MacApp.allAppsMap.values)
         if let hidden = args.macosHidden {
             result = result.filter { $0.nsApp.isHidden == hidden }
@@ -15,12 +15,12 @@ struct ListAppsCommand: Command {
         } else {
             let list = result.map { AeroObj.app($0) }
             if args.json {
-                return switch try await list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
+                return switch list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
                     case .success(let json): io.out(json)
                     case .failure(let msg): io.err(msg)
                 }
             } else {
-                return switch try await list.format(args.format) {
+                return switch list.format(args.format) {
                     case .success(let lines): io.out(lines)
                     case .failure(let msg): io.err(msg)
                 }
diff --git a/Sources/AppBundle/command/impl/ListMonitorsCommand.swift b/Sources/AppBundle/command/impl/ListMonitorsCommand.swift
@@ -4,7 +4,7 @@ import Common
 struct ListMonitorsCommand: Command {
     let args: ListMonitorsCmdArgs
 
-    func run(_ env: CmdEnv, _ io: CmdIo) async throws -> Bool {
+    func run(_ env: CmdEnv, _ io: CmdIo) -> Bool {
         let focus = focus
         var result = sortedMonitors
         if let focused = args.focused {
@@ -20,12 +20,12 @@ struct ListMonitorsCommand: Command {
         } else {
             let list = result.map { AeroObj.monitor($0) }
             if args.json {
-                return switch try await list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
+                return switch list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
                     case .success(let json): io.out(json)
                     case .failure(let msg): io.err(msg)
                 }
             } else {
-                return switch try await list.format(args.format) {
+                return switch list.format(args.format) {
                     case .success(let lines): io.out(lines)
                     case .failure(let msg): io.err(msg)
                 }
diff --git a/Sources/AppBundle/command/impl/ListWindowsCommand.swift b/Sources/AppBundle/command/impl/ListWindowsCommand.swift
@@ -43,20 +43,21 @@ struct ListWindowsCommand: Command {
         if args.outputOnlyCount {
             return io.out("\(windows.count)")
         } else {
-            var _windows: [(window: Window, title: String)] = [] // todo cleanup
+            var _list: [(window: Window, title: String)] = [] // todo cleanup
             for window in windows {
-                _windows.append((window, try await window.title))
+                _list.append((window, try await window.title))
             }
-            windows = _windows.sortedBy([{ $0.window.app.name ?? "" }, \.title]).map { $0.window }
+            _list = _list.filter { $0.window.isBound }
+            _list = _list.sortedBy([{ $0.window.app.name ?? "" }, \.title])
 
-            let list = windows.map { AeroObj.window($0) }
+            let list = _list.map { AeroObj.window(window: $0.window, title: $0.title) }
             if args.json {
-                return switch try await list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
+                return switch list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
                     case .success(let json): io.out(json)
                     case .failure(let msg): io.err(msg)
                 }
             } else {
-                return switch try await list.format(args.format) {
+                return switch list.format(args.format) {
                     case .success(let lines): io.out(lines)
                     case .failure(let msg): io.err(msg)
                 }
diff --git a/Sources/AppBundle/command/impl/ListWorkspacesCommand.swift b/Sources/AppBundle/command/impl/ListWorkspacesCommand.swift
@@ -4,7 +4,7 @@ import Common
 struct ListWorkspacesCommand: Command {
     let args: ListWorkspacesCmdArgs
 
-    func run(_ env: CmdEnv, _ io: CmdIo) async throws -> Bool {
+    func run(_ env: CmdEnv, _ io: CmdIo) -> Bool {
         var result: [Workspace] = Workspace.all
         if let visible = args.filteringOptions.visible {
             result = result.filter { $0.isVisible == visible }
@@ -23,12 +23,12 @@ struct ListWorkspacesCommand: Command {
         } else {
             let list = result.map { AeroObj.workspace($0) }
             if args.json {
-                return switch try await list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
+                return switch list.formatToJson(args.format, ignoreRightPaddingVar: args._format.isEmpty) {
                     case .success(let json): io.out(json)
                     case .failure(let msg): io.err(msg)
                 }
             } else {
-                return switch try await list.format(args.format) {
+                return switch list.format(args.format) {
                     case .success(let lines): io.out(lines)
                     case .failure(let msg): io.err(msg)
                 }
diff --git a/Sources/AppBundle/tree/TreeNode.swift b/Sources/AppBundle/tree/TreeNode.swift
@@ -17,7 +17,8 @@ class TreeNode: Equatable {
     // - drag window with mouse
     // - move-mouse command
     var lastAppliedLayoutPhysicalRect: Rect? = nil // with real inner gaps
-    var unboundStacktrace: String? = nil
+    final var unboundStacktrace: String? = nil
+    var isBound: Bool { unboundStacktrace == nil } // todo drop, once https://github.com/nikitabobko/AeroSpace/issues/1215 is fixed
 
     @MainActor
     init(parent: NonLeafTreeNodeObject, adaptiveWeight: CGFloat, index: Int) {
