Fix Spook action names in translations (#1311)

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Franck Nijhof <frenck@frenck.dev>

Author: 3 people

custom_components/spook/services.py

@@ -11,8 +11,12 @@
 from awesomeversion import AwesomeVersion
 import voluptuous as vol
 
-from homeassistant.const import __short_version__ as current_version
+from homeassistant.const import (
+    EVENT_CORE_CONFIG_UPDATE,
+    __short_version__ as current_version,
+)
 from homeassistant.core import (
+    Event,
     HomeAssistant,
     Service,
     ServiceCall,
@@ -29,15 +33,23 @@
     async_register_admin_service,
     async_set_service_schema,
 )
+from homeassistant.helpers.translation import (
+    _async_get_translations_cache,
+    async_get_cached_translations,
+    async_get_translations,
+)
 from homeassistant.loader import async_get_integration
 
 from .const import DOMAIN, LOGGER
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
     from types import ModuleType
 
 
 _EntityT = TypeVar("_EntityT", bound=Entity, default=Entity)
+GHOST = "👻"
+SERVICE_TRANSLATION_CATEGORY = "services"
 
 
 class AbstractSpookServiceBase(ABC):
@@ -252,6 +264,10 @@ class SpookServiceManager:
 
     _services: set[AbstractSpookService] = field(default_factory=set)
     _service_schemas: dict[str, Any] = field(default_factory=dict)
+    _service_translation_overrides: dict[tuple[str, str, str], str | None] = field(
+        default_factory=dict
+    )
+    _translation_listener: Callable[[], None] | None = None
 
     def __post_init__(self) -> None:
         """Post initialization."""
@@ -318,6 +334,12 @@ def _load_all_service_modules() -> None:
 
             self.async_register_service(service)
 
+        await self.async_inject_service_translations()
+        self._translation_listener = self.hass.bus.async_listen(
+            EVENT_CORE_CONFIG_UPDATE,
+            self._async_core_config_updated,
+        )
+
     @callback
     def async_register_service(self, service: AbstractSpookService) -> None:
         """Register a Spook service."""
@@ -343,10 +365,168 @@ def async_register_service(self, service: AbstractSpookService) -> None:
                 schema=service_schema,
             )
 
+    @callback
+    def _service_schema_key(self, service: AbstractSpookService) -> str:
+        """Return the services.yaml key for a Spook service."""
+        if service.domain == DOMAIN:
+            return service.service
+        return f"{service.domain}_{service.service}"
+
+    @callback
+    def _service_translation_strings(
+        self,
+        service: AbstractSpookService,
+        cached_spook_translations: dict[str, str],
+    ) -> dict[str, str]:
+        """Return service translation strings mapped to the target domain."""
+        schema_key = self._service_schema_key(service)
+        spook_prefix = f"component.{DOMAIN}.services.{schema_key}."
+        target_prefix = f"component.{service.domain}.services.{service.service}."
+
+        return {
+            f"{target_prefix}{key.removeprefix(spook_prefix)}": (
+                f"{value} {GHOST}"
+                if key == f"{spook_prefix}name" and GHOST not in value
+                else value
+            )
+            for key, value in cached_spook_translations.items()
+            if key.startswith(spook_prefix)
+        }
+
+    @callback
+    def _translation_component_cache(
+        self,
+        language: str,
+        domain: str,
+        *,
+        create: bool = False,
+    ) -> dict[str, str] | None:
+        """Return the Home Assistant translation cache for a component."""
+        translations_cache = _async_get_translations_cache(self.hass)
+
+        try:
+            cache = translations_cache.cache_data.cache
+        except AttributeError:
+            LOGGER.warning(
+                "Unable to access Home Assistant's translation cache, "
+                "skipping Spook service translation update"
+            )
+            return None
+
+        if not isinstance(cache, dict):
+            LOGGER.warning(
+                "Home Assistant's translation cache has an unexpected structure, "
+                "skipping Spook service translation update"
+            )
+            return None
+
+        if create:
+            return (
+                cache.setdefault(language, {})
+                .setdefault(
+                    SERVICE_TRANSLATION_CATEGORY,
+                    {},
+                )
+                .setdefault(domain, {})
+            )
+
+        return cache.get(language, {}).get(SERVICE_TRANSLATION_CATEGORY, {}).get(domain)
+
+    @callback
+    def _inject_service_translation_strings(
+        self,
+        service: AbstractSpookService,
+        cached_spook_translations: dict[str, str],
+    ) -> None:
+        """Inject service translation strings into Home Assistant's cache."""
+        language = self.hass.config.language
+        component_cache = self._translation_component_cache(
+            language,
+            service.domain,
+            create=True,
+        )
+        if component_cache is None:
+            return
+
+        cached_translations = async_get_cached_translations(
+            self.hass,
+            language,
+            SERVICE_TRANSLATION_CATEGORY,
+            service.domain,
+        )
+
+        for key, value in self._service_translation_strings(
+            service,
+            cached_spook_translations,
+        ).items():
+            self._service_translation_overrides.setdefault(
+                (language, service.domain, key), cached_translations.get(key)
+            )
+            component_cache[key] = value
+
+    async def async_inject_service_translations(self) -> None:
+        """Inject Spook service strings into Home Assistant translations."""
+        services = [
+            service
+            for service in self._services
+            if self._service_schema_key(service) in self._service_schemas
+        ]
+
+        if not services:
+            return
+
+        await async_get_translations(
+            self.hass,
+            self.hass.config.language,
+            SERVICE_TRANSLATION_CATEGORY,
+            {DOMAIN, *(service.domain for service in services)},
+        )
+        cached_spook_translations = async_get_cached_translations(
+            self.hass,
+            self.hass.config.language,
+            SERVICE_TRANSLATION_CATEGORY,
+            DOMAIN,
+        )
+
+        for service in services:
+            self._inject_service_translation_strings(
+                service,
+                cached_spook_translations,
+            )
+
+    async def _async_core_config_updated(self, event: Event) -> None:
+        """Re-inject service translations when the language changes."""
+        if "language" not in event.data:
+            return
+        await self.async_inject_service_translations()
+
+    @callback
+    def async_clear_service_translation_overrides(self) -> None:
+        """Restore translation strings that were overridden by Spook."""
+        for (
+            language,
+            domain,
+            key,
+        ), original_value in self._service_translation_overrides.items():
+            component_cache = self._translation_component_cache(language, domain)
+            if component_cache is None:
+                continue
+
+            if original_value is None:
+                component_cache.pop(key, None)
+            else:
+                component_cache[key] = original_value
+
+        self._service_translation_overrides.clear()
+
     @callback
     def async_on_unload(self) -> None:
         """Tear down the Spook services."""
         LOGGER.debug("Tearing down Spook services")
+        if self._translation_listener:
+            self._translation_listener()
+            self._translation_listener = None
+
         for service in self._services:
             LOGGER.debug(
                 "Unregistering service: %s.%s",
@@ -373,3 +553,5 @@ def async_on_unload(self) -> None:
 
                 # Flush service description schema cache
                 self.hass.data.pop(SERVICE_DESCRIPTION_CACHE, None)
+
+        self.async_clear_service_translation_overrides()

custom_components/spook/services.yaml

@@ -59,7 +59,7 @@ homeassistant_add_alias_to_area:
         area:
     alias:
       name: Alias
-      description: The alias (or list of aliasses) to add to the area.
+      description: The alias (or list of aliases) to add to the area.
       required: true
       selector:
         object:
@@ -77,15 +77,15 @@ homeassistant_remove_alias_from_area:
         area:
     alias:
       name: Alias
-      description: The alias (or list of aliasses) to remove from the area.
+      description: The alias (or list of aliases) to remove from the area.
       required: true
       selector:
         object:
 
 homeassistant_set_area_aliases:
   name: Sets aliases for an area 👻
   description: >-
-    Sets aliases for an area. Overwrite and removed any existing aliases,
+    Sets aliases for an area. Overwrites and removes any existing aliases,
     fully replacing them with the new ones.
   fields:
     area_id:
@@ -104,7 +104,7 @@ homeassistant_set_area_aliases:
 homeassistant_add_device_to_area:
   name: Add a device to an area 👻
   description: >-
-    Adds an device to an area. Please note, if the device is already in an area,
+    Adds a device to an area. Please note, if the device is already in an area,
     it will be removed from the previous area.
   fields:
     area_id:
@@ -138,7 +138,7 @@ homeassistant_remove_device_from_area:
 homeassistant_add_entity_to_area:
   name: Add an entity to an area 👻
   description: >-
-    Adds an entity to an area. Please note, if the enity is already in an area,
+    Adds an entity to an area. Please note, if the entity is already in an area,
     it will be removed from the previous area. This will override the area
     the device, that provides this entity, is in.
   fields:
@@ -174,7 +174,7 @@ homeassistant_remove_entity_from_area:
 homeassistant_delete_area:
   name: Delete an area 👻
   description: >-
-    Deletes a new area on the fly.
+    Deletes an area on the fly.
   fields:
     area_id:
       name: Area ID
@@ -271,7 +271,7 @@ homeassistant_update_entity_id:
         entity:
     new_entity_id:
       name: New Entity ID
-      description: The new ID for the entity
+      description: The new ID for the entity.
       required: true
       selector:
         text:
@@ -392,7 +392,7 @@ homeassistant_add_alias_to_floor:
         floor:
     alias:
       name: Alias
-      description: The alias (or list of aliasses) to add to the floor.
+      description: The alias (or list of aliases) to add to the floor.
       required: true
       selector:
         object:
@@ -410,15 +410,15 @@ homeassistant_remove_alias_from_floor:
         floor:
     alias:
       name: Alias
-      description: The alias (or list of aliasses) to remove from the floor.
+      description: The alias (or list of aliases) to remove from the floor.
       required: true
       selector:
         object:
 
 homeassistant_set_floor_aliases:
   name: Sets aliases for a floor 👻
   description: >-
-    Sets aliases for a floor. Overwrite and removed any existing aliases,
+    Sets aliases for a floor. Overwrites and removes any existing aliases,
     fully replacing them with the new ones.
   fields:
     floor_id:
@@ -625,7 +625,7 @@ homeassistant_add_label_to_entity:
 homeassistant_remove_label_from_area:
   name: Remove a label from an area 👻
   description: >-
-    Removes a label to an area. If multiple labels or multiple areas are
+    Removes a label from an area. If multiple labels or multiple areas are
     provided, all combinations will be removed.
   fields:
     label_id:
@@ -830,7 +830,7 @@ recorder_import_statistics:
 select_random:
   name: Select random option 👻
   description: >-
-    Select an random option for a select entity.
+    Select a random option for a select entity.
   target:
     entity:
       domain: select
@@ -847,7 +847,7 @@ select_random:
 input_select_random:
   name: Select random option 👻
   description: >-
-    Select an random option for an input_select entity.
+    Select a random option for an input_select entity.
   target:
     entity:
       domain: input_select
@@ -1126,7 +1126,7 @@ person_remove_device_tracker:
 repairs_create:
   name: Create issue 👻
   description: >-
-    Manually create and raise a issue in Home Assistant repairs.
+    Manually create and raise an issue in Home Assistant repairs.
   fields:
     title:
       name: Title
@@ -1145,7 +1145,7 @@ repairs_create:
       name: Issue ID
       description: >-
         The issue can have an identifier, which allows you to cancel it
-        later with that ID if needed. It also prevent duplicate issues
+        later with that ID if needed. It also prevents duplicate issues
         to be created. If not provided, a random ID will be generated.
       required: false
       selector:
@@ -1165,7 +1165,7 @@ repairs_create:
       name: Severity
       description: >-
         The severity of the issue. This will be used to determine the
-        priority of the issue. If not set, "warning" will be used
+        priority of the issue. If not set, "warning" will be used.
       required: false
       selector:
         select: