Adding pulsing circle to LocationComponent options

[langsmith]

This pr adds a pulsing option to the Maps SDK's LocationComponent. It is a follow up to mapbox/mapbox-gl-native#13942, which was closed because of our transition away from a mono-repo (more info about that at mapbox/mapbox-gl-native#15971).

[langsmith]

There's a crash that I'm experiencing when running this pr's test app examples. The examples work for a while (10-40 seconds), but then there's a 💥 . I believe it's related to the Android system being overloaded when the pulsing duration (. pulsingCircleDuration()) is a low number, meaning the animator runs really rapidly.

• https://github.com/mapbox/mapbox-gl-native-android/pull/172/files#diff-7dcce2d0485478de700d188fc32f455aR148

• https://github.com/mapbox/mapbox-gl-native-android/pull/172/files#diff-f712a0ab495dc3879352949f319e9f52R63

Some sort of limit or fix needs to be figured out. I'll try to reproduce again on my device and provide more info soon.

cc @Chaoba @zugaldia @malwoodsantoro @jkevincrowley

[zugaldia]

There's a crash that I'm experiencing when running this pr's test app examples.

@Chaoba Would you be able to have a look at it?

[Chaoba]

@langsmith I have changed SECOND_LOCATION_CIRCLE_PULSE_DURATION_MS to 80 ms and run the test app for a while, not found the crash issue. So, maybe it's something else cause the crash.

[Chaoba]

Others look good to me.

[langsmith]

Ok @Chaoba @LukasPaczos , this is good for another round of review 🙇

[langsmith]

cc @galinelle as FYI about this being another type of LocationComponent type of styling

[Chaoba]

LGTM

[LukasPaczos]

This looks awesome @langsmith 👏

Before we merge I have a couple of comments and issues that I found.

First is, that when we change any of the pulsing options, even if the component is disabled, the animation is started:

Second is a leak:
https://gist.github.com/LukasPaczos/e588678654fec0896f059903d5cc818c

[langsmith]

Second is a leak:
https://gist.github.com/LukasPaczos/e588678654fec0896f059903d5cc818c

This is now the only remaining thing in @LukasPaczos' comments above, that hasn't been fixed

[chloekraw]

@langsmith how is this going? Are you blocked on any particular issue?

[LukasPaczos]

We shouldn't try to implement a client-side solution for:

when we change any of the pulsing options, even if the component is disabled, the animation is started

Instead, the LocationComponent#startPulsingLocationCircle should verify the conditions when the style is applied and avoid showing the layer if the component is disabled.

[langsmith]

Just made a new commit e7848ab

We shouldn't try to implement a client-side solution

Refactored and removed that part from the CustomizedLocationPulsingCircleActivity e7848ab#diff-7dcce2d0485478de700d188fc32f455aL144-L147

Instead, the LocationComponent#startPulsingLocationCircle should verify the conditions when the style is applied and avoid showing the layer if the component is disabled.

Whenever startPulsingLocationCircle() is run within LocationComponent.java, options.pulseEnabled() is first checked

mapbox-gl-native-android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponent.java

Lines 729 to 731 in e7848ab

	if (options.pulseEnabled()) {
	startPulsingLocationCircle();
	} else {

isEnabled() is in reference to the overall LocationComponent:

mapbox-gl-native-android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponent.java

Lines 742 to 745 in e7848ab

	if (isEnabled) {
	locationAnimatorCoordinator.startLocationComponentCirclePulsing(options);
	locationLayerController.adjustPulsingCircleLayerVisibility(true);
	}

[LukasPaczos]

I'm not able to reproduce the leak anymore. Have you been able to narrow it down and fix it? It might also be directly connected to the solution for https://github.com/mapbox/mapbox-gl-native-android/pull/172/files#r413040504.

When the above is address, we'll need to work on rebasing this on top of the master. Let me know if you need any help with that.

[langsmith]

I'm not able to reproduce the leak anymore

I still get the leak on my physical device 🤷 Maybe it's device specific? Will see what happens on an emulated device.

[LukasPaczos]

Could you add incompatibility doc entry to:

mapbox-gl-native-android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentActivationOptions.java

Line 138 in 5cee66a

public boolean useSpecializedLocationLayer() {

and

mapbox-gl-native-android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponentActivationOptions.java

Line 253 in 5cee66a

public Builder useSpecializedLocationLayer(boolean useSpecializedLocationLayer) {

I've spent a fair amount of time trying to track down the leak. The newly added animator seems to be canceled correctly, I'm unable to spot any issues.

The reproduction of the leak has been completely flaky for me, sometimes I've been able to reproduce it many time in the row, then it stopped being reproducible and I had to reinstall the app. And the cycle repeats. I've never been able to reproduce with the debugger attached. Any ideas @mapbox/maps-android?

I've also found an unrelated performance issue - https://github.com/mapbox/mapbox-gl-native/issues/16439.

[langsmith]

incompatibility doc entries added ✔️

[LukasPaczos]

Great work @langsmith!