From d68a3ba5447c41f5a984c1ab3571af206d33dd9b Mon Sep 17 00:00:00 2001 From: Devdutt Shenoi Date: Tue, 14 May 2024 10:28:21 +0000 Subject: [PATCH 1/3] remove changes that don't seem to be related --- rumqttc/src/v5/eventloop.rs | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/rumqttc/src/v5/eventloop.rs b/rumqttc/src/v5/eventloop.rs index d3b643f30..6fa5cb458 100644 --- a/rumqttc/src/v5/eventloop.rs +++ b/rumqttc/src/v5/eventloop.rs @@ -412,19 +412,13 @@ async fn mqtt_connect( // If it's a new session, clear the pendings pending.clear(); } - // Override local settings if set by server. if let Some(props) = &connack.properties { - // Override local keep_alive value if set by server. if let Some(keep_alive) = props.server_keep_alive { options.keep_alive = Duration::from_secs(keep_alive as u64); } network.set_max_outgoing_size(props.max_packet_size); - // Override local session_expiry_interval value if set by server. - if (props.session_expiry_interval).is_some() { - options.set_session_expiry_interval(props.session_expiry_interval); - } } - Ok(Packet::ConnAck(connack)) + Ok(connack) } Incoming::ConnAck(connack) => Err(ConnectionError::ConnectionRefused(connack.code)), packet => Err(ConnectionError::NotConnAck(Box::new(packet))), From 1387d5e07d717a9d3d1407ec3e5275de679ab743 Mon Sep 17 00:00:00 2001 From: Devdutt Shenoi Date: Tue, 14 May 2024 10:32:43 +0000 Subject: [PATCH 2/3] refactor: improve readability --- rumqttc/src/v5/eventloop.rs | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/rumqttc/src/v5/eventloop.rs b/rumqttc/src/v5/eventloop.rs index 6fa5cb458..9c3e59222 100644 --- a/rumqttc/src/v5/eventloop.rs +++ b/rumqttc/src/v5/eventloop.rs @@ -138,21 +138,28 @@ impl EventLoop { if self.network.is_none() { let (network, connack) = time::timeout( Duration::from_secs(self.options.connection_timeout()), - connect(&mut self.pending, &mut self.options), + connect(&mut self.options), ) .await??; + // Last session might contain packets which aren't acked. If it's a new session, clear the pending packets. + if !connack.session_present { + self.pending.clear(); + } self.network = Some(network); if self.keepalive_timeout.is_none() { self.keepalive_timeout = Some(Box::pin(time::sleep(self.options.keep_alive))); } - self.state.handle_incoming_packet(connack)?; + self.state + .handle_incoming_packet(Incoming::ConnAck(connack))?; } match self.select().await { Ok(v) => Ok(v), Err(e) => { + // MQTT requires that packets pending acknowledgement should be republished on session resume. + // Move pending messages from state to eventloop. self.clean(); Err(e) } @@ -263,19 +270,14 @@ impl EventLoop { /// the stream. /// This function (for convenience) includes internal delays for users to perform internal sleeps /// between re-connections so that cancel semantics can be used during this sleep -async fn connect(pending: &mut VecDeque, options: &mut MqttOptions) -> Result<(Network, Incoming), ConnectionError> { +async fn connect(options: &mut MqttOptions) -> Result<(Network, ConnAck), ConnectionError> { // connect to the broker let mut network = network_connect(options).await?; // make MQTT connection request (which internally awaits for ack) - let packet = mqtt_connect(pending, options, &mut network).await?; - - // Last session might contain packets which aren't acked. MQTT says these packets should be - // republished in the next session if session is resumed - // move pending messages from state to eventloop - // let pending = self.state.clean(); - // self.pending = pending.into_iter(); - Ok((network, packet)) + let connack = mqtt_connect(options, &mut network).await?; + + Ok((network, connack)) } async fn network_connect(options: &MqttOptions) -> Result { @@ -385,10 +387,9 @@ async fn network_connect(options: &MqttOptions) -> Result, options: &mut MqttOptions, network: &mut Network, -) -> Result { +) -> Result { let keep_alive = options.keep_alive().as_secs() as u16; let clean_start = options.clean_start(); let client_id = options.client_id(); @@ -407,11 +408,6 @@ async fn mqtt_connect( // validate connack match network.read().await? { Incoming::ConnAck(connack) if connack.code == ConnectReturnCode::Success => { - // Check if it's a new session - if !connack.session_present { - // If it's a new session, clear the pendings - pending.clear(); - } if let Some(props) = &connack.properties { if let Some(keep_alive) = props.server_keep_alive { options.keep_alive = Duration::from_secs(keep_alive as u64); From 2396c849c53ec07015d6cd1690ab51293904cb47 Mon Sep 17 00:00:00 2001 From: Devdutt Shenoi Date: Tue, 14 May 2024 10:41:53 +0000 Subject: [PATCH 3/3] feat: apply changes to v4 --- rumqttc/CHANGELOG.md | 2 +- rumqttc/src/eventloop.rs | 20 ++++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/rumqttc/CHANGELOG.md b/rumqttc/CHANGELOG.md index 5d3c9f08a..d2a59f178 100644 --- a/rumqttc/CHANGELOG.md +++ b/rumqttc/CHANGELOG.md @@ -28,7 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Validate filters while creating subscription requests. * Make v4::Connect::write return correct value * Ordering of `State.events` related to `QoS > 0` publishes -* Resume v5 session only if broker CONNACK with Session Present 1. +* Resume session only if broker sends `CONNACK` with `session_present == 1`. ### Security diff --git a/rumqttc/src/eventloop.rs b/rumqttc/src/eventloop.rs index a9b1ce8c5..25081a179 100644 --- a/rumqttc/src/eventloop.rs +++ b/rumqttc/src/eventloop.rs @@ -149,18 +149,24 @@ impl EventLoop { Ok(inner) => inner?, Err(_) => return Err(ConnectionError::NetworkTimeout), }; + // Last session might contain packets which aren't acked. If it's a new session, clear the pending packets. + if !connack.session_present { + self.pending.clear(); + } self.network = Some(network); if self.keepalive_timeout.is_none() && !self.mqtt_options.keep_alive.is_zero() { self.keepalive_timeout = Some(Box::pin(time::sleep(self.mqtt_options.keep_alive))); } - return Ok(Event::Incoming(connack)); + return Ok(Event::Incoming(Packet::ConnAck(connack))); } match self.select().await { Ok(v) => Ok(v), Err(e) => { + // MQTT requires that packets pending acknowledgement should be republished on session resume. + // Move pending messages from state to eventloop. self.clean(); Err(e) } @@ -294,14 +300,14 @@ impl EventLoop { async fn connect( mqtt_options: &MqttOptions, network_options: NetworkOptions, -) -> Result<(Network, Incoming), ConnectionError> { +) -> Result<(Network, ConnAck), ConnectionError> { // connect to the broker let mut network = network_connect(mqtt_options, network_options).await?; // make MQTT connection request (which internally awaits for ack) - let packet = mqtt_connect(mqtt_options, &mut network).await?; + let connack = mqtt_connect(mqtt_options, &mut network).await?; - Ok((network, packet)) + Ok((network, connack)) } pub(crate) async fn socket_connect( @@ -469,7 +475,7 @@ async fn network_connect( async fn mqtt_connect( options: &MqttOptions, network: &mut Network, -) -> Result { +) -> Result { let keep_alive = options.keep_alive().as_secs() as u16; let clean_session = options.clean_session(); let last_will = options.last_will(); @@ -485,9 +491,7 @@ async fn mqtt_connect( // validate connack match network.read().await? { - Incoming::ConnAck(connack) if connack.code == ConnectReturnCode::Success => { - Ok(Packet::ConnAck(connack)) - } + Incoming::ConnAck(connack) if connack.code == ConnectReturnCode::Success => Ok(connack), Incoming::ConnAck(connack) => Err(ConnectionError::ConnectionRefused(connack.code)), packet => Err(ConnectionError::NotConnAck(packet)), }