GH-4014: MQTT ClientManager: completion timeouts #8552
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes spring-projects#4014 The `ClientManager` implementations uses by mistake a `connectionTimeout` for operations with completion wait * Introduce `completionTimeout` and `disconnectCompletionTimeout` for `ClientManager` abstraction to realign the logic with existing channel adapters and Paho Client by itself. * Deprecate `DEFAULT_COMPLETION_TIMEOUT` and `DISCONNECT_COMPLETION_TIMEOUT` constants in the `AbstractMqttMessageDrivenChannelAdapter` in favor of respective replacement in the `ClientManager` * Pull `disconnectCompletionTimeout` property from the `MqttPahoMessageDrivenChannelAdapter` to its superclass * Use new `disconnectCompletionTimeout` in the `Mqttv5PahoMessageDrivenChannelAdapter` for similar `disconnectForcibly()` call * Fix Lifecycle race condition when `ClientManager` is started by the outbound channel adapter (`Integer.MIN_VALUE` phase and auto-startup - see `DefaultLifecycleProcessor.doStart()` and logic around `dependencies`) which is much earlier than `MessageProducerSupport` (`Integer.MAX_VALUE / 2` phase) and there a `connectComplete()` callback might be called before the `MessageProducerSupport.start()`. For that purpose check for an `isRunning()` in the `connectComplete()` before subscribing and set `readyToSubscribeOnStart` flag to `subscribe()` in a `doStart()` of this `MqttMessageDrivenChannelAdapter` * Remove redundant `MqttPahoMessageDrivenChannelAdapter.cleanSession` property in favor of `this.clientFactory.getConnectionOptions().isCleanSession()` call spring-projectsGH-8550: MQTT: Always re-subscribe on re-connect Fixes spring-projects#8550 Turns out the Paho MQTT client does not re-subscribe when connection re-established on automatic reconnection * Fix `AbstractMqttMessageDrivenChannelAdapter` to always subscribe to their topics in the `connectComplete()` independently of the `reconnect` status * Verify behavior with `MOSQUITTO_CONTAINER` image restart in Docker
|
This PR also includes the fix for #8550. |
garyrussell
reviewed
Feb 15, 2023
...-mqtt/src/main/java/org/springframework/integration/mqtt/core/AbstractMqttClientManager.java
Show resolved
Hide resolved
garyrussell
approved these changes
Feb 15, 2023
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4014
The
ClientManagerimplementations uses by mistake aconnectionTimeoutfor operations with completion waitcompletionTimeoutanddisconnectCompletionTimeoutforClientManagerabstraction to realign the logic with existing channel adapters and Paho Client by itself.DEFAULT_COMPLETION_TIMEOUTandDISCONNECT_COMPLETION_TIMEOUTconstants in theAbstractMqttMessageDrivenChannelAdapterin favor of respective replacement in theClientManagerdisconnectCompletionTimeoutproperty from theMqttPahoMessageDrivenChannelAdapterto its superclassdisconnectCompletionTimeoutin theMqttv5PahoMessageDrivenChannelAdapterfor similardisconnectForcibly()callClientManageris started by the outbound channel adapter (Integer.MIN_VALUEphase and auto-startup - seeDefaultLifecycleProcessor.doStart()and logic arounddependencies) which is much earlier thanMessageProducerSupport(Integer.MAX_VALUE / 2phase) and there aconnectComplete()callback might be called before theMessageProducerSupport.start(). For that purpose check for anisRunning()in theconnectComplete()before subscribing and setreadyToSubscribeOnStartflag tosubscribe()in adoStart()of thisMqttMessageDrivenChannelAdapterMqttPahoMessageDrivenChannelAdapter.cleanSessionproperty in favor ofthis.clientFactory.getConnectionOptions().isCleanSession()callGH-8550: MQTT: Always re-subscribe on re-connect
Fixes #8550
Turns out the Paho MQTT client does not re-subscribe when connection re-established on automatic reconnection
AbstractMqttMessageDrivenChannelAdapterto always subscribe to their topics in theconnectComplete()independently of thereconnectstatusMOSQUITTO_CONTAINERimage restart in Docker