cleanup

Author: bdraco

homeassistant/components/doorbird/device.py

@@ -102,23 +102,23 @@ def token(self) -> str:
         """Get token for device."""
         return self._token
 
+    def _get_hass_url(self) -> str:
+        """Get the Home Assistant URL for this device."""
+        if custom_url := self.custom_url:
+            return custom_url
+        return get_url(self._hass, prefer_external=False)
+
     async def async_register_events(self) -> None:
         """Register events on device."""
         if not self.door_station_events:
             # The config entry might not have any events configured yet
             return
-        # Override url if another is specified in the configuration
-        if custom_url := self.custom_url:
-            hass_url = custom_url
-        else:
-            # Get the URL of this server
-            hass_url = get_url(self._hass, prefer_external=False)
-        http_fav = await self._async_register_events(hass_url)
-        event_config = await self._async_get_event_config(http_fav, hass_url)
+        http_fav = await self._async_register_events()
+        event_config = await self._async_get_event_config(http_fav)
         _LOGGER.debug("%s: Event config: %s", self.name, event_config)
         if event_config.unconfigured_favorites:
             await self._configure_unconfigured_favorites(event_config)
-            event_config = await self._async_get_event_config(http_fav, hass_url)
+            event_config = await self._async_get_event_config(http_fav)
         self.event_descriptions = event_config.events
 
     async def _configure_unconfigured_favorites(
@@ -150,8 +150,9 @@ async def _configure_unconfigured_favorites(
                         code,
                     )
 
-    async def _async_register_events(self, hass_url: str) -> dict[str, Any]:
+    async def _async_register_events(self) -> dict[str, Any]:
         """Register events on device."""
+        hass_url = self._get_hass_url()
         http_fav = await self._async_get_http_favorites()
         if any(
             # Note that a list comp is used here to ensure all
@@ -167,7 +168,7 @@ async def _async_register_events(self, hass_url: str) -> dict[str, Any]:
         return http_fav
 
     async def _async_get_event_config(
-        self, http_fav: dict[str, dict[str, Any]], hass_url: str
+        self, http_fav: dict[str, dict[str, Any]]
     ) -> DoorbirdEventConfig:
         """Get events and unconfigured favorites from http favorites."""
         device = self.device
@@ -190,6 +191,7 @@ async def _async_get_event_config(
             self._get_event_name(event): event_type
             for event, event_type in DEFAULT_EVENT_TYPES
         }
+        hass_url = self._get_hass_url()
         for identifier, data in http_fav.items():
             title: str | None = data.get("title")
             if not title or not title.startswith("Home Assistant"):

tests/components/doorbird/test_device.py

@@ -3,15 +3,24 @@
 from copy import deepcopy
 from http import HTTPStatus
 from typing import Any
+from unittest.mock import patch
 
 from doorbirdpy import DoorBirdScheduleEntry
 import pytest
 
-from homeassistant.components.doorbird.const import CONF_EVENTS
+from homeassistant.components.doorbird.const import (
+    CONF_EVENTS,
+    DEFAULT_DOORBELL_EVENT,
+    DEFAULT_MOTION_EVENT,
+    DOMAIN,
+)
 from homeassistant.core import HomeAssistant
 
+from . import VALID_CONFIG, get_mock_doorbird_api
 from .conftest import DoorbirdMockerType
 
+from tests.common import MockConfigEntry
+
 
 @pytest.fixture
 def doorbird_favorites_with_stale() -> dict[str, dict[str, Any]]:
@@ -95,6 +104,54 @@ async def test_stale_favorites_filtered_by_url(
     assert len(event_entities) == 2
 
 
+async def test_custom_url_used_for_favorites(
+    hass: HomeAssistant,
+    doorbird_info: dict[str, Any],
+    doorbird_schedule: list[DoorBirdScheduleEntry],
+) -> None:
+    """Test that custom URL override is used instead of get_url."""
+    custom_url = "https://my-custom-url.example.com:8443"
+    favorites = {
+        "http": {
+            "1": {
+                "title": "Home Assistant (mydoorbird_doorbell)",
+                "value": f"{custom_url}/api/doorbird/mydoorbird_doorbell?token=test-token",
+            },
+            "2": {
+                "title": "Home Assistant (mydoorbird_motion)",
+                "value": f"{custom_url}/api/doorbird/mydoorbird_motion?token=test-token",
+            },
+        }
+    }
+    config_with_custom_url = {
+        **VALID_CONFIG,
+        "hass_url_override": custom_url,
+    }
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        unique_id="1CCAE3AAAAAA",
+        data=config_with_custom_url,
+        options={CONF_EVENTS: [DEFAULT_DOORBELL_EVENT, DEFAULT_MOTION_EVENT]},
+    )
+    api = get_mock_doorbird_api(
+        info=doorbird_info,
+        schedule=doorbird_schedule,
+        favorites=favorites,
+    )
+    entry.add_to_hass(hass)
+    # Don't patch get_url - we want to verify custom_url takes precedence
+    with patch(
+        "homeassistant.components.doorbird.DoorBird",
+        return_value=api,
+    ):
+        await hass.config_entries.async_setup(entry.entry_id)
+        await hass.async_block_till_done()
+
+    # Should have 2 event entities using the custom URL
+    event_entities = hass.states.async_all("event")
+    assert len(event_entities) == 2
+
+
 async def test_no_configured_events(
     hass: HomeAssistant,
     doorbird_mocker: DoorbirdMockerType,