Route browser content keys around performKeyEquivalent

Author: lawrencecchen

Sources/AppDelegate.swift

@@ -1524,6 +1524,25 @@ func shouldDirectRouteBrowserFirstResponderKeyDown(
     return firstResponder != nil
 }
 
+enum BrowserDirectKeyRoutingStrategy: Equatable {
+    case keyDown
+    case menuOrAppShortcutThenKeyDown
+    case deferToOriginalPerformKeyEquivalent
+}
+
+func browserDirectKeyRoutingStrategy(for event: NSEvent) -> BrowserDirectKeyRoutingStrategy {
+    let flags = event.modifierFlags.intersection(.deviceIndependentFlagsMask)
+    guard flags.contains(.command) else {
+        return .keyDown
+    }
+
+    guard shouldRouteCommandEquivalentDirectlyToMainMenu(event) else {
+        return .deferToOriginalPerformKeyEquivalent
+    }
+
+    return .menuOrAppShortcutThenKeyDown
+}
+
 func shouldToggleMainWindowFullScreenForCommandControlFShortcut(
     flags: NSEvent.ModifierFlags,
     chars: String,
@@ -12878,18 +12897,34 @@ private extension NSWindow {
             return false
         }
 
-        if browserRoute.webView.performKeyEquivalent(with: event) {
+        switch browserDirectKeyRoutingStrategy(for: event) {
+        case .deferToOriginalPerformKeyEquivalent:
+            return false
+
+        case .menuOrAppShortcutThenKeyDown:
+            if let mainMenu = NSApp.mainMenu,
+               mainMenu.performKeyEquivalent(with: event) {
 #if DEBUG
-            let targetType = String(describing: type(of: browserRoute.webView))
-            dlog("window.browserKeyDirect route=performKeyEquivalent target=\(targetType)")
+                dlog("window.browserKeyDirect route=mainMenu")
 #endif
-            return true
+                return true
+            }
+
+            if AppDelegate.shared?.handleBrowserSurfaceKeyEquivalent(event) == true {
+#if DEBUG
+                dlog("window.browserKeyDirect route=appShortcut")
+#endif
+                return true
+            }
+
+        case .keyDown:
+            break
         }
 
         if invokedFromPerformKeyEquivalent {
             if cmuxBrowserKeyDownForwardingDepth > 0 {
 #if DEBUG
-                dlog("window.browserKeyDirect route=performKeyEquivalentReentry")
+                dlog("window.browserKeyDirect route=keyDownReentry")
 #endif
                 return false
             }

cmuxTests/BrowserConfigTests.swift

@@ -2596,6 +2596,66 @@ final class BrowserDirectKeyDownRoutingTests: XCTestCase {
             )
         )
     }
+
+    func testNonCommandBrowserKeysGoStraightToKeyDown() {
+        let event = makeKeyDownEvent(
+            characters: String(UnicodeScalar(NSDownArrowFunctionKey)!),
+            modifiers: [],
+            keyCode: 125
+        )
+
+        XCTAssertEqual(browserDirectKeyRoutingStrategy(for: event), .keyDown)
+    }
+
+    func testCommandShiftArrowFallsBackToBrowserKeyDownWhenNoShortcutConsumesIt() {
+        let event = makeKeyDownEvent(
+            characters: String(UnicodeScalar(NSDownArrowFunctionKey)!),
+            modifiers: [.command, .shift],
+            keyCode: 125
+        )
+
+        XCTAssertEqual(
+            browserDirectKeyRoutingStrategy(for: event),
+            .menuOrAppShortcutThenKeyDown
+        )
+    }
+
+    func testCommandBacktickDefersToOriginalPerformKeyEquivalent() {
+        let event = makeKeyDownEvent(
+            characters: "`",
+            modifiers: [.command],
+            keyCode: 50
+        )
+
+        XCTAssertEqual(
+            browserDirectKeyRoutingStrategy(for: event),
+            .deferToOriginalPerformKeyEquivalent
+        )
+    }
+
+    private func makeKeyDownEvent(
+        characters: String,
+        modifiers: NSEvent.ModifierFlags,
+        keyCode: UInt16
+    ) -> NSEvent {
+        guard let event = NSEvent.keyEvent(
+            with: .keyDown,
+            location: .zero,
+            modifierFlags: modifiers,
+            timestamp: ProcessInfo.processInfo.systemUptime,
+            windowNumber: 0,
+            context: nil,
+            characters: characters,
+            charactersIgnoringModifiers: characters,
+            isARepeat: false,
+            keyCode: keyCode
+        ) else {
+            XCTFail("Failed to create keyDown event for routing strategy test")
+            fatalError("Failed to create keyDown event")
+        }
+
+        return event
+    }
 }
 
 final class BrowserZoomShortcutActionTests: XCTestCase {