WIP on repair

andrew-codechimp · andrew-codechimp · commit f80413429fb7 · 2025-08-06T21:05:15.000Z
diff --git a/custom_components/calendar_event/__init__.py b/custom_components/calendar_event/__init__.py
@@ -14,11 +14,17 @@
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.helper_integration import async_handle_source_entity_changes
+from homeassistant.helpers.issue_registry import (
+    IssueSeverity,
+    async_create_issue,
+    async_delete_issue,
+)
 from homeassistant.helpers.typing import ConfigType
 
 from .const import (
     CONF_CALENDAR_ENTITY_ID,
     DOMAIN,
+    ISSUE_MISSING_CALENDAR_ENTITY,
     LOGGER,
     MIN_HA_VERSION,
     PLATFORMS,
@@ -49,31 +55,69 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up calendar_event from a config entry."""
 
     entity_registry = er.async_get(hass)
-    try:
-        entity_id = er.async_validate_entity_id(  # noqa: F841
-            entity_registry, entry.options[CONF_CALENDAR_ENTITY_ID]
+
+    # try:
+    #     entity_id = er.async_validate_entity_id(  # noqa: F841
+    #         entity_registry, entry.options[CONF_CALENDAR_ENTITY_ID]
+
+    if (
+        calendar_entity := entity_registry.entities.get_entry(
+            entry.options[CONF_CALENDAR_ENTITY_ID]
         )
-    except vol.Invalid:
-        # The entity is identified by an unknown entity registry ID
-        LOGGER.error(
-            "Failed to setup calender_event for unknown entity %s",
-            entry.options[CONF_CALENDAR_ENTITY_ID],
+    ) is None:
+        async_create_issue(
+            hass,
+            DOMAIN,
+            f"{ISSUE_MISSING_CALENDAR_ENTITY}_{entry.options[CONF_CALENDAR_ENTITY_ID]}",
+            is_fixable=True,
+            severity=IssueSeverity.ERROR,
+            translation_key="missing_calendar_entity",
+            translation_placeholders={
+                "calendar_entity": entry.options[CONF_CALENDAR_ENTITY_ID],
+                "entry_title": entry.title or "Calendar Event",
+            },
+            data={"entry_id": entry.entry_id},
         )
+
         return False
 
+    # Clean up any existing repair issues since the entity is now valid
+    async_delete_issue(
+        hass, DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{entry.entry_id}"
+    )
+
     def set_source_entity_id_or_uuid(source_entity_id: str) -> None:
         hass.config_entries.async_update_entry(
             entry,
             options={**entry.options, CONF_CALENDAR_ENTITY_ID: source_entity_id},
         )
+        # Clean up repair issue when entity is updated
+        async_delete_issue(
+            hass, DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{entry.entry_id}"
+        )
 
     async def source_entity_removed() -> None:
         # The source entity has been removed.
         LOGGER.error(
-            "Failed to setup calender_event for unknown entity %s",
+            "Failed to setup calendar_event for unknown entity %s",
             entry.options[CONF_CALENDAR_ENTITY_ID],
         )
 
+        # Create a repair issue for the removed calendar entity
+        async_create_issue(
+            hass,
+            DOMAIN,
+            f"{ISSUE_MISSING_CALENDAR_ENTITY}_{entry.entry_id}",
+            is_fixable=True,
+            severity=IssueSeverity.ERROR,
+            translation_key="missing_calendar_entity",
+            translation_placeholders={
+                "calendar_entity": entry.options[CONF_CALENDAR_ENTITY_ID],
+                "entry_title": entry.title or "Calendar Event",
+            },
+            data={"entry_id": entry.entry_id},
+        )
+
     entry.async_on_unload(
         async_handle_source_entity_changes(
             hass,
@@ -99,4 +143,10 @@ async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry)
 
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
+
+    # Clean up any repair issues when unloading the entry
+    async_delete_issue(
+        hass, DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{entry.entry_id}"
+    )
+
     return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
diff --git a/custom_components/calendar_event/repairs.py b/custom_components/calendar_event/repairs.py
@@ -0,0 +1,77 @@
+"""Repairs for calendar_event integration."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, cast
+
+import voluptuous as vol
+from homeassistant import data_entry_flow
+from homeassistant.components.repairs import RepairsFlow
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import selector
+from homeassistant.helpers.issue_registry import async_delete_issue
+
+from .const import CONF_CALENDAR_ENTITY_ID, DOMAIN, ISSUE_MISSING_CALENDAR_ENTITY
+
+if TYPE_CHECKING:
+    from homeassistant.config_entries import ConfigEntry
+
+
+class CalendarEntityMissingRepairFlow(RepairsFlow):
+    """Handler for calendar entity missing repair flow."""
+
+    def __init__(self, entry: ConfigEntry) -> None:
+        """Initialize the repair flow."""
+        super().__init__()
+        self.entry = entry
+
+    async def async_step_confirm(
+        self, user_input: dict[str, str] | None = None
+    ) -> data_entry_flow.FlowResult:
+        """Handle the confirm step of the repair flow."""
+        if user_input is not None:
+            # Update the config entry with the new calendar entity
+            new_options = {**self.entry.options}
+            new_options[CONF_CALENDAR_ENTITY_ID] = user_input[CONF_CALENDAR_ENTITY_ID]
+            
+            self.hass.config_entries.async_update_entry(
+                self.entry, options=new_options
+            )
+            
+            # Clean up the repair issue since it's now fixed
+            async_delete_issue(
+                self.hass, DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{self.entry.entry_id}"
+            )
+            
+            return self.async_create_entry(data={})
+
+        return self.async_show_form(
+            step_id="confirm",
+            data_schema=vol.Schema({
+                vol.Required(CONF_CALENDAR_ENTITY_ID): selector.EntitySelector(
+                    selector.EntitySelectorConfig(domain="calendar")
+                ),
+            }),
+            description_placeholders={
+                "calendar_entity": self.entry.options[CONF_CALENDAR_ENTITY_ID],
+                "entry_title": self.entry.title or "Calendar Event",
+            },
+        )
+
+
+async def async_create_fix_flow(
+    hass: HomeAssistant,
+    issue_id: str,
+    data: dict[str, str | int | float | None] | None,
+) -> RepairsFlow:
+    """Create flow."""
+    if data and (entry_id := data.get("entry_id")):
+        entry_id = cast(str, entry_id)
+        entry = hass.config_entries.async_get_entry(entry_id)
+        if entry:
+            return CalendarEntityMissingRepairFlow(entry)
+
+    # Fallback to a basic confirm flow if entry not found
+    from homeassistant.components.repairs.issue_handler import ConfirmRepairFlow
+
+    return ConfirmRepairFlow()
diff --git a/custom_components/calendar_event/translations/en.json b/custom_components/calendar_event/translations/en.json
@@ -35,7 +35,7 @@
     "issues": {
         "missing_calendar_entity": {
             "title": "Calendar entity missing for {entry_title}",
-            "description": "The calendar entity `{calendar_entity}` is no longer available. Please update the configuration to select a different calendar entity.",
+            "description": "The calendar entity `{calendar_entity}` is no longer available. Please select a new calendar entity to continue using this Calendar Event helper.",
             "fix_flow": {
                 "step": {
                     "confirm": {
diff --git a/tests/test_repairs.py b/tests/test_repairs.py
@@ -0,0 +1,76 @@
+"""Test repairs for calendar_event integration."""
+
+from __future__ import annotations
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import issue_registry as ir
+from pytest_homeassistant_custom_component.common import MockConfigEntry
+
+from custom_components.calendar_event.const import DOMAIN, ISSUE_MISSING_CALENDAR_ENTITY
+
+
+async def test_repair_issue_created_for_missing_calendar_entity(
+    hass: HomeAssistant,
+) -> None:
+    """Test that a repair issue is created when calendar entity is missing."""
+    
+    # Create a config entry with a non-existent calendar entity
+    config_entry = MockConfigEntry(
+        domain=DOMAIN,
+        options={
+            "calendar_entity_id": "calendar.nonexistent", 
+            "summary": "test"
+        },
+        title="Test Calendar Event",
+    )
+    config_entry.add_to_hass(hass)
+    
+    # Setup should fail and create a repair issue
+    assert not await hass.config_entries.async_setup(config_entry.entry_id)
+    
+    # Check that a repair issue was created
+    issue_registry = ir.async_get(hass)
+    issue = issue_registry.async_get_issue(
+        DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{config_entry.entry_id}"
+    )
+    
+    assert issue is not None
+    assert issue.translation_key == "missing_calendar_entity"
+    assert issue.is_fixable is True
+    assert issue.severity == ir.IssueSeverity.ERROR
+
+
+async def test_repair_issue_cleaned_up_when_entry_unloaded(
+    hass: HomeAssistant,
+) -> None:
+    """Test that repair issues are cleaned up when config entry is unloaded."""
+    
+    # Create a config entry with a non-existent calendar entity
+    config_entry = MockConfigEntry(
+        domain=DOMAIN,
+        options={
+            "calendar_entity_id": "calendar.nonexistent", 
+            "summary": "test"
+        },
+        title="Test Calendar Event",
+    )
+    config_entry.add_to_hass(hass)
+    
+    # Setup should fail and create a repair issue
+    assert not await hass.config_entries.async_setup(config_entry.entry_id)
+    
+    # Verify repair issue exists
+    issue_registry = ir.async_get(hass)
+    issue = issue_registry.async_get_issue(
+        DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{config_entry.entry_id}"
+    )
+    assert issue is not None
+    
+    # Remove the config entry
+    await hass.config_entries.async_remove(config_entry.entry_id)
+    
+    # Verify repair issue is cleaned up
+    issue = issue_registry.async_get_issue(
+        DOMAIN, f"{ISSUE_MISSING_CALENDAR_ENTITY}_{config_entry.entry_id}"
+    )
+    assert issue is None
