Add accidentally dropped proxy support to Wavefront

See spring-projectsgh-30156

Author: mhalbritter

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontMetricsPropertiesConfigAdapter.java

@@ -51,7 +51,7 @@ public String get(String k) {
 
 	@Override
 	public String uri() {
-		return this.properties.getUri().toString();
+		return this.properties.getEffectiveUri().toString();
 	}
 
 	@Override

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontAutoConfiguration.java

@@ -47,7 +47,7 @@ public class WavefrontAutoConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	WavefrontSender wavefrontSender(WavefrontProperties properties) {
-		Builder builder = new Builder(properties.getUri().toString(), properties.getApiTokenOrThrow());
+		Builder builder = new Builder(properties.getEffectiveUri().toString(), properties.getApiTokenOrThrow());
 		PropertyMapper mapper = PropertyMapper.get().alwaysApplyingWhenNonNull();
 		WavefrontProperties.Sender sender = properties.getSender();
 		mapper.from(sender.getMaxQueueSize()).to(builder::maxQueueSize);

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontProperties.java

@@ -51,7 +51,16 @@ public class WavefrontProperties {
 
 	private final Sender sender = new Sender();
 
-	public URI getUri() {
+	/**
+	 * Returns the effective URI of the wavefront instance. This will not be the same URI
+	 * given through {@link #setUri(URI)} when a proxy is used.
+	 * @return the effective URI of the wavefront instance
+	 */
+	public URI getEffectiveUri() {
+		if (usesProxy()) {
+			// See io.micrometer.wavefront.WavefrontMeterRegistry.getWavefrontReportingUri
+			return URI.create(this.uri.toString().replace("proxy://", "http://"));
+		}
 		return this.uri;
 	}
 
@@ -67,8 +76,13 @@ public void setApiToken(String apiToken) {
 		this.apiToken = apiToken;
 	}
 
+	/**
+	 * Returns the API token or throws an exception if the API token is mandatory. If a
+	 * proxy is used, the API token is optional.
+	 * @return the API token
+	 */
 	public String getApiTokenOrThrow() {
-		if (this.apiToken == null) {
+		if (this.apiToken == null && !usesProxy()) {
 			throw new InvalidConfigurationPropertyValueException("management.wavefront.api-token", null,
 					"This property is mandatory whenever publishing directly to the Wavefront API");
 		}
@@ -95,6 +109,10 @@ private String getSourceDefault() {
 		}
 	}
 
+	private boolean usesProxy() {
+		return "proxy".equals(this.uri.getScheme());
+	}
+
 	public static class Sender {
 
 		/**

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontPropertiesTests.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.springframework.boot.actuate.autoconfigure.wavefront;
+
+import java.net.URI;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+/**
+ * Tests for {@link WavefrontProperties}.
+ *
+ * @author Moritz Halbritter
+ */
+class WavefrontPropertiesTests {
+
+	@Test
+	void apiTokenIsOptionalWhenUsingProxy() {
+		WavefrontProperties sut = new WavefrontProperties();
+		sut.setUri(URI.create("proxy://localhost:2878"));
+		sut.setApiToken(null);
+		assertThat(sut.getApiTokenOrThrow()).isNull();
+		assertThat(sut.getEffectiveUri()).isEqualTo(URI.create("http://localhost:2878"));
+	}
+
+	@Test
+	void apiTokenIsMandatoryWhenNotUsingProxy() {
+		WavefrontProperties sut = new WavefrontProperties();
+		sut.setUri(URI.create("http://localhost:2878"));
+		sut.setApiToken(null);
+		assertThatThrownBy(sut::getApiTokenOrThrow).isInstanceOf(InvalidConfigurationPropertyValueException.class)
+				.hasMessageContaining("management.wavefront.api-token");
+	}
+
+}