showing the error of the selected mapping, no useless error for empty mapping

Author: sezanzeb

inputremapper/configs/mapping.py

@@ -486,6 +486,10 @@ def output_matches_input(cls, values: Dict[str, Any]) -> Dict[str, Any]:
         output_symbol = values.get("output_symbol")
         output_key_set = output_symbol or (output_type == EV_KEY and output_code)
 
+        if mapping_type is None:
+            # Empty mapping most likely
+            return values
+
         if not defines_analog_input and mapping_type != MappingType.KEY_MACRO.value:
             raise WrongMappingTypeForKeyError()
 

inputremapper/gui/controller.py

@@ -163,17 +163,27 @@ def _format_status_bar_validation_errors(self) -> Optional[Tuple[str, str]]:
             self.message_broker.publish(StatusData(CTX_MAPPING))
             return None
 
-        for mapping in self.data_manager.active_preset:
-            if not mapping.get_error():
+        mappings = list(self.data_manager.active_preset)
+
+        # Move the selected (active) mapping to the front, so that it is checked first.
+        active_mapping = self.data_manager.active_mapping
+        if active_mapping is not None:
+            mappings.remove(active_mapping)
+            mappings.insert(0, active_mapping)
+
+        for mapping in mappings:
+            if not mapping.has_input_defined():
+                # Empty mapping, nothing recorded yet so nothing can be configured,
+                # therefore there isn't anything to validate.
                 continue
 
             position = mapping.format_name()
             error_strings = self._get_ui_error_strings(mapping)
+
             if len(error_strings) == 0:
-                # shouldn't be possible to get to this point
-                logger.error("Expected an error")
-                return None
-            elif len(error_strings) > 1:
+                continue
+
+            if len(error_strings) > 1:
                 msg = _('%d Mapping errors at "%s", hover for info') % (
                     len(error_strings),
                     position,
@@ -661,12 +671,12 @@ def start_injecting(self):
                 _('Failed to apply preset "%s"') % self.data_manager.active_preset.name,
             )
 
-    def show_injector_result(self, msg: InjectorStateMessage):
+    def show_injector_result(self, msg: InjectorStateMessage) -> None:
         """Show if the injection was successfully started."""
         self.message_broker.unsubscribe(self.show_injector_result)
         state = msg.state
 
-        def running():
+        def running() -> None:
             msg = _('Applied preset "%s"') % self.data_manager.active_preset.name
             if self.data_manager.active_preset.dangerously_mapped_btn_left():
                 msg += _(", CTRL + DEL to stop")
@@ -675,14 +685,13 @@ def running():
                 'Group "%s" is currently mapped', self.data_manager.active_group.key
             )
 
-        def no_grab():
+        def no_grab() -> None:
             msg = (
                 _('Failed to apply preset "%s"') % self.data_manager.active_preset.name
             )
             tooltip = (
-                "Your preset might contain errors, or "
-                "your preset doesn't contain anything that is sent by the "
-                "device or another device is already grabbing it",
+                "Maybe your preset doesn't contain anything that is sent by the "
+                "device or another device is already grabbing it"
             )
 
             # InjectorState.NO_GRAB also happens when all mappings have validation

tests/integration/test_components.py

@@ -905,11 +905,12 @@ def test_placeholder(self):
 
         def focus():
             self.gui.grab_focus()
-            gtk_iteration(5)
+            # Do as many iterations as needed to make it work.
+            gtk_iteration(15)
 
         def unfocus():
             window.set_focus(None)
-            gtk_iteration(5)
+            gtk_iteration(15)
 
         # clears the input when we enter the editor widget
         focus()

tests/integration/test_gui.py

@@ -1489,40 +1489,56 @@ def save():
         self.assertFalse(os.path.exists(preset_path))
 
     def test_check_for_unknown_symbols(self):
+        first_input = InputCombination([InputConfig(type=1, code=1)])
+        second_input = InputCombination([InputConfig(type=1, code=2)])
         status = self.user_interface.get("status_bar")
         error_icon = self.user_interface.get("error_status_icon")
         warning_icon = self.user_interface.get("warning_status_icon")
 
         self.controller.load_preset("preset1")
         self.throttle(20)
-        self.controller.load_mapping(InputCombination([InputConfig(type=1, code=1)]))
+
+        # Switch to the first mapping, and change it
+        self.controller.load_mapping(first_input)
         gtk_iteration()
         self.controller.update_mapping(output_symbol="foo")
         gtk_iteration()
-        self.controller.load_mapping(InputCombination([InputConfig(type=1, code=2)]))
+
+        # Switch to the second mapping, and change it
+        self.controller.load_mapping(second_input)
         gtk_iteration()
         self.controller.update_mapping(output_symbol="qux")
         gtk_iteration()
 
+        # The tooltip should show the error of the currently selected mapping
         tooltip = status.get_tooltip_text().lower()
         self.assertIn("qux", tooltip)
         self.assertTrue(error_icon.get_visible())
         self.assertFalse(warning_icon.get_visible())
 
-        # it will still save it though
+        # So switching to the other mapping changes the tooltip
+        self.controller.load_mapping(first_input)
+        gtk_iteration()
+        tooltip = status.get_tooltip_text().lower()
+        self.assertIn("foo", tooltip)
+
+        # It will still save it though
         with open(PathUtils.get_preset_path("Foo Device", "preset1")) as f:
             content = f.read()
             self.assertIn("qux", content)
             self.assertIn("foo", content)
 
+        # Fix the current active mapping.
+        # It should show the error of the other mapping now.
         self.controller.update_mapping(output_symbol="a")
         gtk_iteration()
         tooltip = status.get_tooltip_text().lower()
-        self.assertIn("foo", tooltip)
+        self.assertIn("qux", tooltip)
         self.assertTrue(error_icon.get_visible())
         self.assertFalse(warning_icon.get_visible())
 
-        self.controller.load_mapping(InputCombination([InputConfig(type=1, code=1)]))
+        # Fix the other mapping as well. No tooltip should be shown afterward.
+        self.controller.load_mapping(second_input)
         gtk_iteration()
         self.controller.update_mapping(output_symbol="b")
         gtk_iteration()
@@ -1531,6 +1547,18 @@ def test_check_for_unknown_symbols(self):
         self.assertFalse(error_icon.get_visible())
         self.assertFalse(warning_icon.get_visible())
 
+    def test_no_validation_tooltip_for_empty_mappings(self):
+        self.controller.load_preset("preset1")
+        self.throttle(20)
+
+        status = self.user_interface.get("status_bar")
+        self.assertIsNone(status.get_tooltip_text())
+
+        self.controller.create_mapping()
+        gtk_iteration()
+        self.assertTrue(self.controller.is_empty_mapping())
+        self.assertIsNone(status.get_tooltip_text())
+
     def test_check_macro_syntax(self):
         status = self.status_bar
         error_icon = self.user_interface.get("error_status_icon")
@@ -1702,7 +1730,7 @@ def wait():
             self.assertFalse(error_icon.get_visible())
             wait()
             text = self.get_status_text()
-            self.assertIn("not grabbed", text)
+            self.assertIn("Failed to apply preset", text)
             self.assertTrue(error_icon.get_visible())
             self.assertNotEqual(
                 self.daemon.get_state("Foo Device 2"), InjectorState.RUNNING