Disable experimental conditions according to labs flag setting (home-assistant#157345)

Author: emontnemery

homeassistant/components/automation/__init__.py

@@ -117,6 +117,10 @@
 
 NEW_TRIGGERS_CONDITIONS_FEATURE_FLAG = "new_triggers_conditions"
 
+_EXPERIMENTAL_CONDITION_PLATFORMS = {
+    "light",
+}
+
 _EXPERIMENTAL_TRIGGER_PLATFORMS = {
     "alarm_control_panel",
     "assist_satellite",
@@ -131,6 +135,19 @@
 }
 
 
+@callback
+def is_disabled_experimental_condition(hass: HomeAssistant, platform: str) -> bool:
+    """Check if the platform is a disabled experimental condition platform."""
+    return (
+        platform in _EXPERIMENTAL_CONDITION_PLATFORMS
+        and not labs.async_is_preview_feature_enabled(
+            hass,
+            DOMAIN,
+            NEW_TRIGGERS_CONDITIONS_FEATURE_FLAG,
+        )
+    )
+
+
 @callback
 def is_disabled_experimental_trigger(hass: HomeAssistant, platform: str) -> bool:
     """Check if the platform is a disabled experimental trigger platform."""

homeassistant/helpers/condition.py

@@ -110,6 +110,9 @@
 CONDITION_DESCRIPTION_CACHE: HassKey[dict[str, dict[str, Any] | None]] = HassKey(
     "condition_description_cache"
 )
+CONDITION_DISABLED_CONDITIONS: HassKey[set[str]] = HassKey(
+    "condition_disabled_conditions"
+)
 CONDITION_PLATFORM_SUBSCRIPTIONS: HassKey[
     list[Callable[[set[str]], Coroutine[Any, Any, None]]]
 ] = HassKey("condition_platform_subscriptions")
@@ -151,9 +154,27 @@ def starts_with_dot(key: str) -> str:
 
 async def async_setup(hass: HomeAssistant) -> None:
     """Set up the condition helper."""
+    from homeassistant.components import automation, labs  # noqa: PLC0415
+
     hass.data[CONDITION_DESCRIPTION_CACHE] = {}
+    hass.data[CONDITION_DISABLED_CONDITIONS] = set()
     hass.data[CONDITION_PLATFORM_SUBSCRIPTIONS] = []
     hass.data[CONDITIONS] = {}
+
+    @callback
+    def new_triggers_conditions_listener() -> None:
+        """Handle new_triggers_conditions flag change."""
+        # Invalidate the cache
+        hass.data[CONDITION_DESCRIPTION_CACHE] = {}
+        hass.data[CONDITION_DISABLED_CONDITIONS] = set()
+
+    labs.async_listen(
+        hass,
+        automation.DOMAIN,
+        automation.NEW_TRIGGERS_CONDITIONS_FEATURE_FLAG,
+        new_triggers_conditions_listener,
+    )
+
     await async_process_integration_platforms(
         hass, "condition", _register_condition_platform, wait_for_platforms=True
     )
@@ -352,11 +373,21 @@ def wrapper(hass: HomeAssistant, variables: TemplateVarsType = None) -> bool | N
 async def _async_get_condition_platform(
     hass: HomeAssistant, condition_key: str
 ) -> tuple[str, ConditionProtocol | None]:
+    from homeassistant.components import automation  # noqa: PLC0415
+
     platform_and_sub_type = condition_key.split(".")
     platform: str | None = platform_and_sub_type[0]
     platform = _PLATFORM_ALIASES.get(platform, platform)
     if platform is None:
         return "", None
+
+    if automation.is_disabled_experimental_condition(hass, platform):
+        raise vol.Invalid(
+            f"Condition '{condition_key}' requires the experimental 'New triggers and "
+            "conditions' feature to be enabled in Home Assistant Labs settings "
+            f"(feature flag: '{automation.NEW_TRIGGERS_CONDITIONS_FEATURE_FLAG}')"
+        )
+
     try:
         integration = await async_get_integration(hass, platform)
     except IntegrationNotFound:
@@ -1209,6 +1240,8 @@ async def async_get_all_descriptions(
     hass: HomeAssistant,
 ) -> dict[str, dict[str, Any] | None]:
     """Return descriptions (i.e. user documentation) for all conditions."""
+    from homeassistant.components import automation  # noqa: PLC0415
+
     descriptions_cache = hass.data[CONDITION_DESCRIPTION_CACHE]
 
     conditions = hass.data[CONDITIONS]
@@ -1217,7 +1250,12 @@ async def async_get_all_descriptions(
     all_conditions = set(conditions)
     previous_all_conditions = set(descriptions_cache)
     # If the conditions are the same, we can return the cache
-    if previous_all_conditions == all_conditions:
+
+    # mypy complains: Invalid index type "HassKey[set[str]]" for "HassDict"
+    if (
+        previous_all_conditions | hass.data[CONDITION_DISABLED_CONDITIONS]  # type: ignore[index]
+        == all_conditions
+    ):
         return descriptions_cache
 
     # Files we loaded for missing descriptions
@@ -1257,6 +1295,9 @@ async def async_get_all_descriptions(
     new_descriptions_cache = descriptions_cache.copy()
     for missing_condition in missing_conditions:
         domain = conditions[missing_condition]
+        if automation.is_disabled_experimental_condition(hass, domain):
+            hass.data[CONDITION_DISABLED_CONDITIONS].add(missing_condition)
+            continue
 
         if (
             yaml_description := new_conditions_descriptions.get(domain, {}).get(

tests/components/light/test_condition.py

@@ -1,9 +1,13 @@
 """Test light conditions."""
 
+from collections.abc import Generator
+from unittest.mock import patch
+
 import pytest
 
 from homeassistant.components import automation
 from homeassistant.const import (
+    ATTR_LABEL_ID,
     CONF_CONDITION,
     CONF_OPTIONS,
     CONF_TARGET,
@@ -83,6 +87,39 @@ async def has_call_after_trigger(
     return has_calls
 
 
+@pytest.fixture(name="enable_experimental_triggers_conditions")
+def enable_experimental_triggers_conditions() -> Generator[None]:
+    """Enable experimental triggers and conditions."""
+    with patch(
+        "homeassistant.components.labs.async_is_preview_feature_enabled",
+        return_value=True,
+    ):
+        yield
+
+
+@pytest.mark.parametrize(
+    "condition",
+    [
+        "light.is_off",
+        "light.is_on",
+    ],
+)
+async def test_light_conditions_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str
+) -> None:
+    """Test the light conditions are gated by the labs flag."""
+    await setup_automation_with_light_condition(
+        hass, condition=condition, target={ATTR_LABEL_ID: "test_label"}, behavior="any"
+    )
+    assert (
+        "Unnamed automation failed to setup conditions and has been disabled: "
+        f"Condition '{condition}' requires the experimental 'New triggers and "
+        "conditions' feature to be enabled in Home Assistant Labs settings "
+        "(feature flag: 'new_triggers_conditions')"
+    ) in caplog.text
+
+
+@pytest.mark.usefixtures("enable_experimental_triggers_conditions")
 @pytest.mark.parametrize(
     ("condition_target_config", "entity_id", "entities_in_target"),
     parametrize_target_entities("light"),
@@ -166,6 +203,7 @@ async def test_light_state_condition_behavior_any(
         assert not await has_call_after_trigger(hass, service_calls)
 
 
+@pytest.mark.usefixtures("enable_experimental_triggers_conditions")
 @pytest.mark.parametrize(
     ("condition_target_config", "entity_id", "entities_in_target"),
     parametrize_target_entities("light"),