From 185aa025acb222f453dc77c837fbe5af69240a52 Mon Sep 17 00:00:00 2001
From: "J. Nick Koston" <nick@koston.org>
Date: Thu, 31 Mar 2022 02:28:19 -1000
Subject: [PATCH] Exclude large and chatty attributes from being recorded for
 update entities (#68940)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
---
 homeassistant/components/update/recorder.py | 12 +++++
 tests/components/update/test_recorder.py    | 55 +++++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 homeassistant/components/update/recorder.py
 create mode 100644 tests/components/update/test_recorder.py

diff --git a/homeassistant/components/update/recorder.py b/homeassistant/components/update/recorder.py
new file mode 100644
index 00000000000..cba4cab8ec2
--- /dev/null
+++ b/homeassistant/components/update/recorder.py
@@ -0,0 +1,12 @@
+"""Integration platform for recorder."""
+from __future__ import annotations
+
+from homeassistant.core import HomeAssistant, callback
+
+from . import ATTR_IN_PROGRESS, ATTR_RELEASE_SUMMARY
+
+
+@callback
+def exclude_attributes(hass: HomeAssistant) -> set[str]:
+    """Exclude large and chatty update attributes from being recorded in the database."""
+    return {ATTR_IN_PROGRESS, ATTR_RELEASE_SUMMARY}
diff --git a/tests/components/update/test_recorder.py b/tests/components/update/test_recorder.py
new file mode 100644
index 00000000000..17ab7445b4b
--- /dev/null
+++ b/tests/components/update/test_recorder.py
@@ -0,0 +1,55 @@
+"""The tests for update recorder."""
+from __future__ import annotations
+
+from datetime import timedelta
+
+from homeassistant.components.recorder.models import StateAttributes, States
+from homeassistant.components.recorder.util import session_scope
+from homeassistant.components.update.const import (
+    ATTR_CURRENT_VERSION,
+    ATTR_IN_PROGRESS,
+    ATTR_RELEASE_SUMMARY,
+    DOMAIN,
+)
+from homeassistant.const import CONF_PLATFORM
+from homeassistant.core import HomeAssistant, 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: HomeAssistant, enable_custom_integrations: None
+):
+    """Test update attributes to be excluded."""
+    await async_init_recorder_component(hass)
+    platform = getattr(hass.components, f"test.{DOMAIN}")
+    platform.init()
+    assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
+    await hass.async_block_till_done()
+    state = hass.states.get("update.update_already_in_progress")
+    assert state.attributes[ATTR_IN_PROGRESS] == 50
+    await async_setup_component(hass, DOMAIN, {})
+
+    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_IN_PROGRESS not in state.attributes
+        assert ATTR_RELEASE_SUMMARY not in state.attributes
+        assert ATTR_CURRENT_VERSION in state.attributes