Allow modules to contribute to Devtools' default properties

Closes gh-

Author: wilkinsona

buildSrc/src/main/java/org/springframework/boot/build/devtools/DocumentDevtoolsPropertyDefaults.java

@@ -16,22 +16,24 @@
 
 package org.springframework.boot.build.devtools;
 
-import java.io.FileInputStream;
+import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.PrintWriter;
-import java.util.HashMap;
 import java.util.Map;
 import java.util.Properties;
 import java.util.TreeMap;
+import java.util.jar.JarFile;
+import java.util.zip.ZipEntry;
 
 import org.gradle.api.DefaultTask;
-import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.file.RegularFileProperty;
 import org.gradle.api.tasks.InputFiles;
 import org.gradle.api.tasks.OutputFile;
+import org.gradle.api.tasks.PathSensitive;
+import org.gradle.api.tasks.PathSensitivity;
 import org.gradle.api.tasks.TaskAction;
 
 /**
@@ -41,46 +43,59 @@
  */
 public abstract class DocumentDevtoolsPropertyDefaults extends DefaultTask {
 
-	private final Configuration devtools;
+	private FileCollection defaults;
 
 	public DocumentDevtoolsPropertyDefaults() {
-		this.devtools = getProject().getConfigurations().create("devtools");
 		getOutputFile().convention(getProject().getLayout()
 			.getBuildDirectory()
 			.file("generated/docs/using/devtools-property-defaults.adoc"));
-		Map<String, String> dependency = new HashMap<>();
-		dependency.put("path", ":module:spring-boot-devtools");
-		dependency.put("configuration", "propertyDefaults");
-		this.devtools.getDependencies().add(getProject().getDependencies().project(dependency));
 	}
 
 	@InputFiles
-	public FileCollection getDevtools() {
-		return this.devtools;
+	@PathSensitive(PathSensitivity.RELATIVE)
+	public FileCollection getDefaults() {
+		return this.defaults;
+	}
+
+	public void setDefaults(FileCollection defaults) {
+		this.defaults = defaults;
 	}
 
 	@OutputFile
 	public abstract RegularFileProperty getOutputFile();
 
 	@TaskAction
 	void documentPropertyDefaults() throws IOException {
-		Map<String, String> properties = loadProperties();
-		documentProperties(properties);
+		Map<String, String> propertyDefaults = loadPropertyDefaults();
+		documentPropertyDefaults(propertyDefaults);
 	}
 
-	private Map<String, String> loadProperties() throws IOException, FileNotFoundException {
+	private Map<String, String> loadPropertyDefaults() throws IOException, FileNotFoundException {
 		Properties properties = new Properties();
-		Map<String, String> sortedProperties = new TreeMap<>();
-		try (FileInputStream stream = new FileInputStream(this.devtools.getSingleFile())) {
-			properties.load(stream);
-			for (String name : properties.stringPropertyNames()) {
-				sortedProperties.put(name, properties.getProperty(name));
+		Map<String, String> propertyDefaults = new TreeMap<>();
+		for (File contribution : this.defaults.getFiles()) {
+			if (contribution.isFile()) {
+				try (JarFile jar = new JarFile(contribution)) {
+					ZipEntry entry = jar.getEntry("META-INF/spring-devtools.properties");
+					if (entry != null) {
+						properties.load(jar.getInputStream(entry));
+					}
+				}
+			}
+			else if (contribution.exists()) {
+				throw new IllegalStateException(
+						"Unexpected Devtools default properties contribution from '" + contribution + "'");
+			}
+		}
+		for (String name : properties.stringPropertyNames()) {
+			if (name.startsWith("defaults.")) {
+				propertyDefaults.put(name.substring("defaults.".length()), properties.getProperty(name));
 			}
 		}
-		return sortedProperties;
+		return propertyDefaults;
 	}
 
-	private void documentProperties(Map<String, String> properties) throws IOException {
+	private void documentPropertyDefaults(Map<String, String> properties) throws IOException {
 		try (PrintWriter writer = new PrintWriter(new FileWriter(getOutputFile().getAsFile().get()))) {
 			writer.println("[cols=\"3,1\"]");
 			writer.println("|===");

core/spring-boot-autoconfigure/src/main/resources/META-INF/spring-devtools.properties

@@ -0,0 +1,3 @@
+defaults.spring.template.provider.cache=false
+defaults.spring.web.resources.cache.period=0
+defaults.spring.web.resources.chain.cache=false

core/spring-boot-docker-compose/src/main/resources/META-INF/spring-devtools.properties

@@ -0,0 +1 @@
+defaults.spring.docker.compose.readiness.wait=only-if-started

documentation/spring-boot-docs/build.gradle

@@ -322,6 +322,10 @@ aggregates {
 		category = Category.DOCUMENTATION
 		usage = "test-slice-metadata"
 	}
+	devtoolsPropertyDefaults {
+		category = Category.LIBRARY
+		usage = "java-runtime"
+	}
 }
 
 tasks.register("documentTestSlices", org.springframework.boot.build.test.autoconfigure.DocumentTestSlices) {
@@ -363,7 +367,9 @@ tasks.register("documentConfigurationProperties", org.springframework.boot.build
 	outputDir = layout.buildDirectory.dir("generated/docs/application-properties")
 }
 
-tasks.register("documentDevtoolsPropertyDefaults", org.springframework.boot.build.devtools.DocumentDevtoolsPropertyDefaults) {}
+tasks.register("documentDevtoolsPropertyDefaults", org.springframework.boot.build.devtools.DocumentDevtoolsPropertyDefaults) {
+	defaults = aggregates.devtoolsPropertyDefaults.files
+}
 
 tasks.register("runRemoteSpringApplicationExample", org.springframework.boot.build.docs.ApplicationRunner) {
 	classpath = configurations.remoteSpringApplicationExample

module/spring-boot-devtools/build.gradle

@@ -29,13 +29,6 @@ configurations {
 	intTestDependencies {
 		extendsFrom dependencyManagement
 	}
-	propertyDefaults
-}
-
-artifacts {
-	propertyDefaults(file("build/resources/main/org/springframework/boot/devtools/env/devtools-property-defaults.properties")) {
-		builtBy(processResources)
-	}
 }
 
 dependencies {
@@ -60,7 +53,6 @@ dependencies {
 	intTestImplementation("org.apache.httpcomponents.client5:httpclient5")
 	intTestImplementation("net.bytebuddy:byte-buddy")
 
-
 	intTestRuntimeOnly("org.springframework:spring-web")
 
 	optional(project(":module:spring-boot-jdbc"))

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/env/DevToolsPropertyDefaultsPostProcessor.java

@@ -16,12 +16,8 @@
 
 package org.springframework.boot.devtools.env;
 
-import java.io.IOException;
-import java.io.InputStream;
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.Map;
-import java.util.Properties;
 
 import org.apache.commons.logging.Log;
 import org.jspecify.annotations.Nullable;
@@ -30,6 +26,7 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.devtools.logger.DevToolsLogFactory;
 import org.springframework.boot.devtools.restart.Restarter;
+import org.springframework.boot.devtools.settings.DevToolsSettings;
 import org.springframework.boot.devtools.system.DevToolsEnablementDeducer;
 import org.springframework.core.NativeDetector;
 import org.springframework.core.Ordered;
@@ -69,7 +66,7 @@ public class DevToolsPropertyDefaultsPostProcessor implements EnvironmentPostPro
 			PROPERTIES = Collections.emptyMap();
 		}
 		else {
-			PROPERTIES = loadDefaultProperties();
+			PROPERTIES = DevToolsSettings.get().getPropertyDefaults();
 		}
 	}
 
@@ -133,24 +130,4 @@ private boolean isWebApplication(Environment environment) {
 		}
 	}
 
-	private static Map<String, Object> loadDefaultProperties() {
-		Properties properties = new Properties();
-		try (InputStream stream = DevToolsPropertyDefaultsPostProcessor.class
-			.getResourceAsStream("devtools-property-defaults.properties")) {
-			if (stream == null) {
-				throw new RuntimeException(
-						"Failed to load devtools-property-defaults.properties because it doesn't exist");
-			}
-			properties.load(stream);
-		}
-		catch (IOException ex) {
-			throw new RuntimeException("Failed to load devtools-property-defaults.properties", ex);
-		}
-		Map<String, Object> map = new HashMap<>();
-		for (String name : properties.stringPropertyNames()) {
-			map.put(name, properties.getProperty(name));
-		}
-		return Collections.unmodifiableMap(map);
-	}
-
 }

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/settings/DevToolsSettings.java

@@ -18,7 +18,9 @@
 
 import java.net.URL;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Enumeration;
+import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -52,14 +54,23 @@ public class DevToolsSettings {
 
 	private final List<Pattern> restartExcludePatterns = new ArrayList<>();
 
+	private final Map<String, Object> propertyDefaults = new HashMap<>();
+
 	DevToolsSettings() {
 	}
 
-	void add(Map<?, ?> properties) {
+	private void add(Map<?, ?> properties) {
 		Map<String, Pattern> includes = getPatterns(properties, "restart.include.");
 		this.restartIncludePatterns.addAll(includes.values());
 		Map<String, Pattern> excludes = getPatterns(properties, "restart.exclude.");
 		this.restartExcludePatterns.addAll(excludes.values());
+		properties.forEach((key, value) -> {
+			String name = String.valueOf(key);
+			if (name.startsWith("defaults.")) {
+				name = name.substring("defaults.".length());
+				this.propertyDefaults.put(name, value);
+			}
+		});
 	}
 
 	private Map<String, Pattern> getPatterns(Map<?, ?> properties, String prefix) {
@@ -82,6 +93,10 @@ public boolean isRestartExclude(URL url) {
 		return isMatch(url.toString(), this.restartExcludePatterns);
 	}
 
+	public Map<String, Object> getPropertyDefaults() {
+		return Collections.unmodifiableMap(this.propertyDefaults);
+	}
+
 	private boolean isMatch(String url, List<Pattern> patterns) {
 		for (Pattern pattern : patterns) {
 			if (pattern.matcher(url).find()) {

module/spring-boot-devtools/src/main/resources/org/springframework/boot/devtools/env/devtools-property-defaults.properties

@@ -19,6 +19,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
+import java.util.Map;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
@@ -60,6 +61,13 @@ void defaultIncludePatterns(@TempDir File tempDir) throws Exception {
 		assertThat(settings.isRestartExclude(makeUrl(tempDir, "spring-boot-starter-some-thing"))).isTrue();
 	}
 
+	@Test
+	void propertyDefaults() {
+		DevToolsSettings settings = DevToolsSettings.load(ROOT + "spring-devtools-defaults.properties");
+		Map<String, Object> propertyDefaults = settings.getPropertyDefaults();
+		assertThat(propertyDefaults).containsExactlyEntriesOf(Map.of("com.example.a", "true", "com.example.b", "17"));
+	}
+
 	private URL makeUrl(File file, String name) throws IOException {
 		file = new File(file, name);
 		file = new File(file, "build");

module/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/settings/DevToolsSettingsTests.java

@@ -0,0 +1,3 @@
+defaults.com.example.a=true
+defaults.com.example.b=17
+