Merge pull request #3142 from vector-im/feature/bma/global_retry

Generic hanlding of rate limit eror by the SDK

CHANGES.md

@@ -18,6 +18,7 @@ Improvements 🙌:
  - Room list improvements (paging)
  - Fix quick click action (#3127)
  - Get Event after a Push for a faster notification display in some conditions
+ - Always try to retry Http requests in case of 429 (#1300)
 
 Bugfix 🐛:
  - Fix bad theme change for the MainActivity

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/network/Request.kt

@@ -19,6 +19,7 @@ package org.matrix.android.sdk.internal.network
 import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.delay
 import org.matrix.android.sdk.api.failure.Failure
+import org.matrix.android.sdk.api.failure.MatrixError
 import org.matrix.android.sdk.api.failure.getRetryDelay
 import org.matrix.android.sdk.api.failure.shouldBeRetried
 import org.matrix.android.sdk.internal.network.ssl.CertUtil
@@ -28,22 +29,21 @@ import java.io.IOException
 
 /**
  * Execute a request from the requestBlock and handle some of the Exception it could generate
+ * Ref: https://github.com/matrix-org/matrix-js-sdk/blob/develop/src/scheduler.js#L138-L175
  *
  * @param globalErrorReceiver will be use to notify error such as invalid token error. See [GlobalError]
  * @param canRetry if set to true, the request will be executed again in case of error, after a delay
- * @param initialDelayBeforeRetry the first delay to wait before a request is retried. Will be doubled after each retry
  * @param maxDelayBeforeRetry the max delay to wait before a retry
  * @param maxRetriesCount the max number of retries
  * @param requestBlock a suspend lambda to perform the network request
  */
 internal suspend inline fun <DATA> executeRequest(globalErrorReceiver: GlobalErrorReceiver?,
                                                   canRetry: Boolean = false,
-                                                  initialDelayBeforeRetry: Long = 100L,
-                                                  maxDelayBeforeRetry: Long = 10_000L,
-                                                  maxRetriesCount: Int = Int.MAX_VALUE,
+                                                  maxDelayBeforeRetry: Long = 32_000L,
+                                                  maxRetriesCount: Int = 4,
                                                   noinline requestBlock: suspend () -> DATA): DATA {
     var currentRetryCount = 0
-    var currentDelay = initialDelayBeforeRetry
+    var currentDelay = 1_000L
 
     while (true) {
         try {
@@ -72,9 +72,16 @@ internal suspend inline fun <DATA> executeRequest(globalErrorReceiver: GlobalErr
                     // }
                     ?.also { unrecognizedCertificateException -> throw unrecognizedCertificateException }
 
-            if (canRetry && currentRetryCount++ < maxRetriesCount && exception.shouldBeRetried()) {
-                // In case of 429, ensure we wait enough
-                delay(currentDelay.coerceAtLeast(exception.getRetryDelay(0)))
+            currentRetryCount++
+
+            if (exception is Failure.ServerError
+                    && exception.httpCode == 429
+                    && exception.error.code == MatrixError.M_LIMIT_EXCEEDED
+                    && currentRetryCount < maxRetriesCount) {
+                // 429, we can retry
+                delay(exception.getRetryDelay(1_000))
+            } else if (canRetry && currentRetryCount < maxRetriesCount && exception.shouldBeRetried()) {
+                delay(currentDelay)
                 currentDelay = currentDelay.times(2L).coerceAtMost(maxDelayBeforeRetry)
                 // Try again (loop)
             } else {

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

@@ -91,7 +91,7 @@ internal class SendEventWorker(context: Context,
             if (/*currentAttemptCount >= MAX_NUMBER_OF_RETRY_BEFORE_FAILING ||**/ !exception.shouldBeRetried()) {
                 Timber.e("## SendEvent: [${System.currentTimeMillis()}]  Send event Failed cannot retry ${params.eventId} > ${exception.localizedMessage}")
                 localEchoRepository.updateSendState(event.eventId, event.roomId, SendState.UNDELIVERED)
-                return Result.success()
+                Result.success()
             } else {
                 Timber.e("## SendEvent: [${System.currentTimeMillis()}]  Send event Failed schedule retry ${params.eventId} > ${exception.localizedMessage}")
                 Result.retry()

vector/src/androidTest/java/im/vector/app/ui/UiAllScreensSanityTest.kt

@@ -78,6 +78,7 @@ class UiAllScreensSanityTest {
     // Last passing:
     // 2020-11-09
     // 2020-12-16 After ViewBinding huge change
+    // 2021-04-08 Testing 429 change
     @Test
     fun allScreensTest() {
         // Create an account