diff --git a/homeassistant/components/media_player/recorder.py b/homeassistant/components/media_player/recorder.py new file mode 100644 index 00000000000..66bd61c72cd --- /dev/null +++ b/homeassistant/components/media_player/recorder.py @@ -0,0 +1,13 @@ +"""Integration platform for recorder.""" +from __future__ import annotations + +from homeassistant.const import ATTR_ENTITY_PICTURE +from homeassistant.core import HomeAssistant, callback + +from . import ATTR_INPUT_SOURCE_LIST, ATTR_SOUND_MODE_LIST + + +@callback +def exclude_attributes(hass: HomeAssistant) -> set[str]: + """Exclude static and token attributes from being recorded in the database.""" + return {ATTR_SOUND_MODE_LIST, ATTR_ENTITY_PICTURE, ATTR_INPUT_SOURCE_LIST} diff --git a/tests/components/media_player/test_recorder.py b/tests/components/media_player/test_recorder.py new file mode 100644 index 00000000000..9532fe75cd0 --- /dev/null +++ b/tests/components/media_player/test_recorder.py @@ -0,0 +1,48 @@ +"""The tests for media_player recorder.""" +from __future__ import annotations + +from datetime import timedelta + +from homeassistant.components import media_player +from homeassistant.components.media_player.const import ( + ATTR_INPUT_SOURCE_LIST, + ATTR_SOUND_MODE_LIST, +) +from homeassistant.components.recorder.models import StateAttributes, States +from homeassistant.components.recorder.util import session_scope +from homeassistant.const import ATTR_ENTITY_PICTURE, ATTR_FRIENDLY_NAME +from homeassistant.core import State +from homeassistant.setup import async_setup_component +from homeassistant.util import dt as dt_util + +from tests.common import async_fire_time_changed, async_init_recorder_component +from tests.components.recorder.common import async_wait_recording_done_without_instance + + +async def test_exclude_attributes(hass): + """Test media_player registered attributes to be excluded.""" + await async_init_recorder_component(hass) + await async_setup_component( + hass, media_player.DOMAIN, {media_player.DOMAIN: {"platform": "demo"}} + ) + await hass.async_block_till_done() + async_fire_time_changed(hass, dt_util.utcnow() + timedelta(minutes=5)) + await hass.async_block_till_done() + await async_wait_recording_done_without_instance(hass) + + def _fetch_states() -> list[State]: + with session_scope(hass=hass) as session: + native_states = [] + for db_state, db_state_attributes in session.query(States, StateAttributes): + state = db_state.to_native() + state.attributes = db_state_attributes.to_native() + native_states.append(state) + return native_states + + states: list[State] = await hass.async_add_executor_job(_fetch_states) + assert len(states) > 1 + for state in states: + assert ATTR_SOUND_MODE_LIST not in state.attributes + assert ATTR_ENTITY_PICTURE not in state.attributes + assert ATTR_INPUT_SOURCE_LIST not in state.attributes + assert ATTR_FRIENDLY_NAME in state.attributes