starred/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2026-09-28 02:18:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Resolve integration brand images before brand images (#182217)

Browse Source 
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Joost Lekkerkerker
2026-09-19 10:08:00 +02:00
committed by GitHub
co-authored by Claude Opus 5
parent d973cfea4d
commit 279b124671
2 changed files with 142 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
homeassistant/components/brands/__init__.py
+37 -20
View File
@@ -155,6 +155,29 @@ class _BrandsBaseView(HomeAssistantView):
return None
async def _get_image_data(
self,
cdn_path: str,
cache_subpath: str,
) -> bytes | None:
"""Read image data from the disk cache, fetching from CDN if needed."""
cache_path = self._cache_dir / cache_subpath
result = await self._hass.async_add_executor_job(
_read_cached_file_with_marker, cache_path
)
if result is None:
return await self._fetch_and_cache(cdn_path, cache_path)
data, mtime = result
# Schedule background refresh if stale
if time.time() - mtime > CACHE_TTL:
self._hass.async_create_background_task(
self._fetch_and_cache(cdn_path, cache_path),
f"brands_refresh_{cache_subpath}",
)
return data
async def _serve_from_cache_or_cdn(
self,
cdn_path: str,
@@ -163,24 +186,7 @@ class _BrandsBaseView(HomeAssistantView):
fallback_placeholder: bool = True,
) -> web.Response:
"""Serve from disk cache, fetching from CDN if needed."""
cache_path = self._cache_dir / cache_subpath
now = time.time()
# Try disk cache
result = await self._hass.async_add_executor_job(
_read_cached_file_with_marker, cache_path
)
if result is not None:
data, mtime = result
# Schedule background refresh if stale
if now - mtime > CACHE_TTL:
self._hass.async_create_background_task(
self._fetch_and_cache(cdn_path, cache_path),
f"brands_refresh_{cache_subpath}",
)
else:
# Cache miss - fetch from CDN
data = await self._fetch_and_cache(cdn_path, cache_path)
data = await self._get_image_data(cdn_path, cache_subpath)
if data is None:
if fallback_placeholder:
@@ -260,10 +266,21 @@ class BrandsIntegrationView(_BrandsBaseView):
) is not None:
return response
# 2. Try cache / CDN (always use direct path for proper 404 caching)
# 2. Try the integration image. Direct paths are used instead of the
# "_/" namespace so real 404s can be cached as markers.
if (
data := await self._get_image_data(
cdn_path=f"{domain}/{image}",
cache_subpath=f"integrations/{domain}/{image}",
)
) is not None:
return self._build_response(data)
# 3. Fall back to the brand image, which is cached separately so the
# integration 404 marker is preserved.
return await self._serve_from_cache_or_cdn(
cdn_path=f"brands/{domain}/{image}",
cache_subpath=f"integrations/{domain}/{image}",
cache_subpath=f"brands/{domain}/{image}",
fallback_placeholder=use_placeholder,
)
tests/components/brands/test_init.py
+105 -19
View File
@@ -26,6 +26,7 @@ from tests.test_util.aiohttp import AiohttpClientMocker
from tests.typing import ClientSessionGenerator, WebSocketGenerator
FAKE_PNG = b"\x89PNG\r\n\x1a\nfakeimagedata"
BRAND_PNG = b"\x89PNG\r\n\x1a\nfakebranddata"
@pytest.fixture(autouse=True)
@@ -73,7 +74,7 @@ async def test_integration_view_serves_from_cdn(
) -> None:
"""Test serving an integration brand image from the CDN."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/icon.png",
f"{BRANDS_CDN_URL}/hue/icon.png",
content=FAKE_PNG,
)
@@ -85,12 +86,68 @@ async def test_integration_view_serves_from_cdn(
assert await resp.read() == FAKE_PNG
async def test_integration_view_prefers_integration_over_brand(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that the integration image wins over a brand image of the same name."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/google/icon.png",
content=FAKE_PNG,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/google/icon.png",
content=BRAND_PNG,
)
client = await hass_client()
resp = await client.get("/api/brands/integration/google/icon.png")
assert resp.status == HTTPStatus.OK
assert await resp.read() == FAKE_PNG
assert aioclient_mock.call_count == 1
async def test_integration_view_falls_back_to_brand(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that a brand-only domain is served from the brand namespace."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/apple/icon.png",
status=HTTPStatus.NOT_FOUND,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/apple/icon.png",
content=BRAND_PNG,
)
client = await hass_client()
resp = await client.get("/api/brands/integration/apple/icon.png")
assert resp.status == HTTPStatus.OK
assert await resp.read() == BRAND_PNG
assert aioclient_mock.call_count == 2
# The integration 404 marker and the brand image are cached separately
resp = await client.get("/api/brands/integration/apple/icon.png")
assert resp.status == HTTPStatus.OK
assert await resp.read() == BRAND_PNG
assert aioclient_mock.call_count == 2
async def test_integration_view_default_placeholder_fallback(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that CDN 404 serves placeholder by default."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/nonexistent/icon.png",
status=HTTPStatus.NOT_FOUND,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/nonexistent/icon.png",
status=HTTPStatus.NOT_FOUND,
@@ -113,6 +170,10 @@ async def test_integration_view_no_placeholder(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that CDN 404 returns 404 when placeholder=no is set."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/nonexistent/icon.png",
status=HTTPStatus.NOT_FOUND,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/nonexistent/icon.png",
status=HTTPStatus.NOT_FOUND,
@@ -187,7 +248,7 @@ async def test_integration_view_all_allowed_images(
]
for image in allowed:
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/{image}",
f"{BRANDS_CDN_URL}/hue/{image}",
content=FAKE_PNG,
)
@@ -203,6 +264,10 @@ async def test_integration_view_cdn_error_returns_none(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that CDN connection errors result in 404 with placeholder=no."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/broken/icon.png",
exc=ClientError(),
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/broken/icon.png",
exc=ClientError(),
@@ -220,6 +285,10 @@ async def test_integration_view_cdn_unexpected_status(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that unexpected CDN status codes result in 404 with placeholder=no."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/broken/icon.png",
status=HTTPStatus.INTERNAL_SERVER_ERROR,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/broken/icon.png",
status=HTTPStatus.INTERNAL_SERVER_ERROR,
@@ -243,7 +312,7 @@ async def test_disk_cache_hit(
) -> None:
"""Test that a second request is served from disk cache."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/icon.png",
f"{BRANDS_CDN_URL}/hue/icon.png",
content=FAKE_PNG,
)
@@ -267,6 +336,10 @@ async def test_disk_cache_404_marker(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that 404s are cached as empty files."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/nothing/icon.png",
status=HTTPStatus.NOT_FOUND,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/nothing/icon.png",
status=HTTPStatus.NOT_FOUND,
@@ -274,15 +347,16 @@ async def test_disk_cache_404_marker(
client = await hass_client()
# First request: CDN returns 404, cached as empty file
# First request: CDN returns 404 for both namespaces, each cached as an
# empty file
resp = await client.get("/api/brands/integration/nothing/icon.png?placeholder=no")
assert resp.status == HTTPStatus.NOT_FOUND
assert aioclient_mock.call_count == 1
assert aioclient_mock.call_count == 2
# Second request: served from cached 404 marker
# Second request: served from cached 404 markers
resp = await client.get("/api/brands/integration/nothing/icon.png?placeholder=no")
assert resp.status == HTTPStatus.NOT_FOUND
assert aioclient_mock.call_count == 1 # No additional CDN call
assert aioclient_mock.call_count == 2 # No additional CDN call
async def test_stale_cache_triggers_background_refresh(
@@ -292,7 +366,7 @@ async def test_stale_cache_triggers_background_refresh(
) -> None:
"""Test that stale cache entries trigger background refresh."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/icon.png",
f"{BRANDS_CDN_URL}/hue/icon.png",
content=FAKE_PNG,
)
@@ -330,6 +404,10 @@ async def test_stale_cache_404_marker_with_placeholder(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that stale cached 404 serves placeholder by default."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/gone/icon.png",
status=HTTPStatus.NOT_FOUND,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/gone/icon.png",
status=HTTPStatus.NOT_FOUND,
@@ -344,7 +422,7 @@ async def test_stale_cache_404_marker_with_placeholder(
# First request caches the 404 (with placeholder=no)
resp = await client.get("/api/brands/integration/gone/icon.png?placeholder=no")
assert resp.status == HTTPStatus.NOT_FOUND
assert aioclient_mock.call_count == 1
assert aioclient_mock.call_count == 2
# Make the cache stale
cache_path = (
@@ -366,6 +444,10 @@ async def test_stale_cache_404_marker_no_placeholder(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that stale cached 404 with placeholder=no returns 404."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/gone/icon.png",
status=HTTPStatus.NOT_FOUND,
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/gone/icon.png",
status=HTTPStatus.NOT_FOUND,
@@ -376,7 +458,7 @@ async def test_stale_cache_404_marker_no_placeholder(
# First request caches the 404
resp = await client.get("/api/brands/integration/gone/icon.png?placeholder=no")
assert resp.status == HTTPStatus.NOT_FOUND
assert aioclient_mock.call_count == 1
assert aioclient_mock.call_count == 2
# Make the cache stale
cache_path = (
@@ -390,9 +472,9 @@ async def test_stale_cache_404_marker_no_placeholder(
resp = await client.get("/api/brands/integration/gone/icon.png?placeholder=no")
assert resp.status == HTTPStatus.NOT_FOUND
# Background refresh should have been triggered
# Background refresh should have been triggered for the stale marker
await hass.async_block_till_done()
assert aioclient_mock.call_count == 2
assert aioclient_mock.call_count == 3
# ------------------------------------------------------------------
@@ -435,7 +517,7 @@ async def test_custom_integration_no_brand_falls_through(
custom = _create_custom_integration(hass, "my_custom", has_branding=False)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/my_custom/icon.png",
f"{BRANDS_CDN_URL}/my_custom/icon.png",
content=FAKE_PNG,
)
@@ -463,7 +545,7 @@ async def test_custom_integration_brand_missing_file_falls_through(
brand_dir.mkdir(parents=True, exist_ok=True)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/my_custom/icon.png",
f"{BRANDS_CDN_URL}/my_custom/icon.png",
content=FAKE_PNG,
)
@@ -488,7 +570,7 @@ async def test_custom_integration_takes_priority_over_cache(
# Prime the CDN cache first
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/my_custom/icon.png",
f"{BRANDS_CDN_URL}/my_custom/icon.png",
content=FAKE_PNG,
)
@@ -672,7 +754,7 @@ async def test_custom_integration_no_fallback_match_falls_through_to_cdn(
# brand dir exists but is empty - no icon.png either
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/my_custom/icon.png",
f"{BRANDS_CDN_URL}/my_custom/icon.png",
content=FAKE_PNG,
)
@@ -757,6 +839,10 @@ async def test_cdn_timeout_returns_404(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""Test that CDN timeout results in 404 with placeholder=no."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/slow/icon.png",
exc=TimeoutError(),
)
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/slow/icon.png",
exc=TimeoutError(),
@@ -780,7 +866,7 @@ async def test_authenticated_request(
) -> None:
"""Test that authenticated requests succeed."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/icon.png",
f"{BRANDS_CDN_URL}/hue/icon.png",
content=FAKE_PNG,
)
@@ -797,7 +883,7 @@ async def test_token_query_param_authentication(
) -> None:
"""Test that a valid access token in query param authenticates."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/icon.png",
f"{BRANDS_CDN_URL}/hue/icon.png",
content=FAKE_PNG,
)
@@ -857,7 +943,7 @@ async def test_token_rotation(
) -> None:
"""Test that access tokens rotate over time."""
aioclient_mock.get(
f"{BRANDS_CDN_URL}/brands/hue/icon.png",
f"{BRANDS_CDN_URL}/hue/icon.png",
content=FAKE_PNG,
)