Move convertToModel to InstrumentationConfigUtil

Author: jack-berg

api/incubator/build.gradle.kts

@@ -12,6 +12,9 @@ otelJava.moduleName.set("io.opentelemetry.api.incubator")
 dependencies {
   api(project(":api:all"))
 
+  // Supports optional InstrumentationConfigUtil#convertToModel
+  compileOnly("com.fasterxml.jackson.core:jackson-databind")
+
   annotationProcessor("com.google.auto.value:auto-value")
 
   // To use parsed config file as input for InstrumentationConfigUtilTest
@@ -24,3 +27,16 @@ dependencies {
 
   testImplementation("com.google.guava:guava")
 }
+
+testing {
+  suites {
+    register<JvmTestSuite>("testConvertToModel") {
+      dependencies {
+        implementation("com.fasterxml.jackson.core:jackson-databind")
+        implementation(project(":sdk-extensions:incubator"))
+        implementation(project(":sdk-extensions:autoconfigure"))
+        implementation("com.google.guava:guava")
+      }
+    }
+  }
+}

api/incubator/src/main/java/io/opentelemetry/api/incubator/config/InstrumentationConfigUtil.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.api.incubator.config;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -148,4 +149,26 @@ public static <T> T getOrNull(
   }
 
   private InstrumentationConfigUtil() {}
+
+  /**
+   * Convert the {@code declarativeConfigProperties} to an instance of a given {@code modelType}.
+   *
+   * <p>This method is a simple wrapper of {@link ObjectMapper#convertValue(Object, Class)} combined
+   * with a call to {@link DeclarativeConfigProperties#toMap(DeclarativeConfigProperties)}.
+   *
+   * <p>NOTE: callers MUST add their own dependency on {@code
+   * com.fasterxml.jackson.core:jackson-databind}. This module's dependency is {@code compileOnly}
+   * since jackson is a large dependency that many users will not require. It's very possible to
+   * convert between {@link DeclarativeConfigProperties} (or a map representation from {@link
+   * DeclarativeConfigProperties#toMap(DeclarativeConfigProperties)}) and a target model type
+   * without jackson. This method is provided a convenience method for demonstration purposes.
+   */
+  public static <T> T convertToModel(
+      ObjectMapper objectMapper,
+      DeclarativeConfigProperties declarativeConfigProperties,
+      Class<T> modelType) {
+    Map<String, Object> configPropertiesMap =
+        DeclarativeConfigProperties.toMap(declarativeConfigProperties);
+    return objectMapper.convertValue(configPropertiesMap, modelType);
+  }
 }

…DeclarativeConfigurationConvertTest.java …ry/api/incubator/ConvertToModelTest.javasdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationConvertTest.java renamed to api/incubator/src/testConvertToModel/java/io/opentelemetry/api/incubator/ConvertToModelTest.java sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationConvertTest.java renamed to api/incubator/src/testConvertToModel/java/io/opentelemetry/api/incubator/ConvertToModelTest.java

@@ -3,17 +3,20 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.sdk.extension.incubator.fileconfig;
+package io.opentelemetry.api.incubator;
 
-import static io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration.MAPPER;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.collect.ImmutableMap;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.api.incubator.config.InstrumentationConfigUtil;
 import io.opentelemetry.sdk.autoconfigure.internal.ComponentLoader;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.YamlDeclarativeConfigProperties;
 import java.io.ByteArrayInputStream;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
@@ -24,7 +27,9 @@
 import java.util.Objects;
 import org.junit.jupiter.api.Test;
 
-class DeclarativeConfigurationConvertTest {
+class ConvertToModelTest {
+
+  private static final ObjectMapper MAPPER = new ObjectMapper();
 
   @Test
   void toMap_RoundTrip() throws JsonProcessingException {
@@ -56,7 +61,7 @@ void toMap_RoundTrip() throws JsonProcessingException {
   void convertToModel_Empty() {
     DeclarativeConfigProperties properties = ofMap(Collections.emptyMap());
 
-    assertThat(DeclarativeConfiguration.convertToModel(properties, Model.class))
+    assertThat(InstrumentationConfigUtil.convertToModel(MAPPER, properties, Model.class))
         .isEqualTo(new Model());
   }
 
@@ -94,12 +99,12 @@ void convertToModel_KitchenSink() {
     listEntryModel.value = "the_value";
     expected.structuredListProperty = Collections.singletonList(listEntryModel);
 
-    assertThat(DeclarativeConfiguration.convertToModel(properties, Model.class))
+    assertThat(InstrumentationConfigUtil.convertToModel(MAPPER, properties, Model.class))
         .isEqualTo(expected);
   }
 
   private static final ComponentLoader componentLoader =
-      SpiHelper.serviceComponentLoader(DeclarativeConfigurationConvertTest.class.getClassLoader());
+      SpiHelper.serviceComponentLoader(ConvertToModelTest.class.getClassLoader());
 
   private static YamlDeclarativeConfigProperties ofMap(Map<String, Object> map) {
     return YamlDeclarativeConfigProperties.create(map, componentLoader);
@@ -140,7 +145,7 @@ private static class Model {
 
     @Override
     public boolean equals(Object o) {
-      if (o == null || getClass() != o.getClass()) {
+      if (!(o instanceof Model)) {
         return false;
       }
       Model model = (Model) o;

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfiguration.java

@@ -11,6 +11,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.api.incubator.config.InstrumentationConfigUtil;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.ComponentLoader;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
@@ -201,7 +202,9 @@ static DeclarativeConfigProperties toConfigProperties(
   public static Sampler createSampler(DeclarativeConfigProperties genericSamplerModel) {
     YamlDeclarativeConfigProperties yamlDeclarativeConfigProperties =
         requireYamlDeclarativeConfigProperties(genericSamplerModel);
-    SamplerModel samplerModel = convertToModel(yamlDeclarativeConfigProperties, SamplerModel.class);
+    SamplerModel samplerModel =
+        InstrumentationConfigUtil.convertToModel(
+            MAPPER, yamlDeclarativeConfigProperties, SamplerModel.class);
     return createAndMaybeCleanup(
         SamplerFactory.getInstance(),
         SpiHelper.create(yamlDeclarativeConfigProperties.getComponentLoader()),
@@ -217,20 +220,6 @@ private static YamlDeclarativeConfigProperties requireYamlDeclarativeConfigPrope
     return (YamlDeclarativeConfigProperties) declarativeConfigProperties;
   }
 
-  /**
-   * Convert the {@code declarativeConfigProperties} to an instance of a given {@code modelType}.
-   *
-   * <p>Wrapper around {@link ObjectMapper#convertValue(Object, Class)}. See {@link ObjectMapper}
-   * for full details. If the {@link ObjectMapper} we use doesn't match your requirements, configure
-   * your own instance and call {@link ObjectMapper#convertValue(Object, Class)} using it.
-   */
-  public static <T> T convertToModel(
-      DeclarativeConfigProperties declarativeConfigProperties, Class<T> modelType) {
-    Map<String, Object> configPropertiesMap =
-        DeclarativeConfigProperties.toMap(declarativeConfigProperties);
-    return MAPPER.convertValue(configPropertiesMap, modelType);
-  }
-
   static <M, R> R createAndMaybeCleanup(Factory<M, R> factory, SpiHelper spiHelper, M model) {
     DeclarativeConfigContext context = new DeclarativeConfigContext(spiHelper);
     try {

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/YamlDeclarativeConfigProperties.java

@@ -11,7 +11,6 @@
 import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.internal.ComponentLoader;
-import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.LinkedHashMap;
@@ -67,10 +66,10 @@ private YamlDeclarativeConfigProperties(
    * com.fasterxml.jackson.databind.ObjectMapper}), and have values which are scalars, lists of
    * scalars, lists of maps, and maps.
    *
-   * @see DeclarativeConfiguration#toConfigProperties(OpenTelemetryConfigurationModel)
+   * @see DeclarativeConfiguration#toConfigProperties(Object)
    */
   @SuppressWarnings("unchecked")
-  static YamlDeclarativeConfigProperties create(
+  public static YamlDeclarativeConfigProperties create(
       Map<String, Object> properties, ComponentLoader componentLoader) {
     Map<String, Object> simpleEntries = new LinkedHashMap<>();
     Map<String, List<YamlDeclarativeConfigProperties>> listEntries = new LinkedHashMap<>();