Ensure original log handlers are restored at close (#49230)

Error messages after close were not being logged
This commit is contained in:
J. Nick Koston 2021-04-14 22:53:48 -10:00 committed by GitHub
parent 055cdc64c0
commit d71f913a12
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 0 deletions

View File

@ -77,6 +77,9 @@ def async_activate_log_queue_handler(hass: HomeAssistant) -> None:
@callback
def _async_stop_queue_handler(_: Any) -> None:
"""Cleanup handler."""
# Ensure any messages that happen after close still get logged
for original_handler in migrated_handlers:
logging.root.addHandler(original_handler)
logging.root.removeHandler(queue_handler)
listener.stop()

View File

@ -7,6 +7,7 @@ from unittest.mock import patch
import pytest
from homeassistant.const import EVENT_HOMEASSISTANT_CLOSE
from homeassistant.core import callback, is_callback
import homeassistant.util.logging as logging_util
@ -65,11 +66,18 @@ async def test_logging_with_queue_handler():
async def test_migrate_log_handler(hass):
"""Test migrating log handlers."""
original_handlers = logging.root.handlers
logging_util.async_activate_log_queue_handler(hass)
assert len(logging.root.handlers) == 1
assert isinstance(logging.root.handlers[0], logging_util.HomeAssistantQueueHandler)
hass.bus.async_fire(EVENT_HOMEASSISTANT_CLOSE)
await hass.async_block_till_done()
assert logging.root.handlers == original_handlers
@pytest.mark.no_fail_on_log_exception
async def test_async_create_catching_coro(hass, caplog):