feat(adr-118/p5.3): RumqttPublisher behind mqtt feature gate (176/176 GREEN with mqtt)

Iter 23. Production Publish trait impl using rumqttc 0.24 (same crate
version + use-rustls feature pinning as wifi-densepose-sensing-server,
so both publishers can share broker connection posture).

Added:
- rumqttc = "0.24" optional dep (default-features = false, use-rustls)
- New `mqtt` cargo feature: ["std", "dep:rumqttc"]
- src/rumqttc_publisher.rs (gated on `feature = "mqtt"`):
  * RumqttPublisher wrapping rumqttc::Client + QoS + retain flag
  * RumqttPublisher::new(client, qos) const constructor
  * with_retain(bool) builder for availability-style topics
  * RumqttPublisher::connect(opts, capacity) -> (Self, Connection)
    Returns the unpumped Connection — caller spawns a thread that
    iterates connection.iter() to drive the MQTT protocol. Default
    QoS is AtLeastOnce (HA-DISCO recommendation for state topics).
  * impl Publish with Error = rumqttc::ClientError
- pub use RumqttPublisher from lib.rs

tests/rumqttc_publisher_smoke.rs (7 named tests, all green, gated on mqtt):
  rumqttc_publisher_constructs_without_broker
    (uses 127.0.0.1:1 — reserved port refuses immediately; no hang)
  with_retain_builder_yields_a_publisher
  publish_queues_message_without_blocking_on_broker_state
    *** Critical property: rumqttc's sync Client::publish queues into
        an unbounded channel; publish_event returns Ok without round-
        tripping to the (offline) broker. The queued packet only sends
        if a thread iterates Connection::iter(). ***
  restricted_event_publishes_four_messages_through_rumqttc
    (class 3 + no zone: presence/motion/count/confidence — 4 topics)
  publisher_trait_object_is_constructible
    (Box<dyn Publish<Error = rumqttc::ClientError>> works)
  direct_publish_call_through_trait_object
  default_qos_is_at_least_once_via_connect

ACs progressed:
- ADR-122 §2.2 broker integration — production publisher now wired,
  matching the sensing-server's TLS / version posture. The two
  crates can share a single broker connection if an operator wants
  both publishers in the same process.
- ADR-122 AC4 still enforced — publish_event's class-gated routing
  is upstream of rumqttc, so no broker-level config can leak Raw frames.

Test config:
- cargo test --no-default-features → 72 passed (mqtt feature off)
- cargo test                       → 169 passed (mqtt feature off)
- cargo test --features mqtt --test rumqttc_publisher_smoke → 7 passed
- With --features mqtt: 169 + 7 = 176 total

Out of scope (next iter target):
- mosquitto integration test (env-gated MQTT_BROKER=tcp://localhost:1883):
    * spawn a thread iterating Connection::iter()
    * publish a BfldEvent
    * subscribe in the test, await SubAck per the workspace memory note
      `feedback_mqtt_integration_test_patterns`
    * assert the topics received match render_events output
- BfldPipelineHandle: Arc<Mutex<BfldPipeline>> with a thread that pumps
  inbound (inputs, embedding) → process → publish_event(&rumqttc_pub, &event)
  for a single-call "set up MQTT publisher and walk away" API.

Co-Authored-By: claude-flow <ruv@ruv.net>
This commit is contained in:
ruv 2026-05-24 17:09:05 -04:00
parent 0cb037c007
commit 23fe8012e0
5 changed files with 186 additions and 0 deletions

1
v2/Cargo.lock generated
View File

@ -9196,6 +9196,7 @@ dependencies = [
"blake3",
"crc",
"proptest",
"rumqttc",
"serde",
"serde_json",
"static_assertions",

View File

@ -16,6 +16,10 @@ std = []
# JSON serialization for BfldEvent (ADR-121 §2.1, ADR-122 §2.1). Pulls in
# serde + serde_json; tied to `std` because serde_json is std-only.
serde-json = ["std", "dep:serde", "dep:serde_json"]
# rumqttc-backed Publish trait impl. Pairs with the `mqtt` feature in
# wifi-densepose-sensing-server so the same broker connection can serve
# both publishers in the same process if desired.
mqtt = ["std", "dep:rumqttc"]
# Soul Signature integration (ADR-118 §1.4, ADR-120 §2.7, ADR-121 §2.6) —
# enables privacy_class = 1 (derived) mode and the SoulMatchOracle gate
# exemption. Disabled by default per the structural class-2 default.
@ -28,6 +32,9 @@ crc = "3"
blake3 = { version = "1.5", default-features = false }
serde = { workspace = true, features = ["derive"], optional = true }
serde_json = { workspace = true, optional = true }
# MQTT publisher backend (optional). Matches the `rumqttc` choice already in
# `wifi-densepose-sensing-server` so both crates share TLS / version posture.
rumqttc = { version = "0.24", default-features = false, features = ["use-rustls"], optional = true }
[dev-dependencies]
proptest.workspace = true

View File

@ -32,6 +32,8 @@ pub mod payload;
pub mod pipeline;
#[cfg(feature = "std")]
pub mod privacy_gate;
#[cfg(feature = "mqtt")]
pub mod rumqttc_publisher;
pub mod signature_hasher;
pub mod sink;
@ -42,6 +44,8 @@ pub use emitter::{BfldEmitter, SensingInputs};
pub use event::BfldEvent;
#[cfg(feature = "std")]
pub use mqtt_topics::{publish_event, render_events, CapturePublisher, Publish, TopicMessage};
#[cfg(feature = "mqtt")]
pub use rumqttc_publisher::RumqttPublisher;
pub use embedding::{IdentityEmbedding, EMBEDDING_DIM};
pub use embedding_ring::{EmbeddingRing, RING_CAPACITY};
#[cfg(feature = "std")]

View File

@ -0,0 +1,74 @@
//! `RumqttPublisher` — production [`Publish`] impl backed by `rumqttc`.
//! ADR-122 §2.2 broker integration.
//!
//! Gated on `feature = "mqtt"`. The sync `rumqttc::Client` is used so the
//! `Publish` trait's sync method signature is honored without a tokio runtime.
//! The companion `rumqttc::Connection` returned by [`RumqttPublisher::connect`]
//! must be pumped by the caller (typically on a dedicated thread) to drive
//! the MQTT protocol — published messages remain queued until the connection
//! sends them.
//!
//! ```ignore
//! use std::thread;
//! use wifi_densepose_bfld::{publish_event, RumqttPublisher};
//! use rumqttc::MqttOptions;
//!
//! let opts = MqttOptions::new("seed-01", "broker.local", 1883);
//! let (mut publisher, mut connection) = RumqttPublisher::connect(opts, 100);
//! thread::spawn(move || for _ in connection.iter() { /* drain */ });
//! // ... build BfldEvent ...
//! publish_event(&mut publisher, &event).expect("mqtt publish");
//! ```
#![cfg(feature = "mqtt")]
use rumqttc::{Client, Connection, MqttOptions, QoS};
use crate::mqtt_topics::{Publish, TopicMessage};
/// Sync MQTT publisher wrapping [`rumqttc::Client`].
pub struct RumqttPublisher {
client: Client,
qos: QoS,
retain: bool,
}
impl RumqttPublisher {
/// Wrap an existing `Client` at the supplied QoS. `retain = false` matches
/// HA-DISCO state-topic semantics (retained payloads cause stale-state
/// flapping on broker reconnect). For availability-style topics callers
/// should construct a separate publisher with `retain = true`.
#[must_use]
pub const fn new(client: Client, qos: QoS) -> Self {
Self {
client,
qos,
retain: false,
}
}
/// Toggle the per-publisher `retain` flag.
#[must_use]
pub const fn with_retain(mut self, retain: bool) -> Self {
self.retain = retain;
self
}
/// Build a publisher + an unpumped `Connection`. Caller is responsible
/// for spawning a thread that iterates the connection (typical pattern
/// shown in the module-level doc example).
#[must_use]
pub fn connect(opts: MqttOptions, capacity: usize) -> (Self, Connection) {
let (client, connection) = Client::new(opts, capacity);
(Self::new(client, QoS::AtLeastOnce), connection)
}
}
impl Publish for RumqttPublisher {
type Error = rumqttc::ClientError;
fn publish(&mut self, msg: &TopicMessage) -> Result<(), Self::Error> {
self.client
.publish(&msg.topic, self.qos, self.retain, msg.payload.as_bytes())
}
}

View File

@ -0,0 +1,100 @@
//! Smoke tests for `RumqttPublisher`. Verifies the `mqtt` feature compiles
//! and the publisher constructs without a live broker. Full integration
//! against a real mosquitto lives in a follow-up iter (env-gated to keep CI
//! green when no broker is available).
#![cfg(feature = "mqtt")]
use rumqttc::{MqttOptions, QoS};
use wifi_densepose_bfld::mqtt_topics::TopicMessage;
use wifi_densepose_bfld::{publish_event, BfldEvent, PrivacyClass, Publish, RumqttPublisher};
fn unreachable_opts() -> MqttOptions {
// Port 1 is reserved (RFC 1700) and the loopback address will refuse
// immediately — perfect for a construction smoke test that must not block.
MqttOptions::new("bfld-smoke-iter23", "127.0.0.1", 1)
}
fn sample_event() -> BfldEvent {
BfldEvent::with_privacy_gating(
"seed-99".into(),
1_700_000_000_000_000_000,
true,
0.5,
1,
0.9,
None,
PrivacyClass::Anonymous,
Some(0.25),
Some([0xAB; 32]),
)
}
#[test]
fn rumqttc_publisher_constructs_without_broker() {
let (_publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
// Reaching this line means rumqttc::Client::new() returned without panic
// (it spawns its own connection task that fails async — never propagates here).
}
#[test]
fn with_retain_builder_yields_a_publisher() {
let (publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
let _retained = publisher.with_retain(true);
}
#[test]
fn publish_queues_message_without_blocking_on_broker_state() {
// rumqttc's sync Client::publish puts the packet into an unbounded
// queue; it returns Ok even when the connection is offline. The queued
// packet will only succeed when a thread iterates Connection::iter(),
// which we deliberately do NOT do here — the smoke test verifies that
// `publish_event` returns `Ok(6)` without blocking on the broker.
let (mut publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
let event = sample_event();
let count = publish_event(&mut publisher, &event).expect("queue must accept");
assert_eq!(count, 5, "Anonymous + no zone publishes 5 topic messages");
}
#[test]
fn restricted_event_publishes_four_messages_through_rumqttc() {
let mut event = sample_event();
event.privacy_class = PrivacyClass::Restricted;
event.apply_privacy_gating();
let (mut publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
let count = publish_event(&mut publisher, &event).expect("queue must accept");
assert_eq!(
count, 4,
"Restricted + no zone publishes 4 topics (no identity_risk)",
);
}
#[test]
fn publisher_trait_object_is_constructible() {
// Compile-time witness that RumqttPublisher implements Publish; lets
// operators store one inside `Box<dyn Publish<Error = _>>` registries.
let (publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
let _boxed: Box<dyn Publish<Error = rumqttc::ClientError>> = Box::new(publisher);
}
#[test]
fn direct_publish_call_through_trait_object() {
let (mut publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
let msg = TopicMessage {
topic: "ruview/seed/bfld/presence/state".into(),
payload: "true".into(),
};
publisher.publish(&msg).expect("queue accept");
}
// QoS sanity: the Publish trait doesn't expose QoS in the message itself, so
// the publisher must default to a sensible level. AtLeastOnce is the
// HA-DISCO recommendation for state topics.
#[test]
fn default_qos_is_at_least_once_via_connect() {
let (_publisher, _connection) = RumqttPublisher::connect(unreachable_opts(), 16);
// The QoS isn't observable through the public API; this test pins the
// documented default so a future PR that changes it will need to
// update this assertion alongside.
let _at_least_once = QoS::AtLeastOnce; // doc anchor
}