Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve DevUI Configuration Editor #43354

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Improve DevUI Configuration Editor #43354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 53 additions & 109 deletions ...ttp/deployment/src/main/java/io/quarkus/devui/deployment/menu/ConfigurationProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
package io.quarkus.devui.deployment.menu;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.StringReader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
Expand All @@ -29,8 +25,8 @@
import io.quarkus.deployment.builditem.CuratedApplicationShutdownBuildItem;
import io.quarkus.deployment.builditem.DevServicesLauncherConfigResultBuildItem;
import io.quarkus.dev.config.CurrentConfig;
import io.quarkus.dev.console.DevConsoleManager;
import io.quarkus.devui.deployment.InternalPageBuildItem;
import io.quarkus.devui.runtime.config.ApplicationPropertiesService;
import io.quarkus.devui.runtime.config.ConfigDescription;
import io.quarkus.devui.runtime.config.ConfigDescriptionBean;
import io.quarkus.devui.runtime.config.ConfigDevUIRecorder;
Expand All @@ -42,6 +38,7 @@
/**
* This creates Extensions Page
*/
@SuppressWarnings("OptionalUsedAsFieldOrParameterType")
public class ConfigurationProcessor {

@BuildStep(onlyIf = IsDevelopment.class)
Expand Down Expand Up @@ -80,16 +77,19 @@ void registerConfigs(List<ConfigDescriptionBuildItem> configDescriptionBuildItem
new ConfigDescription(item.getPropertyName(),
formatJavadoc(cleanUpAsciiDocIfNecessary(item.getDocs())),
item.getDefaultValue(),
isSetByDevServices(devServicesLauncherConfig, item.getPropertyName()),
devServicesLauncherConfig
.map(DevServicesLauncherConfigResultBuildItem::getConfig)
.map(config -> config.containsKey(item.getPropertyName()))
.orElse(false),
item.getValueTypeName(),
item.getAllowedValues(),
item.getConfigPhase().name()));
}

Set<String> devServicesConfig = new HashSet<>();
if (devServicesLauncherConfig.isPresent()) {
devServicesConfig.addAll(devServicesLauncherConfig.get().getConfig().keySet());
}
devServicesLauncherConfig.ifPresent(
devServicesLauncherConfigResultBuildItem -> devServicesConfig
.addAll(devServicesLauncherConfigResultBuildItem.getConfig().keySet()));

recorder.registerConfigs(configDescriptions, devServicesConfig);
}
Expand All @@ -105,21 +105,27 @@ void registerJsonRpcService(

BuildTimeActionBuildItem configActions = new BuildTimeActionBuildItem(NAMESPACE);

configActions.addAction("updateProperty", map -> {
Map<String, String> values = Collections.singletonMap(map.get("name"), map.get("value"));
updateConfig(values);
configActions.addAction("updateProperty", payload -> {
final var updates = new Properties();
updates.setProperty(
payload.get("name"),
Optional
.ofNullable(payload.get("value"))
.orElse(""));
try {
new ApplicationPropertiesService()
.mergeApplicationProperties(updates);
} catch (IOException e) {
return false;
}
return true;
});
configActions.addAction("updateProperties", map -> {
String type = map.get("type");

if (type.equalsIgnoreCase("properties")) {
String content = map.get("content");

Properties p = new Properties();
try (StringReader sr = new StringReader(content)) {
p.load(sr); // Validate
setConfig(content);
configActions.addAction("updatePropertiesAsString", payload -> {
if ("properties".equalsIgnoreCase(payload.get("type"))) {
final var content = payload.get("content");
try {
new ApplicationPropertiesService()
.saveApplicationProperties(content);
return true;
} catch (IOException ex) {
return false;
Expand All @@ -135,19 +141,37 @@ void registerJsonRpcService(
.scope(Singleton.class)
.setRuntimeInit()
.done());
syntheticBeanProducer.produce(
SyntheticBeanBuildItem.configure(ApplicationPropertiesService.class).unremovable()
.supplier(recorder.applicationPropertiesService())
.scope(Singleton.class)
.setRuntimeInit()
.done());

CurrentConfig.EDITOR = ConfigurationProcessor::updateConfig;
shutdown.addCloseTask(new Runnable() {
@Override
public void run() {
CurrentConfig.EDITOR = null;
CurrentConfig.CURRENT = Collections.emptyList();
}
ConfigurationProcessor.setDefaultConfigEditor();
shutdown.addCloseTask(() -> {
CurrentConfig.EDITOR = null;
CurrentConfig.CURRENT = Collections.emptyList();
}, true);

jsonRPCProvidersProducer.produce(new JsonRPCProvidersBuildItem(NAMESPACE, ConfigJsonRPCService.class));
}

public static void setDefaultConfigEditor() {
CurrentConfig.EDITOR = ConfigurationProcessor::mergeApplicationProperties;
}

private static void mergeApplicationProperties(Map<String, String> updatesMap) {
final var updates = new Properties();
updates.putAll(updatesMap);
try {
new ApplicationPropertiesService()
.mergeApplicationProperties(updates);
} catch (IOException e) {
throw new RuntimeException(e);
}
}

private static final Pattern codePattern = Pattern.compile("(\\{@code )([^}]+)(\\})");
private static final Pattern linkPattern = Pattern.compile("(\\{@link )([^}]+)(\\})");

Expand Down Expand Up @@ -178,85 +202,5 @@ private static String cleanUpAsciiDocIfNecessary(String docs) {
.replace("\n", "<br>");
}

private static boolean isSetByDevServices(Optional<DevServicesLauncherConfigResultBuildItem> devServicesLauncherConfig,
String propertyName) {
if (devServicesLauncherConfig.isPresent()) {
return devServicesLauncherConfig.get().getConfig().containsKey(propertyName);
}
return false;
}

public static void updateConfig(Map<String, String> values) {
if (values != null && !values.isEmpty()) {
try {
Path configPath = getConfigPath();
List<String> lines = Files.readAllLines(configPath);
for (Map.Entry<String, String> entry : values.entrySet()) {
String name = entry.getKey();
String value = entry.getValue();
int nameLine = -1;
for (int i = 0, linesSize = lines.size(); i < linesSize; i++) {
String line = lines.get(i);
if (line.startsWith(name + "=")) {
nameLine = i;
break;
}
}
if (nameLine != -1) {
if (value.isEmpty()) {
lines.remove(nameLine);
} else {
lines.set(nameLine, name + "=" + value);
}
} else {
if (!value.isEmpty()) {
lines.add(name + "=" + value);
}
}
}

try (BufferedWriter writer = Files.newBufferedWriter(configPath)) {
for (String i : lines) {
writer.write(i);
writer.newLine();
}
}
} catch (Throwable t) {
throw new RuntimeException(t);
}
}
}

private static void setConfig(String value) {
try {
Path configPath = getConfigPath();
try (BufferedWriter writer = Files.newBufferedWriter(configPath)) {
if (value == null || value.isEmpty()) {
writer.newLine();
} else {
writer.write(value);
}
}
} catch (Throwable t) {
throw new RuntimeException(t);
}
}

private static Path getConfigPath() throws IOException {
List<Path> resourcesDir = DevConsoleManager.getHotReplacementContext().getResourcesDir();
if (resourcesDir.isEmpty()) {
throw new IllegalStateException("Unable to manage configurations - no resource directory found");
}

// In the current project only
Path path = resourcesDir.get(0);
Path configPath = path.resolve("application.properties");
if (!Files.exists(configPath)) {
Files.createDirectories(configPath.getParent());
configPath = Files.createFile(path.resolve("application.properties"));
}
return configPath;
}

private static final String NAMESPACE = "devui-configuration";
}
3 changes: 1 addition & 2 deletions ...ent/src/main/java/io/quarkus/vertx/http/deployment/devmode/DevModeFailedStartHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package io.quarkus.vertx.http.deployment.devmode;

import io.quarkus.dev.config.CurrentConfig;
import io.quarkus.dev.spi.DeploymentFailedStartHandler;
import io.quarkus.devui.deployment.menu.ConfigurationProcessor;

public class DevModeFailedStartHandler implements DeploymentFailedStartHandler {
@Override
public void handleFailedInitialStart() {
CurrentConfig.EDITOR = ConfigurationProcessor::updateConfig;
ConfigurationProcessor.setDefaultConfigEditor();
}
}
70 changes: 70 additions & 0 deletions ...x-http/deployment/src/test/java/io/quarkus/devui/ConfigurationCompleteUpdatesRPCTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package io.quarkus.devui;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertAll;

import java.util.Map;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.devui.tests.DevUIJsonRPCTest;
import io.quarkus.test.QuarkusDevModeTest;

public class ConfigurationCompleteUpdatesRPCTest extends DevUIJsonRPCTest {

@RegisterExtension
static final QuarkusDevModeTest config = new QuarkusDevModeTest()
.withEmptyApplication();

public ConfigurationCompleteUpdatesRPCTest() {
super("devui-configuration");
}

@Test
void testSavePropertiesAsString() throws Exception {
final String appProperties = """
x = y
# test comment
a = b
""";
final var response = super.executeJsonRPCMethod(
"updatePropertiesAsString",
Map.of(
"type", "properties",
"content", appProperties));
assertThat(response)
.isNotNull();
assertThat(response.asBoolean())
.isTrue();

final var result = super.executeJsonRPCMethod("getProjectPropertiesAsString");
assertThat(result.get("error"))
.isNull();
assertAll(
() -> assertThat(result.get("type").asText())
.isEqualTo("properties"),
() -> assertThat(result.get("value").asText().trim())
.isEqualTo(appProperties.trim()));
}

@Test
void testSaveInvalidProperties() throws Exception {
final String appProperties = """
x = y
# test comment
a = b
""";
final var response = super.executeJsonRPCMethod(
"updatePropertiesAsString",
Map.of(
"type", "json",
"content", appProperties));
assertThat(response)
.isNotNull();
assertThat(response.asBoolean())
.isFalse();

}

}
Loading
Loading