Take into account well-known config to disable WorkManager network constraint

changelog.d/8662.misc

@@ -0,0 +1 @@
+Take into account boolean "io.element.disable_network_constraint" from the .well-known file.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/auth/data/DiscoveryInformation.kt

@@ -36,5 +36,11 @@ data class DiscoveryInformation(
          * Note: matrix.org does not send this field
          */
         @Json(name = "m.identity_server")
-        val identityServer: WellKnownBaseConfig? = null
+        val identityServer: WellKnownBaseConfig? = null,
+
+        /**
+         * If set to true, the SDK will not use the network constraint when configuring Worker for the WorkManager.
+         */
+        @Json(name = "io.element.disable_network_constraint")
+        val disableNetworkConstraint: Boolean? = null,
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/auth/data/WellKnown.kt

@@ -61,4 +61,10 @@ data class WellKnown(
          */
         @Json(name = "org.matrix.msc2965.authentication")
         val unstableDelegatedAuthConfig: DelegatedAuthConfig? = null,
+
+        /**
+         * If set to true, the SDK will not use the network constraint when configuring Worker for the WorkManager.
+         */
+        @Json(name = "io.element.disable_network_constraint")
+        val disableNetworkConstraint: Boolean? = null,
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/homeserver/HomeServerCapabilities.kt

@@ -90,6 +90,11 @@ data class HomeServerCapabilities(
          * Authentication issuer for use with MSC3824 delegated OIDC, provided in Wellknown.
          */
         val authenticationIssuer: String? = null,
+
+        /**
+         * If set to true, the SDK will not use the network constraint when configuring Worker for the WorkManager, provided in Wellknown.
+         */
+        val disableNetworkConstraint: Boolean = false,
 ) {
 
     enum class RoomCapabilitySupport {

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/RealmSessionStoreMigration.kt

@@ -70,6 +70,7 @@ import org.matrix.android.sdk.internal.database.migration.MigrateSessionTo050
 import org.matrix.android.sdk.internal.database.migration.MigrateSessionTo051
 import org.matrix.android.sdk.internal.database.migration.MigrateSessionTo052
 import org.matrix.android.sdk.internal.database.migration.MigrateSessionTo053
+import org.matrix.android.sdk.internal.database.migration.MigrateSessionTo054
 import org.matrix.android.sdk.internal.util.Normalizer
 import org.matrix.android.sdk.internal.util.database.MatrixRealmMigration
 import javax.inject.Inject
@@ -78,7 +79,7 @@ internal class RealmSessionStoreMigration @Inject constructor(
         private val normalizer: Normalizer
 ) : MatrixRealmMigration(
         dbName = "Session",
-        schemaVersion = 53L,
+        schemaVersion = 54L,
 ) {
     /**
      * Forces all RealmSessionStoreMigration instances to be equal.
@@ -141,5 +142,6 @@ internal class RealmSessionStoreMigration @Inject constructor(
         if (oldVersion < 51) MigrateSessionTo051(realm).perform()
         if (oldVersion < 52) MigrateSessionTo052(realm).perform()
         if (oldVersion < 53) MigrateSessionTo053(realm).perform()
+        if (oldVersion < 54) MigrateSessionTo054(realm).perform()
     }
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/mapper/HomeServerCapabilitiesMapper.kt

@@ -50,6 +50,7 @@ internal object HomeServerCapabilitiesMapper {
                 canRedactRelatedEvents = entity.canRedactEventWithRelations,
                 externalAccountManagementUrl = entity.externalAccountManagementUrl,
                 authenticationIssuer = entity.authenticationIssuer,
+                disableNetworkConstraint = entity.disableNetworkConstraint,
         )
     }
 

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/migration/MigrateSessionTo054.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2023 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.database.migration
+
+import io.realm.DynamicRealm
+import org.matrix.android.sdk.internal.database.model.HomeServerCapabilitiesEntityFields
+import org.matrix.android.sdk.internal.extensions.forceRefreshOfHomeServerCapabilities
+import org.matrix.android.sdk.internal.util.database.RealmMigrator
+
+internal class MigrateSessionTo054(realm: DynamicRealm) : RealmMigrator(realm, 54) {
+    override fun doMigrate(realm: DynamicRealm) {
+        realm.schema.get("HomeServerCapabilitiesEntity")
+                ?.addField(HomeServerCapabilitiesEntityFields.DISABLE_NETWORK_CONSTRAINT, Boolean::class.java)
+                ?.forceRefreshOfHomeServerCapabilities()
+    }
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/database/model/HomeServerCapabilitiesEntity.kt

@@ -37,6 +37,7 @@ internal open class HomeServerCapabilitiesEntity(
         var canRedactEventWithRelations: Boolean = false,
         var externalAccountManagementUrl: String? = null,
         var authenticationIssuer: String? = null,
+        var disableNetworkConstraint: Boolean = false,
 ) : RealmObject() {
 
     companion object

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/di/WorkManagerProvider.kt

@@ -30,7 +30,9 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import org.matrix.android.sdk.api.MatrixCoroutineDispatchers
 import org.matrix.android.sdk.internal.session.SessionScope
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import org.matrix.android.sdk.internal.worker.MatrixWorkerFactory
+import timber.log.Timber
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 
@@ -102,12 +104,20 @@ internal class WorkManagerProvider @Inject constructor(
     companion object {
         private const val MATRIX_SDK_TAG_PREFIX = "MatrixSDK-"
 
-        /**
-         * Default constraints: connected network.
-         */
-        val workConstraints = Constraints.Builder()
-                .setRequiredNetworkType(NetworkType.CONNECTED)
-                .build()
+        fun getWorkConstraints(
+                workManagerConfig: WorkManagerConfig,
+        ): Constraints {
+            val widthNetworkConstraint = workManagerConfig.withNetworkConstraint()
+            return Constraints.Builder()
+                    .apply {
+                        if (widthNetworkConstraint) {
+                            setRequiredNetworkType(NetworkType.CONNECTED)
+                        } else {
+                            Timber.w("Network constraint is disabled")
+                        }
+                    }
+                    .build()
+        }
 
         // Use min value, smaller value will be ignored
         const val BACKOFF_DELAY_MILLIS = WorkRequest.MIN_BACKOFF_MILLIS

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/SessionModule.kt

@@ -97,6 +97,8 @@ import org.matrix.android.sdk.internal.session.room.tombstone.RoomTombstoneEvent
 import org.matrix.android.sdk.internal.session.typing.DefaultTypingUsersTracker
 import org.matrix.android.sdk.internal.session.user.accountdata.DefaultSessionAccountDataService
 import org.matrix.android.sdk.internal.session.widgets.DefaultWidgetURLFormatter
+import org.matrix.android.sdk.internal.session.workmanager.DefaultWorkManagerConfig
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import retrofit2.Retrofit
 import java.io.File
 import javax.inject.Provider
@@ -422,4 +424,7 @@ internal abstract class SessionModule {
 
     @Binds
     abstract fun bindPollAggregationProcessor(processor: DefaultPollAggregationProcessor): PollAggregationProcessor
+
+    @Binds
+    abstract fun bindWorkManaerConfig(config: DefaultWorkManagerConfig): WorkManagerConfig
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/homeserver/GetHomeServerCapabilitiesTask.kt

@@ -20,6 +20,7 @@ import com.zhuinden.monarchy.Monarchy
 import org.matrix.android.sdk.api.MatrixPatterns.getServerName
 import org.matrix.android.sdk.api.auth.data.HomeServerConnectionConfig
 import org.matrix.android.sdk.api.auth.wellknown.WellknownResult
+import org.matrix.android.sdk.api.extensions.orFalse
 import org.matrix.android.sdk.api.extensions.orTrue
 import org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilities
 import org.matrix.android.sdk.internal.auth.version.Versions
@@ -167,6 +168,7 @@ internal class DefaultGetHomeServerCapabilitiesTask @Inject constructor(
                 }
                 homeServerCapabilitiesEntity.authenticationIssuer = getWellknownResult.wellKnown.unstableDelegatedAuthConfig?.issuer
                 homeServerCapabilitiesEntity.externalAccountManagementUrl = getWellknownResult.wellKnown.unstableDelegatedAuthConfig?.accountManagementUrl
+                homeServerCapabilitiesEntity.disableNetworkConstraint = getWellknownResult.wellKnown.disableNetworkConstraint.orFalse()
             }
 
             homeServerCapabilitiesEntity.canLoginWithQrCode = canLoginWithQrCode(getCapabilitiesResult, getVersionResult)

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/pushers/DefaultPushersService.kt

@@ -28,6 +28,7 @@ import org.matrix.android.sdk.internal.di.SessionDatabase
 import org.matrix.android.sdk.internal.di.SessionId
 import org.matrix.android.sdk.internal.di.WorkManagerProvider
 import org.matrix.android.sdk.internal.session.pushers.gateway.PushGatewayNotifyTask
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import org.matrix.android.sdk.internal.task.TaskExecutor
 import org.matrix.android.sdk.internal.task.configureWith
 import org.matrix.android.sdk.internal.worker.WorkerParamsFactory
@@ -44,7 +45,8 @@ internal class DefaultPushersService @Inject constructor(
         private val addPusherTask: AddPusherTask,
         private val togglePusherTask: TogglePusherTask,
         private val removePusherTask: RemovePusherTask,
-        private val taskExecutor: TaskExecutor
+        private val taskExecutor: TaskExecutor,
+        private val workManagerConfig: WorkManagerConfig,
 ) : PushersService {
 
     override suspend fun testPush(
@@ -130,7 +132,7 @@ internal class DefaultPushersService @Inject constructor(
     private fun enqueueAddPusher(pusher: JsonPusher): UUID {
         val params = AddPusherWorker.Params(sessionId, pusher)
         val request = workManagerProvider.matrixOneTimeWorkRequestBuilder<AddPusherWorker>()
-                .setConstraints(WorkManagerProvider.workConstraints)
+                .setConstraints(WorkManagerProvider.getWorkConstraints(workManagerConfig))
                 .setInputData(WorkerParamsFactory.toData(params))
                 .setBackoffCriteria(BackoffPolicy.LINEAR, WorkManagerProvider.BACKOFF_DELAY_MILLIS, TimeUnit.MILLISECONDS)
                 .build()

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

@@ -53,7 +53,9 @@ import org.matrix.android.sdk.internal.crypto.store.IMXCommonCryptoStore
 import org.matrix.android.sdk.internal.di.SessionId
 import org.matrix.android.sdk.internal.di.WorkManagerProvider
 import org.matrix.android.sdk.internal.session.content.UploadContentWorker
+import org.matrix.android.sdk.internal.session.homeserver.HomeServerCapabilitiesDataSource
 import org.matrix.android.sdk.internal.session.room.send.queue.EventSenderProcessor
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import org.matrix.android.sdk.internal.task.TaskExecutor
 import org.matrix.android.sdk.internal.util.CancelableWork
 import org.matrix.android.sdk.internal.worker.WorkerParamsFactory
@@ -73,7 +75,8 @@ internal class DefaultSendService @AssistedInject constructor(
         private val taskExecutor: TaskExecutor,
         private val localEchoRepository: LocalEchoRepository,
         private val eventSenderProcessor: EventSenderProcessor,
-        private val cancelSendTracker: CancelSendTracker
+        private val cancelSendTracker: CancelSendTracker,
+        private val workManagerConfig: WorkManagerConfig,
 ) : SendService {
 
     @AssistedFactory
@@ -373,7 +376,7 @@ internal class DefaultSendService @AssistedInject constructor(
         val uploadWorkData = WorkerParamsFactory.toData(uploadMediaWorkerParams)
 
         return workManagerProvider.matrixOneTimeWorkRequestBuilder<UploadContentWorker>()
-                .setConstraints(WorkManagerProvider.workConstraints)
+                .setConstraints(WorkManagerProvider.getWorkConstraints(workManagerConfig))
                 .startChain(true)
                 .setInputData(uploadWorkData)
                 .setBackoffCriteria(BackoffPolicy.LINEAR, WorkManagerProvider.BACKOFF_DELAY_MILLIS, TimeUnit.MILLISECONDS)

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

@@ -22,6 +22,8 @@ import androidx.work.ListenableWorker
 import androidx.work.OneTimeWorkRequest
 import org.matrix.android.sdk.api.util.Cancelable
 import org.matrix.android.sdk.internal.di.WorkManagerProvider
+import org.matrix.android.sdk.internal.session.homeserver.HomeServerCapabilitiesDataSource
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import org.matrix.android.sdk.internal.util.CancelableWork
 import org.matrix.android.sdk.internal.worker.startChain
 import java.util.concurrent.TimeUnit
@@ -34,7 +36,8 @@ import javax.inject.Inject
  * if not the chain will be doomed in failed state.
  */
 internal class TimelineSendEventWorkCommon @Inject constructor(
-        private val workManagerProvider: WorkManagerProvider
+        private val workManagerProvider: WorkManagerProvider,
+        private val workManagerConfig: WorkManagerConfig,
 ) {
 
     fun postWork(roomId: String, workRequest: OneTimeWorkRequest, policy: ExistingWorkPolicy = ExistingWorkPolicy.APPEND_OR_REPLACE): Cancelable {
@@ -47,7 +50,7 @@ internal class TimelineSendEventWorkCommon @Inject constructor(
 
     inline fun <reified W : ListenableWorker> createWork(data: Data, startChain: Boolean): OneTimeWorkRequest {
         return workManagerProvider.matrixOneTimeWorkRequestBuilder<W>()
-                .setConstraints(WorkManagerProvider.workConstraints)
+                .setConstraints(WorkManagerProvider.getWorkConstraints(workManagerConfig))
                 .startChain(startChain)
                 .setInputData(data)
                 .setBackoffCriteria(BackoffPolicy.LINEAR, WorkManagerProvider.BACKOFF_DELAY_MILLIS, TimeUnit.MILLISECONDS)

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/sync/DefaultSyncService.kt

@@ -20,8 +20,10 @@ import org.matrix.android.sdk.api.session.sync.SyncService
 import org.matrix.android.sdk.internal.di.SessionId
 import org.matrix.android.sdk.internal.di.WorkManagerProvider
 import org.matrix.android.sdk.internal.session.SessionState
+import org.matrix.android.sdk.internal.session.homeserver.HomeServerCapabilitiesDataSource
 import org.matrix.android.sdk.internal.session.sync.job.SyncThread
 import org.matrix.android.sdk.internal.session.sync.job.SyncWorker
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import timber.log.Timber
 import javax.inject.Inject
 import javax.inject.Provider
@@ -33,15 +35,26 @@ internal class DefaultSyncService @Inject constructor(
         private val syncTokenStore: SyncTokenStore,
         private val syncRequestStateTracker: SyncRequestStateTracker,
         private val sessionState: SessionState,
+        private val workManagerConfig: WorkManagerConfig,
 ) : SyncService {
     private var syncThread: SyncThread? = null
 
     override fun requireBackgroundSync() {
-        SyncWorker.requireBackgroundSync(workManagerProvider, sessionId)
+        SyncWorker.requireBackgroundSync(
+                workManagerProvider = workManagerProvider,
+                sessionId = sessionId,
+                workManagerConfig = workManagerConfig,
+        )
     }
 
     override fun startAutomaticBackgroundSync(timeOutInSeconds: Long, repeatDelayInSeconds: Long) {
-        SyncWorker.automaticallyBackgroundSync(workManagerProvider, sessionId, timeOutInSeconds, repeatDelayInSeconds)
+        SyncWorker.automaticallyBackgroundSync(
+                workManagerProvider = workManagerProvider,
+                sessionId = sessionId,
+                workManagerConfig = workManagerConfig,
+                serverTimeoutInSeconds = timeOutInSeconds,
+                delayInSeconds = repeatDelayInSeconds,
+        )
     }
 
     override fun stopAnyBackgroundSync() {

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

@@ -25,8 +25,10 @@ import org.matrix.android.sdk.api.failure.isTokenError
 import org.matrix.android.sdk.internal.SessionManager
 import org.matrix.android.sdk.internal.di.WorkManagerProvider
 import org.matrix.android.sdk.internal.session.SessionComponent
+import org.matrix.android.sdk.internal.session.homeserver.HomeServerCapabilitiesDataSource
 import org.matrix.android.sdk.internal.session.sync.SyncPresence
 import org.matrix.android.sdk.internal.session.sync.SyncTask
+import org.matrix.android.sdk.internal.session.workmanager.WorkManagerConfig
 import org.matrix.android.sdk.internal.worker.SessionSafeCoroutineWorker
 import org.matrix.android.sdk.internal.worker.SessionWorkerParams
 import org.matrix.android.sdk.internal.worker.WorkerParamsFactory
@@ -59,6 +61,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
 
     @Inject lateinit var syncTask: SyncTask
     @Inject lateinit var workManagerProvider: WorkManagerProvider
+    @Inject lateinit var workManagerConfig: WorkManagerConfig
 
     override fun injectWith(injector: SessionComponent) {
         injector.inject(this)
@@ -77,6 +80,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
                             automaticallyBackgroundSync(
                                     workManagerProvider = workManagerProvider,
                                     sessionId = params.sessionId,
+                                    workManagerConfig = workManagerConfig,
                                     serverTimeoutInSeconds = params.timeout,
                                     delayInSeconds = params.delay,
                                     forceImmediate = hasToDeviceEvents
@@ -86,6 +90,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
                             requireBackgroundSync(
                                     workManagerProvider = workManagerProvider,
                                     sessionId = params.sessionId,
+                                    workManagerConfig = workManagerConfig,
                                     serverTimeoutInSeconds = 0
                             )
                         }
@@ -123,6 +128,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
         fun requireBackgroundSync(
                 workManagerProvider: WorkManagerProvider,
                 sessionId: String,
+                workManagerConfig: WorkManagerConfig,
                 serverTimeoutInSeconds: Long = 0
         ) {
             val data = WorkerParamsFactory.toData(
@@ -134,7 +140,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
                     )
             )
             val workRequest = workManagerProvider.matrixOneTimeWorkRequestBuilder<SyncWorker>()
-                    .setConstraints(WorkManagerProvider.workConstraints)
+                    .setConstraints(WorkManagerProvider.getWorkConstraints(workManagerConfig))
                     .setBackoffCriteria(BackoffPolicy.LINEAR, WorkManagerProvider.BACKOFF_DELAY_MILLIS, TimeUnit.MILLISECONDS)
                     .setInputData(data)
                     .startChain(true)
@@ -146,6 +152,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
         fun automaticallyBackgroundSync(
                 workManagerProvider: WorkManagerProvider,
                 sessionId: String,
+                workManagerConfig: WorkManagerConfig,
                 serverTimeoutInSeconds: Long = 0,
                 delayInSeconds: Long = 30,
                 forceImmediate: Boolean = false
@@ -160,7 +167,7 @@ internal class SyncWorker(context: Context, workerParameters: WorkerParameters,
                     )
             )
             val workRequest = workManagerProvider.matrixOneTimeWorkRequestBuilder<SyncWorker>()
-                    .setConstraints(WorkManagerProvider.workConstraints)
+                    .setConstraints(WorkManagerProvider.getWorkConstraints(workManagerConfig))
                     .setInputData(data)
                     .setBackoffCriteria(BackoffPolicy.LINEAR, WorkManagerProvider.BACKOFF_DELAY_MILLIS, TimeUnit.MILLISECONDS)
                     .setInitialDelay(if (forceImmediate) 0 else delayInSeconds, TimeUnit.SECONDS)