chore(health): ignore health indicator when dependency not exists (#126)

juancgalvis · web-flow · commit 1819ce5a5d4d · 2024-12-14T10:31:13.000-05:00
* fix(health): ignore health indicator when dependency not exists
diff --git a/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/broker/BrokerProvider.java b/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/broker/BrokerProvider.java
@@ -3,8 +3,8 @@
 import org.reactivecommons.api.domain.DomainEventBus;
 import org.reactivecommons.async.api.DirectAsyncGateway;
 import org.reactivecommons.async.commons.HandlerResolver;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import org.reactivecommons.async.starter.props.GenericAsyncProps;
-import org.springframework.boot.actuate.health.Health;
 import reactor.core.publisher.Mono;
 
 @SuppressWarnings("rawtypes")
@@ -25,5 +25,5 @@ public interface BrokerProvider<T extends GenericAsyncProps> {
 
     void listenReplies(HandlerResolver resolver);
 
-    Mono<Health> healthCheck();
+    Mono<RCHealth> healthCheck();
 }
diff --git a/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/RCHealth.java b/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/RCHealth.java
@@ -0,0 +1,46 @@
+package org.reactivecommons.async.starter.config.health;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@Getter
+@Builder
+@AllArgsConstructor
+public class RCHealth {
+    private final Status status;
+    private final Map<String, Object> details;
+
+    public enum Status {
+        UP,
+        DOWN
+    }
+
+    public static class RCHealthBuilder {
+        public RCHealthBuilder() {
+            this.details = new HashMap<>();
+        }
+
+        public RCHealthBuilder up() {
+            this.status = Status.UP;
+            return this;
+        }
+
+        public RCHealthBuilder down() {
+            this.status = Status.DOWN;
+            return this;
+        }
+
+        public RCHealthBuilder withDetail(String key, Object value) {
+            this.details.put(key, value);
+            return this;
+        }
+
+        public RCHealth build() {
+            return new RCHealth(this.status, this.details);
+        }
+    }
+}
diff --git a/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/RCHealthIndicator.java b/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/RCHealthIndicator.java
@@ -0,0 +1,13 @@
+package org.reactivecommons.async.starter.config.health;
+
+import reactor.core.publisher.Mono;
+
+public abstract class RCHealthIndicator {
+
+    public Mono<RCHealth> health() {
+        return doHealthCheck(RCHealth.builder())
+                .onErrorResume(e -> Mono.just(RCHealth.builder().down().withDetail("error", e.getMessage()).build()));
+    }
+
+    public abstract Mono<RCHealth> doHealthCheck(RCHealth.RCHealthBuilder builder);
+}
diff --git a/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/ReactiveCommonsHealthConfig.java b/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/ReactiveCommonsHealthConfig.java
@@ -8,12 +8,12 @@
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
+@ConditionalOnClass(AbstractReactiveHealthIndicator.class)
 public class ReactiveCommonsHealthConfig {
 
     @Bean
     @ConditionalOnProperty(prefix = "management.health.reactive-commons", name = "enabled", havingValue = "true",
             matchIfMissing = true)
-    @ConditionalOnClass(AbstractReactiveHealthIndicator.class)
     public ReactiveCommonsHealthIndicator reactiveCommonsHealthIndicator(ConnectionManager manager) {
         return new ReactiveCommonsHealthIndicator(manager);
     }
diff --git a/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/ReactiveCommonsHealthIndicator.java b/starters/async-commons-starter/src/main/java/org/reactivecommons/async/starter/config/health/ReactiveCommonsHealthIndicator.java
@@ -2,11 +2,10 @@
 
 import lombok.AllArgsConstructor;
 import lombok.extern.log4j.Log4j2;
-import org.reactivecommons.async.starter.config.ConnectionManager;
 import org.reactivecommons.async.starter.broker.BrokerProvider;
+import org.reactivecommons.async.starter.config.ConnectionManager;
 import org.springframework.boot.actuate.health.AbstractReactiveHealthIndicator;
 import org.springframework.boot.actuate.health.Health;
-import org.springframework.boot.actuate.health.Status;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -22,14 +21,14 @@ public class ReactiveCommonsHealthIndicator extends AbstractReactiveHealthIndica
     protected Mono<Health> doHealthCheck(Health.Builder builder) {
         return Flux.fromIterable(manager.getProviders().values())
                 .flatMap(BrokerProvider::healthCheck)
-                .reduceWith(Health::up, (health, status) -> reduceHealth((Health.Builder) health, (Health) status))
+                .reduceWith(Health::up, (health, status) -> reduceHealth((Health.Builder) health, (RCHealth) status))
                 .map(b -> ((Health.Builder) b).build());
 
     }
 
-    private Health.Builder reduceHealth(Health.Builder builder, Health status) {
+    private Health.Builder reduceHealth(Health.Builder builder, RCHealth status) {
         String domain = status.getDetails().get(DOMAIN).toString();
-        if (status.getStatus().equals(Status.DOWN)) {
+        if (status.getStatus().equals(RCHealth.Status.DOWN)) {
             log.error("Broker of domain {} is down", domain);
             return builder.down().withDetail(domain, status.getDetails());
         }
diff --git a/starters/async-commons-starter/src/test/java/org/reactivecommons/async/starter/config/health/ReactiveCommonsHealthIndicatorTest.java b/starters/async-commons-starter/src/test/java/org/reactivecommons/async/starter/config/health/ReactiveCommonsHealthIndicatorTest.java
@@ -37,11 +37,11 @@ void setUp() {
     @Test
     void shouldBeUp() {
         // Arrange
-        when(brokerProvider.healthCheck()).thenReturn(Mono.just(Health.up()
+        when(brokerProvider.healthCheck()).thenReturn(Mono.just(RCHealth.builder().up()
                 .withDetail(DOMAIN, DEFAULT_DOMAIN)
                 .withDetail(VERSION, "123")
                 .build()));
-        when(brokerProvider2.healthCheck()).thenReturn(Mono.just(Health.up()
+        when(brokerProvider2.healthCheck()).thenReturn(Mono.just(RCHealth.builder().up()
                 .withDetail(DOMAIN, OTHER)
                 .withDetail(VERSION, "1234")
                 .build()));
@@ -56,11 +56,11 @@ void shouldBeUp() {
     @Test
     void shouldBeDown() {
         // Arrange
-        when(brokerProvider.healthCheck()).thenReturn(Mono.just(Health.up()
+        when(brokerProvider.healthCheck()).thenReturn(Mono.just(RCHealth.builder().down()
                 .withDetail(DOMAIN, DEFAULT_DOMAIN)
                 .withDetail(VERSION, "123")
                 .build()));
-        when(brokerProvider2.healthCheck()).thenReturn(Mono.just(Health.down()
+        when(brokerProvider2.healthCheck()).thenReturn(Mono.just(RCHealth.builder().up()
                 .withDetail(DOMAIN, OTHER)
                 .withDetail(VERSION, "1234")
                 .build()));
diff --git a/starters/async-commons-starter/src/test/java/org/reactivecommons/async/starter/mybroker/MyBrokerProvider.java b/starters/async-commons-starter/src/test/java/org/reactivecommons/async/starter/mybroker/MyBrokerProvider.java
@@ -6,8 +6,8 @@
 import org.reactivecommons.async.commons.HandlerResolver;
 import org.reactivecommons.async.starter.broker.BrokerProvider;
 import org.reactivecommons.async.starter.broker.DiscardProvider;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import org.reactivecommons.async.starter.mybroker.props.MyBrokerAsyncProps;
-import org.springframework.boot.actuate.health.Health;
 import reactor.core.publisher.Mono;
 
 @AllArgsConstructor
@@ -57,7 +57,7 @@ public void listenReplies(HandlerResolver resolver) {
     }
 
     @Override
-    public Mono<Health> healthCheck() {
+    public Mono<RCHealth> healthCheck() {
         return null;
     }
 }
diff --git a/starters/async-kafka-starter/src/main/java/org/reactivecommons/async/kafka/KafkaBrokerProvider.java b/starters/async-kafka-starter/src/main/java/org/reactivecommons/async/kafka/KafkaBrokerProvider.java
@@ -19,7 +19,7 @@
 import org.reactivecommons.async.kafka.listeners.ApplicationEventListener;
 import org.reactivecommons.async.kafka.listeners.ApplicationNotificationsListener;
 import org.reactivecommons.async.starter.broker.BrokerProvider;
-import org.springframework.boot.actuate.health.Health;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import org.springframework.boot.ssl.SslBundles;
 import reactor.core.publisher.Mono;
 
@@ -100,7 +100,7 @@ public void listenReplies(HandlerResolver resolver) {
     }
 
     @Override
-    public Mono<Health> healthCheck() {
+    public Mono<RCHealth> healthCheck() {
         return healthIndicator.health();
     }
 }
diff --git a/starters/async-kafka-starter/src/main/java/org/reactivecommons/async/kafka/health/KafkaReactiveHealthIndicator.java b/starters/async-kafka-starter/src/main/java/org/reactivecommons/async/kafka/health/KafkaReactiveHealthIndicator.java
@@ -3,21 +3,21 @@
 import lombok.AllArgsConstructor;
 import lombok.extern.log4j.Log4j2;
 import org.apache.kafka.clients.admin.AdminClient;
-import org.springframework.boot.actuate.health.AbstractReactiveHealthIndicator;
-import org.springframework.boot.actuate.health.Health;
+import org.reactivecommons.async.starter.config.health.RCHealth;
+import org.reactivecommons.async.starter.config.health.RCHealthIndicator;
 import reactor.core.publisher.Mono;
 
 import static org.reactivecommons.async.starter.config.health.ReactiveCommonsHealthIndicator.DOMAIN;
 import static org.reactivecommons.async.starter.config.health.ReactiveCommonsHealthIndicator.VERSION;
 
 @Log4j2
 @AllArgsConstructor
-public class KafkaReactiveHealthIndicator extends AbstractReactiveHealthIndicator {
+public class KafkaReactiveHealthIndicator extends RCHealthIndicator {
     private final String domain;
     private final AdminClient adminClient;
 
     @Override
-    protected Mono<Health> doHealthCheck(Health.Builder builder) {
+    public Mono<RCHealth> doHealthCheck(RCHealth.RCHealthBuilder builder) {
         builder.withDetail(DOMAIN, domain);
         return checkKafkaHealth()
                 .map(clusterId -> builder.up().withDetail(VERSION, clusterId).build())
diff --git a/starters/async-kafka-starter/src/test/java/org/reactivecommons/async/kafka/KafkaBrokerProviderTest.java b/starters/async-kafka-starter/src/test/java/org/reactivecommons/async/kafka/KafkaBrokerProviderTest.java
@@ -20,7 +20,7 @@
 import org.reactivecommons.async.kafka.converters.json.KafkaJacksonMessageConverter;
 import org.reactivecommons.async.kafka.health.KafkaReactiveHealthIndicator;
 import org.reactivecommons.async.starter.broker.BrokerProvider;
-import org.springframework.boot.actuate.health.Health;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import org.springframework.boot.ssl.DefaultSslBundleRegistry;
 import org.springframework.boot.ssl.SslBundles;
 import reactor.core.publisher.Flux;
@@ -136,12 +136,12 @@ void shouldListenNotificationEvents() {
 
     @Test
     void shouldProxyHealthCheck() {
-        when(healthIndicator.health()).thenReturn(Mono.fromSupplier(() -> Health.up().build()));
+        when(healthIndicator.health()).thenReturn(Mono.fromSupplier(() -> RCHealth.builder().up().build()));
         // Act
-        Mono<Health> flow = brokerProvider.healthCheck();
+        Mono<RCHealth> flow = brokerProvider.healthCheck();
         // Assert
         StepVerifier.create(flow)
-                .expectNextMatches(health -> health.getStatus().getCode().equals("UP"))
+                .expectNextMatches(health -> health.getStatus().equals(RCHealth.Status.UP))
                 .verifyComplete();
     }
 }
diff --git a/starters/async-kafka-starter/src/test/java/org/reactivecommons/async/kafka/health/KafkaReactiveHealthIndicatorTest.java b/starters/async-kafka-starter/src/test/java/org/reactivecommons/async/kafka/health/KafkaReactiveHealthIndicatorTest.java
@@ -9,6 +9,7 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import org.springframework.boot.actuate.health.Health;
 import org.springframework.boot.actuate.health.Health.Builder;
 import org.springframework.boot.actuate.health.Status;
@@ -39,13 +40,13 @@ void shouldBeUp() {
         when(adminClient.describeCluster()).thenReturn(describeClusterResult);
         when(describeClusterResult.clusterId()).thenReturn(KafkaFuture.completedFuture("cluster123"));
         // Act
-        Mono<Health> result = indicator.doHealthCheck(new Builder());
+        Mono<RCHealth> result = indicator.doHealthCheck(RCHealth.builder());
         // Assert
         StepVerifier.create(result)
                 .assertNext(health -> {
                     assertEquals(DEFAULT_DOMAIN, health.getDetails().get("domain"));
                     assertEquals("cluster123", health.getDetails().get("version"));
-                    assertEquals(Status.UP, health.getStatus());
+                    assertEquals(RCHealth.Status.UP, health.getStatus());
                 })
                 .verifyComplete();
     }
@@ -58,12 +59,12 @@ void shouldBeDown() {
         future.completeExceptionally(new RuntimeException("simulate error"));
         when(describeClusterResult.clusterId()).thenReturn(future);
         // Act
-        Mono<Health> result = indicator.doHealthCheck(new Builder());
+        Mono<RCHealth> result = indicator.doHealthCheck(RCHealth.builder());
         // Assert
         StepVerifier.create(result)
                 .expectNextMatches(health -> {
                     assertEquals(DEFAULT_DOMAIN, health.getDetails().get("domain"));
-                    assertEquals(Status.DOWN, health.getStatus());
+                    assertEquals(RCHealth.Status.DOWN, health.getStatus());
                     return true;
                 })
                 .verifyComplete();
diff --git a/starters/async-rabbit-starter/src/main/java/org/reactivecommons/async/rabbit/RabbitMQBrokerProvider.java b/starters/async-rabbit-starter/src/main/java/org/reactivecommons/async/rabbit/RabbitMQBrokerProvider.java
@@ -22,7 +22,7 @@
 import org.reactivecommons.async.rabbit.listeners.ApplicationQueryListener;
 import org.reactivecommons.async.rabbit.listeners.ApplicationReplyListener;
 import org.reactivecommons.async.starter.broker.BrokerProvider;
-import org.springframework.boot.actuate.health.Health;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import reactor.core.publisher.Mono;
 
 import static reactor.rabbitmq.ExchangeSpecification.exchange;
@@ -154,7 +154,7 @@ public void listenReplies(HandlerResolver resolver) {
     }
 
     @Override
-    public Mono<Health> healthCheck() {
+    public Mono<RCHealth> healthCheck() {
         return healthIndicator.health();
     }
 }
diff --git a/starters/async-rabbit-starter/src/main/java/org/reactivecommons/async/rabbit/health/RabbitReactiveHealthIndicator.java b/starters/async-rabbit-starter/src/main/java/org/reactivecommons/async/rabbit/health/RabbitReactiveHealthIndicator.java
@@ -4,8 +4,8 @@
 import com.rabbitmq.client.ConnectionFactory;
 import lombok.SneakyThrows;
 import lombok.extern.log4j.Log4j2;
-import org.springframework.boot.actuate.health.AbstractReactiveHealthIndicator;
-import org.springframework.boot.actuate.health.Health;
+import org.reactivecommons.async.starter.config.health.RCHealth;
+import org.reactivecommons.async.starter.config.health.RCHealthIndicator;
 import reactor.core.publisher.Mono;
 
 import java.net.SocketException;
@@ -14,7 +14,7 @@
 import static org.reactivecommons.async.starter.config.health.ReactiveCommonsHealthIndicator.VERSION;
 
 @Log4j2
-public class RabbitReactiveHealthIndicator extends AbstractReactiveHealthIndicator {
+public class RabbitReactiveHealthIndicator extends RCHealthIndicator {
     private final String domain;
     private final ConnectionFactory connectionFactory;
 
@@ -25,7 +25,7 @@ public RabbitReactiveHealthIndicator(String domain, ConnectionFactory connection
     }
 
     @Override
-    protected Mono<Health> doHealthCheck(Health.Builder builder) {
+    public Mono<RCHealth> doHealthCheck(RCHealth.RCHealthBuilder builder) {
         builder.withDetail(DOMAIN, domain);
         return Mono.fromCallable(() -> getRawVersion(connectionFactory))
                 .map(status -> builder.up().withDetail(VERSION, status).build());
diff --git a/starters/async-rabbit-starter/src/test/java/org/reactivecommons/async/rabbit/RabbitMQBrokerProviderTest.java b/starters/async-rabbit-starter/src/test/java/org/reactivecommons/async/rabbit/RabbitMQBrokerProviderTest.java
@@ -23,7 +23,7 @@
 import org.reactivecommons.async.rabbit.converters.json.RabbitJacksonMessageConverter;
 import org.reactivecommons.async.rabbit.health.RabbitReactiveHealthIndicator;
 import org.reactivecommons.async.starter.broker.BrokerProvider;
-import org.springframework.boot.actuate.health.Health;
+import org.reactivecommons.async.starter.config.health.RCHealth;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 import reactor.rabbitmq.BindingSpecification;
@@ -181,12 +181,12 @@ void shouldListenQueries() {
 
     @Test
     void shouldProxyHealthCheck() {
-        when(healthIndicator.health()).thenReturn(Mono.fromSupplier(() -> Health.up().build()));
+        when(healthIndicator.health()).thenReturn(Mono.fromSupplier(() -> RCHealth.builder().up().build()));
         // Act
-        Mono<Health> flow = brokerProvider.healthCheck();
+        Mono<RCHealth> flow = brokerProvider.healthCheck();
         // Assert
         StepVerifier.create(flow)
-                .expectNextMatches(health -> health.getStatus().getCode().equals("UP"))
+                .expectNextMatches(health -> health.getStatus().equals(RCHealth.Status.UP))
                 .verifyComplete();
     }
 }
diff --git a/starters/async-rabbit-starter/src/test/java/org/reactivecommons/async/rabbit/health/RabbitReactiveHealthIndicatorTest.java b/starters/async-rabbit-starter/src/test/java/org/reactivecommons/async/rabbit/health/RabbitReactiveHealthIndicatorTest.java

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`import org.reactivecommons.async.commons.HandlerResolver;`
`7`	`7`	`import org.reactivecommons.async.starter.broker.BrokerProvider;`
`8`	`8`	`import org.reactivecommons.async.starter.broker.DiscardProvider;`
	`9`	`+import org.reactivecommons.async.starter.config.health.RCHealth;`
`9`	`10`	`import org.reactivecommons.async.starter.mybroker.props.MyBrokerAsyncProps;`
`10`		`-import org.springframework.boot.actuate.health.Health;`
`11`	`11`	`import reactor.core.publisher.Mono;`
`12`	`12`
`13`	`13`	`@AllArgsConstructor`
`@@ -57,7 +57,7 @@ public void listenReplies(HandlerResolver resolver) {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`@Override`
`60`		`- public Mono<Health> healthCheck() {`
	`60`	`+ public Mono<RCHealth> healthCheck() {`
`61`	`61`	`return null;`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`import org.reactivecommons.async.kafka.listeners.ApplicationEventListener;`
`20`	`20`	`import org.reactivecommons.async.kafka.listeners.ApplicationNotificationsListener;`
`21`	`21`	`import org.reactivecommons.async.starter.broker.BrokerProvider;`
`22`		`-import org.springframework.boot.actuate.health.Health;`
	`22`	`+import org.reactivecommons.async.starter.config.health.RCHealth;`
`23`	`23`	`import org.springframework.boot.ssl.SslBundles;`
`24`	`24`	`import reactor.core.publisher.Mono;`
`25`	`25`
`@@ -100,7 +100,7 @@ public void listenReplies(HandlerResolver resolver) {`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`@Override`
`103`		`- public Mono<Health> healthCheck() {`
	`103`	`+ public Mono<RCHealth> healthCheck() {`
`104`	`104`	`return healthIndicator.health();`
`105`	`105`	`}`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`import org.reactivecommons.async.rabbit.listeners.ApplicationQueryListener;`
`23`	`23`	`import org.reactivecommons.async.rabbit.listeners.ApplicationReplyListener;`
`24`	`24`	`import org.reactivecommons.async.starter.broker.BrokerProvider;`
`25`		`-import org.springframework.boot.actuate.health.Health;`
	`25`	`+import org.reactivecommons.async.starter.config.health.RCHealth;`
`26`	`26`	`import reactor.core.publisher.Mono;`
`27`	`27`
`28`	`28`	`import static reactor.rabbitmq.ExchangeSpecification.exchange;`
`@@ -154,7 +154,7 @@ public void listenReplies(HandlerResolver resolver) {`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`@Override`
`157`		`- public Mono<Health> healthCheck() {`
	`157`	`+ public Mono<RCHealth> healthCheck() {`
`158`	`158`	`return healthIndicator.health();`
`159`	`159`	`}`
`160`	`160`	`}`