Fused Location Provider - onLocationChanged stops getting called

Question

In our app we used the Fused Location Provider (FLP) to track location. We've noticed that occasionally the app can get into a state where the location callback stops getting called. The app in question is used primarily on two tablets (a nexus 7 and LG G-pad 8.3). We have seen the issue occur on both devices. In general resetting the device seems to alleviate the issue. We believe we follow most of the best practices for using the FLP. But just in case we put together this sample code which illustrates how we use the FLP.

Get a google api client and call connect:

m_googleApiClient = builder
                .addConnectionCallbacks(this)
                .addOnConnectionFailedListener(this)
                .addApi(LocationServices.API)
                .build();
m_googleApiClient.connect()

Once connected we start listening for location callbacks:

@Override
public void onConnected(Bundle bundle) {
    m_fusedLocationProviderApi.requestLocationUpdates(m_googleApiClient, m_locationRequest, this);
}

The location request looks like this:

    LocationRequest locationRequest = LocationRequest.create();
    locationRequest.setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY);
    locationRequest.setInterval(UPDATE_INTERVAL_IN_MILLISECONDS);
    locationRequest.setFastestInterval(FASTEST_UPDATE_INTERVAL_IN_MILLISECONDS);

We then implement the callback like so:

    @Override
public void onLocationChanged(Location location) {
   // set location member var and record timestamp.
}

When the issues occurs we don't appear to get any error callbacks. We've tried also calling reset() on the google api client when we detect we haven't received a GPS in a long time. We also monitor location availability using a timer every 2 seconds (using getLocationAvailability). Typically we find that having the user reset their device (power on, power off) fixes the issue.

Our questions are:

1. Has anyone else noticed this issue with FLP?
2. Is there more we can do to fix the issue short of having the user reset? Would remove adding location updates help?
3. Is there more information we can/should collect to diagnose the issue?

Answer 1

I have worked with FusedLocationProvider extensively on a broad spectrum of devices, both low-end & high-end and have seen similar issues where GPS data had bad patches in between. Because of this, I made a few changes catering to these issues related to reliability & robustness (as listed below) and haven't seen these issues after that.

In my experience, the possible solutions to such issues are:

1. Updating Play services: I was using Android Play services versions in the range of 7.x - 8.x when I had these issues.

   Sol: In the recent past, updating to 10.x versions of play services have helped in resolving the issues. We've not seen these issues post the update, so this could definitely be one of the reasons in your case as well.

2. Making Android Service more reliable & robust: This is one of the major reasons we saw blackouts in GPS data and while restarting the device or initializing the setup again, we generally restart the service. And hence, the service starting up back again might resume location updates to normal.

   Sol: I use a Foreground Service instead of background service and this is by far the most reliable solution here but this comes with a sticky UI notification for the user. If not for this, then keeping a health check (running or killed) for the background service can be a good option as well.

3. Reconnecting GoogleAPIClient on connection suspension/error I have seen situations where the GoogleAPIClient connection is suspended or returns an error because of bad network conditions or other reasons. Although I was not able to validate a direct impact of this on the loss of location data, this could very well be a reason in this case. To support this, the resetting of location updates will fail in case this GoogleAPIClient connection issue happens and this is what has been observed by you as well.

   Sol: A simple reconnection of GoogleAPIClient on suspension or error can resolve this.

Apart from these, there is one more reason which could be responsible for this issue:

Device GPS fix lost: There are times when the device loses its GPS fix resulting in absence of GPS data till the time it can get back the GPS fix. There is absolutely no way of determining whether the location was lost because of a GPS fix. Resetting device's location settings have an impact of the device attempting for a GPS fix, which could possibly be the reason here as well.

DISCLAIMER: I am an Android Developer @ HyperTrack and we're developing a location stack for developers who are building location features in their apps and these are the kind of problems we have been solving. It would be great for you to test out similar scenarios using our SDKs and in case you still see the issue we would be happy to help you in getting to its root cause and fixing the issue.

Answer 2

You can try to check LocationSettings like this:

    request = LocationRequest.create();
    LocationSettingsRequest.Builder builder = new LocationSettingsRequest.Builder().addLocationRequest(request);
    builder.setAlwaysShow(true);
    PendingResult<LocationSettingsResult> result =
            LocationServices.SettingsApi.checkLocationSettings(apiClient, builder.build());
    result.setResultCallback(new ResultCallback<LocationSettingsResult>() {
        @Override
        public void onResult(@NonNull LocationSettingsResult result) {
            final Status status = result.getStatus();
            switch (status.getStatusCode()) {
                case LocationSettingsStatusCodes.SUCCESS:
                    LocationServices.FusedLocationApi.requestLocationUpdates(apiClient, request, locationListener);
                    break;
                case LocationSettingsStatusCodes.RESOLUTION_REQUIRED:
                    try {
                        status.startResolutionForResult(context, REQUEST_CODE);
                    } catch (IntentSender.SendIntentException e) {}
                    break;
                case LocationSettingsStatusCodes.SETTINGS_CHANGE_UNAVAILABLE:
                    break;
            }
        }
    });

then handle settings request in onActivityResult

switch (requestCode) {
    case REQUEST_CODE:
      switch (resultCode) {
        case Activity.RESULT_OK:
        // All required changes were successfully made
        LocationServices.FusedLocationApi.requestLocationUpdates(apiClient, request, locationListener);
        break;
        case Activity.RESULT_CANCELED:
        // The user was asked to change settings, but chose not to
        break;
        default:
        break;
      }
    break;
}

If it doesn't help, try to downgrade google-play-services version.