Memory leak when using the mapbox-plugins

[fchen77]

Hi, I'm using mapbox on my android app and it is working great. But when I try to use the locationPlugin to display the user position, I see the consommation of my memory going up when the user move.
Unfortunately, if the user is constantly moving, the app will crash due to a Out of Memory.

The issue may be related to the locationEngine.setInterval()/setFastestInterval() since in the doc of both we have :

If this rate is faster than your app can handle, you may encounter problems with UI flicker or data overflow

Below is a test that I recreate having the same issue :

`
private LocationLayerPlugin locationPlugin;
private LocationEngine locationEngine;
private MapboxMap map;

@Nullable
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
    super.onCreateView(inflater, container, savedInstanceState);

    Mapbox.getInstance(getContext(), MyMapbox.getToken());

    binding = DataBindingUtil.inflate(inflater, R.layout.test, container, false);
    binding.mapView.onCreate(savedInstanceState);
    binding.mapView.getMapAsync(this);

    return binding.getRoot();
}

@Override
public void onStart() {
    super.onStart();
    binding.mapView.onStart();
}

@Override
public void onResume() {
    super.onResume();
    binding.mapView.onResume();
}

@Override
public void onPause() {
    super.onPause();
    binding.mapView.onPause();
}

@Override
public void onStop() {
    super.onStop();
    binding.mapView.onStop();
}

@Override
public void onLowMemory() {
    super.onLowMemory();
    binding.mapView.onLowMemory();
}

@Override
public void onDestroyView() {
    super.onDestroyView();
    if (locationEngine != null) {
        locationEngine.removeLocationUpdates();
        locationEngine.removeLocationEngineListener(this);
        locationEngine.deactivate();
     }

    if (locationPlugin != null) {
        locationPlugin.onStop();
    }
    binding.mapView.onDestroy();
}

@Override
public void onSaveInstanceState(@NonNull Bundle outState) {
    super.onSaveInstanceState(outState);
    binding.mapView.onSaveInstanceState(outState);
}

@SuppressLint("MissingPermission")
@Override
public void onConnected() {
    locationEngine.requestLocationUpdates();
}

@Override
public void onLocationChanged(Location location) {
    Log.d(LOG_TAG, "TEST");
}

private void enableLocationPlugin() {
    if (locationPlugin == null) {
        LocationEngineProvider locationEngineProvider = new LocationEngineProvider(getContext());
        locationEngine = locationEngineProvider.obtainBestLocationEngineAvailable();
        locationEngine.setPriority(LocationEnginePriority.BALANCED_POWER_ACCURACY);
        locationEngine.setFastestInterval(1000);
        locationEngine.setInterval(1000);
        locationEngine.addLocationEngineListener(this);
        locationEngine.activate();

        locationPlugin = new LocationLayerPlugin(binding.mapView, map, locationEngine);
    }
}

@Override
public void onMapReady(MapboxMap mapboxMap) {
    map = mapboxMap;
    enableLocationPlugin();
}`

[LukasPaczos]

Hey @fchen77, thanks for reporting this issue! A couple of follow up questions:

• What's the reproduction rate on your device, can you reproduce every single time?
• How long does it take you to reach OOM?
• Is it reproducible when your device is not connected to the debugger, or your working machine at all?
• Is it reproducible on the latest snapshot build as well?

I know that's a lot of questions, but it would greatly help us to get to the bottom of this, thanks!

[fchen77]

Hi, @LukasPaczos

What's the reproduction rate on your device, can you reproduce every single time?

The issue is occurring every time

How long does it take you to reach OOM?

This depend on the device I'm using but it take more or less 10 min before reaching OOM. A point that I forget to say was I'm running Lockito (a application) in order to simulate path. I dont' think it's related but I prefer to point it out.

Is it reproducible when your device is not connected to the debugger, or your working machine at all?

Yes, since I use real device in order to do some testing, I'm able to reproduce is issue when my device is not connected.

Is it reproducible on the latest snapshot build as well?

I was using 0.5.2 version, just upgraded to 0.5.3 , and unfortunately the issue is still occurring. But the memory consommation does feel slower. After 15min, there are still no OOM

[LukasPaczos]

Thanks @fchen77!

Would you mind retesting that with the 0.6.0-SNAPSHOT as well? You can find instructions here.

Besides that, I just wanted to point out that location updates should be stopped and a call to LocationLayerPlugin#onStop should be made in fragment's/activity's #onStop.
Also, the call to LocationLayerPlugin#onStart should be made in #onStart, but that's unrelated to the issue.

[fchen77]

Yes, I didn't pay attention when writing the testFragment, but did include the LocationLayerPlugin#onStop and the LocationLayerPlugin#onStart when doing the test using 0.5.3 version.

I just tested the snapshot and there is still a constante increase of the memory consummation.
As for stopping the location update, since I need to constantly keep track of the location, I don't think it is a good solution for me. But yes, adding LocationEngine#removeLocationUpdates does resolve the issue but LocationEngine#removeLocationEngineListener doesn't.

[LukasPaczos]

What I mean by calling LocationEngine#removeLocationUpdates in #onStop is that you, in general, shouldn't push location updates after the fragment/activity is stopped.

Back to the issue - unfortunately, I'm not able to reproduce. I'm simulating a route for more than an hour now and memory seems to be stable.

That said, I noticed increased memory consumption resulting in an OOM, but at some point I wasn't able to reproduce anymore.

[fchen77]

I just did new testing using this Code https://www.mapbox.com/help/android-navigation-sdk/ (stopped at Add Marker On click step) and I unfortunately run still run into this issue. There won't be memory leak if the device is in lock screen or if the user doesn't move. It does seem to be related to the plugin and since without it there are no increased memory consumption.

Being unable to really find the source of the issue, I shall try without simulating a route and go for a walk later on the day to see if there are still a OOM.

[nazmuddin77]

Hi @LukasPaczos,

I've been experiencing the same issue. The easiest way to reproduce this issue is, to enable the location layer plugin and set the zoom of the map to maximum level (somewhere around 18 and above) and when locations are getting received. You can clearly see the rise in memory consumption by the native layer in Android Profiler.
Following were my location layer configurations :
renderMode = COMPASS
cameraMode = TRACKING_COMPASS

My LocationLayerPlugin version is 0.5.3 and Mapbox version is 6.2.1

[nazmuddin77]

Hi @LukasPaczos,

I was able to reproduce this issue in the demo app of Mapbox and have also uploaded the video of crash due to memory leak for reference. Please find the link of the video below
https://www.youtube.com/watch?v=UZ9zzdLiIH0

Following is the code of activity in which LocationLayerPlugin is used :

@BindView(R.id.map_view)
MapView mapView;
@BindView(R.id.tv_mode)
TextView modeText;
@BindView(R.id.tv_tracking)
TextView trackingText;
@BindView(R.id.button_location_mode)
Button locationModeBtn;
@BindView(R.id.button_location_tracking)
Button locationTrackingBtn;

private LocationLayerPlugin locationLayerPlugin;
private LocationEngine locationEngine;
private MapboxMap mapboxMap;
private boolean customStyle;

private static final String SAVED_STATE_CAMERA = "saved_state_camera";
private static final String SAVED_STATE_RENDER = "saved_state_render";

@CameraMode.Mode
private int cameraMode = CameraMode.TRACKING_COMPASS;

@RenderMode.Mode
private int renderMode = RenderMode.COMPASS;

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.activity_location_layer_mode);
  ButterKnife.bind(this);

  mapView.onCreate(savedInstanceState);
  mapView.getMapAsync(this);

  if (savedInstanceState != null) {
    cameraMode = savedInstanceState.getInt(SAVED_STATE_CAMERA);
    renderMode = savedInstanceState.getInt(SAVED_STATE_RENDER);
  }
}

@SuppressWarnings( {"MissingPermission"})
@OnClick(R.id.button_location_mode)
public void locationMode(View view) {
  if (locationLayerPlugin == null) {
    return;
  }
  showModeListDialog();
}

@OnClick(R.id.button_location_tracking)
public void locationModeCompass(View view) {
  if (locationLayerPlugin == null) {
    return;
  }
  showTrackingListDialog();
}

@SuppressLint("MissingPermission")
@Override
public void onMapReady(MapboxMap mapboxMap) {
  this.mapboxMap = mapboxMap;
  locationEngine = new LocationEngineProvider(this).obtainBestLocationEngineAvailable();
  locationEngine.setPriority(LocationEnginePriority.HIGH_ACCURACY);
  locationEngine.setInterval(1000);
  locationEngine.setFastestInterval(1000);
  locationEngine.setSmallestDisplacement(0f);
  locationEngine.addLocationEngineListener(this);
  locationEngine.activate();

  int[] padding;
  if (getResources().getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT) {
    padding = new int[] {0, 750, 0, 0};
  } else {
    padding = new int[] {0, 250, 0, 0};
  }
  LocationLayerOptions options = LocationLayerOptions.builder(this)
    .padding(padding)
    .build();
  locationLayerPlugin = new LocationLayerPlugin(mapView, mapboxMap, locationEngine, options);
  locationLayerPlugin.addOnLocationClickListener(this);
  locationLayerPlugin.addOnCameraTrackingChangedListener(this);
  locationLayerPlugin.setCameraMode(cameraMode);
  setRendererMode(renderMode);

  getLifecycle().addObserver(locationLayerPlugin);
}

@Override
public boolean onCreateOptionsMenu(Menu menu) {
  getMenuInflater().inflate(R.menu.menu_location, menu);
  return true;
}

@SuppressLint("MissingPermission")
@Override
public boolean onOptionsItemSelected(MenuItem item) {
  if (locationLayerPlugin == null) {
    return super.onOptionsItemSelected(item);
  }

  int id = item.getItemId();
  if (id == R.id.action_style_change) {
    toggleStyle();
    return true;
  } else if (id == R.id.action_map_style_change) {
    toggleMapStyle();
    return true;
  } else if (id == R.id.action_plugin_disable) {
    locationLayerPlugin.setLocationLayerEnabled(false);
    return true;
  } else if (id == R.id.action_plugin_enabled) {
    locationLayerPlugin.setLocationLayerEnabled(true);
    return true;
  }

  return super.onOptionsItemSelected(item);
}

@VisibleForTesting
public void toggleStyle() {
  customStyle = !customStyle;
  locationLayerPlugin.applyStyle(customStyle ? R.style.CustomLocationLayer
    : R.style.mapbox_LocationLayer);
}

@VisibleForTesting
public void toggleMapStyle() {
  String styleUrl = mapboxMap.getStyleUrl().contentEquals(Style.DARK) ? Style.LIGHT : Style.DARK;
  mapboxMap.setStyle(styleUrl);
}

@VisibleForTesting
public LocationLayerPlugin getLocationLayerPlugin() {
  return locationLayerPlugin;
}

@Override
@SuppressWarnings( {"MissingPermission"})
protected void onStart() {
  super.onStart();
  mapView.onStart();
  if (locationEngine != null) {
    locationEngine.requestLocationUpdates();
    locationEngine.addLocationEngineListener(this);
  }
}

@Override
protected void onResume() {
  super.onResume();
  mapView.onResume();
}

@Override
protected void onPause() {
  super.onPause();
  mapView.onPause();
}

@Override
protected void onStop() {
  super.onStop();
  mapView.onStop();
  if (locationEngine != null) {
    locationEngine.removeLocationEngineListener(this);
    locationEngine.removeLocationUpdates();
  }
}

@Override
protected void onSaveInstanceState(Bundle outState) {
  super.onSaveInstanceState(outState);
  mapView.onSaveInstanceState(outState);
  outState.putInt(SAVED_STATE_CAMERA, cameraMode);
  outState.putInt(SAVED_STATE_RENDER, renderMode);
}

@Override
protected void onDestroy() {
  super.onDestroy();
  mapView.onDestroy();
  if (locationEngine != null) {
    locationEngine.deactivate();
  }
}

@Override
public void onLowMemory() {
  super.onLowMemory();
  mapView.onLowMemory();
}

@Override
@SuppressWarnings( {"MissingPermission"})
public void onConnected() {
  locationEngine.requestLocationUpdates();
}

@Override
public void onLocationChanged(Location location) {
  mapboxMap.animateCamera(CameraUpdateFactory.newLatLngZoom(
    new LatLng(location.getLatitude(), location.getLongitude()), 16));
  locationEngine.removeLocationEngineListener(this);
}

@Override
public void onLocationLayerClick() {
  Toast.makeText(this, "OnLocationLayerClick", Toast.LENGTH_LONG).show();
}

private void showModeListDialog() {
  List<String> modes = new ArrayList<>();
  modes.add("Normal");
  modes.add("Compass");
  modes.add("GPS");
  ArrayAdapter<String> profileAdapter = new ArrayAdapter<>(this,
    android.R.layout.simple_list_item_1, modes);
  ListPopupWindow listPopup = new ListPopupWindow(this);
  listPopup.setAdapter(profileAdapter);
  listPopup.setAnchorView(locationModeBtn);
  listPopup.setOnItemClickListener((parent, itemView, position, id) -> {
    String selectedMode = modes.get(position);
    locationModeBtn.setText(selectedMode);
    if (selectedMode.contentEquals("Normal")) {
      setRendererMode(RenderMode.NORMAL);
    } else if (selectedMode.contentEquals("Compass")) {
      setRendererMode(RenderMode.COMPASS);
    } else if (selectedMode.contentEquals("GPS")) {
      setRendererMode(RenderMode.GPS);
    }
    listPopup.dismiss();
  });
  listPopup.show();
}

private void setRendererMode(@RenderMode.Mode int mode) {
  renderMode = mode;
  locationLayerPlugin.setRenderMode(mode);
  if (mode == RenderMode.NORMAL) {
    locationModeBtn.setText("Normal");
  } else if (mode == RenderMode.COMPASS) {
    locationModeBtn.setText("Compass");
  } else if (mode == RenderMode.GPS) {
    locationModeBtn.setText("Gps");
  }
}

private void showTrackingListDialog() {
  List<String> trackingTypes = new ArrayList<>();
  trackingTypes.add("None");
  trackingTypes.add("Tracking");
  trackingTypes.add("Tracking Compass");
  trackingTypes.add("Tracking GPS");
  trackingTypes.add("Tracking GPS North");
  ArrayAdapter<String> profileAdapter = new ArrayAdapter<>(this,
    android.R.layout.simple_list_item_1, trackingTypes);
  ListPopupWindow listPopup = new ListPopupWindow(this);
  listPopup.setAdapter(profileAdapter);
  listPopup.setAnchorView(locationTrackingBtn);
  listPopup.setOnItemClickListener((parent, itemView, position, id) -> {
    String selectedTrackingType = trackingTypes.get(position);
    locationTrackingBtn.setText(selectedTrackingType);
    if (selectedTrackingType.contentEquals("None")) {
      locationLayerPlugin.setCameraMode(CameraMode.NONE);
    } else if (selectedTrackingType.contentEquals("Tracking")) {
      locationLayerPlugin.setCameraMode(CameraMode.TRACKING);
    } else if (selectedTrackingType.contentEquals("Tracking Compass")) {
      locationLayerPlugin.setCameraMode(CameraMode.TRACKING_COMPASS);
    } else if (selectedTrackingType.contentEquals("Tracking GPS")) {
      locationLayerPlugin.setCameraMode(CameraMode.TRACKING_GPS);
    } else if (selectedTrackingType.contentEquals("Tracking GPS North")) {
      locationLayerPlugin.setCameraMode(CameraMode.TRACKING_GPS_NORTH);
    }
    listPopup.dismiss();
  });
  listPopup.show();
}

@Override
public void onCameraTrackingDismissed() {
  locationTrackingBtn.setText("None");
}

@Override
public void onCameraTrackingChanged(int currentMode) {
  this.cameraMode = currentMode;

  if (cameraMode == CameraMode.NONE) {
    locationTrackingBtn.setText("None");
  } else if (cameraMode == CameraMode.TRACKING) {
    locationTrackingBtn.setText("Tracking");
  } else if (cameraMode == CameraMode.TRACKING_COMPASS) {
    locationTrackingBtn.setText("Tracking Compass");
  } else if (cameraMode == CameraMode.TRACKING_GPS) {
    locationTrackingBtn.setText("Tracking GPS");
  } else if (cameraMode == CameraMode.TRACKING_GPS_NORTH) {
    locationTrackingBtn.setText("Tracking GPS North");
  }
}

[BharathMG]

+1
I was easily able to reproduce it when the Map is fully zoomed and constantly receiving locations.
I tried creating espresso test showcasing it and you can see the constant increase in memory consumption in native layer when running this test (it is a long running test),

(I changed location to London which has more features in max zoom layer.)

 @Test
  fun locationLayerPlugin_increasesMemoryConsumption() {
    val pluginAction = object : GenericPluginAction.OnPerformGenericPluginAction<LocationLayerPlugin> {
      override fun onGenericPluginAction(plugin: LocationLayerPlugin, mapboxMap: MapboxMap,
                                         uiController: UiController, context: Context) {
        val testLifecycleOwner = TestLifecycleOwner()
        testLifecycleOwner.markState(Lifecycle.State.RESUMED)
        testLifecycleOwner.lifecycle.addObserver(plugin)
       val initLocation = Location("test")
        initLocation.latitude = 51.5074
       initLocation.longitude = 0.1278
        mapboxMap.moveCamera(CameraUpdateFactory.newLatLng(LatLng(initLocation)))
        mapboxMap.moveCamera(CameraUpdateFactory.zoomBy(18.0))
        for (i in 0..10000) {
          plugin.forceLocationUpdate(initLocation)
          uiController.loopMainThreadForAtLeast(MAP_RENDER_DELAY)
        }
      }
    }
    executePluginTest(pluginAction,
            PluginGenerationUtil.getLocationLayerPluginProvider(rule.activity))
  }

[LukasPaczos]

Thanks for notes @nazmuddin77, @BharathMG!
I'm again able to kind-of consistently reproduce the issue and working on a solution.

[LukasPaczos]

Thanks everyone involved for code snippets and testing! The issue seems to be resolved with mapbox/mapbox-gl-native#12296 that will be included in the 0.7.0 release targeted EOW next week.

In the meantime, could you retest your implementations while manually including Maps SDK snapshot dependency?

implementation "com.mapbox.mapboxsdk:mapbox-android-sdk:6.3.0-SNAPSHOT"

[fchen77]

Just did some testing using both snapshot 6.3.0 and 0.7.0 and so far I don't get any OOM or excess memory consumption.

[LukasPaczos]

Great, thanks for verifying that @fchen77!