From 18451d7e9f38ea2a49faa73578c8929b5fd25983 Mon Sep 17 00:00:00 2001 From: Adeel Ahmad Date: Sat, 10 Oct 2026 20:31:07 +0000 Subject: [PATCH] fix(sensors): keep a retained MQTT message before acknowledging it The hub sent PUBACK/PUBREC before it stored and forwarded the message, so a client that subscribed right after the publisher's acknowledgement could miss the retained copy and get it as a live message instead. This made test_broker_is_an_ordinary_local_broker fail now and then in CI (seen on #253). Co-Authored-By: Claude Opus 5.5 (1M context) Claude-Session: https://claude.ai/code/session_01GbW6SC3MU2AmYQ9zFa5dk4 --- fastapi_backend/app/domain/mqtt.py | 8 +++++++- fastapi_backend/tests/api/test_sensors.py | 19 +++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/fastapi_backend/app/domain/mqtt.py b/fastapi_backend/app/domain/mqtt.py index fdbfd057d..63dcbab18 100644 --- a/fastapi_backend/app/domain/mqtt.py +++ b/fastapi_backend/app/domain/mqtt.py @@ -286,11 +286,14 @@ def _serve(self, sock, address): topic, payload, qos, retain, pid = parse_publish(flags, body) if not topic or "+" in topic or "#" in topic: raise ProtocolError("a topic name can't have wildcards") + # kept and passed on before the sender hears it arrived, so a client subscribing after the + # acknowledgement gets it as the retained message + self.publish(topic, payload, retain) if qos == 1: session.send(packet(PUBACK, 0, struct.pack("!H", pid))) elif qos == 2: session.send(packet(PUBREC, 0, struct.pack("!H", pid))) - self._take(topic, payload, retain, session.login, address) + self._hear(topic, payload, session.login, address) elif kind == PUBREL: session.send(packet(PUBCOMP, 0, body[:2])) elif kind == SUBSCRIBE: @@ -329,6 +332,9 @@ def _serve(self, sock, address): def _take(self, topic, payload, retain, login, address): self.publish(topic, payload, retain) + self._hear(topic, payload, login, address) + + def _hear(self, topic, payload, login, address): if not topic.startswith("$"): try: self.on_message(topic, payload, login, address) diff --git a/fastapi_backend/tests/api/test_sensors.py b/fastapi_backend/tests/api/test_sensors.py index ca35d963c..63e1b120c 100644 --- a/fastapi_backend/tests/api/test_sensors.py +++ b/fastapi_backend/tests/api/test_sensors.py @@ -188,6 +188,25 @@ def test_broker_is_an_ordinary_local_broker(): b.stop() +def test_a_retained_message_is_kept_before_its_sender_hears_it_arrived(): + b = mqtt.Broker("127.0.0.1", 0, lambda *a: {"ok": 1}, lambda *a: None).start() + keep = b.publish + + def slow(*a, **kw): # a busy hub: the acknowledgement must still wait for the message to be kept + time.sleep(0.3) + keep(*a, **kw) + + b.publish = slow + try: + Device(b.port, "pub", "u", "p").publish("home/kitchen/temp", "21.5", qos=1, retain=True) + sub = Device(b.port, "sub", "u", "p") + assert sub.subscribe("home/#") == [0] + assert sub.receive() == ("home/kitchen/temp", b"21.5", True) + sub.close() + finally: + b.stop() + + def test_bridge_client_reads_another_broker(): b = mqtt.Broker("127.0.0.1", 0, lambda *a: {"ok": 1}, lambda *a: None).start() try: