Split global functionality into a separate class (open-telemetry#2233) (open-telemetry#2239)

bogdandrutu · web-flow · commit 37afb33659cb · 2020-12-15T13:05:46.000-08:00
This ensure clear separation of functionality. This PR does not change any functionality, it just restructures the code to separate global functionality from
the Default implementation. Also helps to ensure that Global initialization does not happen by mistake when working only with the default implementation.

Also it helps with methods like `OpenTelemetry.get()` and `OpenTelemetry.set()` to understand they are interacting with global instance

Signed-off-by: Bogdan Drutu &lt;bogdandrutu@gmail.com&gt;
diff --git a/api/all/src/main/java/io/opentelemetry/api/DefaultOpenTelemetry.java b/api/all/src/main/java/io/opentelemetry/api/DefaultOpenTelemetry.java
@@ -28,10 +28,10 @@ public static DefaultOpenTelemetryBuilder builder() {
 
   private final TracerProvider tracerProvider;
   private final MeterProvider meterProvider;
-
   private volatile ContextPropagators propagators;
 
   @Override
+  @Deprecated
   public void setPropagators(ContextPropagators propagators) {
     this.propagators = propagators;
   }
diff --git a/api/all/src/main/java/io/opentelemetry/api/GlobalOpenTelemetry.java b/api/all/src/main/java/io/opentelemetry/api/GlobalOpenTelemetry.java
@@ -158,7 +158,10 @@ public static ContextPropagators getPropagators() {
 
   /**
    * Sets the globally registered {@link ContextPropagators} for remote propagation of a context.
+   *
+   * @deprecated this will be removed soon, create a new instance if necessary.
    */
+  @Deprecated
   public static void setPropagators(ContextPropagators propagators) {
     requireNonNull(propagators, "propagators");
     get().setPropagators(propagators);
diff --git a/api/all/src/main/java/io/opentelemetry/api/OpenTelemetry.java b/api/all/src/main/java/io/opentelemetry/api/OpenTelemetry.java
@@ -5,8 +5,6 @@
 
 package io.opentelemetry.api;
 
-import static java.util.Objects.requireNonNull;
-
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.api.trace.Tracer;
@@ -15,6 +13,7 @@
 import io.opentelemetry.spi.OpenTelemetryFactory;
 import io.opentelemetry.spi.metrics.MeterProviderFactory;
 import io.opentelemetry.spi.trace.TracerProviderFactory;
+import java.util.Objects;
 
 /**
  * The entrypoint to telemetry functionality for tracing, metrics and baggage.
@@ -130,15 +129,20 @@ static ContextPropagators getGlobalPropagators() {
   /**
    * Sets the globally registered {@link ContextPropagators} for remote propagation of a context.
    *
-   * @deprecated use {@link GlobalOpenTelemetry#setPropagators(ContextPropagators)}
+   * @deprecated this will be removed soon, create a new instance if necessary.
    */
   @Deprecated
   static void setGlobalPropagators(ContextPropagators propagators) {
-    requireNonNull(propagators, "propagators");
+    Objects.requireNonNull(propagators, "propagators");
     get().setPropagators(propagators);
   }
 
-  /** Sets the propagators that this instance should contain. */
+  /**
+   * Sets the propagators that this instance should contain.
+   *
+   * @deprecated this will be removed soon, create a new instance if necessary.
+   */
+  @Deprecated
   void setPropagators(ContextPropagators propagators);
 
   /** Returns the {@link TracerProvider} for this {@link OpenTelemetry}. */
diff --git a/api/all/src/test/java/io/opentelemetry/api/OpenTelemetryTest.java b/api/all/src/test/java/io/opentelemetry/api/OpenTelemetryTest.java
@@ -173,13 +173,15 @@ void testMeterNotFound() {
   }
 
   @Test
+  @SuppressWarnings("deprecation") // tested deprecated code
   void testGlobalPropagatorsSet() {
     ContextPropagators propagators = ContextPropagators.noop();
     GlobalOpenTelemetry.setPropagators(propagators);
     assertThat(GlobalOpenTelemetry.getPropagators()).isEqualTo(propagators);
   }
 
   @Test
+  @SuppressWarnings("deprecation") // tested deprecated code
   void testPropagatorsSet() {
     ContextPropagators propagators = ContextPropagators.noop();
     OpenTelemetry instance = DefaultOpenTelemetry.builder().build();
@@ -237,6 +239,7 @@ void independentNonGlobalPropagators() {
   }
 
   @Test
+  @SuppressWarnings("deprecation") // tested deprecated code
   void testPropagatorsSetNull() {
     assertThrows(NullPointerException.class, () -> GlobalOpenTelemetry.setPropagators(null));
   }
diff --git a/integration-tests/tracecontext/src/main/java/io/opentelemetry/Application.java b/integration-tests/tracecontext/src/main/java/io/opentelemetry/Application.java
@@ -29,6 +29,7 @@
 import spark.Route;
 import spark.Spark;
 
+@SuppressWarnings("deprecation") // using deprecated code in tests
 public class Application {
   private static final Logger logger = Logger.getLogger(Application.class.getName());
   private static final OpenTelemetry openTelemetry;

Original file line number	Diff line number	Diff line change
`@@ -173,13 +173,15 @@ void testMeterNotFound() {`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`@Test`
	`176`	`+ @SuppressWarnings("deprecation") // tested deprecated code`
`176`	`177`	`void testGlobalPropagatorsSet() {`
`177`	`178`	`ContextPropagators propagators = ContextPropagators.noop();`
`178`	`179`	`GlobalOpenTelemetry.setPropagators(propagators);`
`179`	`180`	`assertThat(GlobalOpenTelemetry.getPropagators()).isEqualTo(propagators);`
`180`	`181`	`}`
`181`	`182`
`182`	`183`	`@Test`
	`184`	`+ @SuppressWarnings("deprecation") // tested deprecated code`
`183`	`185`	`void testPropagatorsSet() {`
`184`	`186`	`ContextPropagators propagators = ContextPropagators.noop();`
`185`	`187`	`OpenTelemetry instance = DefaultOpenTelemetry.builder().build();`
`@@ -237,6 +239,7 @@ void independentNonGlobalPropagators() {`
`237`	`239`	`}`
`238`	`240`
`239`	`241`	`@Test`
	`242`	`+ @SuppressWarnings("deprecation") // tested deprecated code`
`240`	`243`	`void testPropagatorsSetNull() {`
`241`	`244`	`assertThrows(NullPointerException.class, () -> GlobalOpenTelemetry.setPropagators(null));`
`242`	`245`	`}`