Add richer information to server status

sualeh · sualeh · commit bab5c7109039 · 2025-11-02T09:56:33.000-05:00
diff --git a/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/server/HealthController.java b/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/server/HealthController.java
@@ -24,7 +24,7 @@ public class HealthController {
   @GetMapping(
       value = {"/", "/health"},
       produces = APPLICATION_JSON_VALUE)
-  public Map<String, String> healthCheck() {
+  public Map<String, Object> healthCheck() {
     return serverHealth.currentState();
   }
 }
diff --git a/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/server/HeartbeatLogger.java b/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/server/HeartbeatLogger.java
@@ -35,7 +35,7 @@ public class HeartbeatLogger {
 
   private final Supplier<String> heartbeatMessage =
       () -> {
-        final Map<String, String> heartbeatMessage = serverHealth.currentState();
+        final Map<String, Object> heartbeatMessage = serverHealth.currentState();
         try {
           return "\n"
               + mapper.writerWithDefaultPrettyPrinter().writeValueAsString(heartbeatMessage);
diff --git a/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/server/ServerHealth.java b/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/server/ServerHealth.java
@@ -33,14 +33,14 @@ public class ServerHealth {
   @Autowired private McpServerTransportType mcpTransport;
   @Autowired private ExcludeTools excludeTools;
 
-  public Map<String, String> currentState() {
-    final Map<String, String> currentState = new HashMap<>();
+  public Map<String, Object> currentState() {
+    final Map<String, Object> currentState = new HashMap<>();
     currentState.put("_server", getServerName());
     currentState.put("current-timestamp", String.valueOf(ZonedDateTime.now(ZoneOffset.UTC)));
-    currentState.put("in-error-state", Boolean.toString(isInErrorState));
+    currentState.put("in-error-state", isInErrorState);
     currentState.put("server-uptime", String.valueOf(getServerUptime()));
     currentState.put("transport", mcpTransport.name());
-    currentState.put("exclude-tools", excludeTools.excludeTools().toString());
+    currentState.put("exclude-tools", excludeTools.excludeTools());
     return currentState;
   }
 
diff --git a/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/utility/EmptyFactory.java b/schemacrawler-ai-mcpserver/src/main/java/schemacrawler/tools/ai/mcpserver/utility/EmptyFactory.java
@@ -67,6 +67,8 @@ public static DatabaseConnectionSource createEmptyDatabaseConnectionSource() {
             case "close":
             case "setFirstConnectionInitializer":
               return null; // No-op
+            case "toString":
+              return "empty-data-source"; // For debugging
             default:
               throw new UnsupportedOperationException("Method not supported: " + method.getName());
           }
diff --git a/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/server/test/HealthControllerTest.java b/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/server/test/HealthControllerTest.java
@@ -8,8 +8,8 @@
 
 package schemacrawler.tools.ai.mcpserver.server.test;
 
+import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
@@ -81,13 +81,10 @@ ServerHealth serverHealth() {
     }
   }
 
-  static Map<String, String> currentState() {
-    final Map<String, String> state = new HashMap<>();
-    state.put("_server", "SchemaCrawler AI MCP Server Test");
-    state.put("current-timestamp", "2025-01-01T00:00:00");
-    state.put("in-error-state", "false");
-    state.put("server-uptime", "PT0S");
-    state.put("transport", "stdio");
+  static Map<String, Object> currentState() {
+    final Map<String, Object> state = new HashMap<>();
+    state.put("_server", "Test Server");
+    state.put("some-junk", true);
     return state;
   }
 
@@ -104,10 +101,12 @@ public void healthCheckEndpoint(final String endpoint) throws Exception {
             .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
             .andReturn();
 
+    // -- Validate the message
     final String currentStatusJson = mvcResult.getResponse().getContentAsString();
     final JsonNode node = mapper.readTree(currentStatusJson);
-    final Map<String, Object> currentStateMap = mapper.convertValue(node, HashMap.class);
     assertThat("Parsed JSON should not be null", node, notNullValue());
-    assertThat("Current state should match", currentStateMap, is(currentState()));
+
+    final Map<String, Object> currentStateMap = mapper.convertValue(node, HashMap.class);
+    assertThat("Current state should match", currentStateMap, equalTo(currentState()));
   }
 }
diff --git a/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/server/test/HeartbeatLoggerTest.java b/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/server/test/HeartbeatLoggerTest.java
@@ -8,6 +8,7 @@
 
 package schemacrawler.tools.ai.mcpserver.server.test;
 
+import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
@@ -80,13 +81,10 @@ ServerHealth serverHealth() {
     }
   }
 
-  static Map<String, String> currentState() {
-    final Map<String, String> state = new HashMap<>();
-    state.put("_server", "SchemaCrawler AI MCP Server Test");
-    state.put("current-timestamp", "2025-01-01T00:00:00");
-    state.put("in-error-state", "false");
-    state.put("server-uptime", "PT0S");
-    state.put("transport", "stdio");
+  static Map<String, Object> currentState() {
+    final Map<String, Object> state = new HashMap<>();
+    state.put("_server", "Test Server");
+    state.put("some-junk", true);
     return state;
   }
 
@@ -125,11 +123,14 @@ public void publish(final LogRecord record) {
 
       // Assert
       assertThat("A heartbeat message should be logged", messages.isEmpty(), is(false));
+
+      // -- Validate the message
       final String currentStatusJson = messages.get(messages.size() - 1);
       final JsonNode node = mapper.readTree(currentStatusJson);
-      final Map<String, Object> currentStateMap = mapper.convertValue(node, HashMap.class);
       assertThat("Parsed JSON should not be null", node, notNullValue());
-      assertThat("Current state should match", currentStateMap, is(currentState()));
+
+      final Map<String, Object> currentStateMap = mapper.convertValue(node, HashMap.class);
+      assertThat("Current state should match", currentStateMap, equalTo(currentState()));
     } finally {
       logger.removeHandler(handler);
       logger.setLevel(previousLevel);
diff --git a/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/server/test/ServerHealthTest.java b/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/server/test/ServerHealthTest.java
@@ -16,6 +16,7 @@
 import static org.hamcrest.Matchers.notNullValue;
 
 import java.time.Duration;
+import java.util.Collections;
 import java.util.Map;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
@@ -63,24 +64,31 @@ McpServerTransportType mcpTransport() {
   @Test
   @DisplayName("ServerHealth.currentState should include expected keys and values")
   public void currentState_hasExpectedEntries() {
-    final Map<String, String> state = serverHealth.currentState();
+    final Map<String, Object> state = serverHealth.currentState();
 
     assertThat(state, is(notNullValue()));
     assertThat(
         state.keySet(),
-        hasItems("_server", "current-timestamp", "in-error-state", "server-uptime", "transport"));
+        hasItems(
+            "_server",
+            "current-timestamp",
+            "in-error-state",
+            "server-uptime",
+            "transport",
+            "exclude-tools"));
 
     assertThat(state.get("_server"), is("SchemaCrawler AI MCP Server TEST"));
-    assertThat(state.get("in-error-state"), is("false"));
+    assertThat(state.get("in-error-state"), is(false));
     assertThat(state.get("transport"), is("http"));
+    assertThat(state.get("exclude-tools"), is(Collections.emptySet()));
 
     // server-uptime should be a valid ISO-8601 duration (e.g., PT123S)
-    final String uptimeStr = state.get("server-uptime");
+    final String uptimeStr = String.valueOf(state.get("server-uptime"));
     assertThat(uptimeStr, not(emptyOrNullString()));
     // Will throw if invalid
     Duration.parse(uptimeStr);
 
-    final String timestamp = state.get("current-timestamp");
+    final String timestamp = String.valueOf(state.get("current-timestamp"));
     assertThat(timestamp, not(emptyOrNullString()));
   }
 }
diff --git a/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/test/SchemaCrawlerMCPServerTest.java b/schemacrawler-ai-mcpserver/src/test/java/schemacrawler/tools/ai/mcpserver/test/SchemaCrawlerMCPServerTest.java
@@ -15,6 +15,7 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import org.junit.jupiter.api.BeforeEach;
@@ -89,13 +90,13 @@ FunctionDefinitionRegistry functionDefinitionRegistry() {
 
   @BeforeEach
   public void _stubServerHealth() {
-    final Map<String, String> state = new HashMap<>();
+    final Map<String, Object> state = new HashMap<>();
     state.put("_server", "SchemaCrawler AI MCP Server Test");
     state.put("current-timestamp", "2025-01-01T00:00:00");
-    state.put("in-error-state", "false");
+    state.put("in-error-state", false);
     state.put("server-uptime", "PT0S");
     state.put("transport", "stdio");
-    state.put("exclude-tools", "[]");
+    state.put("exclude-tools", Collections.emptySet());
     when(serverHealth.currentState()).thenReturn(state);
   }
 

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public class HealthController {`
`24`	`24`	`@GetMapping(`
`25`	`25`	`value = {"/", "/health"},`
`26`	`26`	`produces = APPLICATION_JSON_VALUE)`
`27`		`- public Map<String, String> healthCheck() {`
	`27`	`+ public Map<String, Object> healthCheck() {`
`28`	`28`	`return serverHealth.currentState();`
`29`	`29`	`}`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,8 @@ public static DatabaseConnectionSource createEmptyDatabaseConnectionSource() {`
`67`	`67`	`case "close":`
`68`	`68`	`case "setFirstConnectionInitializer":`
`69`	`69`	`return null; // No-op`
	`70`	`+ case "toString":`
	`71`	`+ return "empty-data-source"; // For debugging`
`70`	`72`	`default:`
`71`	`73`	`throw new UnsupportedOperationException("Method not supported: " + method.getName());`
`72`	`74`	`}`