rename builder

Author: zeitlinger

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/ConfigPropertiesFactory.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.extension.internal;
+
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+@SuppressWarnings("NonApiType")
+class ConfigPropertiesTranslator {
+  // lookup order matters - we choose the first match
+  private final LinkedHashMap<String, String> translationMap;
+  private final Map<String, Object> fixedValues;
+
+  ConfigPropertiesTranslator(
+      LinkedHashMap<String, String> translationMap, Map<String, Object> fixedValues) {
+    this.translationMap = translationMap;
+    this.fixedValues = fixedValues;
+  }
+
+  String translateProperty(String property) {
+    for (Map.Entry<String, String> entry : translationMap.entrySet()) {
+      if (property.startsWith(entry.getKey())) {
+        return entry.getValue() + property.substring(entry.getKey().length());
+      }
+    }
+    return property;
+  }
+
+  public Object get(String propertyName) {
+    return fixedValues.get(propertyName);
+  }
+
+}

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/ConfigPropertiesTranslator.java

@@ -53,11 +53,11 @@ final class DeclarativeConfigPropertiesBridge implements ConfigProperties {
 
   private static final String OTEL_INSTRUMENTATION_PREFIX = "otel.instrumentation.";
 
-  private final ConfigPropertiesFactory translator;
+  private final ConfigPropertiesTranslator translator;
   @Nullable private final DeclarativeConfigProperties baseNode;
 
   DeclarativeConfigPropertiesBridge(
-      @Nullable DeclarativeConfigProperties baseNode, ConfigPropertiesFactory translator) {
+      @Nullable DeclarativeConfigProperties baseNode, ConfigPropertiesTranslator translator) {
     this.baseNode = baseNode;
     this.translator = translator;
   }

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridge.java

@@ -0,0 +1,68 @@
+package io.opentelemetry.javaagent.extension.internal;
+
+import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
+
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import javax.annotation.Nullable;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class DeclarativeConfigPropertiesBridgeBuilder {
+  private final LinkedHashMap<String, String> translationMap = new LinkedHashMap<>();
+  private final Map<String, Object> fixedValues = new LinkedHashMap<>();
+
+  public DeclarativeConfigPropertiesBridgeBuilder() {}
+
+  @CanIgnoreReturnValue
+  public DeclarativeConfigPropertiesBridgeBuilder addTranslation(
+      String propertyName, String yamlPath) {
+    translationMap.put(propertyName, yamlPath);
+    return this;
+  }
+
+  @CanIgnoreReturnValue
+  public DeclarativeConfigPropertiesBridgeBuilder addFixedValue(String propertyName, Object value) {
+    fixedValues.put(propertyName, value);
+    return this;
+  }
+
+  /** Resolve {@link ConfigProperties} from the {@code autoConfiguredOpenTelemetrySdk}. */
+  public ConfigProperties resolveConfigProperties(
+      AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
+    ConfigProperties sdkConfigProperties =
+        AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk);
+    if (sdkConfigProperties != null) {
+      return sdkConfigProperties;
+    }
+    ConfigProvider configProvider =
+        AutoConfigureUtil.getConfigProvider(autoConfiguredOpenTelemetrySdk);
+    if (configProvider != null) {
+      return resolveInstrumentationConfig(configProvider.getInstrumentationConfig());
+    }
+    // Should never happen
+    throw new IllegalStateException(
+        "AutoConfiguredOpenTelemetrySdk does not have ConfigProperties or DeclarativeConfigProperties. This is likely a programming error in opentelemetry-java");
+  }
+
+  public ConfigProperties resolveInstrumentationConfig(
+      @Nullable DeclarativeConfigProperties instrumentationConfig) {
+    if (instrumentationConfig == null) {
+      instrumentationConfig = DeclarativeConfigProperties.empty();
+    }
+    return resolveConfig(instrumentationConfig.getStructured("java", empty()));
+  }
+
+  public ConfigProperties resolveConfig(@Nullable DeclarativeConfigProperties config) {
+    return new DeclarativeConfigPropertiesBridge(
+        config, new ConfigPropertiesTranslator(translationMap, fixedValues));
+  }
+}

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeBuilder.java

@@ -1,8 +1,3 @@
-/*
- * Copyright The OpenTelemetry Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-
 package io.opentelemetry.javaagent.extension.internal;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -20,8 +15,7 @@
 import org.mockito.MockedStatic;
 import org.mockito.Mockito;
 
-@SuppressWarnings("DoNotMockAutoValue")
-class ConfigPropertiesFactoryTest {
+class DeclarativeConfigPropertiesBridgeBuilderTest {
   @Test
   void shouldUseConfigPropertiesForAutoConfiguration() {
     ConfigProperties configPropertiesMock = mock(ConfigProperties.class);
@@ -33,7 +27,7 @@ void shouldUseConfigPropertiesForAutoConfiguration() {
           .thenReturn(configPropertiesMock);
 
       ConfigProperties configProperties =
-          ConfigPropertiesFactory.builder().resolveConfigProperties(sdkMock);
+          new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
 
       assertThat(configProperties).isSameAs(configPropertiesMock);
     }
@@ -62,7 +56,7 @@ void shouldUseConfigProviderForDeclarativeConfiguration() {
           .thenReturn(configProviderMock);
 
       ConfigProperties configProperties =
-          ConfigPropertiesFactory.builder().resolveConfigProperties(sdkMock);
+          new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
 
       assertThat(configProperties.getString(propertyName)).isEqualTo(expectedValue);
     }
@@ -82,7 +76,7 @@ void shouldUseConfigProviderForDeclarativeConfiguration_noInstrumentationConfig(
           .thenReturn(configProviderMock);
 
       ConfigProperties configProperties =
-          ConfigPropertiesFactory.builder().resolveConfigProperties(sdkMock);
+          new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
 
       assertThat(configProperties.getString("testProperty")).isEqualTo(null);
     }

javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/internal/ConfigPropertiesFactoryTest.java renamed to javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeBuilderTest.java

@@ -27,19 +27,20 @@ class DeclarativeConfigPropertiesBridgeTest {
 
   @BeforeEach
   void setup() {
-    bridge = create(ConfigPropertiesFactory.builder());
+    bridge = create(new DeclarativeConfigPropertiesBridgeBuilder());
 
     OpenTelemetryConfigurationModel emptyModel =
         new OpenTelemetryConfigurationModel()
             .withAdditionalProperty("instrumentation/development", new InstrumentationModel());
     SdkConfigProvider emptyConfigProvider = SdkConfigProvider.create(emptyModel);
     emptyBridge =
-        ConfigPropertiesFactory.builder()
+        new DeclarativeConfigPropertiesBridgeBuilder()
             .resolveInstrumentationConfig(
                 Objects.requireNonNull(emptyConfigProvider.getInstrumentationConfig()));
   }
 
-  private static ConfigProperties create(ConfigPropertiesFactory.Builder builder) {
+  private static ConfigProperties create(
+      DeclarativeConfigPropertiesBridgeBuilder builder) {
     OpenTelemetryConfigurationModel model =
         DeclarativeConfiguration.parse(
             DeclarativeConfigPropertiesBridgeTest.class
@@ -124,15 +125,15 @@ void vendor() {
   @Test
   void vendorTranslation() {
     ConfigProperties propertiesBridge =
-        create(ConfigPropertiesFactory.builder().addTranslation("acme", "acme.full_name"));
+        create(new DeclarativeConfigPropertiesBridgeBuilder().addTranslation("acme", "acme.full_name"));
     assertThat(propertiesBridge.getBoolean("acme.preserved")).isTrue();
   }
 
   @Test
   void agentCommonTranslation() {
     assertThat(
             create(
-                    ConfigPropertiesFactory.builder()
+                    new DeclarativeConfigPropertiesBridgeBuilder()
                         .addTranslation(
                             "otel.instrumentation.common.default-enabled",
                             "common.default.enabled"))
@@ -144,7 +145,7 @@ void agentCommonTranslation() {
   void agentTranslation() {
     ConfigProperties bridge =
         create(
-            ConfigPropertiesFactory.builder()
+            new DeclarativeConfigPropertiesBridgeBuilder()
                 .addTranslation("otel.javaagent", "agent")
                 .addFixedValue("otel.javaagent.debug", true)
                 .addFixedValue("otel.javaagent.logging", "application"));

javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeTest.java

@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.javaagent.bootstrap.OpenTelemetrySdkAccess;
-import io.opentelemetry.javaagent.extension.internal.ConfigPropertiesFactory;
+import io.opentelemetry.javaagent.extension.internal.DeclarativeConfigPropertiesBridgeBuilder;
 import io.opentelemetry.javaagent.tooling.config.EarlyInitAgentConfig;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
@@ -47,7 +47,7 @@ public static AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(
           // the Resource from the original instance is also the default Resource,
           // so this is functionally equivalent
           Resource.getDefault(),
-          ConfigPropertiesFactory.builder()
+          new DeclarativeConfigPropertiesBridgeBuilder()
               .addTranslation(
                   "otel.instrumentation.common.default-enabled", "common.default.enabled")
               .addTranslation("otel.javaagent", "agent")