Dev UI fix error in log on Hot Reload when properties change

Signed-off-by: Phillip Kruger <[email protected]>
gsmet · May 31, 2023 · bb026b7 · bb026b7
1 parent 9aaa021
commit bb026b7
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 31 deletions.
diff --git a/...ttp/deployment/src/main/java/io/quarkus/devui/deployment/menu/ConfigurationProcessor.java b/...ttp/deployment/src/main/java/io/quarkus/devui/deployment/menu/ConfigurationProcessor.java
@@ -4,7 +4,9 @@
 import static io.quarkus.vertx.http.deployment.devmode.console.ConfigEditorProcessor.isSetByDevServices;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -13,8 +15,12 @@
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.ConfigDescriptionBuildItem;
 import io.quarkus.deployment.builditem.DevServicesLauncherConfigResultBuildItem;
+import io.quarkus.dev.console.DevConsoleManager;
 import io.quarkus.devui.deployment.InternalPageBuildItem;
+import io.quarkus.devui.runtime.config.ConfigJsonRPCService;
+import io.quarkus.devui.spi.JsonRPCProvidersBuildItem;
 import io.quarkus.devui.spi.page.Page;
+import io.quarkus.vertx.http.deployment.devmode.console.ConfigEditorProcessor;
 import io.quarkus.vertx.http.runtime.devmode.ConfigDescription;
 
 /**
@@ -46,6 +52,16 @@ InternalPageBuildItem createConfigurationPages(List<ConfigDescriptionBuildItem>
         return configurationPages;
     }
 
+    @BuildStep(onlyIf = IsDevelopment.class)
+    JsonRPCProvidersBuildItem registerJsonRpcService() {
+        DevConsoleManager.register("config-update-property", map -> {
+            Map<String, String> values = Collections.singletonMap(map.get("name"), map.get("value"));
+            ConfigEditorProcessor.updateConfig(values, false);
+            return null;
+        });
+        return new JsonRPCProvidersBuildItem("devui-configuration", ConfigJsonRPCService.class);
+    }
+
     private List<ConfigDescription> getAllConfig(List<ConfigDescriptionBuildItem> configDescriptionBuildItems,
             Optional<DevServicesLauncherConfigResultBuildItem> devServicesLauncherConfig) {
         List<ConfigDescription> configDescriptions = new ArrayList<>();

diff --git a/...src/main/java/io/quarkus/vertx/http/deployment/devmode/console/ConfigEditorProcessor.java b/...src/main/java/io/quarkus/vertx/http/deployment/devmode/console/ConfigEditorProcessor.java
@@ -44,8 +44,6 @@
 import io.quarkus.devconsole.runtime.spi.DevConsolePostHandler;
 import io.quarkus.devconsole.spi.DevConsoleRouteBuildItem;
 import io.quarkus.devconsole.spi.DevConsoleRuntimeTemplateInfoBuildItem;
-import io.quarkus.devui.runtime.config.ConfigJsonRPCService;
-import io.quarkus.devui.spi.JsonRPCProvidersBuildItem;
 import io.quarkus.vertx.http.runtime.devmode.ConfigDescription;
 import io.quarkus.vertx.http.runtime.devmode.ConfigDescriptionsManager;
 import io.quarkus.vertx.http.runtime.devmode.ConfigDescriptionsRecorder;
@@ -154,16 +152,6 @@ void handleRequests(BuildProducer<DevConsoleRouteBuildItem> devConsoleRouteProdu
         }));
     }
 
-    @BuildStep(onlyIf = IsDevelopment.class)
-    JsonRPCProvidersBuildItem registerJsonRpcService() {
-        DevConsoleManager.register("config-update-property", map -> {
-            Map<String, String> values = Collections.singletonMap(map.get("name"), map.get("value"));
-            updateConfig(values);
-            return null;
-        });
-        return new JsonRPCProvidersBuildItem("devui-configuration", ConfigJsonRPCService.class);
-    }
-
     private Map<String, String> filterAndApplyProfile(Map<String, String> autoconfig, List<String> configFilter,
             String profile) {
         return autoconfig.entrySet().stream()
@@ -221,6 +209,10 @@ static byte[] getConfig() {
     }
 
     public static void updateConfig(Map<String, String> values) {
+        updateConfig(values, true);
+    }
+
+    public static void updateConfig(Map<String, String> values, boolean preventKill) {
         if (values != null && !values.isEmpty()) {
             try {
                 Path configPath = getConfigPath();
@@ -255,14 +247,19 @@ public static void updateConfig(Map<String, String> values) {
                         writer.newLine();
                     }
                 }
-                preventKill();
+                if (preventKill)
+                    preventKill();
             } catch (Throwable t) {
                 throw new RuntimeException(t);
             }
         }
     }
 
     static void setConfig(String value) {
+        setConfig(value, true);
+    }
+
+    static void setConfig(String value, boolean preventKill) {
         try {
             Path configPath = getConfigPath();
             try (BufferedWriter writer = Files.newBufferedWriter(configPath)) {
@@ -272,7 +269,8 @@ static void setConfig(String value) {
                     writer.write(value);
                 }
             }
-            preventKill();
+            if (preventKill)
+                preventKill();
         } catch (Throwable t) {
             throw new RuntimeException(t);
         }

diff --git a/extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/controller/jsonrpc.js b/extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/controller/jsonrpc.js
@@ -267,10 +267,11 @@ export class JsonRpc {
 
                 if (messageType === MessageType.Void.toString()) { // Void response, typically used on initial subscription
                     // Do nothing
-                } else if (messageType === MessageType.HotReload.toString()){
-                    connectionState.hotreload(JsonRpc.serverUri);
-                    connectionState.connected(JsonRpc.serverUri)
-                } else if (messageType === MessageType.Response.toString()) { // Normal Request-Response
+                } else if (messageType === MessageType.HotReload.toString() || messageType === MessageType.Response.toString()) {
+                    if (messageType === MessageType.HotReload.toString()){
+                        connectionState.hotreload(JsonRpc.serverUri);
+                        connectionState.connected(JsonRpc.serverUri);
+                    }    
                     if (JsonRpc.promiseQueue.has(response.id)) {
                         var saved = JsonRpc.promiseQueue.get(response.id);
                         var promise = saved.promise;

diff --git a/...sions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/comms/JsonRpcMessage.java b/...sions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/comms/JsonRpcMessage.java
@@ -0,0 +1,35 @@
+package io.quarkus.devui.runtime.comms;
+
+/**
+ * Allows JSON RPC methods to response with more finer grade message types
+ *
+ * @param <T> The type of the response object
+ */
+public class JsonRpcMessage<T> {
+    private T response;
+    private MessageType messageType;
+
+    public JsonRpcMessage() {
+    }
+
+    public JsonRpcMessage(T response, MessageType messageType) {
+        this.response = response;
+        this.messageType = messageType;
+    }
+
+    public T getResponse() {
+        return response;
+    }
+
+    public void setResponse(T response) {
+        this.response = response;
+    }
+
+    public MessageType getMessageType() {
+        return messageType;
+    }
+
+    public void setMessageType(MessageType messageType) {
+        this.messageType = messageType;
+    }
+}
diff --git a/...nsions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/comms/JsonRpcRouter.java b/...nsions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/comms/JsonRpcRouter.java
@@ -1,7 +1,5 @@
 package io.quarkus.devui.runtime.comms;
 
-import static io.quarkus.devui.runtime.jsonrpc.JsonRpcKeys.MessageType;
-
 import java.lang.reflect.Method;
 import java.time.LocalDateTime;
 import java.util.ArrayList;
@@ -199,8 +197,14 @@ private void route(JsonRpcRequest jsonRpcRequest, ServerWebSocket s) {
                 }
                 uni.subscribe()
                         .with(item -> {
-                            codec.writeResponse(s, jsonRpcRequest.getId(), item,
-                                    MessageType.Response);
+                            if (JsonRpcMessage.class.isAssignableFrom(item.getClass())) {
+                                JsonRpcMessage jsonRpcMessage = (JsonRpcMessage) item;
+                                codec.writeResponse(s, jsonRpcRequest.getId(), jsonRpcMessage.getResponse(),
+                                        jsonRpcMessage.getMessageType());
+                            } else {
+                                codec.writeResponse(s, jsonRpcRequest.getId(), item,
+                                        MessageType.Response);
+                            }
                         }, failure -> {
                             codec.writeErrorResponse(s, jsonRpcRequest.getId(), jsonRpcMethodName, failure);
                         });

diff --git a/extensions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/comms/MessageType.java b/extensions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/comms/MessageType.java
@@ -0,0 +1,8 @@
+package io.quarkus.devui.runtime.comms;
+
+public enum MessageType {
+    Void,
+    Response,
+    SubscriptionMessage,
+    HotReload
+}
diff --git a/...ertx-http/runtime/src/main/java/io/quarkus/devui/runtime/config/ConfigJsonRPCService.java b/...ertx-http/runtime/src/main/java/io/quarkus/devui/runtime/config/ConfigJsonRPCService.java
@@ -8,14 +8,16 @@
 import org.eclipse.microprofile.config.ConfigProvider;
 
 import io.quarkus.dev.console.DevConsoleManager;
+import io.quarkus.devui.runtime.comms.JsonRpcMessage;
+import io.quarkus.devui.runtime.comms.MessageType;
 import io.vertx.core.json.JsonObject;
 
 @ApplicationScoped
 public class ConfigJsonRPCService {
 
-    public boolean updateProperty(String name, String value) {
+    public JsonRpcMessage<Boolean> updateProperty(String name, String value) {
         DevConsoleManager.invoke("config-update-property", Map.of("name", name, "value", value));
-        return true;
+        return new JsonRpcMessage(true, MessageType.HotReload);
     }
 
     public JsonObject getAllValues() {

diff --git a/...sions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/jsonrpc/JsonRpcCodec.java b/...sions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/jsonrpc/JsonRpcCodec.java
@@ -2,8 +2,8 @@
 
 import static io.quarkus.devui.runtime.jsonrpc.JsonRpcKeys.INTERNAL_ERROR;
 import static io.quarkus.devui.runtime.jsonrpc.JsonRpcKeys.METHOD_NOT_FOUND;
-import static io.quarkus.devui.runtime.jsonrpc.JsonRpcKeys.MessageType;
 
+import io.quarkus.devui.runtime.comms.MessageType;
 import io.quarkus.devui.runtime.jsonrpc.json.JsonMapper;
 import io.vertx.core.http.ServerWebSocket;
 import io.vertx.core.json.JsonObject;

diff --git a/...nsions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/jsonrpc/JsonRpcKeys.java b/...nsions/vertx-http/runtime/src/main/java/io/quarkus/devui/runtime/jsonrpc/JsonRpcKeys.java
@@ -20,10 +20,4 @@ public interface JsonRpcKeys {
     public static final int INVALID_PARAMS = -32602; // Invalid params.	Invalid method parameter(s).
     public static final int INTERNAL_ERROR = -32603; //	Internal error. Internal JSON-RPC error.
 
-    public static enum MessageType {
-        Void,
-        Response,
-        SubscriptionMessage,
-        HotReload
-    }
 }