mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 03:01:21 +02:00
feat(ftp): log how every FTP session closes (issue #3009)
disconnect() and _abandon_connection() logged nothing, at any level. A session closed cleanly and a socket genuinely abandoned therefore produced identical output -- none -- and the only way to tell them apart was to read the source. That is how #3009 was filed. Its trace shows a print completion opening two FTP connections, deleting one file, and then nothing until the printer was powered off 21 minutes later, read as connections left open and offered as a mechanism for the 0500-C010 SD-card error that #645 has been chasing since April. The two connections are the post-print SD cleanup in main.py walking its candidate filenames, each through delete_file_async, which closes in a finally; running that against the mock FTPS server shows the server logging "FTP session closed (disconnect)" for both the 250 and the 550, holding zero sessions afterwards. Nothing in a support bundle could have shown that. Both close paths now log one DEBUG line: the printer, whether QUIT was acknowledged or the socket had to be dropped without it, why, and how long the session was held. Every connect in a debug log now has a matching close. The duration comes from a stamp taken when the control socket opens rather than after login, so a session that dies during login is accounted for too; where no socket was ever established the line says "held unknown" rather than claiming a number. The four connect() failure paths pass their own reason, so a close line stands on its own next to the warning above it. Nine tests, seven of which fail against the unlogged version. The other two assert silence -- a bare disconnect(), and a connect skipped by the handshake cool-off -- where no socket was opened and a close line would pair with no connect.
This commit is contained in:
@@ -554,6 +554,9 @@ class BambuFTPClient:
|
||||
# operation and cannot be overwritten by work against another printer.
|
||||
self.last_failure: FtpFailure | None = None
|
||||
self._ftp: ImplicitFTP_TLS | None = None
|
||||
# When the control socket to the printer was opened, so the close log
|
||||
# can say how long the session was held (#3009).
|
||||
self._connected_at: float | None = None
|
||||
|
||||
def _is_a1_model(self) -> bool:
|
||||
"""Check if this is an A1 series printer."""
|
||||
@@ -656,6 +659,10 @@ class BambuFTPClient:
|
||||
cap_tls_v1_2=profile.cap_tls_v1_2,
|
||||
)
|
||||
self._ftp.connect(self.ip_address, self.FTP_PORT, timeout=self.timeout)
|
||||
# Stamped here rather than after login: the socket exists from this
|
||||
# point on, and a session that dies during login is exactly the one
|
||||
# whose lifetime someone reading the log wants accounted for.
|
||||
self._connected_at = time.monotonic()
|
||||
logger.debug("FTP connected, logging in as bblp")
|
||||
self._ftp.login("bblp", self.access_code)
|
||||
if use_prot_c:
|
||||
@@ -677,12 +684,12 @@ class BambuFTPClient:
|
||||
except ftplib.error_perm as e:
|
||||
logger.warning("FTP connection permission error to %s: %s", self.ip_address, e)
|
||||
self.last_failure = FtpFailure(FtpFailureKind.AUTH, str(e), _ftp_reply_code(e))
|
||||
self._abandon_connection()
|
||||
self._abandon_connection("login rejected")
|
||||
return False
|
||||
except TimeoutError as e:
|
||||
logger.warning("FTP connection timed out to %s: %s", self.ip_address, e)
|
||||
self.last_failure = FtpFailure(FtpFailureKind.TIMEOUT, str(e))
|
||||
self._abandon_connection()
|
||||
self._abandon_connection("connect timed out")
|
||||
return False
|
||||
except ssl.SSLError as e:
|
||||
# Not a transient failure and not something another path or another
|
||||
@@ -711,7 +718,7 @@ class BambuFTPClient:
|
||||
# holding a failed handshake open across that is the exact thing
|
||||
# #2780's cleanup was added to stop. Idempotent, so the call that
|
||||
# used to sit at the end of this branch simply moved up.
|
||||
self._abandon_connection()
|
||||
self._abandon_connection("TLS handshake failed")
|
||||
|
||||
# Ask the printer what it actually said, once per cool-off window.
|
||||
# Checked before the deadline below is written, so a live entry here
|
||||
@@ -743,10 +750,21 @@ class BambuFTPClient:
|
||||
except (OSError, ftplib.Error) as e:
|
||||
logger.warning("FTP connection failed to %s: %s (type: %s)", self.ip_address, e, type(e).__name__)
|
||||
self.last_failure = FtpFailure(FtpFailureKind.NETWORK, str(e), _ftp_reply_code(e))
|
||||
self._abandon_connection()
|
||||
self._abandon_connection("connect failed")
|
||||
return False
|
||||
|
||||
def _abandon_connection(self) -> None:
|
||||
def _held_for(self) -> str:
|
||||
"""How long the control socket has been open, for the close log.
|
||||
|
||||
"unknown" when :meth:`connect` never got as far as opening one -- the
|
||||
cool-off skip and a DNS/refused failure both land in
|
||||
:meth:`_abandon_connection` without a socket ever existing.
|
||||
"""
|
||||
if self._connected_at is None:
|
||||
return "unknown"
|
||||
return f"{time.monotonic() - self._connected_at:.1f}s"
|
||||
|
||||
def _abandon_connection(self, reason: str = "connection never became usable") -> None:
|
||||
"""Drop a connection that never became usable, closing its socket.
|
||||
|
||||
Every failure path in :meth:`connect` used to clear ``self._ftp`` and
|
||||
@@ -765,24 +783,50 @@ class BambuFTPClient:
|
||||
"""
|
||||
ftp = self._ftp
|
||||
self._ftp = None
|
||||
held = self._held_for()
|
||||
self._connected_at = None
|
||||
if ftp is None:
|
||||
return
|
||||
try:
|
||||
ftp.close()
|
||||
except (OSError, ftplib.Error, EOFError):
|
||||
pass # Best-effort; the socket may already be gone
|
||||
# See the note in ``disconnect``: every session that opens a socket
|
||||
# says how it closed, so the log carries matched pairs (#3009).
|
||||
logger.debug(
|
||||
"FTP session to %s closed without QUIT (%s), held %s",
|
||||
self.ip_address,
|
||||
reason,
|
||||
held,
|
||||
)
|
||||
|
||||
def disconnect(self):
|
||||
"""Disconnect from the FTP server."""
|
||||
if self._ftp:
|
||||
held = self._held_for()
|
||||
try:
|
||||
self._ftp.quit()
|
||||
except (OSError, ftplib.Error, EOFError):
|
||||
except (OSError, ftplib.Error, EOFError) as e:
|
||||
# ``quit()`` sends QUIT and only then closes; when the send
|
||||
# raises, ftplib never reaches its own close and the socket
|
||||
# stays open. Close it here rather than leaving it to the GC.
|
||||
self._abandon_connection()
|
||||
self._abandon_connection(f"QUIT failed: {e}")
|
||||
else:
|
||||
# One line per session, at DEBUG. Neither this method nor
|
||||
# ``_abandon_connection`` used to log anything at any level, so
|
||||
# a session closed cleanly and a socket genuinely left open
|
||||
# produced identical logs -- nothing. #3009 read that silence
|
||||
# after a print as proof the connections were never closed, and
|
||||
# nothing in the log could have shown otherwise. Now every
|
||||
# connect has a matching close, so the next person can settle it
|
||||
# from a support bundle instead of by inference.
|
||||
logger.debug(
|
||||
"FTP session to %s closed after QUIT, held %s",
|
||||
self.ip_address,
|
||||
held,
|
||||
)
|
||||
self._ftp = None
|
||||
self._connected_at = None
|
||||
|
||||
def list_files(self, path: str = "/", *, raise_on_error: bool = False) -> list[dict]:
|
||||
"""List files in a directory."""
|
||||
|
||||
@@ -0,0 +1,165 @@
|
||||
"""Every FTP session the client opens says how it closed (#3009).
|
||||
|
||||
The reporter of #3009 read a print-completion trace that showed two FTP
|
||||
connects, one DELE and then nothing, and concluded the connections were never
|
||||
closed -- the SD-card corruption they were chasing being the consequence.
|
||||
|
||||
They were closed. ``disconnect()`` and ``_abandon_connection()`` simply logged
|
||||
nothing at any level, so a clean close and a genuinely leaked socket produced
|
||||
the same log: silence. These tests pin the close line down, because a
|
||||
diagnostic that only exists until someone tidies it away is worth nothing to
|
||||
the next person reading a support bundle.
|
||||
"""
|
||||
|
||||
import logging
|
||||
|
||||
import pytest
|
||||
|
||||
from backend.app.services.bambu_ftp import BambuFTPClient
|
||||
from backend.tests.unit.services.mock_ftp_server import MockBambuFTPServer
|
||||
|
||||
from .conftest import _find_free_port
|
||||
|
||||
|
||||
def _close_lines(caplog) -> list[str]:
|
||||
return [r.getMessage() for r in caplog.records if "FTP session to" in r.getMessage()]
|
||||
|
||||
|
||||
class TestACleanSessionSaysSo:
|
||||
"""The ordinary path: connect, work, QUIT."""
|
||||
|
||||
def test_a_clean_close_is_logged_once(self, ftp_client_factory, caplog):
|
||||
client = ftp_client_factory()
|
||||
assert client.connect() is True
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
client.disconnect()
|
||||
|
||||
lines = _close_lines(caplog)
|
||||
assert len(lines) == 1, lines
|
||||
assert "closed after QUIT" in lines[0]
|
||||
assert "127.0.0.1" in lines[0]
|
||||
|
||||
def test_the_line_carries_how_long_the_session_was_held(self, ftp_client_factory, caplog):
|
||||
"""Without a duration the line cannot distinguish a short delete from a
|
||||
session that sat open for the length of a print -- which is the exact
|
||||
question #3009 asked."""
|
||||
client = ftp_client_factory()
|
||||
client.connect()
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
client.disconnect()
|
||||
|
||||
assert "held 0." in _close_lines(caplog)[0]
|
||||
|
||||
def test_a_delete_through_the_async_wrapper_closes_and_says_so(self, ftp_server, ftp_root, caplog):
|
||||
"""The path #3009 actually traced: the post-print SD-card cleanup in
|
||||
``on_print_complete`` calls ``delete_file_async`` once per candidate."""
|
||||
import asyncio
|
||||
|
||||
from backend.app.services.bambu_ftp import DeleteResult, delete_file_async
|
||||
|
||||
(ftp_root / "cube.gcode").write_bytes(b"G28\n")
|
||||
original_port = BambuFTPClient.FTP_PORT
|
||||
BambuFTPClient.FTP_PORT = ftp_server.port
|
||||
try:
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
result = asyncio.run(delete_file_async("127.0.0.1", "12345678", "/cube.gcode", printer_model="X1C"))
|
||||
finally:
|
||||
BambuFTPClient.FTP_PORT = original_port
|
||||
|
||||
assert result == DeleteResult.DELETED
|
||||
assert len(_close_lines(caplog)) == 1
|
||||
|
||||
def test_the_550_path_closes_too(self, ftp_server, caplog):
|
||||
"""The line #3009's log ends on. A candidate the printer does not have
|
||||
answers 550, and that session has to close like any other."""
|
||||
import asyncio
|
||||
|
||||
from backend.app.services.bambu_ftp import DeleteResult, delete_file_async
|
||||
|
||||
original_port = BambuFTPClient.FTP_PORT
|
||||
BambuFTPClient.FTP_PORT = ftp_server.port
|
||||
try:
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
result = asyncio.run(delete_file_async("127.0.0.1", "12345678", "/not_here.3mf", printer_model="X1C"))
|
||||
finally:
|
||||
BambuFTPClient.FTP_PORT = original_port
|
||||
|
||||
assert result == DeleteResult.NOT_FOUND
|
||||
lines = _close_lines(caplog)
|
||||
assert len(lines) == 1, lines
|
||||
assert "closed after QUIT" in lines[0]
|
||||
|
||||
def test_disconnect_without_a_session_says_nothing(self, ftp_client_factory, caplog):
|
||||
"""No socket was opened, so there is no session to account for. A line
|
||||
here would be worse than none: it would pair with no connect."""
|
||||
client = ftp_client_factory()
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
client.disconnect()
|
||||
|
||||
assert _close_lines(caplog) == []
|
||||
|
||||
|
||||
class TestAFailedConnectIsAccountedForToo:
|
||||
"""A connect that opens a socket and then fails still closed something."""
|
||||
|
||||
def test_a_rejected_login_reports_the_close(self, ftp_client_factory, caplog):
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
assert ftp_client_factory(access_code="wrongcode").connect() is False
|
||||
|
||||
lines = _close_lines(caplog)
|
||||
assert len(lines) == 1, lines
|
||||
assert "closed without QUIT" in lines[0]
|
||||
assert "login rejected" in lines[0]
|
||||
|
||||
def test_an_unreachable_printer_reports_the_close(self, ftp_server, caplog):
|
||||
client = BambuFTPClient("192.0.2.1", "12345678", timeout=1.0, printer_model="X1C")
|
||||
client.FTP_PORT = ftp_server.port
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
assert client.connect() is False
|
||||
|
||||
lines = _close_lines(caplog)
|
||||
assert len(lines) == 1, lines
|
||||
assert "closed without QUIT" in lines[0]
|
||||
# No socket was ever established, so there is no duration to claim.
|
||||
assert "held unknown" in lines[0]
|
||||
|
||||
|
||||
class TestTheSessionIsNotDoubleCounted:
|
||||
"""Isolated class: ``server.stop()`` calls ``close_all()``, which nukes every
|
||||
asyncore socket in the process."""
|
||||
|
||||
def test_a_failing_quit_reports_one_close_not_two(self, ftp_certs, tmp_path, caplog):
|
||||
"""``disconnect()`` falls through to ``_abandon_connection()`` when QUIT
|
||||
cannot be sent. Both log, so the fallback must not produce a second line
|
||||
for one session."""
|
||||
cert_path, key_path = ftp_certs
|
||||
server = MockBambuFTPServer("127.0.0.1", _find_free_port(), str(tmp_path), cert_path, key_path)
|
||||
server.start()
|
||||
|
||||
client = BambuFTPClient("127.0.0.1", "12345678", timeout=5.0)
|
||||
client.FTP_PORT = server.port
|
||||
assert client.connect() is True
|
||||
|
||||
server.stop()
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
client.disconnect()
|
||||
|
||||
lines = _close_lines(caplog)
|
||||
assert len(lines) == 1, lines
|
||||
assert "closed without QUIT" in lines[0]
|
||||
assert "QUIT failed" in lines[0]
|
||||
assert client._ftp is None
|
||||
|
||||
|
||||
class TestTheCoolOffSkipStaysSilent:
|
||||
"""No connect was attempted, so there is nothing to close."""
|
||||
|
||||
def test_a_skipped_connect_logs_no_close(self, ftp_client_factory, caplog):
|
||||
import time
|
||||
|
||||
BambuFTPClient._handshake_blocked_until["127.0.0.1"] = time.monotonic() + 300
|
||||
client = ftp_client_factory()
|
||||
with caplog.at_level(logging.DEBUG, logger="backend.app.services.bambu_ftp"):
|
||||
assert client.connect() is False
|
||||
|
||||
assert _close_lines(caplog) == []
|
||||
Reference in New Issue
Block a user