fix: improve terminal detection on Linux (#278)

Author: brandonskiser

crates/fig_desktop/src/platform/linux/ibus.rs

@@ -80,10 +80,13 @@ pub async fn launch_ibus_connection(proxy: EventLoopProxy, platform_state: Arc<P
                                     active_input_contexts.remove(path.as_str());
                                 },
                                 "SetCursorLocation" => {
-                                    if !active_input_contexts.contains(path.as_str()) {
+                                    if !active_input_contexts.contains(path.as_str())
+                                        || platform_state.active_terminal.lock().is_none()
+                                    {
                                         debug!("SetCursorLocation rejected on {}", path.as_str());
                                         continue;
                                     }
+
                                     let body = match msg.body().deserialize::<(i32, i32, i32, i32)>() {
                                         Ok(body) => body,
                                         Err(err) => {

crates/fig_desktop/src/platform/linux/integrations.rs

@@ -37,8 +37,14 @@ pub static WM_CLASS_ALLOWLIST: Lazy<HashMap<&'static str, Terminal>> = Lazy::new
 pub static GSE_ALLOWLIST: Lazy<HashMap<&'static str, Terminal>> = Lazy::new(|| {
     let mut allowlist = HashMap::new();
     for terminal in fig_util::terminal::LINUX_TERMINALS {
-        if let Some(gnome_id) = terminal.gnome_id() {
-            allowlist.insert(gnome_id, terminal.clone());
+        // Using wm_class_instance here since on Wayland, (most?) terminals set the app_id equal to
+        // the WM_CLASS Instance part. To handle Xwayland terminals, we still want to include wm_class as
+        // well.
+        if let (Some(instance), Some(class)) = (terminal.wm_class_instance(), terminal.wm_class()) {
+            allowlist.insert(instance, terminal.clone());
+            if class != instance {
+                allowlist.insert(class, terminal.clone());
+            }
         }
     }
     allowlist
@@ -65,10 +71,11 @@ pub fn from_hook(hook: FocusedWindowDataHook, platform_state: &PlatformState, pr
     }
 
     debug!("focus event on {} from {}", hook.id, hook.source);
-    if from_source(&hook.source)
+    if let Some(terminal) = from_source(&hook.source)
         .ok_or_else(|| anyhow!("received invalid focus window data source"))?
-        .contains_key(hook.id.as_str())
+        .get(hook.id.as_str())
     {
+        *platform_state.0.active_terminal.lock() = Some(terminal.clone());
         let inner = hook.inner.unwrap();
         let outer = hook.outer.unwrap();
         let mut handle = platform_state.0.active_window_data.lock();
@@ -84,6 +91,7 @@ pub fn from_hook(hook: FocusedWindowDataHook, platform_state: &PlatformState, pr
             scale: hook.scale,
         });
     } else {
+        *platform_state.0.active_terminal.lock() = None;
         proxy.send_event(Event::WindowEvent {
             window_id: AUTOCOMPLETE_ID,
             window_event: WindowEvent::Hide,

crates/fig_util/src/terminal.rs

@@ -464,12 +464,14 @@ impl Terminal {
         }
     }
 
+    /// Returns the "Class" part of the WM_CLASS property.
     pub fn wm_class(&self) -> Option<&'static str> {
         match self {
             Terminal::VSCode => Some("Code"),
             Terminal::VSCodeInsiders => Some("Vscode-insiders"),
             Terminal::GnomeConsole => Some("Kgx"),
             Terminal::GnomeTerminal => Some("Gnome-terminal"),
+            Terminal::Guake => Some("Guake"),
             Terminal::Hyper => Some("Hyper"),
             Terminal::Konsole => Some("konsole"),
             Terminal::Tilix => Some("Tilix"),
@@ -485,22 +487,18 @@ impl Terminal {
         }
     }
 
-    // corresponds to GSE source type
-    pub fn gnome_id(&self) -> Option<&'static str> {
+    /// Returns the "Instance" part of the WM_CLASS property.
+    pub fn wm_class_instance(&self) -> Option<&'static str> {
         match self {
-            // Terminal::Vscode => Some("Code"),
-            // Terminal::VSCodeInsiders => Some("Code - Insiders"),
+            Terminal::GnomeConsole => Some("org.gnome.Console"),
             Terminal::GnomeTerminal => Some("gnome-terminal-server"),
-            // Terminal::Konsole => Some("org.kde.konsole"),
-            Terminal::Tilix => Some("tilix"),
-            Terminal::Alacritty => Some("Alacritty"),
-            Terminal::Kitty => Some("kitty"),
-            Terminal::XfceTerminal => Some("xfce4-terminal"),
+            Terminal::Guake => Some("guake"),
+            Terminal::Hyper => Some("hyper"),
             Terminal::Terminator => Some("terminator"),
-            // Terminal::Terminology => Some("terminology"),
-            // Terminal::WezTerm => Some("org.wezfurlong.wezterm"),
-            // Terminal::Tabby => Some("tabby"),
-            _ => None,
+            Terminal::Tilix => Some("tilix"),
+            // Many terminals seem to use the same name for both, falling back to Class name
+            // as a default.
+            _ => self.wm_class(),
         }
     }
 

extensions/gnome-extension/src/extension.ts

@@ -701,6 +701,7 @@ export default class QCliExtension extends Extension {
    * @param {boolean} overlay_pressed
    */
   #send_window_data(overlay_pressed) {
+    // Mutter populates wm class/instance with the app_id on Wayland.
     const wm_class = this.#window.get_wm_class();
     // https://mutter.gnome.org/meta/method.Window.get_frame_rect.html
     const inner_rect = this.#window.get_frame_rect();

extensions/gnome-legacy-extension/src/extension.js

@@ -727,6 +727,7 @@ class Extension extends GObject.Object {
    * @param {boolean} overlay_pressed
    */
   #send_window_data(overlay_pressed) {
+    // Mutter populates wm class/instance will the app_id on Wayland.
     const wm_class = this.#window.get_wm_class();
     // https://mutter.gnome.org/meta/method.Window.get_frame_rect.html
     const inner_rect = this.#window.get_frame_rect();