GH-18 - Include the edition of the database in the health endpoint.

Author: michael-simons

neo4j-java-driver-spring-boot-autoconfigure/src/main/java/org/neo4j/driver/springframework/boot/actuate/Neo4jHealthIndicator.java

@@ -22,6 +22,7 @@
 import org.apache.commons.logging.LogFactory;
 import org.neo4j.driver.AccessMode;
 import org.neo4j.driver.Driver;
+import org.neo4j.driver.Result;
 import org.neo4j.driver.Session;
 import org.neo4j.driver.exceptions.SessionExpiredException;
 import org.neo4j.driver.SessionConfig;
@@ -47,7 +48,7 @@ public final class Neo4jHealthIndicator extends AbstractHealthIndicator {
 	/**
 	 * The Cypher statement used to verify Neo4j is up.
 	 */
-	static final String CYPHER = "RETURN 1 AS result";
+	static final String CYPHER = "CALL dbms.components() YIELD name, edition WHERE name = 'Neo4j Kernel' RETURN edition";
 	/**
 	 * Message indicating that the health check failed.
 	 */
@@ -75,15 +76,15 @@ public Neo4jHealthIndicator(Driver driver) {
 	protected void doHealthCheck(Health.Builder builder) {
 
 		try {
-			ResultSummary resultSummary;
+			ResultSummaryWithEdition resultSummaryWithEdition;
 			// Retry one time when the session has been expired
 			try {
-				resultSummary = runHealthCheckQuery();
+				resultSummaryWithEdition = runHealthCheckQuery();
 			} catch (SessionExpiredException sessionExpiredException) {
 				logger.warn(MESSAGE_SESSION_EXPIRED);
-				resultSummary = runHealthCheckQuery();
+				resultSummaryWithEdition = runHealthCheckQuery();
 			}
-			buildStatusUp(resultSummary, builder);
+			buildStatusUp(resultSummaryWithEdition, builder);
 		} catch (Exception ex) {
 			builder.down().withException(ex);
 		}
@@ -92,15 +93,17 @@ protected void doHealthCheck(Health.Builder builder) {
 	/**
 	 * Applies the given {@link ResultSummary} to the {@link Health.Builder builder} without actually calling {@code build}.
 	 *
-	 * @param resultSummary the result summary returned by the server
+	 * @param resultSummaryWithEdition the result summary returned by the server
 	 * @param builder the health builder to be modified
 	 * @return the modified health builder
 	 */
-	static Health.Builder buildStatusUp(ResultSummary resultSummary, Health.Builder builder) {
-		ServerInfo serverInfo = resultSummary.server();
-		DatabaseInfo databaseInfo = resultSummary.database();
+	static Health.Builder buildStatusUp(ResultSummaryWithEdition resultSummaryWithEdition, Health.Builder builder) {
+		ServerInfo serverInfo = resultSummaryWithEdition.resultSummary.server();
+		DatabaseInfo databaseInfo = resultSummaryWithEdition.resultSummary.database();
 
-		builder.up().withDetail("server", serverInfo.version() + "@" + serverInfo.address());
+		builder.up()
+			.withDetail("server", serverInfo.version() + "@" + serverInfo.address())
+			.withDetail("edition", resultSummaryWithEdition.edition);
 
 		if (StringUtils.hasText(databaseInfo.name())) {
 			builder.withDetail("database", databaseInfo.name());
@@ -109,12 +112,14 @@ static Health.Builder buildStatusUp(ResultSummary resultSummary, Health.Builder
 		return builder;
 	}
 
-	ResultSummary runHealthCheckQuery() {
+	ResultSummaryWithEdition runHealthCheckQuery() {
 		// We use WRITE here to make sure UP is returned for a server that supports
 		// all possible workloads
 		try (Session session = this.driver.session(DEFAULT_SESSION_CONFIG)) {
-			ResultSummary resultSummary = session.run(CYPHER).consume();
-			return resultSummary;
+			Result result = session.run(CYPHER);
+			String edition = result.single().get("edition").asString();
+			ResultSummary resultSummary = result.consume();
+			return new ResultSummaryWithEdition(resultSummary, edition);
 		}
 	}
 }

neo4j-java-driver-spring-boot-autoconfigure/src/main/java/org/neo4j/driver/springframework/boot/actuate/Neo4jReactiveHealthIndicator.java

@@ -26,8 +26,8 @@
 import org.apache.commons.logging.LogFactory;
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.exceptions.SessionExpiredException;
+import org.neo4j.driver.reactive.RxResult;
 import org.neo4j.driver.reactive.RxSession;
-import org.neo4j.driver.summary.ResultSummary;
 import org.springframework.boot.actuate.health.AbstractReactiveHealthIndicator;
 import org.springframework.boot.actuate.health.Health;
 import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
@@ -60,12 +60,16 @@ protected Mono<Health> doHealthCheck(Health.Builder builder) {
 			.map(r -> buildStatusUp(r, builder).build());
 	}
 
-	Mono<ResultSummary> runHealthCheckQuery() {
+	Mono<ResultSummaryWithEdition> runHealthCheckQuery() {
 		// We use WRITE here to make sure UP is returned for a server that supports
 		// all possible workloads
 		return Mono.using(
 			() -> this.driver.rxSession(DEFAULT_SESSION_CONFIG),
-			session -> Mono.from(session.run(Neo4jHealthIndicator.CYPHER).consume()),
+			session -> {
+				RxResult result = session.run(Neo4jHealthIndicator.CYPHER);
+				return Mono.from(result.records()).map(record -> record.get("edition").asString())
+					.zipWhen(edition -> Mono.from(result.consume()), (e, r) -> new ResultSummaryWithEdition(r, e));
+			},
 			RxSession::close
 		);
 	}

neo4j-java-driver-spring-boot-autoconfigure/src/main/java/org/neo4j/driver/springframework/boot/actuate/ResultSummaryWithEdition.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2019-2020 "Neo4j,"
+ * Neo4j Sweden AB [https://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.driver.springframework.boot.actuate;
+
+import org.neo4j.driver.summary.ResultSummary;
+
+/**
+ * A holder for a {@link ResultSummary result summary} and database edition.
+ *
+ * @author Michael J. Simons
+ * @soundtrack Black Sabbath - The End
+ * @since 4.0.0.2
+ */
+final class ResultSummaryWithEdition {
+
+	final ResultSummary resultSummary;
+
+	final String edition;
+
+	ResultSummaryWithEdition(ResultSummary resultSummary, String edition) {
+		this.resultSummary = resultSummary;
+		this.edition = edition;
+	}
+
+
+}

neo4j-java-driver-spring-boot-autoconfigure/src/test/java/org/neo4j/driver/springframework/boot/actuate/Neo4jHealthIndicatorTest.java

@@ -29,6 +29,7 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.neo4j.driver.Result;
 import org.neo4j.driver.Session;
+import org.neo4j.driver.Values;
 import org.neo4j.driver.exceptions.ServiceUnavailableException;
 import org.neo4j.driver.exceptions.SessionExpiredException;
 import org.neo4j.driver.SessionConfig;
@@ -56,6 +57,8 @@ void shouldWorkWithoutDatabaseName() {
 
 		when(this.databaseInfo.name()).thenReturn(null);
 
+		when(record.get("edition")).thenReturn(Values.value("some edition"));
+		when(this.statementResult.single()).thenReturn(this.record);
 		when(this.statementResult.consume()).thenReturn(this.resultSummary);
 		when(this.session.run(anyString())).thenReturn(this.statementResult);
 
@@ -66,6 +69,7 @@ void shouldWorkWithoutDatabaseName() {
 		assertThat(health.getStatus()).isEqualTo(Status.UP);
 		assertThat(health.getDetails()).containsEntry("server", "4711@Zu Hause");
 		assertThat(health.getDetails()).doesNotContainKey("database");
+		assertThat(health.getDetails()).containsEntry("edition", "some edition");
 	}
 
 	@Test
@@ -77,6 +81,8 @@ void shouldWorkWithEmptyDatabaseName() {
 
 		when(this.databaseInfo.name()).thenReturn("");
 
+		when(record.get("edition")).thenReturn(Values.value("some edition"));
+		when(this.statementResult.single()).thenReturn(this.record);
 		when(this.statementResult.consume()).thenReturn(this.resultSummary);
 		when(this.session.run(anyString())).thenReturn(this.statementResult);
 
@@ -87,12 +93,15 @@ void shouldWorkWithEmptyDatabaseName() {
 		assertThat(health.getStatus()).isEqualTo(Status.UP);
 		assertThat(health.getDetails()).containsEntry("server", "4711@Zu Hause");
 		assertThat(health.getDetails()).doesNotContainKey("database");
+		assertThat(health.getDetails()).containsEntry("edition", "some edition");
 	}
 
 	@Test
 	void neo4jIsUp() {
 
 		prepareSharedMocks();
+
+		when(this.statementResult.single()).thenReturn(this.record);
 		when(this.statementResult.consume()).thenReturn(this.resultSummary);
 		when(this.session.run(anyString())).thenReturn(this.statementResult);
 
@@ -103,6 +112,7 @@ void neo4jIsUp() {
 		assertThat(health.getStatus()).isEqualTo(Status.UP);
 		assertThat(health.getDetails()).containsEntry("server", "4711@Zu Hause");
 		assertThat(health.getDetails()).containsEntry("database", "n/a");
+		assertThat(health.getDetails()).containsEntry("edition", "ultimate collectors edition");
 
 		verify(session).close();
 		verifyNoMoreInteractions(this.driver, this.session, this.statementResult, this.resultSummary, this.serverInfo, this.databaseInfo);
@@ -114,6 +124,7 @@ void neo4jSessionIsExpiredOnce() {
 		AtomicInteger cnt = new AtomicInteger(0);
 
 		prepareSharedMocks();
+		when(this.statementResult.single()).thenReturn(this.record);
 		when(this.statementResult.consume()).thenReturn(this.resultSummary);
 		when(this.session.run(anyString())).thenAnswer(invocation -> {
 			if (cnt.compareAndSet(0, 1)) {

neo4j-java-driver-spring-boot-autoconfigure/src/test/java/org/neo4j/driver/springframework/boot/actuate/Neo4jHealthIndicatorTestBase.java

@@ -22,6 +22,8 @@
 
 import org.mockito.Mock;
 import org.neo4j.driver.Driver;
+import org.neo4j.driver.Record;
+import org.neo4j.driver.Values;
 import org.neo4j.driver.summary.DatabaseInfo;
 import org.neo4j.driver.summary.ResultSummary;
 import org.neo4j.driver.summary.ServerInfo;
@@ -45,12 +47,16 @@ abstract class Neo4jHealthIndicatorTestBase {
 	@Mock
 	protected DatabaseInfo databaseInfo;
 
+	@Mock
+	protected Record record;
+
 	protected void prepareSharedMocks() {
 
 		when(serverInfo.version()).thenReturn("4711");
 		when(serverInfo.address()).thenReturn("Zu Hause");
 		when(databaseInfo.name()).thenReturn("n/a");
 		when(resultSummary.server()).thenReturn(serverInfo);
 		when(resultSummary.database()).thenReturn(databaseInfo);
+		when(record.get("edition")).thenReturn(Values.value("ultimate collectors edition"));
 	}
 }

neo4j-java-driver-spring-boot-autoconfigure/src/test/java/org/neo4j/driver/springframework/boot/actuate/Neo4jReactiveHealthIndicatorTest.java

@@ -53,6 +53,7 @@ class Neo4jReactiveHealthIndicatorTest extends Neo4jHealthIndicatorTestBase {
 	void neo4jIsUp() {
 
 		prepareSharedMocks();
+		when(statementResult.records()).thenReturn(Mono.just(record));
 		when(statementResult.consume()).thenReturn(Mono.just(resultSummary));
 		when(session.run(anyString())).thenReturn(statementResult);
 
@@ -65,6 +66,7 @@ void neo4jIsUp() {
 			.consumeNextWith(health -> {
 				assertThat(health.getStatus()).isEqualTo(Status.UP);
 				assertThat(health.getDetails()).containsEntry("server", "4711@Zu Hause");
+				assertThat(health.getDetails()).containsEntry("edition", "ultimate collectors edition");
 			})
 			.verifyComplete();
 
@@ -78,6 +80,7 @@ void neo4jSessionIsExpiredOnce() {
 		AtomicInteger cnt = new AtomicInteger(0);
 
 		prepareSharedMocks();
+		when(statementResult.records()).thenReturn(Mono.just(record));
 		when(statementResult.consume()).thenReturn(Mono.just(resultSummary));
 		when(session.run(anyString())).thenAnswer(invocation -> {
 			if (cnt.compareAndSet(0, 1)) {
@@ -94,6 +97,7 @@ void neo4jSessionIsExpiredOnce() {
 			.consumeNextWith(health -> {
 				assertThat(health.getStatus()).isEqualTo(Status.UP);
 				assertThat(health.getDetails()).containsEntry("server", "4711@Zu Hause");
+				assertThat(health.getDetails()).containsEntry("edition", "ultimate collectors edition");
 			})
 			.verifyComplete();