Add translation support for ServiceNotFound exc

home-assistant · Oct 24, 2023 · 173183b · 173183b
1 parent cd8cb1b
commit 173183b
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 35 deletions.
diff --git a/homeassistant/components/websocket_api/commands.py b/homeassistant/components/websocket_api/commands.py
@@ -235,9 +235,15 @@ async def handle_call_service(
         connection.send_result(msg["id"], {"context": context})
     except ServiceNotFound as err:
         if err.domain == msg["domain"] and err.service == msg["service"]:
-            connection.send_error(msg["id"], const.ERR_NOT_FOUND, "Service not found.")
+            err.translation_key = "service_not_found_general"
+            err.domain = const.DOMAIN
+            code = const.ERR_NOT_FOUND
         else:
-            connection.send_error(msg["id"], const.ERR_HOME_ASSISTANT_ERROR, str(err))
+            err.translation_key = "service_not_found"
+            err.domain = const.DOMAIN
+            code = const.ERR_HOME_ASSISTANT_ERROR
+        message = await async_build_error_message(hass, err)
+        connection.send_error(msg["id"], code, message)
     except vol.Invalid as err:
         connection.send_error(msg["id"], const.ERR_INVALID_FORMAT, str(err))
     except ServiceValidationError as err:

diff --git a/homeassistant/components/websocket_api/strings.json b/homeassistant/components/websocket_api/strings.json
@@ -0,0 +1,10 @@
+{
+  "exceptions": {
+    "service_not_found_general": {
+      "message": "Service not found"
+    },
+    "service_not_found": {
+      "message": "Service {domain}.{service} not found"
+    }
+  }
+}
diff --git a/homeassistant/exceptions.py b/homeassistant/exceptions.py
@@ -183,6 +183,7 @@ class ServiceNotFound(HomeAssistantError):
     def __init__(self, domain: str, service: str) -> None:
         """Initialize error."""
         super().__init__(self, f"Service {domain}.{service} not found")
+        self.translation_placeholders = {"domain": domain, "service": service}
         self.domain = domain
         self.service = service
 

diff --git a/homeassistant/strings.json b/homeassistant/strings.json
@@ -130,11 +130,6 @@
         "unknown_authorize_url_generation": "Unknown error generating an authorize URL.",
         "cloud_not_connected": "Not connected to Home Assistant Cloud."
       }
-    },
-    "exceptions": {
-      "service_not_found": {
-        "message": "Service not found"
-      }
     }
   }
 }
diff --git a/tests/components/websocket_api/test_commands.py b/tests/components/websocket_api/test_commands.py
@@ -328,21 +328,31 @@ async def test_call_service_not_found(
     hass: HomeAssistant, websocket_client: MockHAClientWebSocket
 ) -> None:
     """Test call service command."""
-    await websocket_client.send_json(
-        {
-            "id": 5,
-            "type": "call_service",
-            "domain": "domain_test",
-            "service": "test_service",
-            "service_data": {"hello": "world"},
-        }
-    )
+    translations = {
+        "component.websocket_api.exceptions.service_not_found_general.message": "Service not found",
+        "component.websocket_api.exceptions.service_not_found.message": "Service {domain}.{service} not found",
+    }
+    with patch(
+        "homeassistant.components.websocket_api.commands.async_get_translations",
+        return_value=translations,
+    ) as mock_get_translations:
+        await websocket_client.send_json(
+            {
+                "id": 5,
+                "type": "call_service",
+                "domain": "domain_test",
+                "service": "test_service",
+                "service_data": {"hello": "world"},
+            }
+        )
 
-    msg = await websocket_client.receive_json()
-    assert msg["id"] == 5
-    assert msg["type"] == const.TYPE_RESULT
-    assert not msg["success"]
-    assert msg["error"]["code"] == const.ERR_NOT_FOUND
+        msg = await websocket_client.receive_json()
+        assert msg["id"] == 5
+        assert msg["type"] == const.TYPE_RESULT
+        assert not msg["success"]
+        assert msg["error"]["code"] == const.ERR_NOT_FOUND
+        assert msg["error"]["message"] == "Service not found"
+        assert len(mock_get_translations.mock_calls) == 1
 
 
 async def test_call_service_child_not_found(
@@ -355,21 +365,31 @@ async def serv_handler(call):
 
     hass.services.async_register("domain_test", "test_service", serv_handler)
 
-    await websocket_client.send_json(
-        {
-            "id": 5,
-            "type": "call_service",
-            "domain": "domain_test",
-            "service": "test_service",
-            "service_data": {"hello": "world"},
-        }
-    )
+    translations = {
+        "component.websocket_api.exceptions.service_not_found_general.message": "Service not found",
+        "component.websocket_api.exceptions.service_not_found.message": "Service {domain}.{service} not found",
+    }
+    with patch(
+        "homeassistant.components.websocket_api.commands.async_get_translations",
+        return_value=translations,
+    ) as mock_get_translations:
+        await websocket_client.send_json(
+            {
+                "id": 5,
+                "type": "call_service",
+                "domain": "domain_test",
+                "service": "test_service",
+                "service_data": {"hello": "world"},
+            }
+        )
 
-    msg = await websocket_client.receive_json()
-    assert msg["id"] == 5
-    assert msg["type"] == const.TYPE_RESULT
-    assert not msg["success"]
-    assert msg["error"]["code"] == const.ERR_HOME_ASSISTANT_ERROR
+        msg = await websocket_client.receive_json()
+        assert msg["id"] == 5
+        assert msg["type"] == const.TYPE_RESULT
+        assert not msg["success"]
+        assert msg["error"]["code"] == const.ERR_HOME_ASSISTANT_ERROR
+        assert msg["error"]["message"] == "Service non.existing not found"
+        assert len(mock_get_translations.mock_calls) == 1
 
 
 async def test_call_service_schema_validation_error(