You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/09/03 16:32:49 UTC
(maven-wagon) 03/04: Preserve usePreemptive and timeouts across httpConfiguration copy and merge
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch wagon-3.x
in repository https://gitbox.apache.org/repos/asf/maven-wagon.git
commit 5acb14e19645669a4b8f021dac2ec63ec4521d15
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Sep 3 18:27:34 2026 +0200
Preserve usePreemptive and timeouts across httpConfiguration copy and merge
Make usePreemptive a Boolean so copy() and merge() preserve it when
merging method-level blocks with <all>.
Make connectionTimeout and readTimeout nullable in HttpMethodConfiguration
and check isConnectionTimeoutSet()/isReadTimeoutSet() so copyConfig() does
not overwrite timeouts set on Wagon with defaults, and merge() allows
setting values back to defaults.
Fixes #906, fixes #908.
---
.../wagon/shared/http/ConfigurationUtils.java | 17 ++-
.../wagon/shared/http/HttpMethodConfiguration.java | 49 ++++++--
.../wagon/shared/http/ConfigurationUtilsTest.java | 135 +++++++++++++++++++++
3 files changed, 185 insertions(+), 16 deletions(-)
diff --git a/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/ConfigurationUtils.java b/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/ConfigurationUtils.java
index 44e53338..9f222f23 100644
--- a/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/ConfigurationUtils.java
+++ b/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/ConfigurationUtils.java
@@ -30,7 +30,6 @@
import org.apache.http.HttpHost;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.message.BasicHeader;
-import org.apache.maven.wagon.Wagon;
/**
* Configuration helper class
@@ -58,8 +57,12 @@ public class ConfigurationUtils {
private static final String COERCE_PATTERN = "%(\\w+),(.+)";
public static void copyConfig(HttpMethodConfiguration config, RequestConfig.Builder builder) {
- builder.setConnectTimeout(config.getConnectionTimeout());
- builder.setSocketTimeout(config.getReadTimeout());
+ if (config.isConnectionTimeoutSet()) {
+ builder.setConnectTimeout(config.getConnectionTimeout());
+ }
+ if (config.isReadTimeoutSet()) {
+ builder.setSocketTimeout(config.getReadTimeout());
+ }
Properties params = config.getParams();
if (params != null) {
@@ -152,11 +155,11 @@ public static HttpMethodConfiguration merge(HttpMethodConfiguration base, HttpMe
} else {
HttpMethodConfiguration result = base.copy();
- if (local.getConnectionTimeout() != Wagon.DEFAULT_CONNECTION_TIMEOUT) {
+ if (local.isConnectionTimeoutSet()) {
result.setConnectionTimeout(local.getConnectionTimeout());
}
- if (local.getReadTimeout() != Wagon.DEFAULT_READ_TIMEOUT) {
+ if (local.isReadTimeoutSet()) {
result.setReadTimeout(local.getReadTimeout());
}
@@ -172,6 +175,10 @@ public static HttpMethodConfiguration merge(HttpMethodConfiguration base, HttpMe
result.setUseDefaultHeaders(local.isUseDefaultHeaders());
}
+ if (local.isUsePreemptiveSet()) {
+ result.setUsePreemptive(local.isUsePreemptive());
+ }
+
return result;
}
}
diff --git a/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/HttpMethodConfiguration.java b/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/HttpMethodConfiguration.java
index 3cae08d6..7bf5e6cf 100755
--- a/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/HttpMethodConfiguration.java
+++ b/wagon-providers/wagon-http-shared/src/main/java/org/apache/maven/wagon/shared/http/HttpMethodConfiguration.java
@@ -36,12 +36,11 @@ public class HttpMethodConfiguration {
private Properties params = new Properties();
- private int connectionTimeout = Wagon.DEFAULT_CONNECTION_TIMEOUT;
+ private Integer connectionTimeout;
- private int readTimeout =
- Integer.parseInt(System.getProperty("maven.wagon.rto", Integer.toString(Wagon.DEFAULT_READ_TIMEOUT)));
+ private Integer readTimeout;
- private boolean usePreemptive = false;
+ private Boolean usePreemptive;
public boolean isUseDefaultHeaders() {
return useDefaultHeaders == null || useDefaultHeaders.booleanValue();
@@ -85,7 +84,7 @@ public HttpMethodConfiguration setParams(Properties params) {
}
public int getConnectionTimeout() {
- return connectionTimeout;
+ return connectionTimeout != null ? connectionTimeout : Wagon.DEFAULT_CONNECTION_TIMEOUT;
}
public HttpMethodConfiguration setConnectionTimeout(int connectionTimeout) {
@@ -93,8 +92,14 @@ public HttpMethodConfiguration setConnectionTimeout(int connectionTimeout) {
return this;
}
+ public boolean isConnectionTimeoutSet() {
+ return connectionTimeout != null;
+ }
+
public int getReadTimeout() {
- return readTimeout;
+ return readTimeout != null
+ ? readTimeout
+ : Integer.parseInt(System.getProperty("maven.wagon.rto", Integer.toString(Wagon.DEFAULT_READ_TIMEOUT)));
}
public HttpMethodConfiguration setReadTimeout(int readTimeout) {
@@ -102,15 +107,27 @@ public HttpMethodConfiguration setReadTimeout(int readTimeout) {
return this;
}
+ public boolean isReadTimeoutSet() {
+ return readTimeout != null;
+ }
+
public boolean isUsePreemptive() {
- return usePreemptive;
+ return Boolean.TRUE.equals(usePreemptive);
}
public HttpMethodConfiguration setUsePreemptive(boolean usePreemptive) {
- this.usePreemptive = usePreemptive;
+ this.usePreemptive = Boolean.valueOf(usePreemptive);
return this;
}
+ public Boolean getUsePreemptive() {
+ return usePreemptive;
+ }
+
+ public boolean isUsePreemptiveSet() {
+ return usePreemptive != null;
+ }
+
public Header[] asRequestHeaders() {
if (headers == null) {
return new Header[0];
@@ -133,8 +150,12 @@ public Header[] asRequestHeaders() {
HttpMethodConfiguration copy() {
HttpMethodConfiguration copy = new HttpMethodConfiguration();
- copy.setConnectionTimeout(getConnectionTimeout());
- copy.setReadTimeout(getReadTimeout());
+ if (connectionTimeout != null) {
+ copy.setConnectionTimeout(connectionTimeout);
+ }
+ if (readTimeout != null) {
+ copy.setReadTimeout(readTimeout);
+ }
if (getHeaders() != null) {
copy.getHeaders().putAll(getHeaders());
}
@@ -143,7 +164,13 @@ HttpMethodConfiguration copy() {
copy.getParams().putAll(getParams());
}
- copy.setUseDefaultHeaders(isUseDefaultHeaders());
+ if (useDefaultHeaders != null) {
+ copy.setUseDefaultHeaders(useDefaultHeaders);
+ }
+
+ if (usePreemptive != null) {
+ copy.setUsePreemptive(usePreemptive);
+ }
return copy;
}
diff --git a/wagon-providers/wagon-http-shared/src/test/java/org/apache/maven/wagon/shared/http/ConfigurationUtilsTest.java b/wagon-providers/wagon-http-shared/src/test/java/org/apache/maven/wagon/shared/http/ConfigurationUtilsTest.java
new file mode 100644
index 00000000..f70304d2
--- /dev/null
+++ b/wagon-providers/wagon-http-shared/src/test/java/org/apache/maven/wagon/shared/http/ConfigurationUtilsTest.java
@@ -0,0 +1,135 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
+ *
+ * http://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.apache.maven.wagon.shared.http;
+
+import org.apache.http.client.config.RequestConfig;
+import org.apache.maven.wagon.Wagon;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class ConfigurationUtilsTest {
+
+ @Test
+ public void testCopyConfigDoesNotOverwriteBuilderTimeoutsWhenUnset() {
+ RequestConfig.Builder builder = RequestConfig.custom();
+ builder.setConnectTimeout(12345);
+ builder.setSocketTimeout(54321);
+
+ HttpMethodConfiguration config = new HttpMethodConfiguration();
+ assertFalse(config.isConnectionTimeoutSet());
+ assertFalse(config.isReadTimeoutSet());
+
+ ConfigurationUtils.copyConfig(config, builder);
+
+ RequestConfig requestConfig = builder.build();
+ assertEquals(12345, requestConfig.getConnectTimeout());
+ assertEquals(54321, requestConfig.getSocketTimeout());
+ }
+
+ @Test
+ public void testCopyConfigOverwritesBuilderTimeoutsWhenSet() {
+ RequestConfig.Builder builder = RequestConfig.custom();
+ builder.setConnectTimeout(12345);
+ builder.setSocketTimeout(54321);
+
+ HttpMethodConfiguration config = new HttpMethodConfiguration();
+ config.setConnectionTimeout(999);
+ config.setReadTimeout(888);
+ assertTrue(config.isConnectionTimeoutSet());
+ assertTrue(config.isReadTimeoutSet());
+
+ ConfigurationUtils.copyConfig(config, builder);
+
+ RequestConfig requestConfig = builder.build();
+ assertEquals(999, requestConfig.getConnectTimeout());
+ assertEquals(888, requestConfig.getSocketTimeout());
+ }
+
+ @Test
+ public void testMergePreservesUsePreemptiveFromBase() {
+ HttpMethodConfiguration base = new HttpMethodConfiguration();
+ base.setUsePreemptive(true);
+
+ HttpMethodConfiguration local = new HttpMethodConfiguration();
+ assertFalse(local.isUsePreemptiveSet());
+
+ HttpMethodConfiguration merged = ConfigurationUtils.merge(base, local);
+ assertTrue(merged.isUsePreemptive());
+ }
+
+ @Test
+ public void testMergeOverridesUsePreemptiveFromLocal() {
+ HttpMethodConfiguration base = new HttpMethodConfiguration();
+ base.setUsePreemptive(true);
+
+ HttpMethodConfiguration local = new HttpMethodConfiguration();
+ local.setUsePreemptive(false);
+ assertTrue(local.isUsePreemptiveSet());
+
+ HttpMethodConfiguration merged = ConfigurationUtils.merge(base, local);
+ assertFalse(merged.isUsePreemptive());
+ }
+
+ @Test
+ public void testMergePreservesTimeoutsFromBase() {
+ HttpMethodConfiguration base = new HttpMethodConfiguration();
+ base.setConnectionTimeout(10000);
+ base.setReadTimeout(20000);
+
+ HttpMethodConfiguration local = new HttpMethodConfiguration();
+
+ HttpMethodConfiguration merged = ConfigurationUtils.merge(base, local);
+ assertEquals(10000, merged.getConnectionTimeout());
+ assertEquals(20000, merged.getReadTimeout());
+ }
+
+ @Test
+ public void testMergeOverridesTimeoutsEvenIfDefaultValue() {
+ HttpMethodConfiguration base = new HttpMethodConfiguration();
+ base.setConnectionTimeout(99999);
+ base.setReadTimeout(88888);
+
+ HttpMethodConfiguration local = new HttpMethodConfiguration();
+ local.setConnectionTimeout(Wagon.DEFAULT_CONNECTION_TIMEOUT);
+ local.setReadTimeout(Wagon.DEFAULT_READ_TIMEOUT);
+
+ HttpMethodConfiguration merged = ConfigurationUtils.merge(base, local);
+ assertEquals(Wagon.DEFAULT_CONNECTION_TIMEOUT, merged.getConnectionTimeout());
+ assertEquals(Wagon.DEFAULT_READ_TIMEOUT, merged.getReadTimeout());
+ }
+
+ @Test
+ public void testCopyClonesPreemptiveAndTimeouts() {
+ HttpMethodConfiguration config = new HttpMethodConfiguration();
+ config.setConnectionTimeout(111);
+ config.setReadTimeout(222);
+ config.setUsePreemptive(true);
+
+ HttpMethodConfiguration copy = config.copy();
+ assertTrue(copy.isConnectionTimeoutSet());
+ assertEquals(111, copy.getConnectionTimeout());
+ assertTrue(copy.isReadTimeoutSet());
+ assertEquals(222, copy.getReadTimeout());
+ assertTrue(copy.isUsePreemptiveSet());
+ assertTrue(copy.isUsePreemptive());
+ }
+}