bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 03:01:50 +02:00
Code Activity

fix: logpanel error cycle

Browse Source
This commit is contained in:
perl_d
2025-05-22 14:57:40 +02:00
committed by Jan Wyzula
parent e4cd4891ad
commit d9dc60ee99
2 changed files with 52 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
bec_widgets/widgets/utility/logpanel/logpanel.py
View File

@ -35,6 +35,7 @@ from qtpy.QtWidgets import (
QWidget,
)
from bec_widgets.utils.bec_connector import BECConnector
from bec_widgets.utils.colors import get_theme_palette, set_theme
from bec_widgets.utils.error_popups import SafeSlot
from bec_widgets.widgets.editors.text_box.text_box import TextBox
@ -69,22 +70,22 @@ DEFAULT_LOG_COLORS = {
}
class BecLogsQueue(QObject):
class BecLogsQueue(BECConnector, QObject):
"""Manages getting logs from BEC Redis and formatting them for display"""
RPC = False
new_message = Signal()
def __init__(
self,
parent: QObject | None,
conn: ConnectorBase,
maxlen: int = 1000,
line_formatter: LineFormatter = noop_format,
) -> None:
super().__init__(parent=parent)
self._timestamp_start: QDateTime | None = None
self._timestamp_end: QDateTime | None = None
self._conn = conn
self._conn = self.client.connector
self._max_length = maxlen
self._data: deque[LogMessage] = deque([], self._max_length)
self._display_queue: deque[str] = deque([], self._max_length)
@ -92,20 +93,28 @@ class BecLogsQueue(QObject):
self._search_query: Pattern | str | None = None
self._selected_services: set[str] | None = None
self._set_formatter_and_update_filter(line_formatter)
self._conn.register([MessageEndpoints.log()], None, self._process_incoming_log_msg)
# instance attribute still accessible after c++ object is deleted, so the callback can be unregistered
self._callback = lambda *args: self._process_incoming_log_msg(*args)
self._conn.register([MessageEndpoints.log()], None, self._callback)
self.destroyed.connect(self.unsub_from_redis)
def unsub_from_redis(self):
def unsub_from_redis(self, *_):
"""Stop listening to the Redis log stream"""
self._conn.unregister([MessageEndpoints.log()], None, self._process_incoming_log_msg)
self._conn.unregister([MessageEndpoints.log()], None, self._callback)
def _process_incoming_log_msg(self, msg: dict):
try:
_msg: LogMessage = msg["data"]
_msg: LogMessage | None = msg.get("data", None)
if _msg is None or not isinstance(_msg, LogMessage):
return
self._data.append(_msg)
if self.filter is None or self.filter(_msg):
self._display_queue.append(self._line_formatter(_msg))
self.new_message.emit()
except Exception as e:
if "Internal C++ object (BecLogsQueue) already deleted." in e.args:
self.unsub_from_redis()
return
logger.warning(f"Error in LogPanel incoming message callback: {e}")
def _set_formatter_and_update_filter(self, line_formatter: LineFormatter = noop_format):
@ -407,17 +416,15 @@ class LogPanel(TextBox):
**kwargs,
):
"""Initialize the LogPanel widget."""
super().__init__(parent=parent, client=client, **kwargs)
super().__init__(parent=parent, client=client, config={"text": ""}, **kwargs)
self._update_colors()
self._service_status = service_status or BECServiceStatusMixin(self, client=self.client) # type: ignore
self._log_manager = BecLogsQueue(
parent,
self.client.connector, # type: ignore
line_formatter=partial(simple_color_format, colors=self._colors),
parent=self, line_formatter=partial(simple_color_format, colors=self._colors)
)
self._log_manager.new_message.connect(self._new_messages)
self.toolbar = LogPanelToolbar(parent=parent)
self.toolbar = LogPanelToolbar(parent=self)
self.toolbar_area = QScrollArea()
self.toolbar_area.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAlwaysOff)
self.toolbar_area.setSizeAdjustPolicy(QScrollArea.SizeAdjustPolicy.AdjustToContents)
@ -529,9 +536,9 @@ class LogPanel(TextBox):
def cleanup(self):
self._service_status.cleanup()
self._log_manager.new_message.disconnect()
self._new_messages.disconnect()
self._log_manager.unsub_from_redis()
self._log_manager.new_message.disconnect(self._new_messages)
self._new_messages.disconnect(self._on_append)
super().cleanup()

33
tests/unit_tests/test_logpanel.py
View File

@ -4,11 +4,12 @@
# pylint: disable=protected-access
from collections import deque
from unittest.mock import MagicMock
from unittest.mock import MagicMock, patch
import pytest
from bec_lib.messages import LogMessage
from qtpy.QtCore import QDateTime, Qt, Signal # type: ignore
from bec_lib.redis_connector import StreamMessage
from qtpy.QtCore import QDateTime
from bec_widgets.widgets.utility.logpanel._util import (
log_time,
@ -136,3 +137,31 @@ def test_timestamp_filter(log_panel: LogPanel):
assert not filter_(TEST_LOG_MESSAGES[0])
assert filter_(TEST_LOG_MESSAGES[1])
assert not filter_(TEST_LOG_MESSAGES[2])
def test_error_handling_in_callback(log_panel: LogPanel):
log_panel._log_manager.new_message = MagicMock()
cbs = (lambda: log_panel._log_manager._process_incoming_log_msg, {})
with patch("bec_widgets.widgets.utility.logpanel.logpanel.logger") as logger:
# generally errors should be logged
log_panel._log_manager.new_message.emit = MagicMock(
side_effect=ValueError("Something went wrong")
)
log_panel.client.connector._handle_message(
msg=StreamMessage(
msg={"data": LogMessage(log_type="debug", log_msg="message")}, callbacks=[cbs]
)
)
logger.warning.assert_called_once()
# this specific error should be ignored and not relogged
log_panel._log_manager.new_message.emit = MagicMock(
side_effect=RuntimeError("Internal C++ object (BecLogsQueue) already deleted.")
)
log_panel.client.connector._handle_message(
msg=StreamMessage(
msg={"data": LogMessage(log_type="debug", log_msg="message")}, callbacks=[cbs]
)
)
logger.warning.assert_called_once()