jordond / compass Goto Github PK

The most minor issue you'll ever have, but the badges in your readme don't show the correct version. Kotlin is stating 1.9.23 while you are using 2.0.20. Compose Multiplatform states 1.6.1 while you are using 1.6.11. This makes your project look less well maintained than it actually is.

These versions of dependencies are automatically updated via a bot, but these bots don't update the readme.

So either change the bots that they update the readme as well, or just don't show version numbers in your badges (so go for https://img.shields.io/badge/kotlin-blue.svg?logo=kotlin and https://img.shields.io/badge/Compose%20Multiplatform-blue ).

The library works fine on my emulator, but on my real device, I get a GeoLocationFailed with the message: Parameter specified as non-null is null: method dev.jordond.compass.geolocation.mobile.internal.MapperKt.toModel, parameter <this>

This happens here:

override suspend fun current(priority: Priority): Location {
    requirePermission(priority)
    return locationManager.currentLocation(priority.toAndroidPriority).toModel()
}

locationManager.currentLocation(priority.toAndroidPriority) is null, hence the toModel() crashing. This is because fusedLocationClient.addOnSuccessListener is triggered with null as its value:

The big question is why this location is null while Kotlin thinks location is of type Location!. This only happened after when requesting a coarse location when no other app recently retrieved a valid location. Before null is returned, it will try to load the location for quite a long time.

The thing is, Kotlin (or more likely the annotations) is wrong. If you check out the docs, you'll see that null can be returned in the success listener:

If unable to retrieve a current location fix before timing out, null will be returned.

This apparently happens quite often when using the coarse location (issue).

You should handle this instead of crashing and returning the crash as the message.

I could be missing something, but any reason why Geolocator.isAvailable is a suspend fun?

It's implemented in DefaultGeolocator:

override suspend fun isAvailable(): Boolean = withContext(dispatcher) {
    locator.isAvailable()
}

But locator.isAvailable() isn't a suspend fun, so isAvailable doesn't have to either. I think making this function not a suspend fun makes it quite a bit more usable: you can then quickly check if the GPS is turned off without having to bother with launching a coroutine.

I have created a PR, but I'm not sure if I'm missing a reason why the code works the way it does.

Currently in docs/ there are a some pages that reference the version number. The value is set to 1.0.0, with the maven central badge above it.

However the version.sh script should be modified to also update any pages in docs/ that contains the version number.

Hello! I'm seeing a crash in the demo app, when I toggle off the "Precise Location" settings.

Steps to reproduce:

1. Run app
2. Tap "Platform" Button under Geolocation
3. Tap "Get Current Location" Button
4. Select "Allow While Using The App"
5. Minimize App
6. Go to Settings > Apps > demo > Location
7. Toggle "Precise Location" off

Actual Result: App crashes
Expected Result: App does not crash

Screen recording:

Error Message:

Uncaught Kotlin exception: kotlin.IllegalStateException: Already resumed
    at 0   demo.debug.dylib                    0x108d6614f        kfun:kotlin.Throwable#<init>(kotlin.String?){} + 119 
    at 1   demo.debug.dylib                    0x108d5f7c7        kfun:kotlin.Exception#<init>(kotlin.String?){} + 115 
    at 2   demo.debug.dylib                    0x108d5f9e7        kfun:kotlin.RuntimeException#<init>(kotlin.String?){} + 115 
    at 3   demo.debug.dylib                    0x108d5ff87        kfun:kotlin.IllegalStateException#<init>(kotlin.String?){} + 115 
    at 4   demo.debug.dylib                    0x108d6d57f        kfun:kotlin.coroutines.SafeContinuation#resumeWith(kotlin.Result<1:0>){} + 739 
    at 5   demo.debug.dylib                    0x108e95e37        kfun:kotlin.coroutines.Continuation#resumeWith(kotlin.Result<1:0>){}-trampoline + 99 
    at 6   demo.debug.dylib                    0x10825d777        kfun:dev.jordond.compass.permissions.IosLocationPermissionController.requirePermissionFor$lambda$1#internal + 351 
    at 7   demo.debug.dylib                    0x10825d98b        kfun:dev.jordond.compass.permissions.IosLocationPermissionController.$requirePermissionFor$lambda$1$FUNCTION_REFERENCE$1.invoke#internal + 87 
    at 8   demo.debug.dylib                    0x10825da8f        kfun:dev.jordond.compass.permissions.IosLocationPermissionController.$requirePermissionFor$lambda$1$FUNCTION_REFERENCE$1.$<bridge-UNNB>invoke(kotlin.Int){}#internal + 123 
    at 9   demo.debug.dylib                    0x108e9126b        kfun:kotlin.Function1#invoke(1:0){}1:1-trampoline + 107 
    at 10  demo.debug.dylib                    0x10825e943        kfun:dev.jordond.compass.permissions.mobile.internal.LocationPermissionManagerDelegate#objc:locationManagerDidChangeAuthorization: + 363 
    at 11  demo.debug.dylib                    0x10825ec13        _636f6d706173733a636f6d706173732d7065726d697373696f6e732d6d6f62696c652f55736572732f6e6174616c69652f446f63756d656e74732f4769744875622f636f6d706173732f636f6d706173732d7065726d697373696f6e732d6d6f62696c652f7372632f696f734d61696e2f6b6f746c696e2f6465762f6a6f72646f6e642f636f6d706173732f7065726d697373696f6e732f6d6f62696c652f696e7465726e616c2f4c6f636174696f6e5065726d697373696f6e4d616e6167657244656c65676174652e6b74_knbridge14 + 183 
    at 12  CoreLocation                        0x1844b3633        CLClientStopVehicleHeadingUpdates + 103707 
    at 13  CoreLocation                        0x1844b2e47        CLClientStopVehicleHeadingUpdates + 101679 
    at 14  CoreLocation                        0x1844927ff        CLClientCreateWithBundleIdentifierAndPathWithWebsiteOnSilo + 6135 
    at 15  LocationSupport                     0x18baa341b        _ZN18CLConnectionServer13handleMessageEP12CLConnectionNSt3__110shared_ptrI19CLConnectionMessageEE + 18399 
    at 16  CoreFoundation                      0x1804108e3        __CFRUNLOOP_IS_CALLING_OUT_TO_A_BLOCK__ + 19 
    at 17  CoreFoundation                      0x180410027        __CFRunLoopDoBlocks + 351 
    at 18  CoreFoundation                      0x18040aeef        __CFRunLoopRun + 2379 
    at 19  CoreFoundation                      0x18040a173        CFRunLoopRunSpecific + 571 
    at 20  GraphicsServices                    0x19050cb0f        GSEventRunModal + 159 
    at 21  UIKitCore                           0x185a0287b        -[UIApplication _run] + 867 
    at 22  UIKitCore                           0x185a06467        UIApplicationMain + 123 
    at 23  SwiftUI                             0x1c31edff3        $s7SwiftUI17KitRendererCommon33_ACC2C5639A7D76F611E170E831FCA491LLys5NeverOyXlXpFAESpySpys4Int8VGSgGXEfU_ + 163 
    at 24  SwiftUI                             0x1c31ede9b        $s7SwiftUI6runAppys5NeverOxAA0D0RzlF + 83 
    at 25  SwiftUI                             0x1c2f63f5b        $s7SwiftUI3AppPAAE4mainyyFZ + 147 
    at 26  demo.debug.dylib                    0x10821d86f        $s4demo6iOSAppV5$mainyyFZ + 39 
    at 27  demo.debug.dylib                    0x10821d91f        __debug_main_executable_dylib_entry_point + 11 (/Users/natalie/Documents/GitHub/compass/demo/iosApp/iosApp/iOSApp.swift:4:8)
    at 28  dyld                                0x102fc140f        0x0 + 4345041935 
    at 29  ???                                 0x10293a0df        0x0 + 4338196703 
    at 30  ???                                 0x35f7fffffffffff  0x0 + 243053642389651455 

It's unclear what PermissionError does. The docs say:

Geocoding operation failed because of a permission error.

Either the user denied the permission, or the permission was denied forever.

But that's already what PermissionDenied is for. It even has a forever boolean.

So let's look at the code. It's caused by either one of these exceptions:

• PermissionMissingException
  • This isn't used at all, thus it can simply be deleted.
• PermissionRequestException
  • This only happens when the WeakReference requester is null at ActivityProvider. Seems like very much an unexpected error.

I would delete PermissionMissingException, PermissionRequestException and the entire PermissionError. In order to do so, I would throw an IllegalStateException in ActivityProvider instead. This makes your library quite a bit easier: right now it's quite confusing to see the difference between PermissionError and PermissionDenied.

[Android] When using any of the Priority enums besides HighAccuracy such as Balanced does not update the location flow. I'm not sure if this is a Google fused location provider issue but when the user choses the 'Approximate Location' from the permission dialog no location updates are emitted from trackingStatus: Flow.

Funny story about my PR you merged which was released in 1.2.1..

Yeah, that one now causes compass to crash, sorry. See the attached PR: I think that should fix it.

A semi-related thing: this is the only place where NotFoundException() is thrown, so this is the only place where GeocoderResult.NotFound is returned. Seems odd: you'd expect this to be thrown at the other platforms as well. Create a new issue for that?

The current implementation of the library mandates that the user is prompted for "Always" authorization. It'd be great if we could have more control from the library in selecting what level of permissions we want to prompt the user with. We don't have a strong need to always be tracking the user, and would like to track them only when they're using the app.

Hey there, awesome library!

Do you guys know, how to keep receiving location updates in kmp, while the app is running in the background?
Best regards, and thank you so much for your amazing work!

It's great that we can implement our own API, but I think you should also support OpenCage as an very popular provider out of the box.

I'm trying to use it on IOs but it doesn't work

Link do github
https://github.com/kenjimaeda54/your_interests_kMP/blob/develop/iosAppYourInterests/iosAppYourInterests/Info.plist

After adding these dependency to my project

libs.version.toml :

compass = "0.1.8"
compass-geocoder = { module = "dev.jordond.compass:compass-geocoder", version.ref = "compass" }
compass-geocoder-mobile = { module = "dev.jordond.compass:compass-geocoder-mobile", version.ref = "compass" }
compass-geocoder-web-googlemaps = { module = "dev.jordond.compass:compass-geocoder-googlemaps", version.ref = "compass" }

build.gradle.kts :

val commonMain by getting {
            dependencies {
                api(libs.decompose.router)
                implementation(libs.compass.geocoder)
                implementation(libs.compass.geocoder.web.googlemaps)
..

val mobileMain by creating {
            dependsOn(commonMain)
            androidMain.dependsOn(this)
            iosMain.dependsOn(this)
            dependencies {
                implementation(libs.compass.geocoder.mobile)
            }
        }

build project was failed with this log report

Execution failed for task ':composeApp:transformIosMainCInteropDependenciesMetadataForIde'.

Could not resolve all files for configuration ':composeApp:iosMainResolvableDependenciesMetadata'.
Could not find dev.jordond.compass:compass-geocoder-googlemaps:0.1.8.
Required by:
project :composeApp

perhaps anybody know the cause or fix for this issue

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update ktor monorepo to v3.2.0 (io.ktor:ktor-serialization-kotlinx-json, io.ktor:ktor-client-logging, io.ktor:ktor-client-content-negotiation, io.ktor:ktor-client-js, io.ktor:ktor-client-core)
• Update compose.multiplatform to v23 (major) (org.jetbrains.compose, org.jetbrains.compose:compose-gradle-plugin)

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

First of all, thanks for making such an amazing library, I've been trying it out and it works very well. :)

One issue that I've noticed is that the location permission dialog is not shown when I launch the app on iOS. On Android it works fine. Maybe I'm missing some additional steps? I've included those two location strings in my plist.info file btw.

I'm also testing the app on my real iOS device (iPhone 15 Pro Max).

Here's my code:

@Composable
fun LocationTracking() {
    val scope = rememberCoroutineScope()
    val geoLocator = remember { Geolocator.mobile() }

    val trackingStatus by geoLocator.trackingStatus
        .collectAsState(initial = null)

    var currentLocation: Coordinates? by remember {
        mutableStateOf(null)
    }

    var currentCity: String? by remember {
        mutableStateOf(null)
    }

    LaunchedEffect(Unit) {
        geoLocator.trackingStatus.collectLatest { status ->
            when (status) {
                is TrackingStatus.Idle -> {}
                is TrackingStatus.Tracking -> {}
                is TrackingStatus.Update -> {}
                is TrackingStatus.Error -> {
                    val error: GeolocatorResult.Error = status.cause
                    println("TRACKING ERROR: $error")
                    // Show the permissions settings screen
                    val permissionDeniedForever = error.isPermissionDeniedForever()
                    println("TRACKING PERMISSION DENIED: $permissionDeniedForever")
                }
            }
        }
    }

    LaunchedEffect(Unit) {
        geoLocator.locationUpdates.collectLatest {
            currentLocation = it.coordinates
            currentCity = MobileGeocoder().placeOrNull(it.coordinates)?.locality
        }
    }

    Text(
        modifier = Modifier.fillMaxWidth(),
        textAlign = TextAlign.Center,
        text = currentCity ?: "Waiting..."
    )
    Spacer(modifier = Modifier.height(12.dp))
    Text(
        modifier = Modifier.fillMaxWidth(),
        textAlign = TextAlign.Center,
        text = "LAT: ${currentLocation?.latitude}\nLNG: ${currentLocation?.longitude}"
    )
    Spacer(modifier = Modifier.height(20.dp))
    Row(
        modifier = Modifier.fillMaxWidth(),
        verticalAlignment = Alignment.CenterVertically,
        horizontalArrangement = Arrangement.Center
    ) {
        Button(
            enabled = trackingStatus == TrackingStatus.Idle,
            onClick = {
                scope.launch(Dispatchers.IO) {
                    geoLocator.startTracking(
                        LocationRequest(
                            priority = Priority.HighAccuracy
                        )
                    )
                }
            }
        ) {
            Text(text = "Start")
        }
        Spacer(modifier = Modifier.width(20.dp))
        Button(
            enabled = trackingStatus != TrackingStatus.Idle,
            onClick = {
                scope.launch(Dispatchers.IO) {
                    geoLocator.stopTracking()
                    currentLocation = null
                    currentCity = null
                }
            }
        ) {
            Text(text = "Stop")
        }
    }
}

And this is the log that I'm seeing:

fopen failed for data file: errno = 2 (No such file or directory)
Errors found! Invalidating cache...
fopen failed for data file: errno = 2 (No such file or directory)
Errors found! Invalidating cache...