fix(discovery): a sweep that could not run is not an answer (t62 F1)

The installed-apps sweep stamped an EMPTY answer on every failure path, so a
Shield that was asleep at the entity's startup sweep was cached as "0 apps" for
APP_LIST_TTL (6 h): `homeassistant.update_entity` then issued zero shells and
the sensor kept reporting 0/"pending" until the TTL or the Configure row's
force. A genuinely empty device was indistinguishable from it, so "ok" was
unreachable for an empty list.

Only a sweep that RAN stamps the cache now. Every failure records the outcome
as `unknown` (`_apps_unavailable`), stores no table, and is retried by the next
non-forced refresh; a sweep that reached the device and failed is spaced by
APP_SWEEP_RETRY_SECONDS (30 s, force=True bypasses) so a silent socket is not
hammered once per poll, while an unavailable transport costs nothing and is
retried immediately. `installed_apps_status` exposes ok/unknown/pending, the
sensor surfaces it, and "ok" + an empty table is now the honest empty answer.
Docstrings, the README vocabulary and the docs on what a refresh actually
re-runs are corrected; the "update_entity re-runs only without a fresh table,
the Configure row forces one" wording stays true.

Red proof (pre-fix sources, current tests): the five new/updated tests fail on
HEAD, e.g. `installed_apps_stale` is False after the ADB-down startup sweep, and
the sensor reports 'pending' where it must say 'unknown'.

Same class already fixed for app labels: a fetch that could not run is not an
answer. Also records that the `-3`/resolve-activity/pm-dump output shapes are
documented, not observed.
This commit is contained in:
engineer committed 2026-10-12 08:19:10 +01:00
1 parent ef42682250
commit c05e6fa929
4 files changed
+217 -43

No files matched your search

+34 -15
View File
@@ -167,10 +167,14 @@ class NvidiaShieldAppsSensor(NvidiaShieldSensorBase):
Only ADB-enabled entries get one. Discovery is a handful of shells, so it
runs once when the entity is added and then only when the table has gone
stale: ``async_update`` goes through the manager's TTL cache, so a poll on a
fresh table issues NO shell. On top of that the user can ask for a refresh
with the standard ``homeassistant.update_entity`` action, and the Configure
page runs the same sweep from its discovery row. With ADB off, or
unreachable, the attributes say why and the state is 0 rather than raising.
fresh table issues NO shell. A sweep that could not run is NOT an answer
(t62 F1): it is recorded as ``unknown`` and retried on the next update
instead of being frozen as a stamped-empty table for APP_LIST_TTL, while a
sweep that ran and found nothing IS the answer ``ok`` with a count of 0. On
top of that the user can ask for a refresh with the standard
``homeassistant.update_entity`` action, and the Configure page runs the same
sweep from its discovery row. With ADB off, or unreachable, the attributes
say why and the state is 0 rather than raising.
"""
_attr_translation_key = "installed_apps"
@@ -178,7 +182,9 @@ class NvidiaShieldAppsSensor(NvidiaShieldSensorBase):
# Polling is what makes the standard `homeassistant.update_entity` action
# work for it — the user-facing "refresh the app list" trigger. The poll is
# free while the table is fresh: the manager returns the cache and issues no
# shell until APP_LIST_TTL expires.
# shell until APP_LIST_TTL expires. A sweep that COULD NOT run leaves no
# fresh table (t62 F1), so a later poll retries it — that retry is the
# recovery the old stamped-empty answer blocked for up to six hours.
_attr_should_poll = True
def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
@@ -203,7 +209,13 @@ class NvidiaShieldAppsSensor(NvidiaShieldSensorBase):
self.async_write_ha_state()
async def async_update(self) -> None:
"""Refresh the table on demand (explicitly requested only)."""
"""Refresh the table when there is no fresh answer (t57, t62 F1).
HA's own poll (``_attr_should_poll``) and an explicit
``homeassistant.update_entity`` both land here; the manager's TTL makes
it a no-op while the table is fresh, and a retry while it is not —
including after a sweep that could not run.
"""
manager = self._manager()
if manager is None:
return
@@ -216,21 +228,28 @@ class NvidiaShieldAppsSensor(NvidiaShieldSensorBase):
@property
def extra_state_attributes(self) -> dict:
"""The table itself, plus why it may be empty (never a crash)."""
"""The table itself, plus why it may be empty (never a crash).
``discovery`` is the honest reason (t62 F1): ``ok`` means the table IS
the answer, including a genuinely empty one, while ``unknown`` means
the last sweep could not run — so an empty list says nothing about the
device and the next update retries.
"""
manager = self._manager()
if manager is None:
return {"installed_apps": [], "discovery": "unavailable"}
apps = manager.installed_apps()
attrs = {"installed_apps": apps}
if not apps:
if not self._entry.options.get(CONF_ADB_ENABLED, True):
attrs["discovery"] = "adb_disabled"
elif not manager.connected:
attrs["discovery"] = "not_connected"
else:
attrs["discovery"] = "pending"
else:
if apps:
attrs["discovery"] = "ok"
elif not self._entry.options.get(CONF_ADB_ENABLED, True):
attrs["discovery"] = "adb_disabled"
elif not manager.connected:
attrs["discovery"] = "not_connected"
else:
# "ok" here is a real empty answer, "unknown" a sweep that could
# not run, "pending" one that has not completed yet.
attrs["discovery"] = manager.installed_apps_status
return attrs