evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rework recorder filters to avoid caching mistakes (#90419)

Browse source
This commit is contained in:
J. Nick Koston 2023-03-28 10:51:46 -10:00 • committed by GitHub
parent 93e1cd8dd8
commit 0550b17d54
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 68 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
homeassistant/components/recorder/filters.py
View file

@ -63,42 +63,53 @@ def merge_include_exclude_filters(
def sqlalchemy_filter_from_include_exclude_conf(conf: ConfigType) -> Filters | None: def sqlalchemy_filter_from_include_exclude_conf(conf: ConfigType) -> Filters | None:
"""Build a sql filter from config.""" """Build a sql filter from config."""
filters = Filters() exclude = conf.get(CONF_EXCLUDE, {})
if exclude := conf.get(CONF_EXCLUDE): include = conf.get(CONF_INCLUDE, {})
filters.excluded_entities = exclude.get(CONF_ENTITIES, []) filters = Filters(
filters.excluded_domains = exclude.get(CONF_DOMAINS, []) excluded_entities=exclude.get(CONF_ENTITIES, []),
filters.excluded_entity_globs = exclude.get(CONF_ENTITY_GLOBS, []) excluded_domains=exclude.get(CONF_DOMAINS, []),
if include := conf.get(CONF_INCLUDE): excluded_entity_globs=exclude.get(CONF_ENTITY_GLOBS, []),
filters.included_entities = include.get(CONF_ENTITIES, []) included_entities=include.get(CONF_ENTITIES, []),
filters.included_domains = include.get(CONF_DOMAINS, []) included_domains=include.get(CONF_DOMAINS, []),
filters.included_entity_globs = include.get(CONF_ENTITY_GLOBS, []) included_entity_globs=include.get(CONF_ENTITY_GLOBS, []),
)
return filters if filters.has_config else None return filters if filters.has_config else None
class Filters: class Filters:
"""Container for the configured include and exclude filters.""" """Container for the configured include and exclude filters.
def __init__(self) -> None: A filter must never change after it is created since it is used in a
cache key.
"""
def __init__(
self,
excluded_entities: Collection[str] | None = None,
excluded_domains: Collection[str] | None = None,
excluded_entity_globs: Collection[str] | None = None,
included_entities: Collection[str] | None = None,
included_domains: Collection[str] | None = None,
included_entity_globs: Collection[str] | None = None,
) -> None:
"""Initialise the include and exclude filters.""" """Initialise the include and exclude filters."""
self.excluded_entities: Collection[str] = [] self._excluded_entities = excluded_entities or []
self.excluded_domains: Collection[str] = [] self._excluded_domains = excluded_domains or []
self.excluded_entity_globs: Collection[str] = [] self._excluded_entity_globs = excluded_entity_globs or []
self._included_entities = included_entities or []
self.included_entities: Collection[str] = [] self._included_domains = included_domains or []
self.included_domains: Collection[str] = [] self._included_entity_globs = included_entity_globs or []
self.included_entity_globs: Collection[str] = []
def __repr__(self) -> str: def __repr__(self) -> str:
"""Return human readable excludes/includes.""" """Return human readable excludes/includes."""
return ( return (
"<Filters" "<Filters"
f" excluded_entities={self.excluded_entities}" f" excluded_entities={self._excluded_entities}"
f" excluded_domains={self.excluded_domains}" f" excluded_domains={self._excluded_domains}"
f" excluded_entity_globs={self.excluded_entity_globs}" f" excluded_entity_globs={self._excluded_entity_globs}"
f" included_entities={self.included_entities}" f" included_entities={self._included_entities}"
f" included_domains={self.included_domains}" f" included_domains={self._included_domains}"
f" included_entity_globs={self.included_entity_globs}" f" included_entity_globs={self._included_entity_globs}"
">" ">"
) )
@ -110,17 +121,17 @@ class Filters:
@property @property
def _have_exclude(self) -> bool: def _have_exclude(self) -> bool:
return bool( return bool(
self.excluded_entities self._excluded_entities
or self.excluded_domains or self._excluded_domains
or self.excluded_entity_globs or self._excluded_entity_globs
) )
@property @property
def _have_include(self) -> bool: def _have_include(self) -> bool:
return bool( return bool(
self.included_entities self._included_entities
or self.included_domains or self._included_domains
or self.included_entity_globs or self._included_entity_globs
) )
def _generate_filter_for_columns( def _generate_filter_for_columns(
@ -130,14 +141,14 @@ class Filters:
This must match exactly how homeassistant.helpers.entityfilter works. This must match exactly how homeassistant.helpers.entityfilter works.
""" """
i_domains = _domain_matcher(self.included_domains, columns, encoder) i_domains = _domain_matcher(self._included_domains, columns, encoder)
i_entities = _entity_matcher(self.included_entities, columns, encoder) i_entities = _entity_matcher(self._included_entities, columns, encoder)
i_entity_globs = _globs_to_like(self.included_entity_globs, columns, encoder) i_entity_globs = _globs_to_like(self._included_entity_globs, columns, encoder)
includes = [i_domains, i_entities, i_entity_globs] includes = [i_domains, i_entities, i_entity_globs]
e_domains = _domain_matcher(self.excluded_domains, columns, encoder) e_domains = _domain_matcher(self._excluded_domains, columns, encoder)
e_entities = _entity_matcher(self.excluded_entities, columns, encoder) e_entities = _entity_matcher(self._excluded_entities, columns, encoder)
e_entity_globs = _globs_to_like(self.excluded_entity_globs, columns, encoder) e_entity_globs = _globs_to_like(self._excluded_entity_globs, columns, encoder)
excludes = [e_domains, e_entities, e_entity_globs] excludes = [e_domains, e_entities, e_entity_globs]
have_exclude = self._have_exclude have_exclude = self._have_exclude
@ -173,7 +184,7 @@ class Filters:
# - Otherwise, entity matches glob exclude: exclude # - Otherwise, entity matches glob exclude: exclude
# - Otherwise, entity matches domain include: include # - Otherwise, entity matches domain include: include
# - Otherwise: exclude # - Otherwise: exclude
if self.included_domains or self.included_entity_globs: if self._included_domains or self._included_entity_globs:
return or_( return or_(
i_entities, i_entities,
# https://github.com/sqlalchemy/sqlalchemy/issues/9190 # https://github.com/sqlalchemy/sqlalchemy/issues/9190
@ -187,7 +198,7 @@ class Filters:
# - Otherwise, entity matches glob exclude: exclude # - Otherwise, entity matches glob exclude: exclude
# - Otherwise, entity matches domain exclude: exclude # - Otherwise, entity matches domain exclude: exclude
# - Otherwise: include # - Otherwise: include
if self.excluded_domains or self.excluded_entity_globs: if self._excluded_domains or self._excluded_entity_globs:
return (not_(or_(*excludes)) | i_entities).self_group() # type: ignore[no-any-return, no-untyped-call] return (not_(or_(*excludes)) | i_entities).self_group() # type: ignore[no-any-return, no-untyped-call]
# Case 6 - No Domain and/or glob includes or excludes # Case 6 - No Domain and/or glob includes or excludes

19
tests/components/history/test_init.py
View file

@ -545,16 +545,15 @@ def test_get_significant_states_only(hass_history) -> None:
def check_significant_states(hass, zero, four, states, config): def check_significant_states(hass, zero, four, states, config):
"""Check if significant states are retrieved.""" """Check if significant states are retrieved."""
filters = history.Filters() domain_config = config[history.DOMAIN]
exclude = config[history.DOMAIN].get(CONF_EXCLUDE) exclude = domain_config.get(CONF_EXCLUDE, {})
if exclude: include = domain_config.get(CONF_INCLUDE, {})
filters.excluded_entities = exclude.get(CONF_ENTITIES, []) filters = history.Filters(
filters.excluded_domains = exclude.get(CONF_DOMAINS, []) excluded_entities=exclude.get(CONF_ENTITIES, []),
include = config[history.DOMAIN].get(CONF_INCLUDE) excluded_domains=exclude.get(CONF_DOMAINS, []),
if include: included_entities=include.get(CONF_ENTITIES, []),
filters.included_entities = include.get(CONF_ENTITIES, []) included_domains=include.get(CONF_DOMAINS, []),
filters.included_domains = include.get(CONF_DOMAINS, []) )
hist = get_significant_states(hass, zero, four, filters=filters) hist = get_significant_states(hass, zero, four, filters=filters)
assert_dict_of_states_equal_without_context_and_last_changed(states, hist) assert_dict_of_states_equal_without_context_and_last_changed(states, hist)

19
tests/components/history/test_init_db_schema_30.py
View file

@ -600,16 +600,15 @@ def test_get_significant_states_only(legacy_hass_history) -> None:
def check_significant_states(hass, zero, four, states, config): def check_significant_states(hass, zero, four, states, config):
"""Check if significant states are retrieved.""" """Check if significant states are retrieved."""
filters = history.Filters() domain_config = config[history.DOMAIN]
exclude = config[history.DOMAIN].get(CONF_EXCLUDE) exclude = domain_config.get(CONF_EXCLUDE, {})
if exclude: include = domain_config.get(CONF_INCLUDE, {})
filters.excluded_entities = exclude.get(CONF_ENTITIES, []) filters = history.Filters(
filters.excluded_domains = exclude.get(CONF_DOMAINS, []) excluded_entities=exclude.get(CONF_ENTITIES, []),
include = config[history.DOMAIN].get(CONF_INCLUDE) excluded_domains=exclude.get(CONF_DOMAINS, []),
if include: included_entities=include.get(CONF_ENTITIES, []),
filters.included_entities = include.get(CONF_ENTITIES, []) included_domains=include.get(CONF_DOMAINS, []),
filters.included_domains = include.get(CONF_DOMAINS, []) )
hist = get_significant_states(hass, zero, four, filters=filters) hist = get_significant_states(hass, zero, four, filters=filters)
assert_dict_of_states_equal_without_context_and_last_changed(states, hist) assert_dict_of_states_equal_without_context_and_last_changed(states, hist)