Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to using reactive streams based APIs for Ditto managed MQTT connections #1411

Merged
merged 42 commits into from
Jul 12, 2022

Conversation

jufickel-b
Copy link

Rewrote Ditto's MQTT backend.
The client now consumes publish messages in a reactive manner. Together with throttling this effectively enables backpressure.
Furthermore, the code could be made simpler by unifying the processing algorithms instead of splitting them for different protocol versions; this was reached by providing a unified abstraction of HiveMQ's APIs for MQTT 3.x and 5.

Juergen Fickel and others added 30 commits March 28, 2022 10:00
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
…o accept a Throwable.

This makes it easier to work with this method while handling CompletionStage results. The functionality of ExceptionToAcknowledgementConverter remains as is.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
This makes it easier to access.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Also added a package for abstracting MQTT Publish messages from their protocol version. This abstraction avoids split processing logic which makes it easier to understand what is going on.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Also added a package for abstracting MQTT Publish messages from their protocol version. This abstraction avoids split processing logic which makes it easier to understand what is going on.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
…ure/reactive_mqtt

# Conflicts:
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/consuming/package-info.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/publish/package-info.java
…d of `Exception`. This change does not affect functionality of `ConnectionMonitor` at all, but it makes it easier to use without superfluous `instanceof` checks.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
The new actor operates on a generic MQTT Publish message and thus is suitable for MQTT version 3 and 5.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
This package provides all means to subscribe for topics at the MQTT broker.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Furthermore,
* moved `InvalidMQttQosCodeException` to package `common` as it is used at another place, too,
* added `ChildActorNanny` for starting and stopping child actors of `BaseClientActor`,
* removed client ID from BasePublisherActor as it was unused.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Restructuring was necessary because there is not always a separate consumer and publisher client; both could use the same HiveMQ client.
Therefore, subscribing client and publishing client were moved to client package and got hidden beyond the new `GenericMqttClient` interface.

More changes:
* Oriented package structure for generic messages toward HiveMQ API.
* Got rid of `SourceSubscribeResult` because now each `SubscribeResult` has a connection `Source`.
* Small improvements in `BaseClientActor`.
* Moved `MqttClientConnected` from `AbstractMqttClientActor` in containing package.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
* Legacy MQTT implementation still has to be removed after testing.
* Refactored `GenericMqttClientFactory` to be a utility class instead of an interface because it did not make sense to have an instance of this factory. This entailed some static mocking in `GenericMqttClientActorTest` and `ConnectionTesterTest`.
* Provide `MqttSpecificConfig` to `HiveMqttClientProperties` because this config is required in `GenericMqttActor` anyway. This prevents duplicate creation of `MqttSpecificConfig`.
* Implemented possibility of reconnecting of consumer client to `GenericMqttActor`.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
It is crucial that `ClientDisconnected` gets emitted even if the client was disconnected previously and is not available anymore.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
…it was its only inheritor.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
# Conflicts:
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/BaseConsumerActor.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/AbstractMqttValidator.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/AbstractHiveMqttClientFactory.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/AbstractMqttClientActor.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/AbstractMqttSubscriptionHandler.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/DefaultHiveMqtt3ClientFactory.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/DefaultHiveMqtt5ClientFactory.java
#	connectivity/service/src/main/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/HiveMqttClientFactory.java
#	connectivity/service/src/test/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/AbstractMqttClientActorTest.java
#	connectivity/service/src/test/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/MockHiveMqtt3ClientFactory.java
#	connectivity/service/src/test/java/org/eclipse/ditto/connectivity/service/messaging/mqtt/hivemq/MockHiveMqtt5ClientFactory.java
…nnection.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
…queue fails.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
…suming and publishing, too, do not have 'Generic' in their name.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
- ChildActorNanny cannot be thread-safe; label it as such.
- Add thread-safe wrapper AsyncChildActorNanny.
- Add health check to MqttPublisherActor and MqttConsumerActor.
- Move CompletableFutureUtils to ditto.base.service for reuse.

Signed-off-by: Yufei Cai <yufei.cai@bosch.io>
Doing so made AsyncChildActorNanny and ChildActorNannyActor superfluous because thread-safe child actor creation now can take place in ConnectionTesterActor itself.

Made SubscriptionsFailedException public in order to use it directly to spare instanceof checks.
Changed getter for failed subscription statuses to return a Stream instead of a List.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Unit testing connection testing now does not work anymore because having made ConnectionTester an actor eliminated possibilities for mocking.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
This allows to throttle incoming QoS 1 and QoS 2 publish messages.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
…ttConfig.

Rationale: This value is set by the Ditto operator and cannot be set by users themselves.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Juergen Fickel and others added 11 commits June 29, 2022 10:19
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Yufei Cai <yufei.cai@bosch.io>
… TestConnectionActor.

* Moved flag for disabling Last Will message to HiveMqttClientProperties.
* Improved ConnectionTesterActor to be more sensitive to possible errors and to disconnect the client whenever possible in case of errors.
* Renamed method in MqttSpecificConfig to comply to convention for names boolean getters values.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Yufei Cai <yufei.cai@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
Furthermore, removed unused MqttPublishTarget.

Signed-off-by: Juergen Fickel <juergen.fickel@bosch.io>
@thjaeckle thjaeckle changed the title Feature/reactive mqtt Switch to using reactive streams based APIs for Ditto managed MQTT connections Jul 12, 2022
@thjaeckle thjaeckle added this to the 3.0.0 milestone Jul 12, 2022
The test fails on resource-constrained Github builder.

Signed-off-by: Yufei Cai <yufei.cai@bosch.io>
@yufei-cai yufei-cai merged commit b1506de into eclipse-ditto:master Jul 12, 2022
@yufei-cai yufei-cai deleted the feature/reactive_mqtt branch July 12, 2022 13:30
This pull request was closed.
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.

3 participants