fix(injection): stop typing test during wtype probe (#627)

Fixes #622
2026-08-02 19:41:02 -07:00
parent 679ff9161b
commit ced8620e69
3 changed files with 74 additions and 22 deletions
@@ -131,10 +131,7 @@ class TextInjector:
            and self.wayland_tool == "wtype"
        ):
            try:
-                # Try a test with wtype
-                result = subprocess.run(
-                    ["wtype", "test"], stderr=subprocess.PIPE, text=True, check=False
-                )
+                result = self._probe_wtype_support()
                error_output = result.stderr.lower()
                if "compositor does not support" in error_output or result.returncode != 0:
                    logger.warning(
@@ -178,6 +175,16 @@ class TextInjector:
                self._ibus_injector = None
            self._ibus_ready = False

+    def _probe_wtype_support(self) -> subprocess.CompletedProcess:
+        """Probe wtype support without typing visible text."""
+        return subprocess.run(
+            ["wtype", ""],
+            stderr=subprocess.PIPE,
+            text=True,
+            check=False,
+            timeout=2,
+        )
+
    def _detect_environment(self) -> DesktopEnvironment:
        """
        Detect the current desktop environment (X11 or Wayland).
@@ -836,12 +843,7 @@ class TextInjector:
        # Check for wtype with compositor support
        if shutil.which("wtype"):
            try:
-                result = subprocess.run(
-                    ["wtype", "test"],
-                    stderr=subprocess.PIPE,
-                    text=True,
-                    check=False,
-                )
+                result = self._probe_wtype_support()
                error_output = result.stderr.lower()
                if "compositor does not support" not in error_output and result.returncode == 0:
                    self.wayland_tool = "wtype"
@@ -95,7 +95,7 @@ class TestTextInjector(unittest.TestCase):
            # Make wtype available for Wayland
            self.mock_which.side_effect = lambda cmd: ("/usr/bin/wtype" if cmd == "wtype" else None)

-            # Mock wtype test call to return success
+            # Mock wtype probe call to return success
            mock_process = MagicMock()
            mock_process.returncode = 0
            mock_process.stderr = ""
@@ -105,6 +105,32 @@ class TestTextInjector(unittest.TestCase):
            self.assertEqual(injector.environment, DesktopEnvironment.WAYLAND)
            self.assertEqual(injector.wayland_tool, "wtype")

+    def test_wtype_startup_probe_is_non_destructive(self):
+        """Startup probing must not type visible text into the focused window."""
+        with patch.dict("os.environ", {"XDG_SESSION_TYPE": "wayland"}):
+            self.mock_which.side_effect = lambda cmd: ("/usr/bin/wtype" if cmd == "wtype" else None)
+
+            mock_process = MagicMock()
+            mock_process.returncode = 0
+            mock_process.stderr = ""
+            self.mock_subprocess.return_value = mock_process
+
+            TextInjector()
+
+            self.mock_subprocess.assert_any_call(
+                ["wtype", ""],
+                stderr=subprocess.PIPE,
+                text=True,
+                check=False,
+                timeout=2,
+            )
+            wtype_calls = [
+                call.args[0]
+                for call in self.mock_subprocess.call_args_list
+                if call.args and call.args[0][0] == "wtype"
+            ]
+            self.assertTrue(all(len(cmd) < 2 or cmd[1] == "" for cmd in wtype_calls))
+
    def test_force_wayland_mode(self):
        """Test forcing Wayland mode."""
        with patch.dict("os.environ", {"XDG_SESSION_TYPE": "x11"}):
@@ -126,7 +152,7 @@ class TestTextInjector(unittest.TestCase):
                "xdotool": "/usr/bin/xdotool",
            }.get(cmd)

-            # Make wtype test fail with compositor error
+            # Make wtype probe fail with compositor error
            mock_process = MagicMock()
            mock_process.returncode = 1
            mock_process.stderr = "compositor does not support virtual keyboard protocol"
@@ -177,7 +203,7 @@ class TestTextInjector(unittest.TestCase):
            # Make wtype available
            self.mock_which.side_effect = lambda cmd: ("/usr/bin/wtype" if cmd == "wtype" else None)

-            # Successful wtype test
+            # Successful wtype probe
            mock_process = MagicMock()
            mock_process.returncode = 0
            mock_process.stderr = ""
@@ -463,12 +489,12 @@ class TestTextInjector(unittest.TestCase):
                "xdotool": "/usr/bin/xdotool",
            }.get(cmd)

-            # First return success for wtype test, then fail for actual injection
+            # First return success for wtype probe, then fail for actual injection
            call_count = [0]

            def mock_subprocess_call(*args, **kwargs):
                call_count[0] += 1
-                if call_count[0] <= 1:  # wtype test call
+                if call_count[0] <= 1:  # wtype probe call
                    mock = MagicMock()
                    mock.returncode = 0
                    mock.stderr = ""
@@ -890,8 +916,8 @@ class TestTextInjectorEdgeCases(unittest.TestCase):
        self.patch_sleep.stop()
        self.patch_ibus_available.stop()

-    def test_wtype_test_exception(self):
-        """Test wtype test handling exceptions gracefully."""
+    def test_wtype_probe_exception(self):
+        """Test wtype probe handling exceptions gracefully."""
        with patch.dict("os.environ", {"XDG_SESSION_TYPE": "wayland"}):

            def which_side_effect(cmd):
@@ -901,7 +927,7 @@ class TestTextInjectorEdgeCases(unittest.TestCase):

            self.mock_which.side_effect = which_side_effect

-            # Make the wtype test raise an exception
+            # Make the wtype probe raise an exception
            self.mock_subprocess.side_effect = Exception("Test wtype error")

            # Should still create the injector (will log warning)
@@ -1014,7 +1040,7 @@ class TestTextInjectorEdgeCases(unittest.TestCase):

            self.mock_which.side_effect = which_side_effect

-            # Make wtype test return error about compositor
+            # Make wtype probe return error about compositor
            mock_process = MagicMock()
            mock_process.returncode = 1
            mock_process.stderr = "compositor does not support virtual keyboard protocol"
@@ -1035,7 +1061,7 @@ class TestTextInjectorEdgeCases(unittest.TestCase):

            self.mock_which.side_effect = which_side_effect

-            # Make wtype test return error
+            # Make wtype probe return error
            mock_process = MagicMock()
            mock_process.returncode = 1
            mock_process.stderr = "compositor does not support virtual keyboard"
@@ -1254,7 +1280,7 @@ class TestTextInjectorEdgeCases(unittest.TestCase):

            self.mock_which.side_effect = which_side_effect

-            # Make wtype test succeed
+            # Make wtype probe succeed
            mock_result = MagicMock()
            mock_result.returncode = 0
            mock_result.stderr = ""
@@ -1362,7 +1388,7 @@ class TestTextInjectorEdgeCases(unittest.TestCase):

            self.mock_which.side_effect = which_side_effect

-            # Succeed on wtype test
+            # Succeed on wtype probe
            mock_result = MagicMock()
            mock_result.returncode = 0
            mock_result.stderr = ""
@@ -504,6 +504,30 @@ class TestCheckDependencies(unittest.TestCase):
        self.assertIn("IBus Wayland", log_output)


+class TestRecoverFromFallback(unittest.TestCase):
+    def test_wtype_recovery_probe_is_non_destructive(self):
+        from vocalinux.text_injection.text_injector import DesktopEnvironment
+
+        obj = _make_injector(DesktopEnvironment.WAYLAND_XDOTOOL)
+
+        with patch(
+            "vocalinux.text_injection.text_injector.shutil.which",
+            side_effect=lambda cmd: "/usr/bin/wtype" if cmd == "wtype" else None,
+        ):
+            with patch("vocalinux.text_injection.text_injector.subprocess.run") as mock_run:
+                mock_run.return_value = MagicMock(returncode=0, stderr="")
+
+                self.assertTrue(obj._try_recover_from_fallback())
+
+        mock_run.assert_called_once_with(
+            ["wtype", ""],
+            stderr=subprocess.PIPE,
+            text=True,
+            check=False,
+            timeout=2,
+        )
+
+
 class TestInjectText(unittest.TestCase):
    def test_inject_x11(self):
        from vocalinux.text_injection.text_injector import DesktopEnvironment