Fix some render tasks being skipped (#1306)

mapbox · Apr 27, 2022 · 41ab43c · 41ab43c
1 parent 592e1e0
commit 41ab43c
Show file tree

Hide file tree

Showing 15 changed files with 32 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,11 @@ Mapbox welcomes participation and contributions from everyone.
 * Optimize how plugins handle settings changes. Call `applySettings` only when settings value changes. ([#1189](https://github.com/mapbox/mapbox-maps-android/pull/1189))
 * Add new Exception type `MapboxMapMemoryLeakException` which will be thrown when there is a leak for nativeMap. ([1193](https://github.com/mapbox/mapbox-maps-android/pull/1193))
 
+# 10.4.3 April 27, 2022
+
+### Bug fixes 🐞
+* Fix render tasks being skipped when creating the map that could lead to missing tiles. ([#1304](https://github.com/mapbox/mapbox-maps-android/pull/1304))
+
 # 10.4.2 April 13, 2022
 
 ### Bug fixes 🐞

diff --git a/extension-localization/README.md b/extension-localization/README.md
@@ -31,7 +31,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-    implementation 'com.mapbox.extension:maps-localization:10.4.2'
+    implementation 'com.mapbox.extension:maps-localization:10.4.3'
 }
 ```
 

diff --git a/extension-style/README.md b/extension-style/README.md
@@ -32,7 +32,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.extension:maps-style:10.4.2'
+  implementation 'com.mapbox.extension:maps-style:10.4.3'
 }
 ```
 

diff --git a/plugin-animation/README.md b/plugin-animation/README.md
@@ -34,7 +34,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-animation:10.4.2'
+  implementation 'com.mapbox.plugin:maps-animation:10.4.3'
 }
 ```
 

diff --git a/plugin-annotation/README.md b/plugin-annotation/README.md
@@ -30,7 +30,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-annotation:10.4.2'
+  implementation 'com.mapbox.plugin:maps-annotation:10.4.3'
 }
 ```
 

diff --git a/plugin-attribution/README.md b/plugin-attribution/README.md
@@ -33,7 +33,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-attribution:10.4.2'
+  implementation 'com.mapbox.plugin:maps-attribution:10.4.3'
 }
 ```
 

diff --git a/plugin-compass/README.md b/plugin-compass/README.md
@@ -32,9 +32,9 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-compass:10.4.2'
+  implementation 'com.mapbox.plugin:maps-compass:10.4.3'
   // Mapbox Maps Compass Plugin depends on the Mapbox Maps Animation Plugin
-  implementation 'com.mapbox.plugin:maps-animation:10.4.2'
+  implementation 'com.mapbox.plugin:maps-animation:10.4.3'
 }
 ```
 

diff --git a/plugin-gestures/README.md b/plugin-gestures/README.md
@@ -30,9 +30,9 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-gestures:10.4.2'
+  implementation 'com.mapbox.plugin:maps-gestures:10.4.3'
   // Mapbox Maps Gestures Plugin depends on the Mapbox Maps Animation Plugin
-  implementation 'com.mapbox.plugin:maps-animation:10.4.2'
+  implementation 'com.mapbox.plugin:maps-animation:10.4.3'
 }
 ```
 

diff --git a/plugin-lifecycle/README.md b/plugin-lifecycle/README.md
@@ -30,7 +30,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-lifecycle:10.4.2'
+  implementation 'com.mapbox.plugin:maps-lifecycle:10.4.3'
   // Make sure the version of appcompat is 1.3.0+
   implementation 'androidx.appcompat:appcompat:1.3.0'
 }

diff --git a/plugin-locationcomponent/README.md b/plugin-locationcomponent/README.md
@@ -29,7 +29,7 @@ allprojects {
 }
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-locationcomponent:10.4.2'
+  implementation 'com.mapbox.plugin:maps-locationcomponent:10.4.3'
 }
 ```
 

diff --git a/plugin-logo/README.md b/plugin-logo/README.md
@@ -30,7 +30,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-logo:10.4.2'
+  implementation 'com.mapbox.plugin:maps-logo:10.4.3'
 }
 ```
 

diff --git a/plugin-overlay/README.md b/plugin-overlay/README.md
@@ -32,7 +32,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-overlay:10.4.2'
+  implementation 'com.mapbox.plugin:maps-overlay:10.4.3'
 }
 ```
 

diff --git a/plugin-scalebar/README.md b/plugin-scalebar/README.md
@@ -32,7 +32,7 @@ allprojects {
 
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-scalebar:10.4.2'
+  implementation 'com.mapbox.plugin:maps-scalebar:10.4.3'
 }
 ```
 

diff --git a/plugin-viewport/README.md b/plugin-viewport/README.md
@@ -50,7 +50,7 @@ allprojects {
 }
 // In the app build.gradle file
 dependencies {
-  implementation 'com.mapbox.plugin:maps-viewport:10.4.2'
+  implementation 'com.mapbox.plugin:maps-viewport:10.4.3'
 }
 ```
 

diff --git a/sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderThread.kt b/sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderThread.kt
@@ -11,7 +11,6 @@ import com.mapbox.common.Logger
 import com.mapbox.maps.renderer.egl.EGLCore
 import com.mapbox.maps.renderer.gl.TextureRenderer
 import com.mapbox.maps.renderer.widget.Widget
-import java.util.LinkedList
 import java.util.concurrent.ConcurrentLinkedQueue
 import java.util.concurrent.locks.ReentrantLock
 import javax.microedition.khronos.egl.EGL10
@@ -147,12 +146,15 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
             // finally we can create native renderer if needed or just report OK
             if (eglContextCreated) {
               if (!renderCreated) {
+                // we set `renderCreated` as `true` before creating native render as core could potentially
+                // schedule task in the same callchain and we need to make sure that `renderThreadPrepared` is already `true`
+                // so that we do not drop this task
+                renderCreated = true
                 mapboxRenderer.createRenderer()
                 mapboxRenderer.onSurfaceChanged(
                   width = width,
                   height = height
                 )
-                renderCreated = true
               }
               return true
             }
@@ -419,9 +421,11 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
     if (renderThreadPrepared && !paused) {
       draw()
     }
-    // we drain queue despite buffers swapped or not
-    drainQueue(nonRenderEventQueue)
     awaitingNextVsync = false
+    // It's critical to drain queue after setting `awaitingNextVsync` to false as some tasks may recursively schedule other tasks when executed.
+    // With `awaitingNextVsync = false` we will always schedule recursive tasks for later execution
+    // via `renderHandlerThread.postDelayed` instead of updating queue concurrently that is being drained (which may lead to deadlock in core).
+    drainQueue(nonRenderEventQueue)
   }
 
   @AnyThread
@@ -508,22 +512,10 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
   }
 
   private fun drainQueue(originalQueue: ConcurrentLinkedQueue<RenderEvent>) {
-    if (originalQueue.isNotEmpty()) {
-      // we iterate over immutable copy in order to avoid executing recursive tasks
-      val localQueueCopy = LinkedList(originalQueue)
-      // clear original queue before executing
-      originalQueue.clear()
-      localQueueCopy.forEach {
-        it.runnable?.run()
-      }
-      // recursive tasks (if any) were added to the original queue - post draining them in new callchain
-      if (originalQueue.isNotEmpty()) {
-        renderHandlerThread.post {
-          if (renderThreadPrepared) {
-            drainQueue(originalQueue)
-          }
-        }
-      }
+    var event = originalQueue.poll()
+    while (event != null) {
+      event.runnable?.run()
+      event = originalQueue.poll()
     }
   }