[Location sharing] - Update DB entity when a live is timed out (PSF-999) #6128
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| [Live location sharing] Update entity in DB when a live is timed out |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| /* | ||
| * Copyright (c) 2022 The Matrix.org Foundation C.I.C. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.matrix.android.sdk.internal.session.room.aggregation.livelocation | ||
|
|
||
| import android.content.Context | ||
| import androidx.work.WorkerParameters | ||
| import com.squareup.moshi.JsonClass | ||
| import io.realm.RealmConfiguration | ||
| import org.matrix.android.sdk.internal.SessionManager | ||
| import org.matrix.android.sdk.internal.database.awaitTransaction | ||
| import org.matrix.android.sdk.internal.database.model.livelocation.LiveLocationShareAggregatedSummaryEntity | ||
| import org.matrix.android.sdk.internal.database.query.getOrCreate | ||
| import org.matrix.android.sdk.internal.di.SessionDatabase | ||
| import org.matrix.android.sdk.internal.session.SessionComponent | ||
| import org.matrix.android.sdk.internal.worker.SessionSafeCoroutineWorker | ||
| import org.matrix.android.sdk.internal.worker.SessionWorkerParams | ||
| import timber.log.Timber | ||
| import javax.inject.Inject | ||
|
|
||
| /** | ||
| * Worker dedicated to update live location summary data so that it is considered as deactivated. | ||
| * For the context: it is needed since a live location share should be deactivated after a certain timeout. | ||
| */ | ||
| internal class DeactivateLiveLocationShareWorker(context: Context, params: WorkerParameters, sessionManager: SessionManager) : | ||
| SessionSafeCoroutineWorker<DeactivateLiveLocationShareWorker.Params>( | ||
| context, | ||
| params, | ||
| sessionManager, | ||
| Params::class.java | ||
| ) { | ||
|
|
||
| @JsonClass(generateAdapter = true) | ||
| internal data class Params( | ||
| override val sessionId: String, | ||
| override val lastFailureMessage: String? = null, | ||
| val eventId: String, | ||
| val roomId: String | ||
| ) : SessionWorkerParams | ||
|
|
||
| @SessionDatabase | ||
| @Inject lateinit var realmConfiguration: RealmConfiguration | ||
|
|
||
| override fun injectWith(injector: SessionComponent) { | ||
| injector.inject(this) | ||
| } | ||
|
|
||
| override suspend fun doSafeWork(params: Params): Result { | ||
| return runCatching { | ||
| deactivateLiveLocationShare(params) | ||
| }.fold( | ||
| onSuccess = { | ||
| Result.success() | ||
| }, | ||
| onFailure = { | ||
| Timber.e("failed to deactivate live, eventId: ${params.eventId}, roomId: ${params.roomId}") | ||
| Result.failure() | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| private suspend fun deactivateLiveLocationShare(params: Params) { | ||
| awaitTransaction(realmConfiguration) { realm -> | ||
| val aggregatedSummary = LiveLocationShareAggregatedSummaryEntity.getOrCreate( | ||
| realm = realm, | ||
| roomId = params.roomId, | ||
| eventId = params.eventId | ||
| ) | ||
| aggregatedSummary.isActive = false | ||
| } | ||
| } | ||
|
|
||
| override fun buildErrorParams(params: Params, message: String): Params { | ||
| return params.copy(lastFailureMessage = params.lastFailureMessage ?: message) | ||
| } | ||
|
|
||
| companion object { | ||
| private const val WORK_NAME_PREFIX = "DeactivateLiveLocationWork-" | ||
|
|
||
| fun getWorkName(eventId: String, roomId: String) = "${WORK_NAME_PREFIX}$eventId-$roomId" | ||
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,7 @@ | |
|
|
||
| package org.matrix.android.sdk.internal.session.room.aggregation.livelocation | ||
|
|
||
| import androidx.work.ExistingWorkPolicy | ||
| import io.realm.Realm | ||
| import org.matrix.android.sdk.api.extensions.orTrue | ||
| import org.matrix.android.sdk.api.session.events.model.Event | ||
|
|
@@ -26,17 +27,27 @@ import org.matrix.android.sdk.api.session.room.model.message.MessageBeaconLocati | |
| import org.matrix.android.sdk.internal.database.mapper.ContentMapper | ||
| import org.matrix.android.sdk.internal.database.model.livelocation.LiveLocationShareAggregatedSummaryEntity | ||
| import org.matrix.android.sdk.internal.database.query.getOrCreate | ||
| import org.matrix.android.sdk.internal.di.SessionId | ||
| import org.matrix.android.sdk.internal.di.WorkManagerProvider | ||
| import org.matrix.android.sdk.internal.util.time.Clock | ||
| import org.matrix.android.sdk.internal.worker.WorkerParamsFactory | ||
| import timber.log.Timber | ||
| import java.util.concurrent.TimeUnit | ||
| import javax.inject.Inject | ||
|
|
||
| internal class LiveLocationAggregationProcessor @Inject constructor( | ||
| @SessionId private val sessionId: String, | ||
| private val workManagerProvider: WorkManagerProvider, | ||
| private val clock: Clock, | ||
| ) { | ||
|
|
||
| fun handleBeaconInfo(realm: Realm, event: Event, content: MessageBeaconInfoContent, roomId: String, isLocalEcho: Boolean) { | ||
| if (event.senderId.isNullOrEmpty() || isLocalEcho) { | ||
| return | ||
| } | ||
|
|
||
| val isLive = content.isLive.orTrue() | ||
| val targetEventId = if (isLive) { | ||
| event.eventId | ||
| } else { | ||
| // when live is set to false, we use the id of the event that should have been replaced | ||
|
|
@@ -56,8 +67,39 @@ internal class LiveLocationAggregationProcessor @Inject constructor() { | |
|
|
||
| Timber.d("updating summary of id=$targetEventId with isLive=${content.isLive}") | ||
|
|
||
| val endOfLiveTimestampMillis = content.getBestTimestampMillis()?.let { it + (content.timeout ?: 0) } | ||
| aggregatedSummary.endOfLiveTimestampMillis = endOfLiveTimestampMillis | ||
| aggregatedSummary.isActive = isLive | ||
|
|
||
| if (isLive) { | ||
| scheduleDeactivationAfterTimeout(targetEventId, roomId, endOfLiveTimestampMillis) | ||
| } else { | ||
| cancelDeactivationAfterTimeout(targetEventId, roomId) | ||
| } | ||
| } | ||
|
|
||
| private fun scheduleDeactivationAfterTimeout(eventId: String, roomId: String, endOfLiveTimestampMillis: Long?) { | ||
| endOfLiveTimestampMillis?.let { endOfLiveMillis -> | ||
|
||
| val workParams = DeactivateLiveLocationShareWorker.Params(sessionId = sessionId, eventId = eventId, roomId = roomId) | ||
| val workData = WorkerParamsFactory.toData(workParams) | ||
| val workName = DeactivateLiveLocationShareWorker.getWorkName(eventId = eventId, roomId = roomId) | ||
|
||
| val workDelayMillis = (endOfLiveMillis - clock.epochMillis()).coerceAtLeast(0) | ||
| val workRequest = workManagerProvider.matrixOneTimeWorkRequestBuilder<DeactivateLiveLocationShareWorker>() | ||
| .setInitialDelay(workDelayMillis, TimeUnit.MILLISECONDS) | ||
| .setInputData(workData) | ||
| .build() | ||
|
|
||
| workManagerProvider.workManager.enqueueUniqueWork( | ||
| workName, | ||
| ExistingWorkPolicy.KEEP, | ||
|
||
| workRequest | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private fun cancelDeactivationAfterTimeout(eventId: String, roomId: String) { | ||
| val workName = DeactivateLiveLocationShareWorker.getWorkName(eventId = eventId, roomId = roomId) | ||
| workManagerProvider.workManager.cancelUniqueWork(workName) | ||
| } | ||
|
|
||
| fun handleBeaconLocationData( | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need a
getOrCreatehere? I mean if the instance is not found, does it worth creating it? I guess it will be always found, except after a clear cache maybe.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right, I changed it in b081429