Desktop: Mac menu workaround (#3398)

Author: timon-schelling

Cargo.lock

@@ -182,7 +182,7 @@ image = { version = "0.25", default-features = false, features = [
 	"jpeg",
 	"bmp",
 ] }
-parley = "0.5"
+parley = "0.6"
 skrifa = "0.36"
 pretty_assertions = "1.4"
 fern = { version = "0.7", features = ["colored"] }

Cargo.toml

@@ -58,5 +58,8 @@ windows = { version = "0.58.0", features = [
 
 # macOS-specific dependencies
 [target.'cfg(target_os = "macos")'.dependencies]
+objc2 = { version = "0.6.1", default-features = false }
+objc2-foundation = { version = "0.3.2", default-features = false }
+objc2-app-kit = { version = "0.3.2", default-features = false }
 muda = { git = "https://github.com/tauri-apps/muda.git", rev = "3f460b8fbaed59cda6d95ceea6904f000f093f15", default-features = false }
 

desktop/Cargo.toml

@@ -44,6 +44,10 @@ pub(crate) struct App {
 }
 
 impl App {
+	pub(crate) fn init() {
+		Window::init();
+	}
+
 	pub(crate) fn new(
 		cef_context: Box<dyn cef::CefContext>,
 		cef_view_info_sender: Sender<cef::ViewInfoUpdate>,

desktop/src/app.rs

@@ -88,11 +88,27 @@ pub(crate) fn handle_window_event(browser: &Browser, input_state: &mut InputStat
 			key_event.native_key_code = event.physical_key.to_native_keycode();
 
 			key_event.character = event.logical_key.to_char_representation() as u16;
-			key_event.unmodified_character = event.key_without_modifiers.to_char_representation() as u16;
+
+			// Mitigation for CEF on Mac bug to prevent NSMenu being triggered by this key event.
+			//
+			// CEF converts the key event into an `NSEvent` internally and passes that to Chromium.
+			// In some cases the `NSEvent` gets to the native Cocoa application, is considered "unhandled" and can trigger menus.
+			//
+			// Why mitigation works:
+			// Leaving `key_event.unmodified_character = 0` still leads to CEF forwarding a "unhandled" event to the native application
+			// but that event is discarded because `key_event.unmodified_character = 0` is considered non-printable and not used for shortcut matching.
+			//
+			// See https://github.com/chromiumembedded/cef/issues/3857
+			//
+			// TODO: Remove mitigation once bug is fixed or a better solution is found.
+			#[cfg(not(target_os = "macos"))]
+			{
+				key_event.unmodified_character = event.key_without_modifiers.to_char_representation() as u16;
+			}
 
 			#[cfg(target_os = "macos")] // See https://www.magpcss.org/ceforum/viewtopic.php?start=10&t=11650
 			if key_event.character == 0 && key_event.unmodified_character == 0 && event.text_with_all_modifiers.is_some() {
-				key_event.unmodified_character = 1;
+				key_event.character = 1;
 			}
 
 			if key_event.type_ == cef_key_event_type_t::KEYEVENT_CHAR.into() {

desktop/src/cef/input.rs

@@ -36,6 +36,8 @@ pub fn start() {
 		return;
 	}
 
+	App::init();
+
 	let cli = Cli::parse();
 
 	let wgpu_context = futures::executor::block_on(gpu_context::create_wgpu_context());

desktop/src/lib.rs

@@ -4,9 +4,11 @@ use winit::window::{Window as WinitWindow, WindowAttributes};
 
 use crate::consts::APP_NAME;
 use crate::event::AppEventScheduler;
+use crate::window::mac::NativeWindowImpl;
 use crate::wrapper::messages::MenuItem;
 
 pub(crate) trait NativeWindow {
+	fn init() {}
 	fn configure(attributes: WindowAttributes, event_loop: &dyn ActiveEventLoop) -> WindowAttributes;
 	fn new(window: &dyn WinitWindow, app_event_scheduler: AppEventScheduler) -> Self;
 	fn update_menu(&self, _entries: Vec<MenuItem>) {}
@@ -34,6 +36,10 @@ pub(crate) struct Window {
 }
 
 impl Window {
+	pub(crate) fn init() {
+		NativeWindowImpl::init();
+	}
+
 	pub(crate) fn new(event_loop: &dyn ActiveEventLoop, app_event_scheduler: AppEventScheduler) -> Self {
 		let mut attributes = WindowAttributes::default()
 			.with_title(APP_NAME)