Merge branch 'next' into tms/step-use

Author: Steve Kirkland-Walton

.github/workflows/codeql.yml

@@ -49,7 +49,7 @@ jobs:
           submodules: recursive
       - uses: gradle/wrapper-validation-action@f9c9c575b8b21b6485636a91ffecd10e558c62f6 #v3.5.0
 
-      - uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 #v4.7.0
+      - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #v4.7.1
         with:
           distribution: 'zulu'
           java-version: 17

bugsnag-android-performance/src/test/java/com/bugsnag/android/performance/ContextAwareScheduledThreadPoolExecutorTest.kt

@@ -4,17 +4,16 @@ import android.os.SystemClock
 import com.bugsnag.android.performance.internal.SpanFactory
 import com.bugsnag.android.performance.test.CollectingSpanProcessor
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertSame
-import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.annotation.Config
 import org.robolectric.shadows.ShadowPausedSystemClock
-import java.lang.Thread.sleep
 import java.util.concurrent.Callable
-import java.util.concurrent.CountDownLatch
+import java.util.concurrent.SynchronousQueue
 import java.util.concurrent.TimeUnit
 
 @RunWith(RobolectricTestRunner::class)
@@ -81,25 +80,28 @@ class ContextAwareScheduledThreadPoolExecutorTest {
     fun scheduleWithFixedDelay() {
         val scheduledExecutor = ContextAwareScheduledThreadPoolExecutor(1)
         var startTime = SystemClock.elapsedRealtime()
-        val countDownLatch = CountDownLatch(2)
+        // this is a weird use of SynchronousQueue - we use it to block until the appropriate spans are created
+        // we could probably use a Phaser or Semaphore instead but this is simpler to understand
+        // the span tasks put Units in the queue to signal that they have run, and we poll the queue to wait for them
+        val sync = SynchronousQueue<Unit>()
         spanFactory.createCustomSpan("parent").use {
             scheduledExecutor.scheduleWithFixedDelay(
                 {
                     startTime += 100L
                     SystemClock.setCurrentTimeMillis(startTime)
                     spanFactory.createCustomSpan("child").end()
-                    countDownLatch.countDown()
+                    sync.put(Unit)
                 },
                 0L,
                 100L,
                 TimeUnit.MILLISECONDS,
             )
 
             // end the parent span after one task execution
-            sleep(75L)
+            sync.poll(500, TimeUnit.MILLISECONDS)
         }
 
-        assertTrue(countDownLatch.await(500L, TimeUnit.MILLISECONDS))
+        assertNotNull(sync.poll(500, TimeUnit.MILLISECONDS))
         scheduledExecutor.shutdownNow()
 
         val collectedSpans = spanProcessor.toList()
@@ -112,25 +114,28 @@ class ContextAwareScheduledThreadPoolExecutorTest {
     fun scheduleAtFixedRate() {
         val scheduledExecutor = ContextAwareScheduledThreadPoolExecutor(1)
         var startTime = SystemClock.elapsedRealtime()
-        val countDownLatch = CountDownLatch(2)
+        // this is a weird use of SynchronousQueue - we use it to block until the appropriate spans are created
+        // we could probably use a Phaser or Semaphore instead but this is simpler to understand
+        // the span tasks put Units in the queue to signal that they have run, and we poll the queue to wait for them
+        val sync = SynchronousQueue<Unit>()
         spanFactory.createCustomSpan("parent").use {
             scheduledExecutor.scheduleAtFixedRate(
                 {
                     startTime += 100L
                     SystemClock.setCurrentTimeMillis(startTime)
                     spanFactory.createCustomSpan("child").end()
-                    countDownLatch.countDown()
+                    sync.put(Unit)
                 },
                 0L,
                 100L,
                 TimeUnit.MILLISECONDS,
             )
 
             // end the parent span after one task execution
-            sleep(75L)
+            sync.poll(500, TimeUnit.MILLISECONDS)
         }
 
-        assertTrue(countDownLatch.await(500L, TimeUnit.MILLISECONDS))
+        assertNotNull(sync.poll(500, TimeUnit.MILLISECONDS))
         scheduledExecutor.shutdownNow()
 
         val collectedSpans = spanProcessor.toList()

bugsnag-android-performance/src/test/java/com/bugsnag/android/performance/ContextAwareThreadPoolExecutorTest.kt

@@ -3,6 +3,7 @@ package com.bugsnag.android.performance
 import com.bugsnag.android.performance.internal.SpanFactory
 import com.bugsnag.android.performance.test.CollectingSpanProcessor
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -47,15 +48,17 @@ class ContextAwareThreadPoolExecutorTest {
     fun closedContext() {
         val executor = ContextAwareThreadPoolExecutor(1, 1, 1L, TimeUnit.MILLISECONDS, LinkedBlockingQueue())
         spanFactory.createCustomSpan("parent").use {
-            executor.submit {
+            executor.execute {
                 // allow the parent span to close before starting a span within the task
                 sleep(10L)
                 spanFactory.createCustomSpan("child").end(10L)
             }
         }
 
+        executor.shutdown()
+
         // wait for the task to complete
-        executor.awaitTermination(20L, TimeUnit.MILLISECONDS)
+        assertTrue(executor.awaitTermination(500, TimeUnit.MILLISECONDS))
 
         val collectedSpans = spanProcessor.toList()
         assertEquals(2, collectedSpans.size)