Implement debug-windows command

nikitabobko · nikitabobko · commit ae8558ebd6db · 2024-01-26T03:05:51.000+01:00
closes #137
diff --git a/AeroSpace.xcodeproj/project.pbxproj b/AeroSpace.xcodeproj/project.pbxproj
@@ -32,6 +32,7 @@
 		43E3628E37D2439B820FFC82 /* server.swift in Sources */ = {isa = PBXBuildFile; fileRef = 796713A1B3AEEBF4D0D180C7 /* server.swift */; };
 		45AA5FD4A023AF751922BC22 /* BundleEx.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B7A2DF0D1F72B80B1F04240 /* BundleEx.swift */; };
 		45EA2D1C90430C432E123B51 /* keysMap.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1C0D40CBD65704BA9595C2FA /* keysMap.swift */; };
+		4CC374136F60299FB672662D /* DebugWindowsCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 71908440CD1ADBE13AD58E26 /* DebugWindowsCommand.swift */; };
 		51AB4C0992703B2E9D0F55E2 /* MonitorDescriptionEx.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9C1D626244E63437F1CA24C3 /* MonitorDescriptionEx.swift */; };
 		56E72B24303F5F337B31B776 /* TrayMenuModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5F5F52E346D024960EAF5938 /* TrayMenuModel.swift */; };
 		5BA537EABFE48178D6BD2544 /* parseGaps.swift in Sources */ = {isa = PBXBuildFile; fileRef = CCDFB9D7321F08B5CCEF6AFB /* parseGaps.swift */; };
@@ -149,6 +150,7 @@
 		67DBAF4ECF8A0B931FC34EAD /* parseConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = parseConfig.swift; sourceTree = "<group>"; };
 		6D9C5ED5AC77D80F1CCD103F /* JoinWithCommandTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JoinWithCommandTest.swift; sourceTree = "<group>"; };
 		6F1905935B0C61590A96EFEF /* TestWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestWindow.swift; sourceTree = "<group>"; };
+		71908440CD1ADBE13AD58E26 /* DebugWindowsCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DebugWindowsCommand.swift; sourceTree = "<group>"; };
 		739F4FE1DB101DF4E508F3FE /* Monitor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Monitor.swift; sourceTree = "<group>"; };
 		796713A1B3AEEBF4D0D180C7 /* server.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = server.swift; sourceTree = "<group>"; };
 		7ACD4E9C6C0C08F1B0622C57 /* ResizeCommandTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ResizeCommandTest.swift; sourceTree = "<group>"; };
@@ -387,6 +389,7 @@
 		9797FA095A9BE84428C5E2C0 /* query */ = {
 			isa = PBXGroup;
 			children = (
+				71908440CD1ADBE13AD58E26 /* DebugWindowsCommand.swift */,
 				B0185502A3752FF618BB3D36 /* ListAppsCommand.swift */,
 				FD6BB613EC44C1B32CE4A47E /* ListMonitorsCommand.swift */,
 				E9FCB66B928701F68AD8CA78 /* ListWindowsCommand.swift */,
@@ -599,6 +602,7 @@
 				78C38FAF21E574DBE3B88806 /* CloseCommand.swift in Sources */,
 				F982DB924450BBBB4FDF4C2C /* Command.swift in Sources */,
 				FD4386BC632BAA6A4105FFD8 /* Config.swift in Sources */,
+				4CC374136F60299FB672662D /* DebugWindowsCommand.swift in Sources */,
 				B0D7495387478CE6FBE79A2E /* DynamicConfigValue.swift in Sources */,
 				9FAD09BC5CC390167106563B /* EnableCommand.swift in Sources */,
 				BC6511DA2ABE84164D90C181 /* ExecAndForgetCommand.swift in Sources */,
diff --git a/LocalPackage/Sources/Cli/subcommandDescriptionsGenerated.swift b/LocalPackage/Sources/Cli/subcommandDescriptionsGenerated.swift
@@ -2,6 +2,7 @@
 let subcommandDescriptions = [
     ["  close-all-windows-but-current", "On the focused workspace, closes all windows but current"],
     ["  close", "Closes the focused window"],
+    ["  debug-windows", "Interactive command to record Accessibility API debug information to create bug reports"],
     ["  enable", "Temporarily disable window management"],
     ["  flatten-workspace-tree", "Flattens the tree of currently focused workspace."],
     ["  focus", "Sets focus to the nearest window in in the given direction."],
diff --git a/LocalPackage/Sources/Common/cmdArgs/CmdKind.swift b/LocalPackage/Sources/Common/cmdArgs/CmdKind.swift
@@ -1,6 +1,7 @@
 public enum CmdKind: String, CaseIterable, Equatable {
     case close
     case closeAllWindowsButCurrent = "close-all-windows-but-current"
+    case debugWindows = "debug-windows"
     case enable
     case execAndForget = "exec-and-forget"
     case flattenWorkspaceTree = "flatten-workspace-tree"
diff --git a/LocalPackage/Sources/Common/cmdArgs/noCmdArgs.swift b/LocalPackage/Sources/Common/cmdArgs/noCmdArgs.swift
@@ -31,7 +31,7 @@ public struct ServerVersionInternalCommandCmdArgs: RawCmdArgs, CmdArgs {
     public static let parser: CmdParser<Self> = noArgsParser(.serverVersionInternalCommand, allowInConfig: false)
 }
 
-private func noArgsParser<T : Copyable>(_ kind: CmdKind, allowInConfig: Bool) -> CmdParser<T> {
+func noArgsParser<T : Copyable>(_ kind: CmdKind, allowInConfig: Bool) -> CmdParser<T> {
     cmdParser(
         kind: kind,
         allowInConfig: allowInConfig,
diff --git a/LocalPackage/Sources/Common/cmdArgs/parseCmdArgs.swift b/LocalPackage/Sources/Common/cmdArgs/parseCmdArgs.swift
@@ -22,6 +22,8 @@ private func initSubcommands() -> [String: any SubCommandParserProtocol] {
             result[kind.rawValue] = noArgsSubCommandParser(CloseCmdArgs())
         case .closeAllWindowsButCurrent:
             result[kind.rawValue] = noArgsSubCommandParser(CloseAllWindowsButCurrentCmdArgs())
+        case .debugWindows:
+            result[kind.rawValue] = noArgsSubCommandParser(DebugWindowsCmdArgs())
         case .enable:
             result[kind.rawValue] = SubCommandParser(parseEnableCmdArgs)
         case .execAndForget:
diff --git a/LocalPackage/Sources/Common/cmdArgs/query/DebugWindowsCmdArgs.swift b/LocalPackage/Sources/Common/cmdArgs/query/DebugWindowsCmdArgs.swift
@@ -0,0 +1,4 @@
+public struct DebugWindowsCmdArgs: RawCmdArgs, CmdArgs {
+    public init() {}
+    public static let parser: CmdParser<Self> = noArgsParser(.debugWindows, allowInConfig: false)
+}
diff --git a/LocalPackage/Sources/Common/util/commonUtil.swift b/LocalPackage/Sources/Common/util/commonUtil.swift
@@ -93,6 +93,10 @@ public extension String {
     func removePrefix(_ prefix: String) -> String {
         hasPrefix(prefix) ? String(dropFirst(prefix.count)) : self
     }
+
+    func prependLines(_ prefix: String) -> String {
+        split(separator: "\n").map { prefix + $0 }.joined(separator: "\n")
+    }
 }
 
 public extension Double {
diff --git a/docs/aerospace-debug-windows.adoc b/docs/aerospace-debug-windows.adoc
@@ -0,0 +1,39 @@
+= aerospace-debug-windows(1)
+include::util/man-attributes.adoc[]
+:manname: aerospace-debug-windows
+// tag::purpose[]
+:manpurpose: Interactive command to record Accessibility API debug information to create bug reports
+// end::purpose[]
+
+== Synopsis
+[verse]
+// tag::synopsis[]
+debug-windows [-h|--help]
+
+// end::synopsis[]
+
+== Description
+
+// tag::body[]
+{manpurpose}
+
+Use this command output to report bug reports about incorrect windows handling
+(e.g. some windows are floated when they shouldn't).
+
+The intended usage is the following:
+
+. Run the command to start the debug session recording
+. Focus problematic window
+. Run the command one more time to stop the debug session recording and print the results
+
+_debug-windows_ command is *not stable API*.
+Please *don't rely on* the command existence and output format.
+The only intended use case is to report bugs about incorrect windows handling.
+
+include::util/conditional-options-header.adoc[]
+
+-h, --help:: Print help
+
+// end::body[]
+
+include::util/man-footer.adoc[]
diff --git a/docs/commands.adoc b/docs/commands.adoc
@@ -168,6 +168,13 @@ Query commands are commands that do not change the state but rather allow the ex
 (because there is no way to consume the stdout of these commands in config)
 - Query commands are only available in CLI
 
+=== debug-windows
+----
+include::aerospace-debug-windows.adoc[tags=synopsis]
+----
+include::aerospace-debug-windows.adoc[tags=purpose]
+include::aerospace-debug-windows.adoc[tags=body]
+
 === list-apps
 ----
 include::aerospace-list-apps.adoc[tags=synopsis]
diff --git a/src/command/parseCommand.swift b/src/command/parseCommand.swift
@@ -13,6 +13,8 @@ extension CmdArgs {
             command = CloseCommand()
         case .closeAllWindowsButCurrent:
             command = CloseAllWindowsButCurrentCommand()
+        case .debugWindows:
+            command = DebugWindowsCommand()
         case .enable:
             command = EnableCommand(args: self as! EnableCmdArgs)
         case .execAndForget:
diff --git a/src/command/query/DebugWindowsCommand.swift b/src/command/query/DebugWindowsCommand.swift
@@ -0,0 +1,124 @@
+import Common
+
+private let priorityAx: Set<String> = [
+    Ax.titleAttr.key,
+    Ax.roleAttr.key,
+    Ax.subroleAttr.key,
+    Ax.identifierAttr.key,
+]
+
+private let foldAxKeys: Set<String> = ["AXChildrenInNavigationOrder", "AXChildren"]
+
+private let disclaimer =
+    """
+    !!! DISCLAIMER !!!
+    !!! 'debug-windows' command is not stable API. Please don't rely on the command existence and output format !!!
+    !!! The only intended use case is to report bugs about incorrect windows handling !!!
+    """
+
+private var debugWindowsState: DebugWindowsState = .notRecording
+private var debugWindowsLog: [UInt32: String] = [:]
+private let debugWindowsLimit = 5
+
+enum DebugWindowsState {
+    case recording
+    case notRecording
+    case recordingAborted
+}
+
+struct DebugWindowsCommand: Command {
+    let args = DebugWindowsCmdArgs()
+
+    func _run(_ state: CommandMutableState, stdin: String) -> Bool {
+        check(Thread.current.isMainThread)
+        switch debugWindowsState {
+        case .recording:
+            debugWindowsState = .notRecording
+            state.stdout.append((debugWindowsLog.values + ["Debug session finished"]).joined(separator: "\n\n"))
+            debugWindowsLog = [:]
+            return true
+        case .notRecording:
+            debugWindowsState = .recording
+            state.stdout.append(
+                """
+                Debug windows session has started
+                1. Focus the problematic window
+                2. Run 'aerospace debug-windows' once again to finish the session and get the results
+
+                \(disclaimer)
+                """
+            )
+            debugWindowsLog = [:]
+            return true
+        case .recordingAborted:
+            state.stdout.append(
+                """
+                Recording of the previous session was aborted after \(debugWindowsLimit) windows has been focused
+                Run the command one more time to start new debug session
+                """
+            )
+            debugWindowsState = .notRecording
+            debugWindowsLog = [:]
+            return false
+        }
+    }
+}
+
+func debugWindowsIfRecording(_ window: Window) {
+    switch debugWindowsState {
+    case .recording:
+        break
+    case .notRecording, .recordingAborted:
+        return
+    }
+    if debugWindowsLog.count > debugWindowsLimit {
+        debugWindowsState = .recordingAborted
+        debugWindowsLog = [:]
+    }
+    let window = window as! MacWindow
+    if debugWindowsLog.keys.contains(window.windowId) {
+        return
+    }
+    let app = window.app as! MacApp
+    let appId = app.id ?? "null-app-id"
+    let windowPrefix = appId + ".window.\(window.windowId)"
+    var result: [String] = []
+
+    result.append("\(windowPrefix) recognizedAsDialog: \(shouldFloat(window.axWindow, app))")
+    result.append("\(windowPrefix) windowId: \(window.windowId)")
+    result.append("\(windowPrefix) workspace: \(window.workspace.name)")
+    result.append(dumpAx(window.axWindow, windowPrefix))
+    result.append(dumpAx(app.axApp, appId.padding(toLength: windowPrefix.count, withPad: " ", startingAt: 0)))
+
+    debugWindowsLog[window.windowId] = result.joined(separator: "\n")
+}
+
+private func prettyKeyValue(_ key: String, _ value: Any) -> String {
+    let value = String(describing: value)
+    return value.contains("\n")
+        ? "\(key):\n" + value.prependLines("    ")
+        : "\(key): '\(value)'"
+}
+
+private func dumpAx(_ ax: AXUIElement, _ prefix: String) -> String {
+    var result: [String] = []
+    for attr in ax.attrs.sortedBy({ priorityAx.contains($0) ? 0 : 1 }) {
+        var raw: AnyObject?
+        AXUIElementCopyAttributeValue(ax, attr as CFString, &raw)
+        if foldAxKeys.contains(attr) {
+            let nillability = raw != nil ? "not-nil" : "nil"
+            result.append("\(prefix) \(attr): \(nillability)")
+        } else {
+            result.append(prettyKeyValue(attr, raw as Any).prependLines("\(prefix) "))
+        }
+    }
+    return result.joined(separator: "\n")
+}
+
+extension AXUIElement {
+    var attrs: [String] {
+        var rawArray: CFArray?
+        AXUIElementCopyAttributeNames(self, &rawArray)
+        return rawArray as? [String] ?? []
+    }
+}
diff --git a/src/refresh.swift b/src/refresh.swift
@@ -10,6 +10,7 @@ func refreshSession<T>(startup: Bool = false, forceFocus: Bool = false, body: ()
     detectNewWindowsAndAttachThemToWorkspaces(startup: startup)
 
     let nativeFocused = getNativeFocusedWindow(startup: startup)
+    if let nativeFocused { debugWindowsIfRecording(nativeFocused) }
     takeFocusFromMacOs(nativeFocused, startup: startup)
     let focusBefore = focusedWindow
 
diff --git a/src/tree/MacWindow.swift b/src/tree/MacWindow.swift
@@ -53,7 +53,7 @@ final class MacWindow: Window, CustomStringConvertible {
             ("subrole", axWindow.get(Ax.subroleAttr)),
             ("identifier", axWindow.get(Ax.identifierAttr)),
             ("modal", axWindow.get(Ax.modalAttr).map { String($0) } ?? ""),
-            ("windowId", String(windowId))
+            ("windowId", String(windowId)),
         ].map { "\($0.0): '\(String(describing: $0.1))'" }.joined(separator: ", ")
         return "Window(\(description))"
     }
@@ -178,7 +178,7 @@ private func isWindow(_ axWindow: AXUIElement, _ app: MacApp) -> Bool {
         app.id == "com.apple.finder" && subrole == "Quick Look" // Finder preview (hit space) is a floating window
 }
 
-private func shouldFloat(_ axWindow: AXUIElement, _ app: MacApp) -> Bool { // Note: a lot of windows don't have title on startup
+func shouldFloat(_ axWindow: AXUIElement, _ app: MacApp) -> Bool { // Note: a lot of windows don't have title on startup
     // Don't tile:
     // - Chrome cmd+f window ("AXUnknown" value)
     // - login screen (Yes fuck, it's also a window from Apple's API perspective) ("AXUnknown" value)
@@ -247,6 +247,7 @@ private func destroyedObs(_ obs: AXObserver, ax: AXUIElement, notif: CFString, d
 
 private func onWindowDetected(_ window: Window, startup: Bool) {
     check(Thread.current.isMainThread)
+    debugWindowsIfRecording(window)
     for callback in config.onWindowDetected {
         if callback.matches(window, startup: startup) {
             _ = callback.run.run(CommandMutableState(.window(window)))
diff --git a/src/util/accessibility.swift b/src/util/accessibility.swift
@@ -194,16 +194,27 @@ enum Ax {
         key: kAXIdentifierAttribute,
         getter: { $0 as? String }
     )
-    static let modalAttr = WritableAttrImpl<Bool>(
+    static let modalAttr = ReadableAttrImpl<Bool>(
         key: kAXModalAttribute,
-        getter: { $0 as? Bool },
-        setter: { $0 as CFTypeRef }
+        getter: { $0 as? Bool }
     )
     static let enhancedUserInterfaceAttr = WritableAttrImpl<Bool>(
         key: "AXEnhancedUserInterface",
         getter: { $0 as? Bool },
         setter: { $0 as CFTypeRef }
     )
+    //static let minimizedAttr = ReadableAttrImpl<Bool>(
+    //    key: kAXMinimizedAttribute,
+    //    getter: { $0 as? Bool }
+    //)
+    //static let isFullscreenAttr = ReadableAttrImpl<Bool>(
+    //    key: "AXFullScreen",
+    //    getter: { $0 as? Bool }
+    //)
+    //static let axMainAttr = ReadableAttrImpl<Bool>(
+    //    key: kAXMainAttribute,
+    //    getter: { $0 as? Bool }
+    //)
     static let sizeAttr = WritableAttrImpl<CGSize>(
             key: kAXSizeAttribute,
             getter: {
@@ -254,6 +265,18 @@ enum Ax {
         key: kAXFullScreenButtonAttribute,
         getter: { ($0 as! AXUIElement) }
     )
+    //static let zoomButtonAttr = ReadableAttrImpl<AXUIElement>(
+    //    key: kAXZoomButtonAttribute,
+    //    getter: { ($0 as! AXUIElement) }
+    //)
+    //static let minimizeButtonAttr = ReadableAttrImpl<AXUIElement>(
+    //    key: kAXMinimizeButtonAttribute,
+    //    getter: { ($0 as! AXUIElement) }
+    //)
+    //static let growAreaAttr = ReadableAttrImpl<AXUIElement>(
+    //    key: kAXGrowAreaAttribute,
+    //    getter: { ($0 as! AXUIElement) }
+    //)
 }
 
 extension AXUIElement {

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public struct ServerVersionInternalCommandCmdArgs: RawCmdArgs, CmdArgs {`
`31`	`31`	`public static let parser: CmdParser<Self> = noArgsParser(.serverVersionInternalCommand, allowInConfig: false)`
`32`	`32`	`}`
`33`	`33`
`34`		`-private func noArgsParser<T : Copyable>(_ kind: CmdKind, allowInConfig: Bool) -> CmdParser<T> {`
	`34`	`+func noArgsParser<T : Copyable>(_ kind: CmdKind, allowInConfig: Bool) -> CmdParser<T> {`
`35`	`35`	`cmdParser(`
`36`	`36`	`kind: kind,`
`37`	`37`	`allowInConfig: allowInConfig,`
Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,10 @@ public extension String {`
`93`	`93`	`func removePrefix(_ prefix: String) -> String {`
`94`	`94`	`hasPrefix(prefix) ? String(dropFirst(prefix.count)) : self`
`95`	`95`	`}`
	`96`	`+`
	`97`	`+ func prependLines(_ prefix: String) -> String {`
	`98`	`+ split(separator: "\n").map { prefix + $0 }.joined(separator: "\n")`
	`99`	`+ }`
`96`	`100`	`}`
`97`	`101`
`98`	`102`	`public extension Double {`