fix comments

Author: jpbempel

dd-trace-core/src/test/java/datadog/trace/common/writer/DDIntakeWriterCombinedTest.java

@@ -40,6 +40,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicInteger;
 import okhttp3.HttpUrl;
+import okhttp3.OkHttpClient;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -322,7 +323,7 @@ void monitorHappyPath() {
                 server.handlers(h -> h.post(path, api -> api.getResponse().status(200).send())));
     try {
       HttpUrl hostUrl = HttpUrl.get(intake.getAddress());
-      okhttp3.OkHttpClient httpClient = OkHttpUtils.buildHttpClient(hostUrl, 1000);
+      OkHttpClient httpClient = OkHttpUtils.buildHttpClient(hostUrl, 1000);
       DDIntakeApi api =
           DDIntakeApi.builder()
               .hostUrl(hostUrl)

dd-trace-core/src/test/java/datadog/trace/common/writer/TraceProcessingWorkerTest.java

@@ -92,7 +92,7 @@ void testHeartbeatsShouldBeTriggeredAutomaticallyWhenEnabled() throws Exception
   @Test
   void testHeartbeatsShouldOccurAtLeastOncePerSecondWhenNotThrottled() throws Exception {
     AtomicInteger flushCount = new AtomicInteger();
-    TraceProcessingWorker worker =
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             mock(HealthMetrics.class),
@@ -101,12 +101,11 @@ void testHeartbeatsShouldOccurAtLeastOncePerSecondWhenNotThrottled() throws Exce
             FAST_LANE,
             1,
             TimeUnit.NANOSECONDS, // stop heartbeats from being throttled
-            null);
+            null)) {
 
-    // processor is started
-    worker.start();
+      // processor is started
+      worker.start();
 
-    try {
       // heartbeat occurs automatically approximately once per second
       // wait 1 second initial delay, then poll up to 1 second
       Thread.sleep(1000);
@@ -116,9 +115,6 @@ void testHeartbeatsShouldOccurAtLeastOncePerSecondWhenNotThrottled() throws Exce
         Thread.sleep(50);
       }
       assertTrue(flushCount.get() > 1);
-    } finally {
-      // cleanup
-      worker.close();
     }
   }
 
@@ -129,7 +125,9 @@ void testHeartbeatsShouldOccurAtLeastOncePerSecondWhenNotThrottled() throws Exce
   @Test
   void testAFlushShouldClearThePrimaryQueue() {
     AtomicInteger flushCount = new AtomicInteger();
-    TraceProcessingWorker worker =
+    // prevent heartbeats from helping the flush happen
+
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             mock(HealthMetrics.class),
@@ -138,9 +136,7 @@ void testAFlushShouldClearThePrimaryQueue() {
             FAST_LANE,
             100,
             TimeUnit.SECONDS, // prevent heartbeats from helping the flush happen
-            null);
-
-    try {
+            null)) {
       // there is pending work it is completed before a flush
       // processing this span will throw an exception, but it should be caught
       // and not disrupt the flush
@@ -153,9 +149,6 @@ void testAFlushShouldClearThePrimaryQueue() {
       assertTrue(flushed);
       assertEquals(1, flushCount.get());
       assertTrue(worker.getPrimaryQueue().isEmpty());
-    } finally {
-      // cleanup
-      worker.close();
     }
   }
 
@@ -195,7 +188,9 @@ void testShouldReportFailureIfSerializationFails(
         .when(healthMetrics)
         .onFailedSerialize(any(), any());
 
-    TraceProcessingWorker worker =
+    // prevent heartbeats from helping the flush happen
+
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             healthMetrics,
@@ -204,10 +199,8 @@ void testShouldReportFailureIfSerializationFails(
             FAST_LANE,
             100,
             TimeUnit.SECONDS, // prevent heartbeats from helping the flush happen
-            null);
-    worker.start();
-
-    try {
+            null)) {
+      worker.start();
       // a trace is processed but can't be passed on
       worker.publish(mock(DDSpan.class), priority, Collections.singletonList(mock(DDSpan.class)));
 
@@ -218,9 +211,6 @@ void testShouldReportFailureIfSerializationFails(
         Thread.sleep(50);
       }
       assertEquals(1, errorReported.get());
-    } finally {
-      // cleanup
-      worker.close();
     }
   }
 
@@ -276,7 +266,7 @@ void testTraceShouldBePostProcessed() throws Exception {
 
     SpanPostProcessor.Holder.INSTANCE = mockProcessor;
 
-    TraceProcessingWorker worker =
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             healthMetrics,
@@ -285,10 +275,8 @@ void testTraceShouldBePostProcessed() throws Exception {
             FAST_LANE,
             100,
             TimeUnit.SECONDS,
-            null);
-    worker.start();
-
-    try {
+            null)) {
+      worker.start();
       // traces are submitted
       List<DDSpan> trace = new ArrayList<>();
       trace.add(span1);
@@ -305,9 +293,7 @@ void testTraceShouldBePostProcessed() throws Exception {
       assertTrue(processedSpan1.get());
       assertTrue(processedSpan2.get());
     } finally {
-      // cleanup
       SpanPostProcessor.Holder.INSTANCE = SpanPostProcessor.Holder.NOOP;
-      worker.close();
     }
   }
 
@@ -350,7 +336,9 @@ void testTracesShouldBeProcessed(
         .when(countingDispatcher)
         .addTrace(any());
     HealthMetrics healthMetrics = mock(HealthMetrics.class);
-    TraceProcessingWorker worker =
+    // prevent heartbeats from helping the flush happen
+
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             healthMetrics,
@@ -359,10 +347,8 @@ void testTracesShouldBeProcessed(
             FAST_LANE,
             100,
             TimeUnit.SECONDS, // prevent heartbeats from helping the flush happen
-            null);
-    worker.start();
-
-    try {
+            null)) {
+      worker.start();
       // traces are submitted
       int submitted = 0;
       for (int i = 0; i < traceCount; ++i) {
@@ -380,10 +366,8 @@ void testTracesShouldBeProcessed(
         Thread.sleep(50);
       }
       assertEquals(expectedSubmitted, acceptedCount.get());
-    } finally {
-      // cleanup
-      worker.close();
     }
+    // cleanup
   }
 
   // -------------------------------------------------------------------------
@@ -490,7 +474,7 @@ public <T extends CoreSpan<T>> boolean setSamplingPriority(T span) {
           }
         };
 
-    TraceProcessingWorker worker =
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             healthMetrics,
@@ -499,10 +483,8 @@ public <T extends CoreSpan<T>> boolean setSamplingPriority(T span) {
             FAST_LANE,
             100,
             TimeUnit.SECONDS,
-            singleSpanSampler);
-    worker.start();
-
-    try {
+            singleSpanSampler)) {
+      worker.start();
       // traces are submitted
       for (int i = 0; i < traceCount; ++i) {
         List<DDSpan> trace = new ArrayList<>();
@@ -523,9 +505,6 @@ public <T extends CoreSpan<T>> boolean setSamplingPriority(T span) {
       assertEquals(acceptedTraces, acceptedCount.get());
       assertEquals(acceptedSpans, acceptedSpanCount.get());
       assertEquals(sampledSingleSpans, sampledSpansCount.get());
-    } finally {
-      // cleanup
-      worker.close();
     }
   }
 
@@ -604,7 +583,7 @@ public <T extends CoreSpan<T>> boolean setSamplingPriority(T span) {
           }
         };
 
-    TraceProcessingWorker worker =
+    try (TraceProcessingWorker worker =
         new TraceProcessingWorker(
             10,
             healthMetrics,
@@ -613,10 +592,8 @@ public <T extends CoreSpan<T>> boolean setSamplingPriority(T span) {
             FAST_LANE,
             100,
             TimeUnit.SECONDS,
-            singleSpanSampler);
-    worker.start();
-
-    try {
+            singleSpanSampler)) {
+      worker.start();
       // traces are submitted
       for (int i = 0; i < traceCount; ++i) {
         List<DDSpan> trace = new ArrayList<>();
@@ -637,9 +614,6 @@ public <T extends CoreSpan<T>> boolean setSamplingPriority(T span) {
       assertEquals(expectedChunks, chunksCount.get());
       assertEquals(expectedSpans, spansCount.get());
       assertEquals(sampledSingleSpans, sampledSpansCount.get());
-    } finally {
-      // cleanup
-      worker.close();
     }
   }
 }