Fix multiple annotation clusters not supported issue. (#2631)

Author: pengdev

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 Mapbox welcomes participation and contributions from everyone.
 
+## Bug fixes 🐞
+* Fix multiple annotation clusters not supported issue.
 
 # 10.18.2 June 24, 2024
 ## Features ✨ and improvements 🏁

plugin-annotation/api/PublicRelease/metalava.txt

@@ -47,6 +47,13 @@ package com.mapbox.maps.plugin.annotation {
     property protected abstract String layerId;
     property public java.util.List<V> longClickListeners;
     property protected abstract String sourceId;
+    field public static final com.mapbox.maps.plugin.annotation.AnnotationManagerImpl.Companion Companion;
+  }
+
+  public static final class AnnotationManagerImpl.Companion {
+    method public java.util.concurrent.atomic.AtomicLong getID_GENERATOR();
+    method public void setID_GENERATOR(java.util.concurrent.atomic.AtomicLong ID_GENERATOR);
+    property public final java.util.concurrent.atomic.AtomicLong ID_GENERATOR;
   }
 
   public final class AnnotationManagerImpl.MapClick implements com.mapbox.maps.plugin.gestures.OnMapClickListener {
@@ -176,13 +183,6 @@ package com.mapbox.maps.plugin.annotation.generated {
     property public com.mapbox.maps.extension.style.expressions.generated.Expression? layerFilter;
     property protected String layerId;
     property protected String sourceId;
-    field public static final com.mapbox.maps.plugin.annotation.generated.CircleAnnotationManager.Companion Companion;
-  }
-
-  public static final class CircleAnnotationManager.Companion {
-    method public java.util.concurrent.atomic.AtomicLong getID_GENERATOR();
-    method public void setID_GENERATOR(java.util.concurrent.atomic.AtomicLong ID_GENERATOR);
-    property public final java.util.concurrent.atomic.AtomicLong ID_GENERATOR;
   }
 
   public final class CircleAnnotationManagerKt {
@@ -518,13 +518,6 @@ package com.mapbox.maps.plugin.annotation.generated {
     property public final com.mapbox.maps.extension.style.layers.properties.generated.TextTranslateAnchor? textTranslateAnchor;
     property public final java.util.List<java.lang.String>? textVariableAnchor;
     property public final java.util.List<java.lang.String>? textWritingMode;
-    field public static final com.mapbox.maps.plugin.annotation.generated.PointAnnotationManager.Companion Companion;
-  }
-
-  public static final class PointAnnotationManager.Companion {
-    method public java.util.concurrent.atomic.AtomicLong getID_GENERATOR();
-    method public void setID_GENERATOR(java.util.concurrent.atomic.AtomicLong ID_GENERATOR);
-    property public final java.util.concurrent.atomic.AtomicLong ID_GENERATOR;
   }
 
   public final class PointAnnotationManagerKt {
@@ -756,13 +749,6 @@ package com.mapbox.maps.plugin.annotation.generated {
     property public com.mapbox.maps.extension.style.expressions.generated.Expression? layerFilter;
     property protected String layerId;
     property protected String sourceId;
-    field public static final com.mapbox.maps.plugin.annotation.generated.PolygonAnnotationManager.Companion Companion;
-  }
-
-  public static final class PolygonAnnotationManager.Companion {
-    method public java.util.concurrent.atomic.AtomicLong getID_GENERATOR();
-    method public void setID_GENERATOR(java.util.concurrent.atomic.AtomicLong ID_GENERATOR);
-    property public final java.util.concurrent.atomic.AtomicLong ID_GENERATOR;
   }
 
   public final class PolygonAnnotationManagerKt {
@@ -902,13 +888,6 @@ package com.mapbox.maps.plugin.annotation.generated {
     property public final com.mapbox.maps.extension.style.layers.properties.generated.LineTranslateAnchor? lineTranslateAnchor;
     property public final java.util.List<java.lang.Double>? lineTrimOffset;
     property protected String sourceId;
-    field public static final com.mapbox.maps.plugin.annotation.generated.PolylineAnnotationManager.Companion Companion;
-  }
-
-  public static final class PolylineAnnotationManager.Companion {
-    method public java.util.concurrent.atomic.AtomicLong getID_GENERATOR();
-    method public void setID_GENERATOR(java.util.concurrent.atomic.AtomicLong ID_GENERATOR);
-    property public final java.util.concurrent.atomic.AtomicLong ID_GENERATOR;
   }
 
   public final class PolylineAnnotationManagerKt {

plugin-annotation/src/main/java/com/mapbox/maps/plugin/annotation/AnnotationManagerImpl.kt

@@ -40,6 +40,7 @@ import java.util.*
 import java.util.concurrent.ConcurrentHashMap
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit
+import java.util.concurrent.atomic.AtomicLong
 
 /**
  * Base class for annotation managers
@@ -49,6 +50,7 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
   final override val delegateProvider: MapDelegateProvider,
   private val annotationConfig: AnnotationConfig?
 ) : AnnotationManager<G, T, S, D, U, V, I> {
+  internal val id: Long = ID_GENERATOR.incrementAndGet()
   private var mapCameraManagerDelegate: MapCameraManagerDelegate =
     delegateProvider.mapCameraManagerDelegate
   private var mapFeatureQueryDelegate: MapFeatureQueryDelegate =
@@ -70,6 +72,9 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
   protected abstract val dragLayerId: String
   protected abstract val dragSourceId: String
 
+  private val associatedLayers = mutableListOf<String>()
+  private val associatedSources = mutableListOf<String>()
+
   @Suppress("UNCHECKED_CAST")
   private var gesturesPlugin: GesturesPlugin = delegateProvider.mapPluginProviderDelegate.getPlugin(
     MAPBOX_GESTURES_PLUGIN_ID
@@ -207,6 +212,7 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
     source?.let {
       if (!style.styleSourceExists(it.sourceId)) {
         style.addSource(it)
+        associatedSources.add(it.sourceId)
       }
     }
 
@@ -228,19 +234,22 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
         if (!layerAdded) {
           style.addPersistentLayer(it)
         }
+        associatedLayers.add(it.layerId)
       }
     }
 
     dragSource?.let {
       if (!style.styleSourceExists(it.sourceId)) {
         style.addSource(it)
+        associatedSources.add(it.sourceId)
       }
     }
     dragLayer?.let {
       if (!style.styleLayerExists(it.layerId)) {
         layer?.layerId?.let { aboveLayerId ->
           // Add drag layer above the annotation layer
           style.addPersistentLayer(it, LayerPosition(aboveLayerId, null, null))
+          associatedLayers.add(it.layerId)
         }
       }
     }
@@ -257,17 +266,19 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
         val clusterLevelLayer = createClusterLevelLayer(level, it.colorLevels)
         if (!style.styleLayerExists(clusterLevelLayer.layerId)) {
           style.addPersistentLayer(clusterLevelLayer)
+          associatedLayers.add(clusterLevelLayer.layerId)
         }
       }
       val clusterTextLayer = createClusterTextLayer()
       if (!style.styleLayerExists(clusterTextLayer.layerId)) {
         style.addPersistentLayer(clusterTextLayer)
+        associatedLayers.add(clusterTextLayer.layerId)
       }
     }
   }
 
   private fun createClusterLevelLayer(level: Int, colorLevels: List<Pair<Int, Int>>) =
-    circleLayer("mapbox-android-cluster-circle-layer-$level", sourceId) {
+    circleLayer("mapbox-android-cluster-circle-layer-$id-level-$level", sourceId) {
       circleColor(colorLevels[level].second)
       annotationConfig?.annotationSourceOptions?.clusterOptions?.let {
         if (it.circleRadiusExpression == null) {
@@ -289,7 +300,7 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
       )
     }
 
-  private fun createClusterTextLayer() = symbolLayer(CLUSTER_TEXT_LAYER_ID, sourceId) {
+  private fun createClusterTextLayer() = symbolLayer("mapbox-android-cluster-text-layer-$id", sourceId) {
     annotationConfig?.annotationSourceOptions?.clusterOptions?.let {
       textField(if (it.textField == null) DEFAULT_TEXT_FIELD else it.textField as Expression)
       if (it.textSizeExpression == null) {
@@ -516,24 +527,14 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
    */
   override fun onDestroy() {
     delegateProvider.getStyle { style ->
-      layer?.let {
-        if (style.styleLayerExists(it.layerId)) {
-          style.removeStyleLayer(it.layerId)
-        }
-      }
-      source?.let {
-        if (style.styleSourceExists(it.sourceId)) {
-          style.removeStyleSource(it.sourceId)
-        }
-      }
-      dragLayer?.let {
-        if (style.styleLayerExists(it.layerId)) {
-          style.removeStyleLayer(it.layerId)
+      associatedLayers.forEach {
+        if (style.styleLayerExists(it)) {
+          style.removeStyleLayer(it)
         }
       }
-      dragSource?.let {
-        if (style.styleSourceExists(it.sourceId)) {
-          style.removeStyleSource(it.sourceId)
+      associatedSources.forEach {
+        if (style.styleSourceExists(it)) {
+          style.removeStyleSource(it)
         }
       }
     }
@@ -874,7 +875,7 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
   /**
    * Static variables and methods.
    */
-  private companion object {
+  companion object {
     /**
      * Tag for log
      */
@@ -883,7 +884,8 @@ abstract class AnnotationManagerImpl<G : Geometry, T : Annotation<G>, S : Annota
 
     /** At most wait 2 seconds to prevent ANR */
     private const val QUERY_WAIT_TIME = 2L
-    private const val CLUSTER_TEXT_LAYER_ID = "mapbox-android-cluster-text-layer"
     private val DEFAULT_TEXT_FIELD = get("point_count")
+    /** The generator for id */
+    var ID_GENERATOR = AtomicLong(0)
   }
 }