Keep location component's layers hidden when new style with the "layer-below" option is applied

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationLayerController.java

@@ -111,6 +111,11 @@ void applyStyle(@NonNull LocationComponentOptions options) {
       if (layerBelow == null || !layerBelow.equals(newLayerBelowOption)) {
         removeLayers();
         addLayers(newLayerBelowOption);
+        if (isHidden) {
+          for (String layerId : layerMap) {
+            setLayerVisibility(layerId, false);
+          }
+        }
         setRenderMode(renderMode);
       }
     }

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/StaleStateManager.java

@@ -1,8 +1,11 @@
 package com.mapbox.mapboxsdk.location;
 
 import android.os.Handler;
+import android.os.Message;
 import android.support.annotation.NonNull;
 
+import java.lang.ref.WeakReference;
+
 /**
  * Class controls the location stale state when the {@link android.location.Location} hasn't
  * been updated in 'x' amount of time. {@link LocationComponentOptions#staleStateTimeout()} can be used to
@@ -14,25 +17,19 @@ class StaleStateManager {
   private boolean isEnabled;
   private final OnLocationStaleListener innerOnLocationStaleListeners;
   @NonNull
-  private final Handler handler;
+  private final StaleMessageHandler handler;
   private boolean isStale = true;
   private long delayTime;
 
+  private final int staleStateMessage = 1;
+
   StaleStateManager(OnLocationStaleListener innerListener, LocationComponentOptions options) {
     innerOnLocationStaleListeners = innerListener;
-    handler = new Handler();
+    handler = new StaleMessageHandler(this);
     isEnabled = options.enableStaleState();
     delayTime = options.staleStateTimeout();
   }
 
-  @NonNull
-  private Runnable staleStateRunnable = new Runnable() {
-    @Override
-    public void run() {
-      setState(true);
-    }
-  };
-
   void setEnabled(boolean enabled) {
     if (enabled) {
       setState(isStale);
@@ -54,7 +51,9 @@ void updateLatestLocationTime() {
 
   void setDelayTime(long delayTime) {
     this.delayTime = delayTime;
-    postTheCallback();
+    if (handler.hasMessages(staleStateMessage)) {
+      postTheCallback();
+    }
   }
 
   void onStart() {
@@ -69,7 +68,7 @@ void onStop() {
 
   private void postTheCallback() {
     handler.removeCallbacksAndMessages(null);
-    handler.postDelayed(staleStateRunnable, delayTime);
+    handler.sendEmptyMessageDelayed(staleStateMessage, delayTime);
   }
 
   private void setState(boolean stale) {
@@ -80,4 +79,21 @@ private void setState(boolean stale) {
       }
     }
   }
+
+  private static class StaleMessageHandler extends Handler {
+
+    private final WeakReference<StaleStateManager> managerWeakReference;
+
+    private StaleMessageHandler(StaleStateManager staleStateManager) {
+      this.managerWeakReference = new WeakReference<>(staleStateManager);
+    }
+
+    @Override
+    public void handleMessage(Message msg) {
+      StaleStateManager manager = managerWeakReference.get();
+      if (manager != null) {
+        manager.setState(true);
+      }
+    }
+  }
 }

platform/android/MapboxGLAndroidSDKTestApp/src/androidTest/java/com/mapbox/mapboxsdk/location/LocationLayerControllerTest.kt

@@ -17,12 +17,9 @@ import com.mapbox.mapboxsdk.camera.CameraUpdateFactory
 import com.mapbox.mapboxsdk.geometry.LatLng
 import com.mapbox.mapboxsdk.location.LocationComponentConstants.*
 import com.mapbox.mapboxsdk.location.modes.RenderMode
-import com.mapbox.mapboxsdk.location.utils.LocationComponentAction
+import com.mapbox.mapboxsdk.location.utils.*
 import com.mapbox.mapboxsdk.location.utils.MapboxTestingUtils.Companion.MAPBOX_HEAVY_STYLE
 import com.mapbox.mapboxsdk.location.utils.MapboxTestingUtils.Companion.pushSourceUpdates
-import com.mapbox.mapboxsdk.location.utils.StyleChangeIdlingResource
-import com.mapbox.mapboxsdk.location.utils.isLayerVisible
-import com.mapbox.mapboxsdk.location.utils.querySourceFeatures
 import com.mapbox.mapboxsdk.maps.MapboxMap
 import com.mapbox.mapboxsdk.maps.Style
 import com.mapbox.mapboxsdk.style.sources.GeoJsonSource
@@ -247,6 +244,33 @@ class LocationLayerControllerTest : EspressoTest() {
     executeComponentTest(componentAction)
   }
 
+  @Test
+  fun whenStyleChanged_isDisabled_hasLayerBelow_staysHidden() {
+    val componentAction = object : LocationComponentAction.OnPerformLocationComponentAction {
+      override fun onLocationComponentAction(component: LocationComponent, mapboxMap: MapboxMap,
+                                             style: Style, uiController: UiController, context: Context) {
+        component.activateLocationComponent(context, style, false)
+        component.isLocationComponentEnabled = true
+        component.forceLocationUpdate(location)
+        TestingAsyncUtils.waitForLayer(uiController, idlingResource.mapView)
+        component.isLocationComponentEnabled = false
+        TestingAsyncUtils.waitForLayer(uiController, idlingResource.mapView)
+        assertThat(mapboxMap.queryRenderedFeatures(location, FOREGROUND_LAYER).isEmpty(), `is`(true))
+
+        val options =
+          LocationComponentOptions.createFromAttributes(context, com.mapbox.mapboxsdk.testapp.R.style.CustomLocationComponent)
+            .toBuilder()
+            .layerBelow("road-label")
+            .build()
+
+        component.applyStyle(options)
+        TestingAsyncUtils.waitForLayer(uiController, idlingResource.mapView)
+        assertThat(mapboxMap.queryRenderedFeatures(location, FOREGROUND_LAYER).isEmpty(), `is`(true))
+      }
+    }
+    executeComponentTest(componentAction)
+  }
+
   @Test
   fun whenStyleChanged_staleStateChanges() {
     val componentAction = object : LocationComponentAction.OnPerformLocationComponentAction {