Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
19 changes: 18 additions & 1 deletion homeassistant/components/imap/coordinator.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import asyncio
from collections.abc import Mapping
from contextlib import suppress
Comment thread
jbouwh marked this conversation as resolved.
Outdated
from datetime import datetime, timedelta
import email
from email.header import decode_header, make_header
Expand Down Expand Up @@ -494,6 +495,7 @@ async def async_start(self) -> None:

async def _async_wait_push_loop(self) -> None:
"""Wait for data push from server."""
idle: asyncio.Future | None = None
while True:
try:
self.number_of_messages = await self._async_fetch_number_of_messages()
Expand Down Expand Up @@ -527,8 +529,9 @@ async def _async_wait_push_loop(self) -> None:
else:
self.auth_errors = 0
self.async_set_updated_data(self.number_of_messages)

try:
idle: asyncio.Future = await self.imap_client.idle_start()
idle = await self.imap_client.idle_start()
await self.imap_client.wait_server_push()
self.imap_client.idle_done()
async with asyncio.timeout(10):
Expand All @@ -543,6 +546,20 @@ async def _async_wait_push_loop(self) -> None:
await self._cleanup()
await asyncio.sleep(BACKOFF_TIME)

finally:
# Ensure no pending IDLE future survives
if idle is not None and not idle.done():
idle.cancel()
_LOGGER.debug(
"Canceling IDLE wait for %s",
self.config_entry.data[CONF_SERVER],
)
with suppress(
AioImapException, asyncio.CancelledError, TimeoutError
):
Comment thread
bdraco marked this conversation as resolved.
Outdated
async with asyncio.timeout(BACKOFF_TIME):
Comment thread
bdraco marked this conversation as resolved.
Outdated
await idle
Comment thread
jbouwh marked this conversation as resolved.
Outdated
Comment thread
jbouwh marked this conversation as resolved.
Outdated

async def shutdown(self, *_: Any) -> None:
"""Close resources."""
if self._push_wait_task:
Expand Down
5 changes: 5 additions & 0 deletions tests/components/imap/test_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,7 @@ async def test_lost_connection_with_imap_push(
) -> None:
"""Test error handling when the connection is lost."""
# Mock an error in waiting for a pushed update
mock_imap_protocol.idle_start.return_value = asyncio.Future()
mock_imap_protocol.wait_server_push.side_effect = imap_wait_server_push_exception
config_entry = MockConfigEntry(domain=DOMAIN, data=MOCK_CONFIG)
config_entry.add_to_hass(hass)
Expand All @@ -550,6 +551,10 @@ async def test_lost_connection_with_imap_push(
assert state is not None
assert state.state == "0"

async_fire_time_changed(hass, utcnow() + timedelta(seconds=30))
await hass.async_block_till_done()
assert "Canceling IDLE wait for imap.server.com" in caplog.text


@pytest.mark.parametrize("imap_has_capability", [True], ids=["push"])
async def test_fetch_number_of_messages(
Expand Down