fix(hotkeys): prefer evdev on GNOME X11 and skip redundant IBus engine restore (#963)
Fixes #954. GNOME X11: mutter never delivers physical key events to the XRecord extension pynput relies on, so the listener started cleanly but shortcuts stayed dead. Prefer the evdev backend there (same path as Wayland), falling back to pynput when /dev/input is unusable. Shutdown: `ibus engine <name>` rewrites the whole X server XKB map, and the unconditional restore collapsed GNOME's multi-layout map and broke layout switching. The daemon check now uses _query_active_engine() (no GNOME gsettings fallback) so a cleared engine reads as None; the restore write is skipped when a real engine is live or the target is an xkb:* source GNOME owns, and still runs for real IM engines (#558).
This commit is contained in:
devin-ai-integration[bot]
+118
-5
@@ -751,13 +751,14 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
|
||||
self.assertEqual(sent["data"], b"\n")
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine._query_active_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine", return_value=True)
|
||||
def test_stop_restores_engine(
|
||||
self, mock_switch, mock_ensure_dir, mock_get_current, mock_stop_proc
|
||||
self, mock_switch, mock_ensure_dir, mock_get_current, mock_stop_proc, mock_live
|
||||
):
|
||||
"""Test stop() restores cached engine when live engine is unavailable (#558)."""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
@@ -776,13 +777,14 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
self.assertEqual([c[0] for c in parent.mock_calls], ["stop_proc", "switch"])
|
||||
self.assertIsNone(injector._previous_engine)
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine._query_active_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value="xkb:de::deu")
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine", return_value=True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_prefers_live_engine_over_stale_warmup_cache(
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc, mock_live
|
||||
):
|
||||
"""Quit must restore the live input source, not a stale warmup cache (#643 Bugbot)."""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
@@ -797,13 +799,14 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
mock_switch.assert_called_once_with("xkb:de::deu")
|
||||
self.assertIsNone(injector._previous_engine)
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine._query_active_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value="xkb:es::spa")
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine", return_value=True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_restores_current_engine_when_previous_unset(
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc, mock_live
|
||||
):
|
||||
"""Warmup quit must restore the live engine after register_component teardown (#558)."""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
@@ -822,6 +825,105 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
mock_switch.assert_called_once_with("xkb:es::spa")
|
||||
self.assertEqual([c[0] for c in parent.mock_calls], ["stop_proc", "switch"])
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch(
|
||||
"vocalinux.text_injection.ibus_engine._query_active_engine",
|
||||
return_value="xkb:us::eng",
|
||||
)
|
||||
@patch(
|
||||
"vocalinux.text_injection.ibus_engine.get_current_engine",
|
||||
return_value="xkb:us::eng",
|
||||
)
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine")
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_skips_engine_write_when_live_engine_healthy(
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_live, mock_stop_proc
|
||||
):
|
||||
"""A healthy live engine must not be rewritten at quit (#954).
|
||||
|
||||
`ibus engine <name>` applies the engine's XKB map server-wide; on
|
||||
GNOME the redundant write collapses the user's multi-layout map and
|
||||
breaks keyboard layout switching after exit.
|
||||
"""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
|
||||
injector = IBusTextInjector(auto_activate=False)
|
||||
injector._previous_engine = "xkb:us::eng"
|
||||
|
||||
injector.stop()
|
||||
|
||||
mock_get_current.assert_called()
|
||||
mock_stop_proc.assert_called_once()
|
||||
mock_switch.assert_not_called()
|
||||
self.assertIsNone(injector._previous_engine)
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine._is_gnome_session", return_value=True)
|
||||
@patch("vocalinux.text_injection.ibus_engine._query_active_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine")
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_skips_xkb_restore_when_gnome_engine_cleared(
|
||||
self,
|
||||
mock_ensure_dir,
|
||||
mock_switch,
|
||||
mock_get_current,
|
||||
mock_stop_proc,
|
||||
mock_live,
|
||||
mock_gnome,
|
||||
):
|
||||
"""On GNOME, a cleared engine with an xkb:* target must not be rewritten (#954).
|
||||
|
||||
gnome-shell owns the XKB map; restoring an xkb engine would only
|
||||
collapse the user's multi-layout map.
|
||||
"""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
|
||||
injector = IBusTextInjector(auto_activate=False)
|
||||
injector._previous_engine = "xkb:us::eng"
|
||||
|
||||
injector.stop()
|
||||
|
||||
mock_stop_proc.assert_called_once()
|
||||
mock_live.assert_called_once()
|
||||
mock_switch.assert_not_called()
|
||||
self.assertIsNone(injector._previous_engine)
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine._is_gnome_session", return_value=True)
|
||||
@patch("vocalinux.text_injection.ibus_engine._query_active_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine", return_value=True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_restores_im_engine_when_gnome_teardown_cleared(
|
||||
self,
|
||||
mock_ensure_dir,
|
||||
mock_switch,
|
||||
mock_get_current,
|
||||
mock_stop_proc,
|
||||
mock_live,
|
||||
mock_gnome,
|
||||
):
|
||||
"""On GNOME, a cleared engine with a real IM target still restores (#558).
|
||||
|
||||
A libpinyin/mozc user left with no global engine would lose input
|
||||
method support entirely, so the restore write must still run.
|
||||
"""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
|
||||
injector = IBusTextInjector(auto_activate=False)
|
||||
injector._previous_engine = "libpinyin"
|
||||
|
||||
injector.stop()
|
||||
|
||||
mock_stop_proc.assert_called_once()
|
||||
mock_live.assert_called_once()
|
||||
mock_switch.assert_called_once_with("libpinyin")
|
||||
self.assertIsNone(injector._previous_engine)
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.switch_engine")
|
||||
@@ -840,6 +942,7 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
mock_stop_proc.assert_called_once()
|
||||
mock_switch.assert_not_called()
|
||||
|
||||
@patch("vocalinux.text_injection.ibus_engine._query_active_engine", return_value=None)
|
||||
@patch("vocalinux.text_injection.ibus_engine.restore_xkb_layout")
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch("vocalinux.text_injection.ibus_engine.get_current_engine", return_value="xkb:es::spa")
|
||||
@@ -847,7 +950,13 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_restores_xkb_layout(
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc, mock_restore_xkb
|
||||
self,
|
||||
mock_ensure_dir,
|
||||
mock_switch,
|
||||
mock_get_current,
|
||||
mock_stop_proc,
|
||||
mock_restore_xkb,
|
||||
mock_live,
|
||||
):
|
||||
"""Test stop() restores XKB after post-teardown engine restore (#292/#558)."""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
@@ -892,6 +1001,10 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
mock_restore_xkb.assert_not_called()
|
||||
mock_switch.assert_not_called()
|
||||
|
||||
@patch(
|
||||
"vocalinux.text_injection.ibus_engine._query_active_engine",
|
||||
return_value="vocalinux",
|
||||
)
|
||||
@patch("vocalinux.text_injection.ibus_engine.stop_engine_process")
|
||||
@patch(
|
||||
"vocalinux.text_injection.ibus_engine.get_current_engine",
|
||||
@@ -901,7 +1014,7 @@ class TestIBusTextInjector(unittest.TestCase):
|
||||
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
|
||||
@patch("vocalinux.text_injection.ibus_engine.ensure_ibus_dir")
|
||||
def test_stop_uses_cached_engine_when_stuck_on_vocalinux(
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc
|
||||
self, mock_ensure_dir, mock_switch, mock_get_current, mock_stop_proc, mock_live
|
||||
):
|
||||
"""If quit finds vocalinux selected, fall back to the warmup-captured engine (#558)."""
|
||||
from vocalinux.text_injection.ibus_engine import IBusTextInjector
|
||||
|
||||
Reference in New Issue
Block a user