ki-labs / gps-permission-checks-livedata Goto Github PK

Sample project to demonstrate how GPS and Runtime Location Permission checks can be done on UI and Background Service using LiveData

Home Page: https://medium.com/ki-labs-engineering/monitoring-gps-and-location-permission-checks-using-livedata-part-1-278907344b77

License: MIT License

Kotlin 100.00%

android livedata service location-services

gps-permission-checks-livedata's Introduction

Monitoring GPS and Location Permission checks using LiveData

Background:

In Android apps, users need to allow specific permissions so that app can use that particular resource. All location tracking apps need “GPS to be enabled” and want users to allow “Location Permission” so that app can start receiving location coordinates. For our usecase, it was critically needed to ensure both of these requirements are fulfilled. If not, user should be alerted and informed on UI level during or after Onboarding and also when Location Tracking is started/running in background.

This is a sample app to demonstrate the usecase.

Motivation to publish my solution:

There are already native android ways to implement both of these checks but we tried to do it using LiveData which is a newly introduced API from Android to handle asynchronous operations using Subscribe/Publish mechanism. We faced our fair share of challenges and there was limited help available as not many have tried for this usecase. Solutions which are challenging are the best candidate to be shared with public because it means many others out there will face the same problems and it could save their time. At the end of the day, it’s basically giving back to the community.

What is this project about:

UI (app is active): Checking for both elements, displaying state and showing dialogs for user to react accordingly

Medium Article: Read Here
Background (app is not active): Check for both elements as part of Service whenever it is started by System and inform user via notification so that user can enable them for us. Otherwise, location tracking won’t succeed at all.

Medium Article: Read Here

How sample app looks like or behaves

gps-permission-checks-livedata's People

Contributors

Stargazers

Watchers

Forkers

matheusbristot wahibhaq androidkotlinid lazercorn lumleon harloom qusibue morristech saepul8 muchori ibrahim-mrq lool8x

gps-permission-checks-livedata's Issues

Improve common mistakes with ViewModel

https://twitter.com/passsy/status/1061670191225061377?s=19

Write test for the livedata

shown as here https://dev.to/autonomousapps/a-custom-livedata-that-has-onactive-and-oninactive-listeners----tested-4gbl

Ensure 2 separate notifications are created for both gps and permission while in service mode

copy code from main project PR

Remove reobserve if unnecessary

Introduce usecase and use it in both viewmodel and service to access pair livedata

See if you can create extension function for both livedata

like this https://gist.github.com/80998062/162fa5591387ed9e171fdb2f7659acf5#file-sharedpreferencelivedata-kt

Try Transform LiveData to return both PermissionState and GpsState

https://developer.android.com/topic/libraries/architecture/livedata

https://gist.github.com/JoseAlcerreca/4b17994cf7f5d64a61f27a2a9bdfb1fd#file-myviewmodel-java

Does permission listener LiveData actually work?

I consider myself a beginner regarding Kotlin, so hopefully it is just me that is doing something wrong, but I have been struggling for several days to try to get this LiveData to actually work, but without success.

In the end, I built this app and just added some extra logging in the listener class to see when it actually reacts to permission changes:

class PermissionStatusListener(private val context: Context,
                               private val permissionToListen: String) : LiveData<PermissionStatus>() {

    private val TAG = "* Permission listener "
    override fun onActive() = handlePermissionCheck()

    private fun handlePermissionCheck() {
        val isPermissionGranted = ActivityCompat.checkSelfPermission(context,
                permissionToListen) == PackageManager.PERMISSION_GRANTED

        Log.d(TAG, " permission status ${isPermissionGranted}")
        if (isPermissionGranted)
            postValue(PermissionStatus.Granted())
        else
            postValue(PermissionStatus.Denied())
    }
}

sealed class PermissionStatus {
    data class Granted(
            val message: Int = R.string.permission_status_granted
    ) : PermissionStatus()
    data class Denied(
            val message: Int = R.string.permission_status_denied
    ) : PermissionStatus()
    data class Blocked(
            val message: Int = R.string.permission_status_blocked
    ) : PermissionStatus()
}

When the app starts, it shows the correct status of the permission:

2019-12-21 21:55:04.668 11799-11799/com.wahibhaq.locationservicelivedata D/* Permission listener:  permission status false

But when the permission is granted, there is no update of the LiveData, only the normal permission handling callbacks:

2019-12-21 22:20:47.899 11799-11799/com.wahibhaq.locationservicelivedata D/Permissions: No rationale.
2019-12-21 22:20:47.939 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: setView = DecorView@b80bcc5[PermissionsActivity] TM=true MM=false
2019-12-21 22:20:47.956 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: dispatchAttachedToWindow
2019-12-21 22:20:47.969 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: Relayout returned: old=[0,63][1080,2094] new=[540,1078][540,1078] result=0x7 surface={valid=true 532950945792} changed=true
2019-12-21 22:20:47.976 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: MSG_RESIZED: frame=Rect(540, 1078 - 540, 1078) ci=Rect(0, 0 - 0, 0) vi=Rect(0, 0 - 0, 0) or=1
2019-12-21 22:20:51.313 11799-11799/com.wahibhaq.locationservicelivedata D/Permissions: Just allowed.
2019-12-21 22:20:51.363 11799-11799/com.wahibhaq.locationservicelivedata I/MainActivity$permissionHandler: Activity: 2131427403
2019-12-21 22:20:51.381 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: MSG_WINDOW_FOCUS_CHANGED 0 1
2019-12-21 22:20:51.381 11799-11799/com.wahibhaq.locationservicelivedata D/InputMethodManager: prepareNavigationBarInfo() DecorView@b80bcc5[PermissionsActivity]
2019-12-21 22:20:51.413 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: MSG_WINDOW_FOCUS_CHANGED 0 0
2019-12-21 22:20:51.428 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: setWindowStopped(true) old=false
2019-12-21 22:20:51.433 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: dispatchDetachedFromWindow
2019-12-21 22:20:51.434 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: Surface release. android.view.ViewRootImpl.doDie:7979 android.view.ViewRootImpl.die:7947 android.view.WindowManagerGlobal.removeViewLocked:497 android.view.WindowManagerGlobal.removeView:435 android.view.WindowManagerImpl.removeViewImmediate:124 android.app.ActivityThread.handleDestroyActivity:4753 android.app.servertransaction.DestroyActivityItem.execute:39 android.app.servertransaction.TransactionExecutor.executeLifecycleState:145 
2019-12-21 22:20:51.644 11799-11799/com.wahibhaq.locationservicelivedata D/ViewRootImpl@ac9ab27[PermissionsActivity]: Surface release. android.view.ViewRootImpl$ViewRootHandler.handleMessage:4825 android.os.Handler.dispatchMessage:106

To me it seems that the LiveData is only updated when the observing activity is resumed, and not directly when the permission is granted.

Am I missing something obvious, or does the Android framework not allow this listener to see the changed permission and update the LiveData immediately?

Find better way to listen to Service state

Referring to tracking and service flags

Incorporate new UI created by Droidninja

XML is in slack chat
Remove linearlayout later

I am already using this https://developer.android.com/training/location/change-location-settings or this https://developers.google.com/android/reference/com/google/android/gms/location/SettingsClient which also includes using Actvity.onActivityResult to show dialog

show dialog by yourself on UI
show notification for service to avoid showing dialog and need of an activity

Introduce LiveData also for Location (low-prio)

https://medium.com/google-developers/lifecycle-aware-data-loading-with-android-architecture-components-f95484159de4

Update

Hello!

The application does not work pointing to the api 29 and changing the libraries to androidx. Could you update the code please?

Greetings,
Patrick

separate permissions 3rd party lib and keep livedata for only service. Keep mainactivity observe simple on just GPS for now.
show both dialogs on app foreground. Keep the link click for now.

TBD PermissionStatusListener to be separated to that can be injected directly...test if it will even work
- Try keeping Permission lib for just UI so makes sense to keep livedata only for service
MainViewModel shouldn't inject Context
Also decide for once how UI should react

make the PermissionStatusListener more generic

pass array of permissions
return type of permission along with the state