@capgo/background-geolocation 8.0.6 → 8.0.8

package/android/src/main/AndroidManifest.xml

@@ -16,6 +16,8 @@
     <!-- Android SDK 33+ requires the POST_NOTIFICATIONS runtime permission to
     display the foreground service notification. -->
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <!-- See https://github.com/Cap-go/capacitor-background-geolocation/issues/12 for more details-->
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-feature android:name="android.hardware.location.gps" />
 </manifest>
   

package/android/src/main/java/com/capgo/capacitor_background_geolocation/BackgroundGeolocationService.java

@@ -14,7 +14,10 @@ import android.location.LocationManager;
 import android.media.MediaPlayer;
 import android.os.Binder;
 import android.os.Build;
+import android.os.Handler;
 import android.os.IBinder;
+import android.os.Looper;
+import android.os.PowerManager;
 import androidx.localbroadcastmanager.content.LocalBroadcastManager;
 import com.getcapacitor.Logger;
 
@@ -40,6 +43,12 @@ public class BackgroundGeolocationService extends Service {
     private double distanceThreshold;
     private boolean isOffRoute;
 
+    private Handler watchdogHandler = new Handler(Looper.getMainLooper());
+    private Runnable watchdogRunnable;
+    private Runnable restartRunnable;
+    private float currentDistanceFilter;
+    private PowerManager.WakeLock wakeLock;
+
     @Override
     public IBinder onBind(Intent intent) {
         return binder;
@@ -55,6 +64,8 @@ public class BackgroundGeolocationService extends Service {
             client.removeUpdates(locationCallback);
         }
         releaseMediaPlayer();
+        releaseWakeLock();
+        stopWatchdog();
         stopSelf();
         return false;
     }
@@ -66,6 +77,8 @@ public class BackgroundGeolocationService extends Service {
         }
         super.onDestroy();
         releaseMediaPlayer();
+        releaseWakeLock();
+        stopWatchdog();
     }
 
     private void releaseMediaPlayer() {
@@ -83,15 +96,87 @@ public class BackgroundGeolocationService extends Service {
         mediaPlayer = null;
     }
 
+    private void acquireWakeLock() {
+        if (wakeLock != null && wakeLock.isHeld()) {
+            return;
+        }
+        try {
+            PowerManager powerManager = (PowerManager) getSystemService(Context.POWER_SERVICE);
+            wakeLock = powerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "BackgroundGeolocation::LocationWakeLock");
+            wakeLock.acquire();
+            Logger.info("Wake lock acquired");
+        } catch (Exception e) {
+            Logger.error("Error acquiring wake lock", e);
+        }
+    }
+
+    private void releaseWakeLock() {
+        if (wakeLock == null) {
+            return;
+        }
+        try {
+            if (wakeLock.isHeld()) {
+                wakeLock.release();
+                Logger.info("Wake lock released");
+            }
+        } catch (Exception e) {
+            Logger.error("Error releasing wake lock", e);
+        }
+        wakeLock = null;
+    }
+
+    private void restartLocationUpdates() {
+        Logger.debug("Location watchdog timed out, restarting updates");
+        if (client == null || locationCallback == null) {
+            return;
+        }
+        client.removeUpdates(locationCallback);
+        if (restartRunnable != null) {
+            watchdogHandler.removeCallbacks(restartRunnable);
+        }
+        restartRunnable = () -> {
+            if (client == null || locationCallback == null) {
+                return;
+            }
+            try {
+                client.requestLocationUpdates(LocationManager.GPS_PROVIDER, 1000, currentDistanceFilter, locationCallback);
+            } catch (SecurityException ignore) {
+                // Permission issues are handled in the start() method
+            }
+            startWatchdog();
+        };
+        watchdogHandler.postDelayed(restartRunnable, 10000);
+    }
+
+    private void startWatchdog() {
+        stopWatchdog();
+        if (watchdogRunnable == null) {
+            watchdogRunnable = this::restartLocationUpdates;
+        }
+        watchdogHandler.postDelayed(watchdogRunnable, 60000);
+    }
+
+    private void stopWatchdog() {
+        if (watchdogRunnable != null) {
+            watchdogHandler.removeCallbacks(watchdogRunnable);
+        }
+        if (restartRunnable != null) {
+            watchdogHandler.removeCallbacks(restartRunnable);
+        }
+    }
+
     // Handles requests from the activity.
     public class LocalBinder extends Binder {
 
         void start(final String id, final String notificationTitle, final String notificationMessage, float distanceFilter) {
             releaseMediaPlayer();
+            acquireWakeLock();
             client = (LocationManager) getSystemService(Context.LOCATION_SERVICE);
             callbackId = id;
+            currentDistanceFilter = distanceFilter;
 
             locationCallback = (location) -> {
+                startWatchdog();
                 if (mediaPlayer != null) {
                     double[] point = { location.getLongitude(), location.getLatitude() };
                     var offRoute = distancePointToRoute(point) > distanceThreshold;
@@ -139,10 +224,12 @@ public class BackgroundGeolocationService extends Service {
         }
 
         String stop() {
+            stopWatchdog();
             client.removeUpdates(locationCallback);
             stopForeground(true);
             stopSelf();
             releaseMediaPlayer();
+            releaseWakeLock();
             return callbackId;
         }
 

package/ios/Sources/CapgoBackgroundGeolocationPlugin/CapgoCapacitorBackgroundGeolocationPlugin.swift

@@ -38,7 +38,7 @@ func formatLocation(_ location: CLLocation) -> PluginCallResultData {
 @objc(BackgroundGeolocation)
 // swiftlint:disable:next type_body_length
 public class BackgroundGeolocation: CAPPlugin, CLLocationManagerDelegate, CAPBridgedPlugin {
-    private let pluginVersion: String = "8.0.6"
+    private let pluginVersion: String = "8.0.8"
     public let identifier = "BackgroundGeolocationPlugin"
     public let jsName = "BackgroundGeolocation"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/background-geolocation",
-  "version": "8.0.6",
+  "version": "8.0.8",
   "description": "Receive accurate geolocation updates even while the app is in the background.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",