Apache Solr open-source search software
Fix misleading deprecation warning for SOLR_HOST_ADVERTISE (#4715)
msternermxye8463623f9dc
diff --git a/changelog/unreleased/fix-solr-18337.yml b/changelog/unreleased/fix-solr-18337.ymlnew file mode 100644index 00000000000..155a9cb1154--- /dev/null+++ b/changelog/unreleased/fix-solr-18337.yml@@ -0,0 +1,8 @@+title: Fix misleading deprecation warning for SOLR_HOST_ADVERTISE+type: fixed+authors:+ - name: Eric Pugh+ - name: Mikael Sterner+links:+ - name: SOLR-18337+ url: https://issues.apache.org/jira/browse/SOLR-18337diff --git a/solr/core/src/java/org/apache/solr/util/tracing/SimplePropagator.java b/solr/core/src/java/org/apache/solr/util/tracing/SimplePropagator.javaindex a626e55f707..6e0fc91179c 100644--- a/solr/core/src/java/org/apache/solr/util/tracing/SimplePropagator.java+++ b/solr/core/src/java/org/apache/solr/util/tracing/SimplePropagator.java@@ -21,14 +21,11 @@ import io.opentelemetry.context.ContextKey;import io.opentelemetry.context.propagation.TextMapGetter;import io.opentelemetry.context.propagation.TextMapPropagator;import io.opentelemetry.context.propagation.TextMapSetter;-import java.lang.invoke.MethodHandles;import java.util.Collection;import java.util.List;import java.util.concurrent.atomic.AtomicLong;import org.apache.solr.common.util.EnvUtils;import org.apache.solr.logging.MDCLoggingContext;-import org.slf4j.Logger;-import org.slf4j.LoggerFactory;/*** Simple Http Header Propagator. When enabled, this will only propagate the trace id from the@@ -39,10 +36,9 @@ import org.slf4j.LoggerFactory;* replacing/upgrading once that becomes generally available*/public class SimplePropagator implements TextMapPropagator {- private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());private static final String TRACE_HOST_NAME =- EnvUtils.getProperty("solr.traceHostName", EnvUtils.getProperty("host"));+ EnvUtils.getProperty("solr.traceHostName", EnvUtils.getProperty("solr.host.advertise"));private static final TextMapPropagator INSTANCE = new SimplePropagator();private static final ContextKey<String> TRACE_ID_KEY = ContextKey.named("trace_id");diff --git a/solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/OtelTracerConfigurator.java b/solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/OtelTracerConfigurator.javaindex ae1aa625991..d3cb53f5f74 100644--- a/solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/OtelTracerConfigurator.java+++ b/solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/OtelTracerConfigurator.java@@ -74,8 +74,8 @@ public class OtelTracerConfigurator extends OpenTelemetryConfigurator {setDefaultIfNotConfigured("OTEL_EXPORTER_OTLP_PROTOCOL", "http/protobuf");setDefaultIfNotConfigured("OTEL_TRACES_SAMPLER", "parentbased_always_on");setDefaultIfNotConfigured("OTEL_PROPAGATORS", "tracecontext,baggage");- if (EnvUtils.getProperty("host") != null) {- addOtelResourceAttributes(Map.of("host.name", EnvUtils.getProperty("host")));+ if (EnvUtils.getProperty("solr.host.advertise") != null) {+ addOtelResourceAttributes(Map.of("host.name", EnvUtils.getProperty("solr.host.advertise")));}final String currentConfig = getCurrentOtelConfigAsString();diff --git a/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/CustomTestOtelTracerConfigurator.java b/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/CustomTestOtelTracerConfigurator.javaindex c9501edd810..3790bc7c61b 100644--- a/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/CustomTestOtelTracerConfigurator.java+++ b/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/CustomTestOtelTracerConfigurator.java@@ -32,8 +32,8 @@ public class CustomTestOtelTracerConfigurator extends OtelTracerConfigurator {private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());static {- if (EnvUtils.getProperty("host") == null) {- System.setProperty("host", "localhost");+ if (EnvUtils.getProperty("solr.host.advertise") == null) {+ System.setProperty("solr.host.advertise", "localhost");}}diff --git a/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/OtelTracerConfiguratorTest.java b/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/OtelTracerConfiguratorTest.javaindex a1cfc7bf10d..0818e9961a5 100644--- a/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/OtelTracerConfiguratorTest.java+++ b/solr/modules/opentelemetry/src/test/org/apache/solr/opentelemetry/OtelTracerConfiguratorTest.java@@ -39,7 +39,7 @@ public class OtelTracerConfiguratorTest extends SolrTestCaseJ4 {System.setProperty("otelnothere", "bar");System.setProperty("otel.k1", "prop-k1");System.setProperty("otel.k3", "prop-k3");- System.setProperty("host", "my.solr.host");+ System.setProperty("solr.host.advertise", "my.solr.host");instance = new OtelTracerConfigurator(currentEnv);}diff --git a/solr/solrj/src/resources/EnvToSyspropMappings.properties b/solr/solrj/src/resources/EnvToSyspropMappings.propertiesindex 176bccf7a13..61fabd7ea8f 100644--- a/solr/solrj/src/resources/EnvToSyspropMappings.properties+++ b/solr/solrj/src/resources/EnvToSyspropMappings.properties@@ -1,17 +1,18 @@# Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.#-# Mapping from Environment variable to system property-# This file only contains non-standard mappings that do not follow the standard naming convention-# Map to nothing to avoid setting any system property for the env.variable-# CamelCase properties are mapped to dot separated lowercase-# This way, env SOLR_FOO_BAR will also match property 'solr.foo.bar' without a mapping in this file-# TODO: Deprecate non-standard sysprops and standardize on solr.foo.bar in Solr 10+# Mapping from Environment variable to system property.+# This file only contains non-standard mappings that do not follow the standard naming convention.+# Map to nothing to avoid setting any system property for the env.variable.+# Env var names are mapped to sys props by lowercasing and replacing '_' with '.', so+# SOLR_FOO_BAR will match property 'solr.foo.bar' without needing a mapping in this file.+# Separately, sysprop lookups (EnvUtils.getProperty) also fall back from camelCase to+# dot-separated form (e.g. 'solr.logLevel' <-> 'solr.log.level'), independent of this file.+# TODO: Deprecate non-standard sysprops and standardize on solr.foo.bar.AWS_PROFILE=aws.profile-SOLR_ALWAYS_ON_TRACE_ID=solr.alwaysOnTraceId-SOLR_AUTH_JWT_ALLOW_OUTBOUND_HTTP=solr.auth.jwt.allowOutboundHttp-SOLR_HIDDEN_SYS_PROPS=solr.hiddenSysProps+SOLR_ALWAYS_ON_TRACE_ID=solr.tracing.always.on.enabled+SOLR_AUTH_JWT_ALLOW_OUTBOUND_HTTP=solr.auth.jwt.outbound.http.enabled+SOLR_HIDDEN_SYS_PROPS=solr.responses.hidden.sys.propsSOLR_HOME=solr.solr.home-SOLR_HOST_ADVERTISE=hostSOLR_HTTP_DISABLE_COOKIES=solr.http.disableCookies# Couldn't we just use solr.ip.allowlist everywhere instead of solr.jetty.inetaccess.includes?SOLR_IP_ALLOWLIST=solr.jetty.inetaccess.includes@@ -20,8 +21,8 @@ SOLR_OTEL_DEFAULT_CONFIGURATOR=solr.otelDefaultConfiguratorSOLR_TIMEZONE=user.timezoneSOLR_TIP=solr.install.dirSOLR_TIP_SYM=solr.install.symDir-ZK_CLIENT_TIMEOUT=zkClientTimeout-ZK_CREATE_CHROOT=createZkChroot+ZK_CLIENT_TIMEOUT=solr.zookeeper.client.timeout+ZK_CREATE_CHROOT=solr.zookeeper.chroot.createZK_CREDENTIALS_INJECTOR=zkCredentialsInjectorZK_CREDENTIALS_PROVIDER=zkCredentialsProviderZK_DIGEST=PASSWORD=zkDigestPassword@@ -32,8 +33,8 @@ ZK_DIGEST_USERNAME=zkDigestUsernameZK_HOST=zkHost# Commonly used in solr.xml-SOLR_ALLOW_PATHS=solr.allowPaths-SOLR_ALLOW_URLS=solr.allowUrls+SOLR_ALLOW_PATHS=solr.security.allow.paths+SOLR_ALLOW_URLS=solr.security.allow.urlsSOLR_MAX_BOOLEAN_CLAUSES=solr.max.booleanClausesSOLR_METRICS_ENABLED=metricsEnabledSOLR_SHARED_LIB=solr.sharedLibdiff --git a/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java b/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.javaindex 346aee08b42..2d425c5fe18 100644--- a/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java+++ b/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java@@ -17,27 +17,35 @@package org.apache.solr.common.util;+import java.io.IOException;+import java.io.InputStreamReader;+import java.nio.charset.StandardCharsets;import java.util.List;import java.util.Map;import java.util.Properties;+import java.util.regex.Pattern;+import java.util.stream.Collectors;import org.apache.solr.SolrTestCase;+import org.apache.solr.util.LogListener;import org.junit.BeforeClass;import org.junit.Test;public class EnvUtilsTest extends SolrTestCase {private static final Map<String, String> ENV =- Map.of(- "SOLR_HOME", "/home/solr",- "SOLR_PORT_LISTEN", "8983",- "SOLR_HOST_ADVERTISE", "localhost",- "SOLR_LOG_LEVEL", "INFO",- "SOLR_BOOLEAN", "true",- "SOLR_LONG", "1234567890",- "SOLR_COMMASEP", "one,two, three",- "SOLR_JSON_LIST", "[\"one\", \"two\", \"three\"]",- "SOLR_ALWAYS_ON_TRACE_ID", "true",- "SOLR_STR_WITH_NEWLINE", "foo\nbar,baz");+ Map.ofEntries(+ Map.entry("SOLR_HOME", "/home/solr"),+ Map.entry("SOLR_PORT_LISTEN", "8983"),+ Map.entry("SOLR_HOST_ADVERTISE", "localhost"),+ Map.entry("SOLR_LOG_LEVEL", "INFO"),+ Map.entry("SOLR_BOOLEAN", "true"),+ Map.entry("SOLR_LONG", "1234567890"),+ Map.entry("SOLR_COMMASEP", "one,two, three"),+ Map.entry("SOLR_JSON_LIST", "[\"one\", \"two\", \"three\"]"),+ Map.entry("SOLR_ALWAYS_ON_TRACE_ID", "true"),+ Map.entry("SOLR_STR_WITH_NEWLINE", "foo\nbar,baz"),+ Map.entry("SOLR_TIP", "/opt/solr"),+ Map.entry("SOLR_TIP_SYM", "/opt/solr-9.9.9"));@BeforeClasspublic static void beforeClass() throws Exception {@@ -71,16 +79,17 @@ public class EnvUtilsTest extends SolrTestCase {assertEquals("INFO", EnvUtils.getProperty("solr.logLevel"));assertEquals("INFO", EnvUtils.getProperty("solr.LogLevel"));assertEquals(Long.valueOf(1234567890L), EnvUtils.getPropertyAsLong("solrLong"));- assertEquals(Boolean.TRUE, EnvUtils.getPropertyAsBool("solr.alwaysOnTraceId"));- assertEquals(Boolean.TRUE, EnvUtils.getPropertyAsBool("solr.always.on.trace.id"));+ assertEquals(Boolean.TRUE, EnvUtils.getPropertyAsBool("solr.tracing.always.on.enabled"));}@Testpublic void testEnvsWithCustomKeyNameMappings() {- // These have different names than the environment variables- assertEquals(ENV.get("SOLR_HOME"), EnvUtils.getProperty("solr.solr.home"));- assertEquals(ENV.get("SOLR_HOST_ADVERTISE"), EnvUtils.getProperty("host"));- assertEquals(ENV.get("SOLR_LOGS_DIR"), EnvUtils.getProperty("solr.logs.dir"));+ // These map to a sysprop name that doesn't follow the standard SOLR_FOO_BAR -> solr.foo.bar+ // convention (see EnvToSyspropMappings.properties). Assert against literal expected values,+ // not ENV.get(...), so a broken/missing mapping would actually be caught here.+ assertEquals("/home/solr", EnvUtils.getProperty("solr.solr.home"));+ assertEquals("/opt/solr", EnvUtils.getProperty("solr.install.dir"));+ assertEquals("/opt/solr-9.9.9", EnvUtils.getProperty("solr.install.symDir"));}@Test@@ -143,4 +152,91 @@ public class EnvUtilsTest extends SolrTestCase {EnvUtils.init(false, env, defaultProps);assertEquals(false, EnvUtils.getPropertyAsBool("solr.ui.enabled"));}++ /**+ * These env vars must map directly to their current sysprop name, not to a legacy/intermediate+ * name that DeprecatedSystemPropertyMappings.properties also treats as deprecated -- otherwise+ * EnvUtils' own deprecation-forwarding logic trips on itself and logs a confusing warning, even+ * though the value still resolves correctly via that indirection. A value-only assertion wouldn't+ * catch a regression here, since the value resolves fine either way -- the warning is the actual+ * symptom, so this asserts on both.+ *+ * <p>SOLR_ALWAYS_ON_TRACE_ID is the same pattern (see {@link #getPropWithCamelCase}) but is+ * deliberately excluded here: it shares a target sysprop with that other test, and this test+ * would clobber it with a non-boolean value depending on random test execution order.+ *+ * <p>The LogListener is scoped to only these six properties' names (rather than listening for+ * *any* WARN from EnvUtils) because {@code init()} is called here with the real, live {@code+ * System.getProperties()} -- its deprecated-property-forwarding loop rescans *all* current system+ * properties every time, so leftover deprecated markers set by unrelated tests earlier in this+ * same suite/JVM (e.g. {@link #testFlippingDisabledToEnabledPropertyName}) would otherwise be+ * re-detected and re-warned-about here too, causing flaky, unrelated failures.+ */+ @Test+ public void envToSyspropMappingsDoNotTriggerDeprecationWarnings() {+ var envVarToExpectedSysprop =+ Map.of(+ "ZK_CLIENT_TIMEOUT", "solr.zookeeper.client.timeout",+ "ZK_CREATE_CHROOT", "solr.zookeeper.chroot.create",+ "SOLR_AUTH_JWT_ALLOW_OUTBOUND_HTTP", "solr.auth.jwt.outbound.http.enabled",+ "SOLR_HIDDEN_SYS_PROPS", "solr.responses.hidden.sys.props",+ "SOLR_ALLOW_PATHS", "solr.security.allow.paths",+ "SOLR_ALLOW_URLS", "solr.security.allow.urls");+ var onlyOurTargets =+ Pattern.compile(+ envVarToExpectedSysprop.values().stream()+ .map(Pattern::quote)+ .collect(Collectors.joining("|")));++ try (LogListener warnLog = LogListener.warn(EnvUtils.class).regex(onlyOurTargets)) {+ for (var entry : envVarToExpectedSysprop.entrySet()) {+ EnvUtils.init(true, Map.of(entry.getKey(), entry.getKey()), System.getProperties());+ assertEquals(+ "env var " + entry.getKey() + " should map to " + entry.getValue(),+ entry.getKey(),+ EnvUtils.getProperty(entry.getValue()));+ }+ assertEquals(+ "No deprecated-property warnings should be logged for these mappings",+ 0,+ warnLog.getCount());+ }+ }++ @Test+ public void envToSyspropMappingsDoNotMapToDeprecatedSystemProperties() throws IOException {+ Properties envMappings = loadProperties("EnvToSyspropMappings.properties");+ Properties deprecatedMappings = loadProperties("DeprecatedSystemPropertyMappings.properties");+ Map<String, String> reverseDeprecatedMappings =+ deprecatedMappings.entrySet().stream()+ .collect(Collectors.toMap(e -> (String) e.getValue(), e -> (String) e.getKey()));++ for (String envVar : envMappings.stringPropertyNames()) {+ String sysProp = envMappings.getProperty(envVar);+ String newSysProp = reverseDeprecatedMappings.get(sysProp);+ if (newSysProp != null) {+ fail(+ "expected <"+ + sysProp+ + "> "+ + "mapped from <"+ + envVar+ + "> to not be deprecated, "+ + "but it was replaced by <"+ + newSysProp+ + ">");+ }+ }+ }++ private static Properties loadProperties(String resourceName) throws IOException {+ Properties properties = new Properties();+ try (var resource =+ new InputStreamReader(+ EnvUtils.class.getClassLoader().getResourceAsStream(resourceName),+ StandardCharsets.UTF_8)) {+ properties.load(resource);+ }+ return properties;+ }}