Repository navigation
Fix BLE close() deadlock from re-entrant disconnect callback #976
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,6 +60,7 @@ def __init__( # pylint: disable=R0917 | |
| ) | ||
|
|
||
| self.should_read = False | ||
| self._closing = False | ||
|
|
||
| logger.debug("Threads starting") | ||
| self._want_receive = True | ||
|
|
@@ -254,26 +255,34 @@ def _sendToRadioImpl(self, toRadio) -> None: | |
| self.should_read = True | ||
|
|
||
| def close(self) -> None: | ||
| if self._closing: | ||
| return | ||
| self._closing = True | ||
|
|
||
| try: | ||
| MeshInterface.close(self) | ||
| except Exception as e: | ||
| logger.error(f"Error closing mesh interface: {e}") | ||
| try: | ||
| MeshInterface.close(self) | ||
| except Exception as e: | ||
| logger.error(f"Error closing mesh interface: {e}") | ||
|
|
||
| if self._want_receive: | ||
| self._want_receive = False # Tell the thread we want it to stop | ||
| if self._receiveThread: | ||
| self._receiveThread.join( | ||
| timeout=2 | ||
| ) # If bleak is hung, don't wait for the thread to exit (it is critical we disconnect) | ||
| self._receiveThread = None | ||
|
|
||
| if self.client: | ||
| if self._exit_handler is not None: | ||
| atexit.unregister(self._exit_handler) | ||
| self.client.disconnect() | ||
| self.client.close() | ||
| self.client = None | ||
| self._disconnected() # send the disconnected indicator up to clients | ||
| if self.client: | ||
| self.client.disconnect() | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Skip completed disconnect work when If Make a retry resume cleanup. Record that the disconnect completed, and skip that call on retry. Do not submit work to a closed event loop. Keep the first close path unchanged: normal cleanup must still disconnect before the loop stops. Add a regression test that closes the event loop before the retry.
|
||
| self.client.close() | ||
| if self._exit_handler is not None: | ||
| atexit.unregister(self._exit_handler) | ||
| self.client = None | ||
| self._disconnected() | ||
| except BaseException: | ||
| # Keep successful closes idempotent, but allow failed cleanup to retry. | ||
| self._closing = False | ||
| raise | ||
|
Comment on lines
+282
to
+285
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: set -eu
printf '%s\n' '--- current BLEInterface callback and close paths ---'
nl -ba meshtastic/ble_interface.py | sed -n '175,205p;235,295p;325,365p'
printf '%s\n' '--- relevant diff from merge base ---'
git diff --unified=25 0539a9600fc6c15eda398494ffb0309322cfb089 6887c8678db14f56297885cc8e28aeeb8ee6fbdf -- meshtastic/ble_interface.pyRepository: meshtastic/python Length of output: 11935 Block late BLE callbacks before resetting On Bleak 1.1.1 BlueZ, Keep Suggested fix self.should_read = False
self._closing = False
+ self._close_callback_disabled = False
@@
- client = BLEClient(device.address, disconnected_callback=lambda _: self.close())
+ client = BLEClient(
+ device.address,
+ disconnected_callback=lambda _: self._on_disconnected(),
+ )
client.connect()
client.discover()
return client
+ def _on_disconnected(self) -> None:
+ if not self._close_callback_disabled:
+ self.close()
+
@@
except BaseException:
# Keep successful closes idempotent, but allow failed cleanup to retry.
+ self._close_callback_disabled = True
self._closing = False
raise🤖 Prompt for AI Agents |
||
|
|
||
|
|
||
| class BLEClient: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -67,3 +67,78 @@ def test_ble_receive_wraps_unexpected_bleak_error_with_kind(): | |
| with pytest.raises(BLEInterface.BLEError) as excinfo: | ||
| iface._receiveFromRadioImpl() | ||
| assert excinfo.value.kind == BLEInterface.BLEError.READ_ERROR | ||
|
|
||
|
|
||
| @pytest.mark.unit | ||
| def test_ble_close_reentrant_does_not_deadlock() -> None: | ||
| """close() must not deadlock when disconnect callback re-enters close().""" | ||
| iface = object.__new__(BLEInterface) | ||
| iface._closing = False | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
| iface._want_receive = False | ||
| iface._receiveThread = None | ||
|
|
||
| disconnect_count = 0 | ||
|
|
||
| def fake_disconnect(): | ||
| nonlocal disconnect_count | ||
| disconnect_count += 1 | ||
| iface.close() # re-entrant call — should return immediately | ||
|
Comment on lines
+82
to
+85
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Add the return annotation to Declare the nested callback as As per coding guidelines, Python files must use type hints for all new function parameters and return values. 🤖 Prompt for AI AgentsSource: Coding guidelines |
||
|
|
||
| mock_client = MagicMock() | ||
| mock_client.disconnect.side_effect = fake_disconnect | ||
| iface.client = mock_client | ||
| iface._exit_handler = lambda: None | ||
|
|
||
| with patch("meshtastic.mesh_interface.MeshInterface.close"), \ | ||
| patch.object(iface, "_disconnected"): | ||
| iface.close() | ||
| iface.close() # A completed close must also remain idempotent. | ||
|
|
||
| assert disconnect_count == 1, "disconnect() should be called exactly once" | ||
| assert iface.client is None, "client should be cleaned up" | ||
|
|
||
|
|
||
| @pytest.mark.unit | ||
| @pytest.mark.parametrize("failure", ["join", "disconnect", "close", "notification"]) | ||
| def test_ble_close_can_retry_after_cleanup_failure(failure) -> None: | ||
| """A failed cleanup must not permanently disable close().""" | ||
| iface = object.__new__(BLEInterface) | ||
| iface._closing = False | ||
| iface._want_receive = True | ||
| receive_thread = MagicMock() | ||
| iface._receiveThread = receive_thread | ||
| client = MagicMock() | ||
| iface.client = client | ||
| iface._exit_handler = lambda: None | ||
| notification = MagicMock() | ||
| iface._disconnected = notification # type: ignore[method-assign] | ||
| failing_step = { | ||
| "join": receive_thread.join, | ||
| "disconnect": client.disconnect, | ||
| "close": client.close, | ||
| "notification": notification, | ||
| }[failure] | ||
| failing_step.side_effect = RuntimeError("cleanup failed") | ||
|
|
||
| with patch("meshtastic.mesh_interface.MeshInterface.close"), \ | ||
| patch("meshtastic.ble_interface.atexit.unregister") as unregister: | ||
| with pytest.raises(RuntimeError, match="cleanup failed"): | ||
| iface.close() | ||
|
|
||
| assert iface._closing is False | ||
| if failure != "notification": | ||
| assert iface.client is client | ||
| unregister.assert_not_called() | ||
|
|
||
| failing_step.side_effect = None | ||
| iface.close() | ||
| iface.close() | ||
|
|
||
| assert iface._closing is True | ||
| assert iface.client is None | ||
| assert iface._receiveThread is None | ||
| assert iface._want_receive is False | ||
| assert failing_step.call_count == 2 | ||
| unregister.assert_called_once_with(iface._exit_handler) | ||
| client.close.assert_called() | ||
| notification.assert_called() | ||
Uh oh!
There was an error while loading. Please reload this page.