Skip to content

fix: MQTT v2 callback API and disconnect leak (#15, #16) - #32

Merged
weslleyspereira merged 5 commits into
NatLabRockies:mainfrom
xtruan:fix/mqtt-issues-15-16
Sep 15, 2026
Merged

weslleyspereira merged 5 commits into
NatLabRockies:mainfrom
xtruan:fix/mqtt-issues-15-16

Conversation

@xtruan

@xtruan xtruan commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Issue #15: mqtt_publisher used the deprecated paho-mqtt v1 callback API while pyproject requires paho-mqtt>=2.0.0, producing a DeprecationWarning and future breakage.

  • Construct mqtt.Client with callback_api_version=VERSION2
  • Update _on_connect/_on_disconnect/_on_publish to the v2 signatures, handling ReasonCode objects (is_failure/value)

Issue #16: the MQTT publisher's network-loop thread was never stopped and no DISCONNECT was sent on teardown (resource leak).

  • Add Tracker.disconnect_mqtt() (idempotent) and a stop() override that disconnects in a finally block
  • Route Tracker.exit and track_until_forced_exit through the cleanup
  • Add matching cleanup to TrackerArray for all child trackers

Update the test FakeMQTTModule to the v2 API and add regression tests covering both issues.

xtruan and others added 4 commits September 8, 2026 09:25
…bRockies#16)

Issue NatLabRockies#15: mqtt_publisher used the deprecated paho-mqtt v1 callback API
while pyproject requires paho-mqtt>=2.0.0, producing a DeprecationWarning
and future breakage.
- Construct mqtt.Client with callback_api_version=VERSION2
- Update _on_connect/_on_disconnect/_on_publish to the v2 signatures,
  handling ReasonCode objects (is_failure/value)

Issue NatLabRockies#16: the MQTT publisher's network-loop thread was never stopped and
no DISCONNECT was sent on teardown (resource leak).
- Add Tracker.disconnect_mqtt() (idempotent) and a stop() override that
  disconnects in a finally block
- Route Tracker.__exit__ and track_until_forced_exit through the cleanup
- Add matching cleanup to TrackerArray for all child trackers

Update the test FakeMQTTModule to the v2 API and add regression tests
covering both issues.
The merge of main into this branch replaced BaseTracker._read_and_sleep()
with an inlined scheduler (_sleep_until_next_tick), and a branch-only
commit changed Tracker.start/stop default freq_write from 0 to -1 (=
self.freq_write). Both changes are correct but broke the MQTT tests
added earlier, which were written against the old API/semantics.

- Re-point interrupt injection from the removed _read_and_sleep seam to
  the new _sleep_until_next_tick scheduler in the tracker and CLI tests.
- Update CLI assertions to expect track_until_forced_exit(disconnect_mqtt
  =False), matching the CLI's cleanup-ownership flow.
- Account for the new read-loop structure (one loop read + one final read)
  in test_cli_final_batch_before_disconnect read counts, batch sample
  counts, and written-row counts, including partial writes when the last
  array reader fails.
- Reframe test_write_after_stop_is_local_only around the real invariant:
  stop() flushes the final batch, and a subsequent write() must not
  publish again or recreate a publisher.

Full suite: 225 passed, 5 skipped.

@weslleyspereira weslleyspereira left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks

@weslleyspereira
weslleyspereira merged commit deefd19 into NatLabRockies:main Sep 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants