Modified the initialize layers behavior to always apply the current options even if it means removing the existing layers.

Author: Seth Bourget

changelog/unreleased/bugfixes/6793.md

@@ -0,0 +1 @@
+- Updated behavior of `MapboxRouteLineView::initializeLayers` to always reset the route line related layers with the options provided even if it means removing existing layers in order to apply the options. Also new instances of `MapboxRouteLineView` will result in an initialization of the layers upon the first render call. 

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/route/line/MapboxRouteLineUtils.kt

@@ -1751,4 +1751,31 @@ internal object MapboxRouteLineUtils {
             .iconIgnorePlacement(true)
             .iconKeepUpright(true)
     }
+
+    internal fun removeLayersAndSources(style: Style) {
+        style.removeStyleSource(RouteLayerConstants.LAYER_GROUP_1_SOURCE_ID)
+        style.removeStyleSource(RouteLayerConstants.LAYER_GROUP_2_SOURCE_ID)
+        style.removeStyleSource(RouteLayerConstants.LAYER_GROUP_3_SOURCE_ID)
+        style.removeStyleSource(RouteLayerConstants.WAYPOINT_SOURCE_ID)
+        style.removeStyleLayer(RouteLayerConstants.TOP_LEVEL_ROUTE_LINE_LAYER_ID)
+        style.removeStyleLayer(RouteLayerConstants.BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_TRAIL_CASING)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_TRAIL)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_CASING)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_MAIN)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_TRAFFIC)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_1_RESTRICTED)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_TRAIL_CASING)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_TRAIL)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_CASING)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_MAIN)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_TRAFFIC)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_2_RESTRICTED)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_TRAIL_CASING)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_TRAIL)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_CASING)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_MAIN)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_TRAFFIC)
+        style.removeStyleLayer(RouteLayerConstants.LAYER_GROUP_3_RESTRICTED)
+    }
 }

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/route/line/api/MapboxRouteLineView.kt

@@ -18,6 +18,7 @@ import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.ge
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layerGroup1SourceLayerIds
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layerGroup2SourceLayerIds
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layerGroup3SourceLayerIds
+import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.layersAreInitialized
 import com.mapbox.navigation.ui.maps.internal.route.line.MapboxRouteLineUtils.sourceLayerMap
 import com.mapbox.navigation.ui.maps.route.RouteLayerConstants
 import com.mapbox.navigation.ui.maps.route.RouteLayerConstants.LAYER_GROUP_1_CASING
@@ -78,6 +79,8 @@ import org.jetbrains.annotations.TestOnly
 @UiThread
 class MapboxRouteLineView(options: MapboxRouteLineOptions) {
 
+    private var rebuildLayersOnFirstRender: Boolean = true
+
     private companion object {
         private const val TAG = "MbxRouteLineView"
     }
@@ -142,14 +145,32 @@ class MapboxRouteLineView(options: MapboxRouteLineOptions) {
      * the layers if they have not yet been initialized. If you have a use case for initializing
      * the layers in advance of any API calls this method may be used.
      *
+     * If the layers already exist they will be removed and re-initialized with the options provided.
+     *
      * Each [Layer] added to the map by this class is a persistent layer - it will survive style changes.
      * This means that if the data has not changed, it does not have to be manually redrawn after a style change.
      * See [Style.addPersistentStyleLayer].
      *
      * @param style a valid [Style] instance
      */
     fun initializeLayers(style: Style) {
-        MapboxRouteLineUtils.initializeLayers(style, options)
+        resetLayers(style)
+    }
+
+    /**
+     * Updates the [MapboxRouteLineOptions] used for the route line related layers and initializes the layers.
+     * If the layers already exist they will be removed and re-initialized with the options provided.
+     *
+     * Each [Layer] added to the map by this class is a persistent layer - it will survive style changes.
+     * This means that if the data has not changed, it does not have to be manually redrawn after a style change.
+     * See [Style.addPersistentStyleLayer].
+     *
+     * @param style a valid [Style] instance
+     * @param options used for the route line related layers.
+     */
+    fun initializeLayers(style: Style, options: MapboxRouteLineOptions) {
+        this.options = options
+        resetLayers(style)
     }
 
     /**
@@ -159,7 +180,7 @@ class MapboxRouteLineView(options: MapboxRouteLineOptions) {
      * @param routeDrawData a [Expected<RouteLineError, RouteSetValue>]
      */
     fun renderRouteDrawData(style: Style, routeDrawData: Expected<RouteLineError, RouteSetValue>) {
-        MapboxRouteLineUtils.initializeLayers(style, options)
+        rebuildSourcesAndLayersIfNeeded(style)
         jobControl.scope.launch(Dispatchers.Main) {
             mutex.withLock {
                 val primaryRouteTrafficVisibility = getTrafficVisibility(style)
@@ -332,7 +353,7 @@ class MapboxRouteLineView(options: MapboxRouteLineOptions) {
         style: Style,
         clearRouteLineValue: Expected<RouteLineError, RouteLineClearValue>
     ) {
-        MapboxRouteLineUtils.initializeLayers(style, options)
+        rebuildSourcesAndLayersIfNeeded(style)
         jobControl.scope.launch(Dispatchers.Main) {
             mutex.withLock {
                 clearRouteLineValue.onValue { value ->
@@ -862,4 +883,33 @@ class MapboxRouteLineView(options: MapboxRouteLineOptions) {
                 }
             }
     }
+
+    private fun rebuildSourcesAndLayersIfNeeded(style: Style) {
+        if (rebuildLayersOnFirstRender || !layersAreInitialized(style, options)) {
+            rebuildLayersOnFirstRender = false
+            resetLayers(style)
+        }
+    }
+
+    private fun resetLayers(style: Style) {
+        sourceToFeatureMap.clear()
+        sourceToFeatureMap[MapboxRouteLineUtils.layerGroup1SourceKey] = RouteLineFeatureId(null)
+        sourceToFeatureMap[MapboxRouteLineUtils.layerGroup2SourceKey] = RouteLineFeatureId(null)
+        sourceToFeatureMap[MapboxRouteLineUtils.layerGroup3SourceKey] = RouteLineFeatureId(null)
+        primaryRouteLineLayerGroup = setOf()
+        listOf(
+            RouteLayerConstants.LAYER_GROUP_1_SOURCE_ID,
+            RouteLayerConstants.LAYER_GROUP_2_SOURCE_ID,
+            RouteLayerConstants.LAYER_GROUP_3_SOURCE_ID,
+            RouteLayerConstants.WAYPOINT_SOURCE_ID
+        ).forEach {
+            updateSource(
+                style,
+                it,
+                FeatureCollection.fromFeatures(listOf())
+            )
+        }
+        MapboxRouteLineUtils.removeLayersAndSources(style)
+        MapboxRouteLineUtils.initializeLayers(style, options)
+    }
 }

libnavui-maps/src/test/java/com/mapbox/navigation/ui/maps/internal/route/line/MapboxRouteLineUtilsTest.kt

@@ -2028,6 +2028,41 @@ class MapboxRouteLineUtilsTest {
         assertFalse(result)
     }
 
+    @Test
+    fun removeLayersAndSources() {
+        val style = mockk<Style> {
+            every { removeStyleLayer(any()) } returns ExpectedFactory.createNone()
+            every { removeStyleSource(any()) } returns ExpectedFactory.createNone()
+        }
+
+        MapboxRouteLineUtils.removeLayersAndSources(style)
+
+        verify { style.removeStyleSource(LAYER_GROUP_1_SOURCE_ID) }
+        verify { style.removeStyleSource(LAYER_GROUP_2_SOURCE_ID) }
+        verify { style.removeStyleSource(LAYER_GROUP_3_SOURCE_ID) }
+        verify { style.removeStyleSource(WAYPOINT_SOURCE_ID) }
+        verify { style.removeStyleLayer(TOP_LEVEL_ROUTE_LINE_LAYER_ID) }
+        verify { style.removeStyleLayer(BOTTOM_LEVEL_ROUTE_LINE_LAYER_ID) }
+        verify { style.removeStyleLayer(LAYER_GROUP_1_TRAIL_CASING) }
+        verify { style.removeStyleLayer(LAYER_GROUP_1_TRAIL) }
+        verify { style.removeStyleLayer(LAYER_GROUP_1_CASING) }
+        verify { style.removeStyleLayer(LAYER_GROUP_1_MAIN) }
+        verify { style.removeStyleLayer(LAYER_GROUP_1_TRAFFIC) }
+        verify { style.removeStyleLayer(LAYER_GROUP_1_RESTRICTED) }
+        verify { style.removeStyleLayer(LAYER_GROUP_2_TRAIL_CASING) }
+        verify { style.removeStyleLayer(LAYER_GROUP_2_TRAIL) }
+        verify { style.removeStyleLayer(LAYER_GROUP_2_CASING) }
+        verify { style.removeStyleLayer(LAYER_GROUP_2_MAIN) }
+        verify { style.removeStyleLayer(LAYER_GROUP_2_TRAFFIC) }
+        verify { style.removeStyleLayer(LAYER_GROUP_2_RESTRICTED) }
+        verify { style.removeStyleLayer(LAYER_GROUP_3_TRAIL_CASING) }
+        verify { style.removeStyleLayer(LAYER_GROUP_3_TRAIL) }
+        verify { style.removeStyleLayer(LAYER_GROUP_3_CASING) }
+        verify { style.removeStyleLayer(LAYER_GROUP_3_MAIN) }
+        verify { style.removeStyleLayer(LAYER_GROUP_3_TRAFFIC) }
+        verify { style.removeStyleLayer(LAYER_GROUP_3_RESTRICTED) }
+    }
+
     private fun <T> listElementsAreEqual(
         first: List<T>,
         second: List<T>,