fix(health): Add option to disable health indicator for MQ listeners (#…

…76)

README.md

@@ -377,6 +377,24 @@ You should create and register many fixed response queues for request reply, in
     }
 ```
 
+### Health Checks
+
+Commons JMS has two health indicators, the first one is the default spring boot jms health indicator, which checks the connection. The second one is the `MQHealthIndicator` which checks the listeners connection to the queue manager.
+
+Both health indicators are enabled by default, but you can disable them by setting the next properties:
+
+- application.properties
+  ```properties
+  management.health.jms.enabled=false
+  ```
+- application.yaml
+  ```yaml
+  management:
+    health:
+      jms:
+        enabled: false
+  ```
+
 ### Usual utilities
 
 - [`MQUtils`](commons-jms-mq/src/main/java/co/com/bancolombia/commons/jms/mq/utils/MQUtils.java)

commons-jms-mq/src/main/java/co/com/bancolombia/commons/jms/mq/config/MQAutoconfiguration.java

@@ -7,17 +7,19 @@
 import co.com.bancolombia.commons.jms.api.MQQueueManagerSetter;
 import co.com.bancolombia.commons.jms.api.MQQueuesContainer;
 import co.com.bancolombia.commons.jms.api.exceptions.MQHealthListener;
+import co.com.bancolombia.commons.jms.internal.listener.selector.MQExecutorService;
 import co.com.bancolombia.commons.jms.internal.listener.selector.strategy.SelectorBuilder;
 import co.com.bancolombia.commons.jms.internal.models.MQListenerConfig;
 import co.com.bancolombia.commons.jms.internal.models.RetryableConfig;
+import co.com.bancolombia.commons.jms.mq.config.health.MQListenerDisabledHealthIndicator;
 import co.com.bancolombia.commons.jms.mq.config.health.MQListenerHealthIndicator;
-import co.com.bancolombia.commons.jms.internal.listener.selector.MQExecutorService;
 import co.com.bancolombia.commons.jms.mq.utils.MQUtils;
 import co.com.bancolombia.commons.jms.utils.MQQueueUtils;
 import co.com.bancolombia.commons.jms.utils.MQQueuesContainerImp;
 import co.com.bancolombia.commons.jms.utils.ReactiveReplyRouter;
 import com.ibm.mq.jakarta.jms.MQQueue;
 import jakarta.jms.Message;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.ApplicationEventPublisher;
@@ -74,7 +76,11 @@ public MQBrokerUtils defaultMqBrokerUtils() {
 
     @Bean
     @ConditionalOnMissingBean(MQHealthListener.class)
-    public MQHealthListener defaultMqHealthListener(ApplicationEventPublisher publisher) {
+    public MQHealthListener defaultMqHealthListener(ApplicationEventPublisher publisher,
+                                                    @Value("${management.health.jms.enabled:true}") boolean enabled) {
+        if (!enabled) {
+            return new MQListenerDisabledHealthIndicator();
+        }
         return new MQListenerHealthIndicator(publisher);
     }
 

commons-jms-mq/src/main/java/co/com/bancolombia/commons/jms/mq/config/health/MQListenerDisabledHealthIndicator.java

@@ -0,0 +1,27 @@
+package co.com.bancolombia.commons.jms.mq.config.health;
+
+import co.com.bancolombia.commons.jms.api.exceptions.MQHealthListener;
+import jakarta.jms.JMSException;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+
+@Log4j2
+@RequiredArgsConstructor
+public class MQListenerDisabledHealthIndicator implements MQHealthListener {
+
+    @Override
+    public void onInit(String listener) {
+        // Do nothing
+    }
+
+    @Override
+    public void onStarted(String listener) {
+        // Do nothing
+    }
+
+    @Override
+    public void onException(String listener, JMSException exception) {
+        // Do nothing
+    }
+
+}

commons-jms-mq/src/test/java/co/com/bancolombia/commons/jms/mq/config/MQAutoconfiguracionTest.java

@@ -7,9 +7,9 @@
 import co.com.bancolombia.commons.jms.api.MQQueueManagerSetter;
 import co.com.bancolombia.commons.jms.api.MQQueuesContainer;
 import co.com.bancolombia.commons.jms.api.exceptions.MQHealthListener;
+import co.com.bancolombia.commons.jms.internal.listener.selector.MQExecutorService;
 import co.com.bancolombia.commons.jms.internal.listener.selector.strategy.SelectorBuilder;
 import co.com.bancolombia.commons.jms.internal.models.RetryableConfig;
-import co.com.bancolombia.commons.jms.internal.listener.selector.MQExecutorService;
 import co.com.bancolombia.commons.jms.utils.ReactiveReplyRouter;
 import com.ibm.mq.jakarta.jms.MQQueue;
 import jakarta.jms.JMSContext;
@@ -21,9 +21,12 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.boot.actuate.health.HealthIndicator;
 import org.springframework.context.ApplicationEventPublisher;
 
 import static com.ibm.msg.client.jakarta.wmq.common.CommonConstants.WMQ_TARGET_CLIENT;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -92,8 +95,19 @@ void shouldCreateMQQueueManagerSetter() throws JMSException {
 
     @Test
     void shouldCreateMQListenerHealthIndicator() {
-        MQHealthListener bean = configuration.defaultMqHealthListener(publisher);
+        MQHealthListener bean = configuration.defaultMqHealthListener(publisher, true);
+        Assertions.assertNotNull(bean);
+        assertInstanceOf(HealthIndicator.class, bean);
+    }
+
+    @Test
+    void shouldCreateDisabledMQListenerHealthIndicator() {
+        MQHealthListener bean = configuration.defaultMqHealthListener(publisher, false);
+        bean.onInit("listener");
+        bean.onStarted("listener");
+        bean.onException("listener", new JMSException("test"));
         Assertions.assertNotNull(bean);
+        assertFalse(bean instanceof HealthIndicator);
     }
 
     @Test

examples/mq-reactive/src/main/resources/application.yaml

@@ -24,6 +24,8 @@ management:
   health:
     probes:
       enabled: true # To test liveness and readiness probes
+    jms:
+      enabled: false
   endpoint:
     health:
       show-details: always