[All] Add function for getting last known location (#211)

michalgwo · web-flow · commit 009df1321c82 · 2025-05-13T17:17:55.000-04:00
diff --git a/compass-geolocation-browser/src/commonMain/kotlin/dev/jordond/compass/geolocation/browser/internal/DefaultBrowserLocator.kt b/compass-geolocation-browser/src/commonMain/kotlin/dev/jordond/compass/geolocation/browser/internal/DefaultBrowserLocator.kt
@@ -40,6 +40,14 @@ internal class DefaultBrowserLocator : BrowserLocator {
     )
     override val locationUpdates: Flow<Location> = _locationUpdates
 
+    override suspend fun lastLocation(priority: Priority): Location? {
+        try {
+            return current(priority)
+        } catch (error: NotFoundException) {
+            return null
+        }
+    }
+
     override suspend fun isAvailable(): Boolean {
         return navigator?.geolocation != null
     }
diff --git a/compass-geolocation-mobile/src/androidMain/kotlin/dev/jordond/compass/geolocation/mobile/MobileLocator.android.kt b/compass-geolocation-mobile/src/androidMain/kotlin/dev/jordond/compass/geolocation/mobile/MobileLocator.android.kt
@@ -33,6 +33,11 @@ internal class AndroidLocator(
     override val locationUpdates: Flow<Location> = locationManager.locationUpdates
         .mapNotNull { result -> result.lastLocation?.toModel() }
 
+    override suspend fun lastLocation(priority: Priority): Location? {
+        requirePermission(priority)
+        return locationManager.lastLocation()?.toModel()
+    }
+
     override suspend fun isAvailable(): Boolean {
         return locationManager.locationEnabled()
     }
diff --git a/compass-geolocation-mobile/src/androidMain/kotlin/dev/jordond/compass/geolocation/mobile/internal/LocationManager.kt b/compass-geolocation-mobile/src/androidMain/kotlin/dev/jordond/compass/geolocation/mobile/internal/LocationManager.kt
@@ -18,11 +18,15 @@ import com.google.android.gms.location.Priority.PRIORITY_PASSIVE
 import com.google.android.gms.location.SettingsClient
 import com.google.android.gms.tasks.CancellationTokenSource
 import dev.jordond.compass.exception.NotFoundException
+import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.tasks.await
+import kotlin.coroutines.resume
+import kotlin.coroutines.resumeWithException
+import kotlin.coroutines.suspendCoroutine
 
 internal class LocationManager(
     private val context: Context,
@@ -45,6 +49,19 @@ internal class LocationManager(
         LocationServices.getSettingsClient(context)
     }
 
+    suspend fun lastLocation(): Location? {
+        return suspendCoroutine { continuation ->
+            fusedLocationClient.lastLocation
+                .addOnSuccessListener { location ->
+                    continuation.resume(location)
+                }.addOnCanceledListener {
+                    continuation.resumeWithException(CancellationException())
+                }.addOnFailureListener { exception ->
+                    continuation.resumeWithException(exception)
+                }
+        }
+    }
+
     suspend fun locationEnabled(): Boolean {
         val request = LocationSettingsRequest.Builder().addAllLocationRequests(
             listOf(
diff --git a/compass-geolocation-mobile/src/iosMain/kotlin/dev/jordond/compass/geolocation/mobile/MobileLocator.ios.kt b/compass-geolocation-mobile/src/iosMain/kotlin/dev/jordond/compass/geolocation/mobile/MobileLocator.ios.kt
@@ -43,6 +43,11 @@ internal class IosLocator(
         }
     }
 
+    override suspend fun lastLocation(priority: Priority): Location? {
+        requirePermission()
+        return locationDelegate.lastLocation()?.toModel()
+    }
+
     override suspend fun isAvailable(): Boolean {
         return CLLocationManager.locationServicesEnabled()
     }
diff --git a/compass-geolocation-mobile/src/iosMain/kotlin/dev/jordond/compass/geolocation/mobile/internal/LocationManagerDelegate.kt b/compass-geolocation-mobile/src/iosMain/kotlin/dev/jordond/compass/geolocation/mobile/internal/LocationManagerDelegate.kt
@@ -21,6 +21,10 @@ internal class LocationManagerDelegate : NSObject(), CLLocationManagerDelegatePr
         manager.delegate = this
     }
 
+    fun lastLocation(): CLLocation? {
+        return manager.location
+    }
+
     fun monitorLocation(callback: (CLLocation) -> Unit) {
         locationCallback = callback
     }
diff --git a/compass-geolocation/api/android/compass-geolocation.api b/compass-geolocation/api/android/compass-geolocation.api
@@ -12,6 +12,8 @@ public abstract interface class dev/jordond/compass/geolocation/Geolocator {
 	public abstract fun getLocationUpdates ()Lkotlinx/coroutines/flow/Flow;
 	public abstract fun getTrackingStatus ()Lkotlinx/coroutines/flow/Flow;
 	public abstract fun isAvailable (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun lastLocation (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun lastLocation (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun startTracking (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun stopTracking ()V
 	public abstract fun track (Ldev/jordond/compass/geolocation/LocationRequest;)Lkotlinx/coroutines/flow/Flow;
@@ -23,6 +25,7 @@ public final class dev/jordond/compass/geolocation/Geolocator$Companion {
 public final class dev/jordond/compass/geolocation/Geolocator$DefaultImpls {
 	public static synthetic fun current$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static fun getLocationUpdates (Ldev/jordond/compass/geolocation/Geolocator;)Lkotlinx/coroutines/flow/Flow;
+	public static synthetic fun lastLocation$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static fun startTracking (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static synthetic fun startTracking$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static synthetic fun track$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/geolocation/LocationRequest;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
@@ -139,6 +142,7 @@ public abstract interface class dev/jordond/compass/geolocation/Locator {
 	public abstract fun current (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun getLocationUpdates ()Lkotlinx/coroutines/flow/Flow;
 	public abstract fun isAvailable (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun lastLocation (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun stopTracking ()V
 	public abstract fun track (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 }
@@ -148,6 +152,7 @@ public final class dev/jordond/compass/geolocation/Locator$Companion {
 
 public final class dev/jordond/compass/geolocation/Locator$DefaultImpls {
 	public static synthetic fun current$default (Ldev/jordond/compass/geolocation/Locator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public static synthetic fun lastLocation$default (Ldev/jordond/compass/geolocation/Locator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static synthetic fun track$default (Ldev/jordond/compass/geolocation/Locator;Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 }
 
@@ -156,6 +161,7 @@ public final class dev/jordond/compass/geolocation/NotSupportedLocator : dev/jor
 	public fun current (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun getLocationUpdates ()Lkotlinx/coroutines/flow/Flow;
 	public fun isAvailable (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun lastLocation (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun stopTracking ()V
 	public fun track (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 }
diff --git a/compass-geolocation/api/jvm/compass-geolocation.api b/compass-geolocation/api/jvm/compass-geolocation.api
@@ -12,6 +12,8 @@ public abstract interface class dev/jordond/compass/geolocation/Geolocator {
 	public abstract fun getLocationUpdates ()Lkotlinx/coroutines/flow/Flow;
 	public abstract fun getTrackingStatus ()Lkotlinx/coroutines/flow/Flow;
 	public abstract fun isAvailable (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun lastLocation (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun lastLocation (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun startTracking (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun stopTracking ()V
 	public abstract fun track (Ldev/jordond/compass/geolocation/LocationRequest;)Lkotlinx/coroutines/flow/Flow;
@@ -23,6 +25,7 @@ public final class dev/jordond/compass/geolocation/Geolocator$Companion {
 public final class dev/jordond/compass/geolocation/Geolocator$DefaultImpls {
 	public static synthetic fun current$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static fun getLocationUpdates (Ldev/jordond/compass/geolocation/Geolocator;)Lkotlinx/coroutines/flow/Flow;
+	public static synthetic fun lastLocation$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static fun startTracking (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static synthetic fun startTracking$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static synthetic fun track$default (Ldev/jordond/compass/geolocation/Geolocator;Ldev/jordond/compass/geolocation/LocationRequest;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
@@ -139,6 +142,7 @@ public abstract interface class dev/jordond/compass/geolocation/Locator {
 	public abstract fun current (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun getLocationUpdates ()Lkotlinx/coroutines/flow/Flow;
 	public abstract fun isAvailable (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun lastLocation (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun stopTracking ()V
 	public abstract fun track (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 }
@@ -148,6 +152,7 @@ public final class dev/jordond/compass/geolocation/Locator$Companion {
 
 public final class dev/jordond/compass/geolocation/Locator$DefaultImpls {
 	public static synthetic fun current$default (Ldev/jordond/compass/geolocation/Locator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public static synthetic fun lastLocation$default (Ldev/jordond/compass/geolocation/Locator;Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static synthetic fun track$default (Ldev/jordond/compass/geolocation/Locator;Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 }
 
@@ -156,6 +161,7 @@ public final class dev/jordond/compass/geolocation/NotSupportedLocator : dev/jor
 	public fun current (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun getLocationUpdates ()Lkotlinx/coroutines/flow/Flow;
 	public fun isAvailable (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun lastLocation (Ldev/jordond/compass/Priority;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun stopTracking ()V
 	public fun track (Ldev/jordond/compass/geolocation/LocationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 }
diff --git a/compass-geolocation/src/commonMain/kotlin/dev/jordond/compass/geolocation/Geolocator.kt b/compass-geolocation/src/commonMain/kotlin/dev/jordond/compass/geolocation/Geolocator.kt
@@ -41,6 +41,22 @@ public interface Geolocator {
     public val locationUpdates: Flow<Location>
         get() = trackingStatus.filterIsInstance<TrackingStatus.Update>().map { it.location }
 
+    /**
+     * Get the last known location on Android and iOS. On the web, it returns the current location.
+     *
+     * @param priority The priority of the location request.
+     * @return A [GeolocatorResult] with the success or error state.
+     */
+    public suspend fun lastLocation(priority: Priority = Priority.Balanced): GeolocatorResult
+
+    /**
+     * Get the last known location on Android and iOS. On the web, it returns the current location.
+     *
+     * @param request The location request details.
+     * @return A [GeolocatorResult] with the success or error state.
+     */
+    public suspend fun lastLocation(request: LocationRequest): GeolocatorResult
+
     /**
      * Check if location services are available.
      *
diff --git a/compass-geolocation/src/commonMain/kotlin/dev/jordond/compass/geolocation/Locator.kt b/compass-geolocation/src/commonMain/kotlin/dev/jordond/compass/geolocation/Locator.kt
@@ -25,6 +25,9 @@ public interface Locator {
      */
     public val locationUpdates: Flow<Location>
 
+
+    public suspend fun lastLocation(priority: Priority = Priority.Balanced): Location?
+
     /**
      * Check if the platform supports geolocation.
      */
@@ -86,6 +89,7 @@ public interface PermissionLocator : Locator {
 public object NotSupportedLocator : Locator {
 
     override val locationUpdates: Flow<Location> = emptyFlow()
+    override suspend fun lastLocation(priority: Priority): Location? = throw NotSupportedException()
     override suspend fun isAvailable(): Boolean = false
     override suspend fun current(priority: Priority): Location = throw NotSupportedException()
     override suspend fun track(request: LocationRequest): Flow<Location> = emptyFlow()
diff --git a/compass-geolocation/src/commonMain/kotlin/dev/jordond/compass/geolocation/internal/DefaultGeolocator.kt b/compass-geolocation/src/commonMain/kotlin/dev/jordond/compass/geolocation/internal/DefaultGeolocator.kt
@@ -43,6 +43,12 @@ internal class DefaultGeolocator(
 
     override val trackingStatus: Flow<TrackingStatus> = status
 
+    override suspend fun lastLocation(priority: Priority): GeolocatorResult =
+        lastLocation(LocationRequest(priority))
+
+    override suspend fun lastLocation(request: LocationRequest): GeolocatorResult =
+        handleResult(request) { locator.lastLocation(request.priority) }
+
     override suspend fun isAvailable(): Boolean = locator.isAvailable()
 
     override suspend fun current(request: LocationRequest): GeolocatorResult {
diff --git a/demo/composeApp/src/commonMain/kotlin/geolocation/GeolocationContent.kt b/demo/composeApp/src/commonMain/kotlin/geolocation/GeolocationContent.kt
@@ -23,6 +23,7 @@ fun GeolocationContent(
     currentLocation: () -> Unit,
     startTracking: () -> Unit,
     stopTracking: () -> Unit,
+    getLastLocation: () -> Unit,
     modifier: Modifier = Modifier,
 ) {
     Column(
@@ -57,5 +58,16 @@ fun GeolocationContent(
                 Text("Stop")
             }
         }
+
+        Spacer(modifier = Modifier.height(64.dp))
+
+        Text("Last Location")
+        Text("Last known location: ${state.lastLocation}")
+
+        Row {
+            Button(onClick = getLastLocation) {
+                Text("Get Last Location")
+            }
+        }
     }
 }
diff --git a/demo/composeApp/src/commonMain/kotlin/geolocation/GeolocationModel.kt b/demo/composeApp/src/commonMain/kotlin/geolocation/GeolocationModel.kt
@@ -30,6 +30,13 @@ class GeolocationModel(private val geolocator: Geolocator) : StateScreenModel<St
             .launchIn(screenModelScope)
     }
 
+    fun getLastLocation() {
+        screenModelScope.launch {
+            val result = geolocator.lastLocation()
+            updateState { it.copy(lastLocation = result) }
+        }
+    }
+
     fun currentLocation() {
         screenModelScope.launch {
             updateState { it.copy(loading = true) }
@@ -55,6 +62,7 @@ class GeolocationModel(private val geolocator: Geolocator) : StateScreenModel<St
         val lastResult: GeolocatorResult? = null,
         val locationServiceAvailable: Boolean = false,
         val trackingLocation: TrackingStatus = TrackingStatus.Idle,
+        val lastLocation: GeolocatorResult? = null,
     ) {
 
         val tracking = trackingLocation.isActive
diff --git a/demo/composeApp/src/commonMain/kotlin/geolocation/PlatformGeolocationScreen.kt b/demo/composeApp/src/commonMain/kotlin/geolocation/PlatformGeolocationScreen.kt
@@ -63,6 +63,7 @@ class PlatformGeolocationScreen : Screen {
                 currentLocation = model::currentLocation,
                 startTracking = model::startTracking,
                 stopTracking = model::stopTracking,
+                getLastLocation = model::getLastLocation,
                 modifier = Modifier.padding(innerPadding),
             )
         }

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,14 @@ internal class DefaultBrowserLocator : BrowserLocator {`
`40`	`40`	`)`
`41`	`41`	`override val locationUpdates: Flow<Location> = _locationUpdates`
`42`	`42`
	`43`	`+ override suspend fun lastLocation(priority: Priority): Location? {`
	`44`	`+ try {`
	`45`	`+ return current(priority)`
	`46`	`+ } catch (error: NotFoundException) {`
	`47`	`+ return null`
	`48`	`+ }`
	`49`	`+ }`
	`50`	`+`
`43`	`51`	`override suspend fun isAvailable(): Boolean {`
`44`	`52`	`return navigator?.geolocation != null`
`45`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ internal class IosLocator(`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ override suspend fun lastLocation(priority: Priority): Location? {`
	`47`	`+ requirePermission()`
	`48`	`+ return locationDelegate.lastLocation()?.toModel()`
	`49`	`+ }`
	`50`	`+`
`46`	`51`	`override suspend fun isAvailable(): Boolean {`
`47`	`52`	`return CLLocationManager.locationServicesEnabled()`
`48`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,10 @@ internal class LocationManagerDelegate : NSObject(), CLLocationManagerDelegatePr`
`21`	`21`	`manager.delegate = this`
`22`	`22`	`}`
`23`	`23`
	`24`	`+ fun lastLocation(): CLLocation? {`
	`25`	`+ return manager.location`
	`26`	`+ }`
	`27`	`+`
`24`	`28`	`fun monitorLocation(callback: (CLLocation) -> Unit) {`
`25`	`29`	`locationCallback = callback`
`26`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ fun GeolocationContent(`
`23`	`23`	`currentLocation: () -> Unit,`
`24`	`24`	`startTracking: () -> Unit,`
`25`	`25`	`stopTracking: () -> Unit,`
	`26`	`+ getLastLocation: () -> Unit,`
`26`	`27`	`modifier: Modifier = Modifier,`
`27`	`28`	`) {`
`28`	`29`	`Column(`
`@@ -57,5 +58,16 @@ fun GeolocationContent(`
`57`	`58`	`Text("Stop")`
`58`	`59`	`}`
`59`	`60`	`}`
	`61`	`+`
	`62`	`+ Spacer(modifier = Modifier.height(64.dp))`
	`63`	`+`
	`64`	`+ Text("Last Location")`
	`65`	`+ Text("Last known location: ${state.lastLocation}")`
	`66`	`+`
	`67`	`+ Row {`
	`68`	`+ Button(onClick = getLastLocation) {`
	`69`	`+ Text("Get Last Location")`
	`70`	`+ }`
	`71`	`+ }`
`60`	`72`	`}`
`61`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ class PlatformGeolocationScreen : Screen {`
`63`	`63`	`currentLocation = model::currentLocation,`
`64`	`64`	`startTracking = model::startTracking,`
`65`	`65`	`stopTracking = model::stopTracking,`
	`66`	`+ getLastLocation = model::getLastLocation,`
`66`	`67`	`modifier = Modifier.padding(innerPadding),`
`67`	`68`	`)`
`68`	`69`	`}`