Apache Solr open-source search software
SOLR-17611: SolrJ User-Agent, pass Solr version (#2927)
David Smiley32aee2d54ab1
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex 373cd50b9f4..5be26c0d743 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -191,6 +191,9 @@ Other Changes* SOLR-17589: Prevent error log entry on solr server due to initial HEAD request from HttpJdkSolrClient. (Paul Blanchaert via James Dyer)+* SOLR-17611: SolrJ's User-Agent header now uses the version of SolrJ. There's a corresponding+ HttpSolrCall.getUserAgentSolrVersion to parse it. (David Smiley)+================== 9.8.0 ==================New Features---------------------diff --git a/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java b/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.javaindex 1e6c9f42e29..904f3216b35 100644--- a/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java+++ b/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java@@ -74,6 +74,7 @@ import org.apache.http.client.methods.HttpRequestBase;import org.apache.http.entity.InputStreamEntity;import org.apache.solr.api.ApiBag;import org.apache.solr.api.V2HttpCall;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.impl.CloudSolrClient;import org.apache.solr.client.solrj.impl.HttpClientUtil;import org.apache.solr.common.SolrException;@@ -1170,6 +1171,24 @@ public class HttpSolrCall {return handler;}+ /**+ * Gets the client (user-agent) SolrJ version, or null if isn't SolrJ. Note that older SolrJ+ * clients prior to 9.9 present themselves as 1.0 or 2.0.+ */+ public SolrVersion getUserAgentSolrVersion() {+ String header = req.getHeader("User-Agent");+ if (header == null || !header.startsWith("Solr")) {+ return null;+ }+ try {+ return SolrVersion.valueOf(header.substring(header.lastIndexOf(' ') + 1));+ } catch (Exception e) {+ // unexpected but let's not freak out+ assert false : e.toString();+ return null;+ }+ }+private AuthorizationContext getAuthCtx() {String resource = getPath();diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/ConcurrentUpdateSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/ConcurrentUpdateSolrClient.javaindex 0911b1c0a18..60683496e71 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/ConcurrentUpdateSolrClient.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/ConcurrentUpdateSolrClient.java@@ -339,7 +339,7 @@ public class ConcurrentUpdateSolrClient extends SolrClient {method.setConfig(requestConfigBuilder.build());method.setEntity(template);- method.addHeader("User-Agent", HttpSolrClient.AGENT);+ method.addHeader("User-Agent", HttpSolrClient.USER_AGENT);method.addHeader("Content-Type", contentType);response =diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/Http2SolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/Http2SolrClient.javaindex 14fe9d7f4cf..b5755335cf6 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/Http2SolrClient.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/Http2SolrClient.java@@ -39,6 +39,7 @@ import java.util.concurrent.Semaphore;import java.util.concurrent.TimeUnit;import java.util.concurrent.TimeoutException;import java.util.stream.Collectors;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.ResponseParser;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrClientFunction;@@ -104,11 +105,12 @@ import org.slf4j.MDC;* </ul>*/public class Http2SolrClient extends HttpSolrClientBase {+ private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());public static final String REQ_PRINCIPAL_KEY = "solr-req-principal";+ private static final String USER_AGENT =+ "Solr[" + MethodHandles.lookup().lookupClass().getName() + "] " + SolrVersion.LATEST_STRING;private static volatile SSLConfig defaultSSLConfig;- private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());- private static final String AGENT = "Solr[" + Http2SolrClient.class.getName() + "] 2.0";private final HttpClient httpClient;@@ -249,7 +251,7 @@ public class Http2SolrClient extends HttpSolrClientBase {httpClient.setFollowRedirects(false);httpClient.setMaxRequestsQueuedPerDestination(asyncTracker.getMaxRequestsQueuedPerDestination());- httpClient.setUserAgentField(new HttpField(HttpHeader.USER_AGENT, AGENT));+ httpClient.setUserAgentField(new HttpField(HttpHeader.USER_AGENT, USER_AGENT));httpClient.setIdleTimeout(idleTimeoutMillis);if (builder.cookieStore != null) {diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpJdkSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpJdkSolrClient.javaindex 07cc7f242b1..c72708b39e7 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpJdkSolrClient.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpJdkSolrClient.java@@ -47,6 +47,7 @@ import java.util.regex.Matcher;import java.util.regex.Pattern;import java.util.stream.Collectors;import javax.net.ssl.SSLContext;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.ResponseParser;import org.apache.solr.client.solrj.SolrRequest;import org.apache.solr.client.solrj.SolrServerException;@@ -73,7 +74,7 @@ public class HttpJdkSolrClient extends HttpSolrClientBase {private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());private static final String USER_AGENT =- "Solr[" + MethodHandles.lookup().lookupClass().getName() + "] 1.0";+ "Solr[" + MethodHandles.lookup().lookupClass().getName() + "] " + SolrVersion.LATEST_STRING;protected HttpClient httpClient;diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.javaindex bff1a819407..e1bfd69ef74 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java@@ -70,6 +70,7 @@ import org.apache.http.entity.mime.content.InputStreamBody;import org.apache.http.entity.mime.content.StringBody;import org.apache.http.message.BasicHeader;import org.apache.http.message.BasicNameValuePair;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.ResponseParser;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrRequest;@@ -85,8 +86,6 @@ import org.apache.solr.common.util.ExecutorUtil;import org.apache.solr.common.util.NamedList;import org.apache.solr.common.util.SolrNamedThreadFactory;import org.apache.solr.common.util.Utils;-import org.slf4j.Logger;-import org.slf4j.LoggerFactory;import org.slf4j.MDC;/**@@ -98,15 +97,12 @@ import org.slf4j.MDC;public class HttpSolrClient extends BaseHttpSolrClient {private static final Charset FALLBACK_CHARSET = StandardCharsets.UTF_8;- private static final String DEFAULT_PATH = "/select";private static final long serialVersionUID = -946812319974801896L;protected static final Set<Integer> UNMATCHED_ACCEPTED_ERROR_CODES = Collections.singleton(429);- /** User-Agent String. */- public static final String AGENT = "Solr[" + HttpSolrClient.class.getName() + "] 1.0";-- private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());+ static final String USER_AGENT =+ "Solr[" + MethodHandles.lookup().lookupClass().getName() + "] " + SolrVersion.LATEST_STRING;static final Class<HttpSolrClient> cacheKey = HttpSolrClient.class;@@ -542,7 +538,7 @@ public class HttpSolrClient extends BaseHttpSolrClient {final ResponseParser processor,final boolean isV2Api)throws SolrServerException {- method.addHeader("User-Agent", AGENT);+ method.addHeader("User-Agent", USER_AGENT);org.apache.http.client.config.RequestConfig.Builder requestConfigBuilder =HttpClientUtil.createDefaultRequestConfigBuilder();diff --git a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/BasicHttpSolrClientTest.java b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/BasicHttpSolrClientTest.javaindex 2074a4c8a48..f898c3bfac1 100644--- a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/BasicHttpSolrClientTest.java+++ b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/BasicHttpSolrClientTest.java@@ -53,6 +53,7 @@ import org.apache.http.impl.cookie.BasicClientCookie;import org.apache.http.protocol.HttpContext;import org.apache.solr.SolrJettyTestBase;import org.apache.solr.SolrTestCaseJ4;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrQuery;import org.apache.solr.client.solrj.SolrRequest;@@ -79,6 +80,7 @@ import org.slf4j.LoggerFactory;public class BasicHttpSolrClientTest extends SolrJettyTestBase {private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());+ private static final String UA_VERSION = SolrVersion.LATEST_STRING;public static class RedirectServlet extends HttpServlet {@Override@@ -260,7 +262,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("get", DebugServlet.lastMethod);// agentassertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));// default wtassertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);@@ -271,7 +273,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {client.getParser().getVersion(), DebugServlet.parameters.get(CommonParams.VERSION)[0]);// agentassertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));// keepaliveassertEquals("keep-alive", DebugServlet.headers.get("Connection"));@@ -288,7 +290,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("javabin", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -298,7 +300,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals(1, DebugServlet.parameters.get("a").length);assertEquals("\u1234", DebugServlet.parameters.get("a")[0]);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals("keep-alive", DebugServlet.headers.get("Connection"));assertEquals(@@ -312,7 +314,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("put", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("javabin", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -322,7 +324,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals(1, DebugServlet.parameters.get("a").length);assertEquals("\u1234", DebugServlet.parameters.get("a")[0]);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals("keep-alive", DebugServlet.headers.get("Connection"));assertEquals(@@ -342,7 +344,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("get", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("xml", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -352,7 +354,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals(1, DebugServlet.parameters.get("a").length);assertEquals("\u1234", DebugServlet.parameters.get("a")[0]);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals("keep-alive", DebugServlet.headers.get("Connection"));@@ -363,7 +365,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("xml", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -373,7 +375,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals(1, DebugServlet.parameters.get("a").length);assertEquals("\u1234", DebugServlet.parameters.get("a")[0]);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals("keep-alive", DebugServlet.headers.get("Connection"));assertEquals(@@ -386,7 +388,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("put", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("xml", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -396,7 +398,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals(1, DebugServlet.parameters.get("a").length);assertEquals("\u1234", DebugServlet.parameters.get("a")[0]);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals("keep-alive", DebugServlet.headers.get("Connection"));assertEquals(@@ -420,7 +422,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);// agentassertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));// default wtassertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);@@ -431,7 +433,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {client.getParser().getVersion(), DebugServlet.parameters.get(CommonParams.VERSION)[0]);// agentassertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));// keepaliveassertEquals("keep-alive", DebugServlet.headers.get("Connection"));@@ -451,7 +453,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("xml", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -459,7 +461,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals(client.getParser().getVersion(), DebugServlet.parameters.get(CommonParams.VERSION)[0]);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals("keep-alive", DebugServlet.headers.get("Connection"));}@@ -493,7 +495,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);// agentassertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));// default wtassertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);@@ -524,7 +526,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("xml", DebugServlet.parameters.get(CommonParams.WT)[0]);@@ -551,7 +553,7 @@ public class BasicHttpSolrClientTest extends SolrJettyTestBase {assertEquals("post", DebugServlet.lastMethod);assertEquals(- "Solr[" + HttpSolrClient.class.getName() + "] 1.0",+ "Solr[" + HttpSolrClient.class.getName() + "] " + UA_VERSION,DebugServlet.headers.get("User-Agent"));assertEquals(1, DebugServlet.parameters.get(CommonParams.WT).length);assertEquals("javabin", DebugServlet.parameters.get(CommonParams.WT)[0]);diff --git a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/Http2SolrClientTest.java b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/Http2SolrClientTest.javaindex 6bf74daa0e6..f8c2d73aa89 100644--- a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/Http2SolrClientTest.java+++ b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/Http2SolrClientTest.java@@ -23,6 +23,7 @@ import java.util.Base64;import java.util.Collections;import java.util.HashMap;import java.util.concurrent.TimeUnit;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.ResponseParser;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrQuery;@@ -44,7 +45,7 @@ public class Http2SolrClientTest extends HttpSolrClientTestBase {@Overrideprotected String expectedUserAgent() {- return "Solr[" + Http2SolrClient.class.getName() + "] 2.0";+ return "Solr[" + Http2SolrClient.class.getName() + "] " + SolrVersion.LATEST_STRING;}@Overridediff --git a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/HttpJdkSolrClientTest.java b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/HttpJdkSolrClientTest.javaindex 9161cb6bde5..09c8578afce 100644--- a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/HttpJdkSolrClientTest.java+++ b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/HttpJdkSolrClientTest.java@@ -29,6 +29,7 @@ import java.util.concurrent.ExecutorService;import java.util.concurrent.TimeUnit;import java.util.stream.Collectors;import org.apache.lucene.util.NamedThreadFactory;+import org.apache.solr.client.api.util.SolrVersion;import org.apache.solr.client.solrj.ResponseParser;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrQuery;@@ -534,7 +535,7 @@ public class HttpJdkSolrClientTest extends HttpSolrClientTestBase {@Overrideprotected String expectedUserAgent() {- return "Solr[" + HttpJdkSolrClient.class.getName() + "] 1.0";+ return "Solr[" + HttpJdkSolrClient.class.getName() + "] " + SolrVersion.LATEST_STRING;}@Override