Merge pull request #1406 from OpenTracksApp/raceCondition#1328

Handle LocationManager callbacks with TrackRecordingService's handler.

.github/workflows/test.yml.disabled

@@ -1,3 +1,6 @@
+# We have flaky test results due to performance limitations in Github Actions.
+# Happens too often nowadays; See https://github.com/OpenTracksApp/OpenTracks/issues/1409
+
 #https://github.com/marketplace/actions/android-emulator-runner
 name: Test
 on:

src/androidTest/java/de/dennisguse/opentracks/services/handlers/GPSHandlerTest.java

@@ -6,6 +6,7 @@ import static org.mockito.Mockito.verify;
 
 import android.content.Context;
 import android.location.Location;
+import android.os.Handler;
 import android.os.Looper;
 
 import androidx.test.core.app.ApplicationProvider;
@@ -49,7 +50,7 @@ public class GPSHandlerTest {
         Mockito.when(trackPointCreator.createNow())
                 .thenReturn(Instant.now());
 
-        locationHandler.onStart(context);
+        locationHandler.onStart(context, new Handler());
     }
 
     /**

src/main/java/de/dennisguse/opentracks/services/handlers/GPSHandler.java

@@ -3,14 +3,16 @@ package de.dennisguse.opentracks.services.handlers;
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.location.Location;
-import android.location.LocationListener;
 import android.location.LocationManager;
 import android.os.Bundle;
+import android.os.Handler;
 import android.util.Log;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.VisibleForTesting;
+import androidx.core.location.LocationListenerCompat;
 import androidx.core.location.LocationManagerCompat;
+import androidx.core.location.LocationRequestCompat;
 
 import java.time.Duration;
 import java.time.Instant;
@@ -23,12 +25,16 @@ import de.dennisguse.opentracks.util.LocationUtils;
 import de.dennisguse.opentracks.util.PermissionRequester;
 
 @VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
-public class GPSHandler implements LocationListener, GpsStatus.GpsStatusListener, SharedPreferences.OnSharedPreferenceChangeListener {
+public class GPSHandler implements LocationListenerCompat, GpsStatus.GpsStatusListener, SharedPreferences.OnSharedPreferenceChangeListener {
 
     private final String TAG = GPSHandler.class.getSimpleName();
 
+    public static final String LOCATION_PROVIDER = LocationManager.GPS_PROVIDER;
+
     private final TrackPointCreator trackPointCreator;
     private Context context;
+    private Handler handler;
+
     private LocationManager locationManager;
     private GpsStatus gpsStatus;
     private Duration gpsInterval;
@@ -38,8 +44,10 @@ public class GPSHandler implements LocationListener, GpsStatus.GpsStatusListener
         this.trackPointCreator = trackPointCreator;
     }
 
-    public void onStart(@NonNull Context context) {
+    public void onStart(@NonNull Context context, @NonNull Handler handler) {
         this.context = context;
+        this.handler = handler;
+
         PreferencesUtils.registerOnSharedPreferenceChangeListener(this);
         gpsStatus = new GpsStatus(context, this);
         locationManager = (LocationManager) context.getSystemService(Context.LOCATION_SERVICE);
@@ -56,10 +64,11 @@ public class GPSHandler implements LocationListener, GpsStatus.GpsStatusListener
     public void onStop() {
         if (locationManager != null && context != null) {
             if (PermissionRequester.GPS.hasPermission(context)) {
-                locationManager.removeUpdates(this);
+                LocationManagerCompat.removeUpdates(locationManager, this);
             }
             locationManager = null;
             context = null;
+            handler = null;
         }
 
         if (gpsStatus != null) {
@@ -154,14 +163,20 @@ public class GPSHandler implements LocationListener, GpsStatus.GpsStatusListener
             return;
         }
 
-        if(!LocationManagerCompat.hasProvider(locationManager, LocationManager.GPS_PROVIDER)) {
+        if (!LocationManagerCompat.hasProvider(locationManager, LOCATION_PROVIDER)) {
             Log.e(TAG, "Device doesn't have GPS.");
             return;
         }
 
+        LocationRequestCompat locationRequest = new LocationRequestCompat.Builder(gpsInterval.toMillis())
+                .setQuality(LocationRequestCompat.QUALITY_HIGH_ACCURACY)
+                .setMaxUpdateDelayMillis(0)
+                .build();
+
         if (PermissionRequester.GPS.hasPermission(context)) {
             try {
-                locationManager.requestLocationUpdates(LocationManager.GPS_PROVIDER, gpsInterval.toMillis(), 0, this);
+                final Handler HANDLER = handler;
+                LocationManagerCompat.requestLocationUpdates(locationManager, LOCATION_PROVIDER, locationRequest, HANDLER::post, this);
             } catch (SecurityException e) {
                 Log.e(TAG, "Could not register location listener; permissions not granted.", e);
             }

src/main/java/de/dennisguse/opentracks/services/handlers/TrackPointCreator.java

@@ -52,7 +52,7 @@ public class TrackPointCreator implements BluetoothRemoteSensorManager.SensorDat
     public synchronized void start(@NonNull Context context, @NonNull Handler handler) {
         this.context = context;
 
-        gpsHandler.onStart(context);
+        gpsHandler.onStart(context, handler);
 
         remoteSensorManager = new BluetoothRemoteSensorManager(context, handler, this);
         altitudeSumManager = new AltitudeSumManager();