Skip to content

Fix: entity subscription dropped when it arrives before connect (Remote restart race) #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SPLBendrix wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix: entity subscription dropped when it arrives before connect (Remote restart race) #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion ucapi/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1031,6 +1031,34 @@ async def set_device_state(self, state: uc.DeviceStates) -> None:
uc.EventCategory.DEVICE,
)

async def _retry_subscribe_entity(
self, entity_id: str, attempts: int = 20, delay: float = 0.5
) -> None:
"""
PATCHED: retry configuring an entity that wasn't available yet
at subscribe time (e.g. because subscribe_events arrived before
the device's connect() had finished creating its entities).

Polls _available_entities briefly and configures the entity as
soon as it appears, instead of silently dropping the
subscription forever on a single early miss.
"""
for _ in range(attempts):
await asyncio.sleep(delay)
entity = self._available_entities.get(entity_id)
if entity is not None:
self._configured_entities.add(entity)
_LOG.info(
"Entity %s became available - configured on retry "
"(post-restart fix)",
entity_id,
)
return
_LOG.warning(
"Entity %s still not available after retrying - giving up",
entity_id,
)

async def _subscribe_events(
self, websocket: Any, msg_data: dict[str, Any] | None
) -> None:
Expand All @@ -1043,9 +1071,11 @@ async def _subscribe_events(
self._configured_entities.add(entity)
else:
_LOG.warning(
"WARN: cannot subscribe entity %s: entity is not available",
"WARN: cannot subscribe entity %s: entity is not available "
"- will retry for a few seconds (post-restart fix)",
entity_id,
)
self._loop.create_task(self._retry_subscribe_entity(entity_id))

self._events.emit(
uc.Events.SUBSCRIBE_ENTITIES,
Expand Down