GH-3732 add mqqtClient initialization check before adding or removing topic

Author: Mikhail Polivakha

Diff for: spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/AbstractMqttMessageDrivenChannelAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 package org.springframework.integration.mqtt.inbound;
 
 import java.util.LinkedHashSet;
+import java.util.Objects;
 import java.util.Set;
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReentrantLock;
@@ -331,15 +332,7 @@ public boolean equals(Object obj) {
 				return false;
 			}
 			Topic other = (Topic) obj;
-			if (this.topic == null) {
-				if (other.topic != null) {
-					return false;
-				}
-			}
-			else if (!this.topic.equals(other.topic)) {
-				return false;
-			}
-			return true;
+			return Objects.equals(this.topic, other.topic);
 		}
 
 		@Override

Diff for: spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/MqttPahoMessageDrivenChannelAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

Diff for: spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/inbound/Mqttv5PahoMessageDrivenChannelAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors.
+ * Copyright 2021-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -65,6 +65,7 @@
  * See {@link #setPayloadType} for more information about type conversion.
  *
  * @author Artem Bilan
+ * @author Mikhail Polivakha
  *
  * @since 5.5.5
  *
@@ -141,13 +142,15 @@ public void setHeaderMapper(HeaderMapper<MqttProperties> headerMapper) {
 	@Override
 	protected void onInit() {
 		super.onInit();
-		try {
-			this.mqttClient = new MqttAsyncClient(getUrl(), getClientId(), this.persistence);
-			this.mqttClient.setCallback(this);
-			this.mqttClient.setManualAcks(isManualAcks());
-		}
-		catch (MqttException ex) {
-			throw new BeanCreationException("Cannot create 'MqttAsyncClient' for: " + getComponentName(), ex);
+		if (mqttClient == null) {
+			try {
+				this.mqttClient = new MqttAsyncClient(getUrl(), getClientId(), this.persistence);
+				this.mqttClient.setCallback(this);
+				this.mqttClient.setManualAcks(isManualAcks());
+			}
+			catch (MqttException ex) {
+				throw new BeanCreationException("Cannot create 'MqttAsyncClient' for: " + getComponentName(), ex);
+			}
 		}
 		if (this.messageConverter == null) {
 			setMessageConverter(getBeanFactory()
@@ -189,8 +192,12 @@ protected void doStop() {
 		this.topicLock.lock();
 		String[] topics = getTopic();
 		try {
-			this.mqttClient.unsubscribe(topics).waitForCompletion(getCompletionTimeout());
-			this.mqttClient.disconnect().waitForCompletion(getCompletionTimeout());
+			if (mqttClient != null && mqttClient.isConnected()) {
+				this.mqttClient.unsubscribe(topics).waitForCompletion(getCompletionTimeout());
+				this.mqttClient.disconnect().waitForCompletion(getCompletionTimeout());
+			} else {
+				logger.warn("An attempt to stop mqtt client without having one initialized or connected");
+			}
 		}
 		catch (MqttException ex) {
 			logger.error(ex, () -> "Error unsubscribing from " + Arrays.toString(topics));
@@ -204,9 +211,10 @@ protected void doStop() {
 	public void destroy() {
 		super.destroy();
 		try {
-			this.mqttClient.close(true);
-		}
-		catch (MqttException ex) {
+			if (mqttClient != null) {
+				this.mqttClient.close(true);
+			}
+		} catch (MqttException ex) {
 			logger.error(ex, "Failed to close 'MqttAsyncClient'");
 		}
 	}
@@ -215,8 +223,12 @@ public void destroy() {
 	public void addTopic(String topic, int qos) {
 		this.topicLock.lock();
 		try {
-			this.mqttClient.subscribe(topic, qos).waitForCompletion(getCompletionTimeout());
 			super.addTopic(topic, qos);
+			if (mqttClient != null && mqttClient.isConnected()) {
+				this.mqttClient.subscribe(topic, qos).waitForCompletion(getCompletionTimeout());
+			} else {
+				logger.warn(String.format("An attempt to add topic : '%s' with QoS : '%s' without having mqtt client initialized or connected", topic, qos));
+			}
 		}
 		catch (MqttException ex) {
 			throw new MessagingException("Failed to subscribe to topic " + topic, ex);
@@ -230,7 +242,11 @@ public void addTopic(String topic, int qos) {
 	public void removeTopic(String... topic) {
 		this.topicLock.lock();
 		try {
-			this.mqttClient.unsubscribe(topic).waitForCompletion(getCompletionTimeout());
+			if (mqttClient != null && mqttClient.isConnected()) {
+				this.mqttClient.unsubscribe(topic).waitForCompletion(getCompletionTimeout());
+			} else {
+				logger.warn(String.format("An attempt to remove topics : '%s' without having mqtt client initialized or connected", Arrays.toString(topic)));
+			}
 			super.removeTopic(topic);
 		}
 		catch (MqttException ex) {

Diff for: spring-integration-mqtt/src/test/java/org/springframework/integration/mqtt/inbound/Mqttv5PahoMessageDrivenChannelAdapterTest.java

@@ -0,0 +1,24 @@
+package org.springframework.integration.mqtt.inbound;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Mqttv5PahoMessageDrivenChannelAdapterTest's unit tests
+ *
+ * @author Mikhail Polivakha
+ */
+class Mqttv5PahoMessageDrivenChannelAdapterTest {
+
+	@Test //GH-3732
+	public void testNoNpeIsNotThrownInCaseDoInitIsNotInvokedBeforeTopicAddition() {
+		Mqttv5PahoMessageDrivenChannelAdapter channelAdapter = new Mqttv5PahoMessageDrivenChannelAdapter("tcp://mock-url.com:8091", "mock-client-id", "123");
+		Assertions.assertDoesNotThrow(() -> channelAdapter.addTopic("abc", 1));
+	}
+
+	@Test //GH-3732
+	public void testNoNpeIsNotThrownInCaseDoInitIsNotInvokedBeforeTopicRemoval() {
+		Mqttv5PahoMessageDrivenChannelAdapter channelAdapter = new Mqttv5PahoMessageDrivenChannelAdapter("tcp://mock-url.com:8091", "mock-client-id", "123");
+		Assertions.assertDoesNotThrow(() -> channelAdapter.removeTopic("abc"));
+	}
+}