Live Location Sharing - Foreground Service #5595

onurays · 2022-03-21T14:49:17Z

We need to start a foreground service and show a sticky notification to be able to share live location if the application is in background and even if it is killed.

Start a foreground service when users start sharing live location
Show a sticky notification to inform users that the app continues to share location
Support sharing location in multiple rooms at the same time
We need to set a timer per room and stop foreground service once all times are up
Navigate to room list screen when users click on the notification (we will discuss showing room list in which live location is active)
Check if we can stop the location manager when the service is destroyed
Check if the service is not recreated when users share live location in another room

Live Location Sharing is disabled by a BuildConfig. We are creating small PRs to make them easily reviewable.

* develop: (152 commits) Remove exhaustive. fixing the onboarding sanity test failing - adds tapping the new take me home button within the sanity test Fix lint issues on weblate sync fixing view model tests not collecting flow results - the switch from runBlockingTest to runTest means we need to provide a separate scope from the test in order to asynchronously collect the flow results Do not suggest collapse if there is only one section Translated using Weblate (Spanish) Translated using Weblate (Spanish) runBlocking -> runTest https://github.com/Kotlin/kotlinx.coroutines/blob/master/kotlinx-coroutines-test/MIGRATION.md runBlockingTest -> runTest https://github.com/Kotlin/kotlinx.coroutines/blob/master/kotlinx-coroutines-test/MIGRATION.md Small cleanup The `.exhaustive` trick is not needed anymore in Kotlin 1.6.0 https://kotlinlang.org/docs/whatsnew16.html#stable-exhaustive-when-statements-for-enum-sealed-and-boolean-subjects Also upgrade the coroutine lib Fix compilation warning (exhaustive when) Fix compilation warning (exhaustive when) Format file (no other change) Fix compilation warning (exhaustive when) Bump moshi from 1.12.0 to 1.13.0 Bump kotlin-gradle-plugin from 1.5.31 to 1.6.0 Code review fixes. fixing presence icon anchoring to the middle of the room icon - creates a secondary verification shield and aligns to the start of the room title when presence is present ... # Conflicts: # vector/src/main/java/im/vector/app/features/location/LocationSharingFragment.kt # vector/src/main/java/im/vector/app/features/location/LocationSharingViewModel.kt # vector/src/main/res/values/strings.xml

github-actions · 2022-03-23T14:07:26Z

Unit Test Results

106 files ±0 106 suites ±0 1m 21s ⏱️ +13s
188 tests ±0 188 ✔️ ±0 0 💤 ±0 0 ❌ ±0
622 runs ±0 622 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 9b271e4. ± Comparison against base commit 6d0b823.

♻️ This comment has been updated with latest results.

ouchadam · 2022-03-25T08:43:55Z

vector/src/main/AndroidManifest.xml

@@ -46,6 +46,7 @@
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />


we already have this permission 😄 https://github.com/vector-im/element-android/blob/develop/vector/src/main/AndroidManifest.xml#L13

Oh no! Good catch, done.

ouchadam · 2022-03-25T09:13:27Z

vector/src/main/java/im/vector/app/features/location/LocationSharingFragment.kt

@@ -176,6 +179,17 @@ class LocationSharingFragment @Inject constructor(
        views.mapView.zoomToLocation(event.userLocation.latitude, event.userLocation.longitude)
    }

+    private fun handleStartLiveLocationService(event: LocationSharingViewEvents.StartLiveLocationService) {
+        Intent(requireContext(), LocationSharingService::class.java)
+                .apply {


as the putX methods on Intent are builder style, we could avoid the apply

Intent() .putExtra(foo, bar) .also { ContextCompat.startForegroundService(requireContext(), it) }

what do you think?

Exactly, forgot that puExtra returns Intent. Done.

ouchadam · 2022-03-25T09:27:35Z

vector/src/main/java/im/vector/app/features/location/LocationSharingFragment.kt

@@ -221,7 +235,9 @@ class LocationSharingFragment @Inject constructor(
    }

    private fun startLiveLocationSharing() {
-        viewModel.handle(LocationSharingAction.StartLiveLocationSharing)
+        // TODO. Get duration from user
+        val duration = 30 * 1000L


might be worth a constant?

not for this PR - thinking out of loud about todos I'm wondering if they are helpful or add noise, would a User can set live location duration ticket that references the class provide the same information 🤔

I already started implementing time-limiting UI. I will create another quick PR today.

ouchadam · 2022-03-25T10:16:16Z

vector/src/main/java/im/vector/app/features/location/LocationTracker.kt


    private var hasGpsProviderLiveLocation = false

    @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION])
-    fun start(callback: Callback?) {
+    fun start() {


now that we're calling start from multiple places, do we need to guard the...

locationManager.requestLocationUpdates( provider, MIN_TIME_TO_UPDATE_LOCATION_MILLIS, MIN_DISTANCE_TO_UPDATE_LOCATION_METERS, this )

to avoid registering duplicate updates?

It is protected internally and doesn't create multiple requests.

good to know, thanks!

ouchadam · 2022-03-25T10:18:40Z

vector/src/main/java/im/vector/app/features/location/LocationTracker.kt

+    }
+
+    fun addCallback(callback: Callback) {
+        synchronized(callbacks) {


if we only call addCallback/removeCallback from the main thread, we could avoid needing to use synchronized

if we are calling from multiple threads, we'll probably want to make all the callback interactions synchronised 😢

You are right. It is called in a single UI thread. Done.

ouchadam · 2022-03-25T10:58:58Z

vector/src/main/java/im/vector/app/features/location/LocationSharingService.kt

+    }
+
+    private fun scheduleTimer(roomId: String, durationMillis: Long) {
+        Timer().schedule(object : TimerTask() {


we might also want to keep a reference to the timer and cancel it if it's still running when the service is destroyed

Nice catch, done.

ouchadam

LGTM! ~~Would be handy to see a screenshot of the notification in action~~ It wasn't loading properly but now it is 🤦
(and a tiny comment about the timer instance maybe leaking~)

Onuray Sahin added 8 commits March 18, 2022 15:26

Create a foreground service.

a1d2794

Start the foreground service when users start live location sharing.

c63fc3d

Track location in foreground service.

3343680

Use primary color for location notification item.

7e5c293

Support sharing live location in multiple rooms.

70c8a8b

Navigate to room list when user clicks to the sticky notification.

3fa4aea

Changelog added.

96a2bc9

onurays marked this pull request as ready for review March 23, 2022 13:30

onurays requested a review from ganfra March 23, 2022 13:30

Reorder functions.

5f74442

onurays requested a review from ouchadam March 24, 2022 09:21

Lint fixes.

7a575ed

ouchadam reviewed Mar 25, 2022

View reviewed changes

Onuray Sahin added 2 commits March 25, 2022 13:48

Code review fixes.

79afdf7

Code review fixes.

7285bc6

ouchadam reviewed Mar 25, 2022

View reviewed changes

ouchadam approved these changes Mar 25, 2022

View reviewed changes

Onuray Sahin added 2 commits March 25, 2022 14:24

Cancel timers when service is destroyed.

bdbdfe5

Trigger github actions.

9b271e4

onurays merged commit 08476a9 into develop Mar 28, 2022

onurays deleted the feature/ons/live_location_service branch March 28, 2022 09:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Live Location Sharing - Foreground Service #5595

Live Location Sharing - Foreground Service #5595

onurays commented Mar 21, 2022 •

edited

Loading

github-actions bot commented Mar 23, 2022 •

edited

Loading

ouchadam Mar 25, 2022

onurays Mar 25, 2022

ouchadam Mar 25, 2022

onurays Mar 25, 2022

ouchadam Mar 25, 2022

onurays Mar 25, 2022

ouchadam Mar 25, 2022 •

edited

Loading

onurays Mar 25, 2022

ouchadam Mar 25, 2022

ouchadam Mar 25, 2022

onurays Mar 25, 2022 •

edited

Loading

ouchadam Mar 25, 2022

onurays Mar 25, 2022

ouchadam left a comment •

edited

Loading

Live Location Sharing - Foreground Service #5595

Live Location Sharing - Foreground Service #5595

Conversation

onurays commented Mar 21, 2022 • edited Loading

github-actions bot commented Mar 23, 2022 • edited Loading

Unit Test Results

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ouchadam Mar 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onurays Mar 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ouchadam left a comment • edited Loading

Choose a reason for hiding this comment

onurays commented Mar 21, 2022 •

edited

Loading

github-actions bot commented Mar 23, 2022 •

edited

Loading

ouchadam Mar 25, 2022 •

edited

Loading

onurays Mar 25, 2022 •

edited

Loading

ouchadam left a comment •

edited

Loading