Deprecate entities in Xbox integration (home-assistant#154891)

Author: tr4nt0r

homeassistant/components/xbox/binary_sensor.py

@@ -11,14 +11,15 @@
 from yarl import URL
 
 from homeassistant.components.binary_sensor import (
+    DOMAIN as BINARY_SENSOR_DOMAIN,
     BinarySensorEntity,
     BinarySensorEntityDescription,
 )
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from .coordinator import XboxConfigEntry, XboxUpdateCoordinator
-from .entity import XboxBaseEntity
+from .entity import XboxBaseEntity, check_deprecated_entity
 
 
 class XboxBinarySensor(StrEnum):
@@ -37,6 +38,7 @@ class XboxBinarySensorEntityDescription(BinarySensorEntityDescription):
 
     is_on_fn: Callable[[Person], bool | None]
     entity_picture_fn: Callable[[Person], str | None] | None = None
+    deprecated: bool | None = None
 
 
 def profile_pic(person: Person) -> str | None:
@@ -82,13 +84,8 @@ def in_game(person: Person) -> bool:
     ),
     XboxBinarySensorEntityDescription(
         key=XboxBinarySensor.IN_PARTY,
-        translation_key=XboxBinarySensor.IN_PARTY,
-        is_on_fn=(
-            lambda x: bool(x.multiplayer_summary.in_party)
-            if x.multiplayer_summary
-            else None
-        ),
-        entity_registry_enabled_default=False,
+        is_on_fn=lambda _: None,
+        deprecated=True,
     ),
     XboxBinarySensorEntityDescription(
         key=XboxBinarySensor.IN_GAME,
@@ -97,13 +94,8 @@ def in_game(person: Person) -> bool:
     ),
     XboxBinarySensorEntityDescription(
         key=XboxBinarySensor.IN_MULTIPLAYER,
-        translation_key=XboxBinarySensor.IN_MULTIPLAYER,
-        is_on_fn=(
-            lambda x: bool(x.multiplayer_summary.in_multiplayer_session)
-            if x.multiplayer_summary
-            else None
-        ),
-        entity_registry_enabled_default=False,
+        is_on_fn=lambda _: None,
+        deprecated=True,
     ),
     XboxBinarySensorEntityDescription(
         key=XboxBinarySensor.HAS_GAME_PASS,
@@ -121,7 +113,9 @@ async def async_setup_entry(
     """Set up Xbox Live friends."""
     coordinator = entry.runtime_data
 
-    update_friends = partial(async_update_friends, coordinator, {}, async_add_entities)
+    update_friends = partial(
+        async_update_friends, hass, coordinator, {}, async_add_entities
+    )
 
     entry.async_on_unload(coordinator.async_add_listener(update_friends))
 
@@ -152,6 +146,7 @@ def entity_picture(self) -> str | None:
 
 @callback
 def async_update_friends(
+    hass: HomeAssistant,
     coordinator: XboxUpdateCoordinator,
     current: dict[str, list[XboxBinarySensorEntity]],
     async_add_entities,
@@ -163,10 +158,11 @@ def async_update_friends(
     # Process new favorites, add them to Home Assistant
     new_entities: list[XboxBinarySensorEntity] = []
     for xuid in new_ids - current_ids:
-        current[xuid] = [
-            XboxBinarySensorEntity(coordinator, xuid, description)
-            for description in SENSOR_DESCRIPTIONS
-        ]
+        current[xuid] = []
+        for description in SENSOR_DESCRIPTIONS:
+            entity = XboxBinarySensorEntity(coordinator, xuid, description)
+            if check_deprecated_entity(hass, entity, BINARY_SENSOR_DOMAIN):
+                current[xuid].append(entity)
         new_entities = new_entities + current[xuid]
     if new_entities:
         async_add_entities(new_entities)

homeassistant/components/xbox/entity.py

@@ -4,6 +4,10 @@
 
 from xbox.webapi.api.provider.smartglass.models import ConsoleType, SmartglassConsole
 
+from homeassistant.components.automation import automations_with_entity
+from homeassistant.components.script import scripts_with_entity
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity import EntityDescription
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
@@ -83,3 +87,29 @@ def __init__(
     def data(self) -> ConsoleData:
         """Return coordinator data for this console."""
         return self.coordinator.data.consoles[self._console.id]
+
+
+def entity_used_in(hass: HomeAssistant, entity_id: str) -> list[str]:
+    """Get list of related automations and scripts."""
+    used_in = automations_with_entity(hass, entity_id)
+    used_in += scripts_with_entity(hass, entity_id)
+    return used_in
+
+
+def check_deprecated_entity(
+    hass: HomeAssistant,
+    entity: XboxBaseEntity,
+    entity_domain: str,
+) -> bool:
+    """Check for deprecated entity and remove it."""
+    if not getattr(entity.entity_description, "deprecated", False):
+        return True
+    ent_reg = er.async_get(hass)
+    if entity_id := ent_reg.async_get_entity_id(
+        entity_domain,
+        DOMAIN,
+        f"{entity.xuid}_{entity.entity_description.key}",
+    ):
+        ent_reg.async_remove(entity_id)
+
+    return False

homeassistant/components/xbox/icons.json

@@ -7,12 +7,6 @@
       "gamer_score": {
         "default": "mdi:alpha-g-circle"
       },
-      "account_tier": {
-        "default": "mdi:microsoft-xbox"
-      },
-      "gold_tenure": {
-        "default": "mdi:microsoft-xbox"
-      },
       "last_online": {
         "default": "mdi:account-clock"
       },
@@ -27,15 +21,9 @@
       "online": {
         "default": "mdi:account"
       },
-      "in_party": {
-        "default": "mdi:account-group"
-      },
       "in_game": {
         "default": "mdi:microsoft-xbox-controller"
       },
-      "in_multiplayer": {
-        "default": "mdi:account-multiple"
-      },
       "has_game_pass": {
         "default": "mdi:microsoft-xbox"
       }

homeassistant/components/xbox/sensor.py

@@ -11,6 +11,7 @@
 from xbox.webapi.api.provider.people.models import Person
 
 from homeassistant.components.sensor import (
+    DOMAIN as SENSOR_DOMAIN,
     SensorDeviceClass,
     SensorEntity,
     SensorEntityDescription,
@@ -20,7 +21,7 @@
 from homeassistant.helpers.typing import StateType
 
 from .coordinator import XboxConfigEntry, XboxUpdateCoordinator
-from .entity import XboxBaseEntity
+from .entity import XboxBaseEntity, check_deprecated_entity
 
 
 class XboxSensor(StrEnum):
@@ -40,6 +41,7 @@ class XboxSensorEntityDescription(SensorEntityDescription):
     """Xbox sensor description."""
 
     value_fn: Callable[[Person], StateType | datetime]
+    deprecated: bool | None = None
 
 
 SENSOR_DESCRIPTIONS: tuple[XboxSensorEntityDescription, ...] = (
@@ -55,15 +57,13 @@ class XboxSensorEntityDescription(SensorEntityDescription):
     ),
     XboxSensorEntityDescription(
         key=XboxSensor.ACCOUNT_TIER,
-        translation_key=XboxSensor.ACCOUNT_TIER,
-        entity_registry_enabled_default=False,
-        value_fn=lambda x: x.detail.account_tier if x.detail else None,
+        value_fn=lambda _: None,
+        deprecated=True,
     ),
     XboxSensorEntityDescription(
         key=XboxSensor.GOLD_TENURE,
-        translation_key=XboxSensor.GOLD_TENURE,
-        entity_registry_enabled_default=False,
-        value_fn=lambda x: x.detail.tenure if x.detail else None,
+        value_fn=lambda _: None,
+        deprecated=True,
     ),
     XboxSensorEntityDescription(
         key=XboxSensor.LAST_ONLINE,
@@ -96,7 +96,9 @@ async def async_setup_entry(
     """Set up Xbox Live friends."""
     coordinator = config_entry.runtime_data
 
-    update_friends = partial(async_update_friends, coordinator, {}, async_add_entities)
+    update_friends = partial(
+        async_update_friends, hass, coordinator, {}, async_add_entities
+    )
 
     config_entry.async_on_unload(coordinator.async_add_listener(update_friends))
     update_friends()
@@ -115,6 +117,7 @@ def native_value(self) -> StateType | datetime:
 
 @callback
 def async_update_friends(
+    hass: HomeAssistant,
     coordinator: XboxUpdateCoordinator,
     current: dict[str, list[XboxSensorEntity]],
     async_add_entities,
@@ -126,10 +129,11 @@ def async_update_friends(
     # Process new favorites, add them to Home Assistant
     new_entities: list[XboxSensorEntity] = []
     for xuid in new_ids - current_ids:
-        current[xuid] = [
-            XboxSensorEntity(coordinator, xuid, description)
-            for description in SENSOR_DESCRIPTIONS
-        ]
+        current[xuid] = []
+        for description in SENSOR_DESCRIPTIONS:
+            entity = XboxSensorEntity(coordinator, xuid, description)
+            if check_deprecated_entity(hass, entity, SENSOR_DOMAIN):
+                current[xuid].append(entity)
         new_entities = new_entities + current[xuid]
     if new_entities:
         async_add_entities(new_entities)

homeassistant/components/xbox/strings.json

@@ -37,12 +37,6 @@
         "name": "Gamerscore",
         "unit_of_measurement": "points"
       },
-      "account_tier": {
-        "name": "Account tier"
-      },
-      "gold_tenure": {
-        "name": "Gold tenure"
-      },
       "last_online": {
         "name": "Last online"
       },
@@ -56,15 +50,9 @@
       }
     },
     "binary_sensor": {
-      "in_party": {
-        "name": "In party"
-      },
       "in_game": {
         "name": "In game"
       },
-      "in_multiplayer": {
-        "name": "In multiplayer"
-      },
       "has_game_pass": {
         "name": "Subscribed to Xbox Game Pass"
       }