Ensure we do not cancel Work from other lib or SDK client

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/DefaultSession.kt

@@ -20,7 +20,6 @@ import android.content.Context
 import android.os.Looper
 import androidx.annotation.MainThread
 import androidx.lifecycle.LiveData
-import androidx.work.WorkManager
 import im.vector.matrix.android.api.MatrixCallback
 import im.vector.matrix.android.api.auth.data.SessionParams
 import im.vector.matrix.android.api.pushrules.PushRuleService
@@ -44,6 +43,7 @@ import im.vector.matrix.android.internal.crypto.CryptoManager
 import im.vector.matrix.android.internal.database.LiveEntityObserver
 import im.vector.matrix.android.internal.session.sync.job.SyncThread
 import im.vector.matrix.android.internal.session.sync.job.SyncWorker
+import im.vector.matrix.android.internal.worker.WorkManagerUtil
 import timber.log.Timber
 import javax.inject.Inject
 
@@ -150,10 +150,7 @@ internal class DefaultSession @Inject constructor(override val sessionParams: Se
                         Timber.w("SIGN_OUT: clear cache -> SUCCESS: clear crypto cache")
                         cryptoService.clearCryptoCache(MatrixCallbackDelegate(callback))
 
-                        WorkManager.getInstance(context).also {
-                            it.cancelAllWork()
-                            it.pruneWork()
-                        }
+                        WorkManagerUtil.cancelAllWorks(context)
                     }
 
                     override fun onFailure(failure: Throwable) {

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/group/GroupSummaryUpdater.kt

@@ -20,7 +20,6 @@ import android.content.Context
 import androidx.work.Constraints
 import androidx.work.ExistingWorkPolicy
 import androidx.work.NetworkType
-import androidx.work.OneTimeWorkRequestBuilder
 import androidx.work.WorkManager
 import com.zhuinden.monarchy.Monarchy
 import im.vector.matrix.android.api.auth.data.Credentials
@@ -28,6 +27,7 @@ import im.vector.matrix.android.internal.database.RealmLiveEntityObserver
 import im.vector.matrix.android.internal.database.model.GroupEntity
 import im.vector.matrix.android.internal.database.query.where
 import im.vector.matrix.android.internal.di.SessionDatabase
+import im.vector.matrix.android.internal.worker.WorkManagerUtil.matrixOneTimeWorkRequestBuilder
 import im.vector.matrix.android.internal.worker.WorkerParamsFactory
 import io.realm.RealmConfiguration
 import javax.inject.Inject
@@ -50,7 +50,7 @@ internal class GroupSummaryUpdater @Inject constructor(private val context: Cont
         val getGroupDataWorkerParams = GetGroupDataWorker.Params(credentials.userId, newGroupIds)
         val workData = WorkerParamsFactory.toData(getGroupDataWorkerParams)
 
-        val sendWork = OneTimeWorkRequestBuilder<GetGroupDataWorker>()
+        val sendWork = matrixOneTimeWorkRequestBuilder<GetGroupDataWorker>()
                 .setInputData(workData)
                 .setConstraints(workConstraints)
                 .build()

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/pushers/DefaultPusherService.kt

@@ -20,21 +20,18 @@ import androidx.lifecycle.LiveData
 import androidx.work.BackoffPolicy
 import androidx.work.Constraints
 import androidx.work.NetworkType
-import androidx.work.OneTimeWorkRequestBuilder
 import androidx.work.WorkManager
 import com.zhuinden.monarchy.Monarchy
 import im.vector.matrix.android.api.MatrixCallback
 import im.vector.matrix.android.api.auth.data.SessionParams
 import im.vector.matrix.android.api.session.pushers.Pusher
-import im.vector.matrix.android.api.session.pushers.PusherState
 import im.vector.matrix.android.api.session.pushers.PushersService
 import im.vector.matrix.android.internal.database.mapper.asDomain
-import im.vector.matrix.android.internal.database.mapper.toEntity
 import im.vector.matrix.android.internal.database.model.PusherEntity
-import im.vector.matrix.android.internal.database.model.PusherEntityFields
 import im.vector.matrix.android.internal.database.query.where
 import im.vector.matrix.android.internal.task.TaskExecutor
 import im.vector.matrix.android.internal.task.configureWith
+import im.vector.matrix.android.internal.worker.WorkManagerUtil.matrixOneTimeWorkRequestBuilder
 import im.vector.matrix.android.internal.worker.WorkerParamsFactory
 import java.util.*
 import java.util.concurrent.TimeUnit
@@ -78,7 +75,7 @@ internal class DefaultPusherService @Inject constructor(
 
         val constraints = Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build()
 
-        val request = OneTimeWorkRequestBuilder<AddHttpPusherWorker>()
+        val request = matrixOneTimeWorkRequestBuilder<AddHttpPusherWorker>()
                 .setConstraints(constraints)
                 .setInputData(WorkerParamsFactory.toData(params))
                 .setBackoffCriteria(BackoffPolicy.LINEAR, 10_000L, TimeUnit.MILLISECONDS)

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/send/DefaultSendService.kt

@@ -29,6 +29,7 @@ import im.vector.matrix.android.api.util.CancelableBag
 import im.vector.matrix.android.internal.session.content.UploadContentWorker
 import im.vector.matrix.android.internal.session.room.timeline.TimelineSendEventWorkCommon
 import im.vector.matrix.android.internal.util.CancelableWork
+import im.vector.matrix.android.internal.worker.WorkManagerUtil.matrixOneTimeWorkRequestBuilder
 import im.vector.matrix.android.internal.worker.WorkerParamsFactory
 import timber.log.Timber
 import java.util.concurrent.TimeUnit
@@ -135,7 +136,7 @@ internal class DefaultSendService @Inject constructor(private val context: Conte
         val params = EncryptEventWorker.Params(credentials.userId, roomId, event)
         val sendWorkData = WorkerParamsFactory.toData(params)
 
-        return OneTimeWorkRequestBuilder<EncryptEventWorker>()
+        return matrixOneTimeWorkRequestBuilder<EncryptEventWorker>()
                 .setConstraints(WORK_CONSTRAINTS)
                 .setInputData(sendWorkData)
                 .setBackoffCriteria(BackoffPolicy.LINEAR, BACKOFF_DELAY, TimeUnit.MILLISECONDS)
@@ -162,7 +163,7 @@ internal class DefaultSendService @Inject constructor(private val context: Conte
         val uploadMediaWorkerParams = UploadContentWorker.Params(credentials.userId, roomId, event, attachment, isRoomEncrypted)
         val uploadWorkData = WorkerParamsFactory.toData(uploadMediaWorkerParams)
 
-        return OneTimeWorkRequestBuilder<UploadContentWorker>()
+        return matrixOneTimeWorkRequestBuilder<UploadContentWorker>()
                 .setConstraints(WORK_CONSTRAINTS)
                 .setInputData(uploadWorkData)
                 .setBackoffCriteria(BackoffPolicy.LINEAR, BACKOFF_DELAY, TimeUnit.MILLISECONDS)

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/timeline/TimelineSendEventWorkCommon.kt

@@ -17,6 +17,7 @@ package im.vector.matrix.android.internal.session.room.timeline
 
 import android.content.Context
 import androidx.work.*
+import im.vector.matrix.android.internal.worker.WorkManagerUtil.matrixOneTimeWorkRequestBuilder
 import java.util.concurrent.TimeUnit
 
 
@@ -60,7 +61,7 @@ internal object TimelineSendEventWorkCommon {
     }
 
     inline fun <reified W : ListenableWorker> createWork(data: Data): OneTimeWorkRequest {
-        return OneTimeWorkRequestBuilder<W>()
+        return matrixOneTimeWorkRequestBuilder<W>()
                 .setConstraints(WORK_CONSTRAINTS)
                 .setInputData(data)
                 .setBackoffCriteria(BackoffPolicy.LINEAR, BACKOFF_DELAY, TimeUnit.MILLISECONDS)

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/sync/job/SyncWorker.kt

@@ -24,6 +24,7 @@ import im.vector.matrix.android.internal.session.sync.SyncTask
 import im.vector.matrix.android.internal.task.TaskExecutor
 import im.vector.matrix.android.internal.task.TaskThread
 import im.vector.matrix.android.internal.task.configureWith
+import im.vector.matrix.android.internal.worker.WorkManagerUtil.matrixOneTimeWorkRequestBuilder
 import im.vector.matrix.android.internal.worker.WorkerParamsFactory
 import im.vector.matrix.android.internal.worker.getSessionComponent
 import timber.log.Timber
@@ -86,7 +87,7 @@ internal class SyncWorker(context: Context,
 
         fun requireBackgroundSync(context: Context, userId: String, serverTimeout: Long = 0) {
             val data = WorkerParamsFactory.toData(Params(userId, serverTimeout, false))
-            val workRequest = OneTimeWorkRequestBuilder<SyncWorker>()
+            val workRequest = matrixOneTimeWorkRequestBuilder<SyncWorker>()
                     .setInputData(data)
                     .setConstraints(Constraints.Builder()
                             .setRequiredNetworkType(NetworkType.CONNECTED)
@@ -98,7 +99,7 @@ internal class SyncWorker(context: Context,
 
         fun automaticallyBackgroundSync(context: Context, userId: String, serverTimeout: Long = 0, delay: Long = 30_000) {
             val data = WorkerParamsFactory.toData(Params(userId, serverTimeout, true))
-            val workRequest = OneTimeWorkRequestBuilder<SyncWorker>()
+            val workRequest = matrixOneTimeWorkRequestBuilder<SyncWorker>()
                     .setInputData(data)
                     .setConstraints(Constraints.Builder()
                             .setRequiredNetworkType(NetworkType.CONNECTED)

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/worker/WorkManagerUtil.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2019 New Vector Ltd
+ *
+ * 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 im.vector.matrix.android.internal.worker
+
+import android.content.Context
+import androidx.work.ListenableWorker
+import androidx.work.OneTimeWorkRequestBuilder
+import androidx.work.WorkManager
+
+internal object WorkManagerUtil {
+    private const val MATRIX_SDK_TAG = "MatrixSDK"
+
+    inline fun <reified W : ListenableWorker> matrixOneTimeWorkRequestBuilder() =
+            OneTimeWorkRequestBuilder<W>()
+                    .addTag(MATRIX_SDK_TAG)
+
+    /**
+     * Cancel all work instanciated by the Matrix SDK and not those from the SDK client
+     */
+    fun cancelAllWorks(context: Context) {
+        WorkManager.getInstance(context).also {
+            it.cancelAllWorkByTag(MATRIX_SDK_TAG)
+            it.pruneWork()
+        }
+    }
+}

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/worker/WorkerKey.kt

@@ -1,26 +0,0 @@
-/*
- * Copyright 2019 New Vector Ltd
- *
- * 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 im.vector.matrix.android.internal.worker
-
-import androidx.work.ListenableWorker
-import dagger.MapKey
-import kotlin.reflect.KClass
-
-@MapKey
-@Target(AnnotationTarget.FUNCTION)
-@Retention(AnnotationRetention.RUNTIME)
-internal annotation class WorkerKey(val value: KClass<out ListenableWorker>)

tools/check/forbidden_strings_in_code.txt

@@ -147,3 +147,6 @@ android\.app\.AlertDialog
 
 ### Use JsonUtils.getBasicGson()
 new Gson\(\)
+
+### Use matrixOneTimeWorkRequestBuilder
+import androidx.work.OneTimeWorkRequestBuilder===1