Various fixes (#233)

Author: itaihanski

README.md

@@ -9,7 +9,7 @@ written for Android. You can read more on the [Descope Website](https://descope.
 Add the following to your `build.gradle` dependencies:
 
 ```groovy
-implementation 'com.descope:descope-kotlin:0.16.0'
+implementation 'com.descope:descope-kotlin:0.16.1'
 ```
 
 ## Quickstart

descopesdk/src/main/java/com/descope/android/DescopeFlowCoordinator.kt

@@ -49,8 +49,10 @@ import com.descope.session.DescopeSession
 import com.descope.session.Token
 import com.descope.types.AuthenticationResponse
 import com.descope.types.DescopeException
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.Runnable
 import kotlinx.coroutines.launch
 import org.json.JSONObject
 import java.lang.ref.WeakReference
@@ -59,6 +61,9 @@ import java.util.Timer
 import java.util.TimerTask
 import kotlin.concurrent.timer
 
+private const val retryWindow = 10 * 1000L
+private const val retryInterval = 1250L
+
 @SuppressLint("SetJavaScriptEnabled")
 class DescopeFlowCoordinator(val webView: WebView) {
 
@@ -75,6 +80,9 @@ class DescopeFlowCoordinator(val webView: WebView) {
         get() = if (flow?.sessionProvider != null) flow?.sessionProvider?.invoke() else sdk?.sessionManager?.session?.takeIf { !it.refreshToken.isExpired }
     private var currentFlowUrl: Uri? = null
     private var alreadySetUp = false
+    private var startedAt: Long = 0L
+    private var attempts: Int = 0
+    private var loadFailure: Boolean = false
 
     init {
         webView.settings.javaScriptEnabled = true
@@ -127,11 +135,7 @@ class DescopeFlowCoordinator(val webView: WebView) {
                     return
                 }
                 currentFlowUrl = url.toUri()
-                val scope = webView.findViewTreeLifecycleOwner()?.lifecycleScope
-                if (scope == null) {
-                    logger.error("Unable to find lifecycle owner coroutine scope")
-                    return
-                }
+                val scope = webView.findViewTreeLifecycleOwner()?.lifecycleScope ?: CoroutineScope(Job())
                 scope.launch(Dispatchers.Main) {
                     var type: String
                     var canceled = false
@@ -179,7 +183,7 @@ class DescopeFlowCoordinator(val webView: WebView) {
                         type = "failure"
                         val failure = when (e) {
                             DescopeException.oauthNativeCancelled -> {
-                                logger.info("OAuth native canceled" )
+                                logger.info("OAuth native canceled")
                                 canceled = true
                                 "OAuthNativeCancelled"
                             }
@@ -243,6 +247,11 @@ class DescopeFlowCoordinator(val webView: WebView) {
             }
 
             override fun onPageFinished(view: WebView?, url: String?) {
+                if (loadFailure) {
+                    logger.info("Page finished after error", url)
+                    loadFailure = false
+                    return
+                }
                 logger.info("On page finished", url, view?.progress)
                 if (alreadySetUp) {
                     logger.error("Bridge is already set up", url, view?.progress)
@@ -271,6 +280,7 @@ class DescopeFlowCoordinator(val webView: WebView) {
             override fun onReceivedError(view: WebView?, request: WebResourceRequest?, error: WebResourceError?) {
                 if (request?.isForMainFrame == true) {
                     logger.error("Error loading flow page", error?.errorCode, error?.description)
+                    if (scheduleRetryAfterError()) return
                     val code = error?.errorCode ?: 0
                     val failure = error?.description?.toString() ?: ""
                     val message = when (code) {
@@ -288,11 +298,28 @@ class DescopeFlowCoordinator(val webView: WebView) {
                 if (request?.isForMainFrame == true) {
                     logger.error("Flow page failed to load", errorResponse?.statusCode)
                     val statusCode = errorResponse?.statusCode ?: 0
+                    if (statusCode >= 500 && scheduleRetryAfterError()) return // potentially retry only on server errors
                     val message = failureFromResponseCode(statusCode)
                     val exception = DescopeException.networkError.with(message = message)
                     handleError(exception)
                 }
             }
+
+            private fun scheduleRetryAfterError(): Boolean {
+                val retryIn = attempts * retryInterval
+                if (
+                    alreadySetUp // initial loading was successful
+                    || System.currentTimeMillis() - startedAt + retryIn > retryWindow // or retry window exceeded
+                ) {
+                    return false
+                }
+
+                loadFailure = true
+                logger.info("Will retry to load in $retryIn ms")
+                val ref = WeakReference(this@DescopeFlowCoordinator)
+                handler.postDelayed(createRetryRunnable(ref), retryIn)
+                return true
+            }
         }
     }
 
@@ -324,11 +351,18 @@ document.head.appendChild(element)
 
     // Internal API
 
-    internal fun run(flow: DescopeFlow) {
+    internal fun startFlow(flow: DescopeFlow) {
         this.flow = flow
         handleStarted()
         webView.loadUrl(flow.url)
     }
+    
+    internal fun reloadFlow() {
+        val flowUrl = flow?.url ?: return
+        attempts++
+        logger.info("Retrying to load flow (attempt $attempts)")
+        webView.loadUrl(flowUrl)
+    }
 
     internal fun resumeFromDeepLink(deepLink: Uri) {
         if (flow == null) {
@@ -364,6 +398,8 @@ document.head.appendChild(element)
         if (state == Started) return
         state = Started
         alreadySetUp = false
+        startedAt = System.currentTimeMillis()
+        attempts++
         executeHooks(Event.Started)
     }
 
@@ -378,6 +414,7 @@ document.head.appendChild(element)
             logger.info("Flow is ready ($tag)")
             startTimer()
             state = Ready
+            attempts = 0
             executeHooks(Event.Ready)
             listener?.onReady()
         }
@@ -391,20 +428,22 @@ document.head.appendChild(element)
         if (state == Failed) return
 
         handler.post {
-            logger.error("Flow failed with ${e.code}) error", e)
+            logger.error("Flow failed with [${e.code}] error", e)
             stopTimer()
             state = Failed
+            attempts = 0
             listener?.onError(e)
         }
     }
 
     private fun handleSuccess(authResponse: AuthenticationResponse) {
-        if (ensureState(Ready)) return
+        if (ensureState(Started, Ready)) return
         handler.post {
             val res = if (logger.isUnsafeEnabled) authResponse else null
             logger.info("Flow finished successfully", res)
             stopTimer()
             state = Finished
+            attempts = 0
             listener?.onSuccess(authResponse)
         }
     }
@@ -661,3 +700,16 @@ private fun createTimerAction(ref: WeakReference<DescopeFlowCoordinator>): (Time
         }
     }
 }
+
+private fun createRetryRunnable(ref: WeakReference<DescopeFlowCoordinator>): (Runnable) {
+    return object : Runnable {
+        override fun run() {
+            val coordinator = ref.get()
+            if (coordinator == null) {
+                return
+            } else {
+                coordinator.reloadFlow()
+            }
+        }
+    }
+}

descopesdk/src/main/java/com/descope/android/DescopeFlowView.kt

@@ -6,13 +6,10 @@ import android.util.AttributeSet
 import android.view.ViewGroup
 import android.view.ViewGroup.LayoutParams.MATCH_PARENT
 import android.webkit.WebView
-import androidx.browser.customtabs.CustomTabsIntent
 import com.descope.Descope
-import com.descope.sdk.DescopeSdk
 import com.descope.session.DescopeSession
 import com.descope.types.AuthenticationResponse
 import com.descope.types.DescopeException
-import com.descope.types.OAuthProvider
 
 /**
  * Authenticate a user using Descope Flows.
@@ -135,15 +132,15 @@ class DescopeFlowView : ViewGroup {
     // API
 
     /**
-     * Run a flow based on the configuration provided
+     * Start a flow based on the configuration provided
      * via a [DescopeFlowView]
      *
      * @param flow The [DescopeFlow] to execute
      */
-    fun run(flow: DescopeFlow) {
-        flowCoordinator.run(flow)
+    fun startFlow(flow: DescopeFlow) {
+        flowCoordinator.startFlow(flow)
     }
-
+    
     /**
      * Resume an already running flow after a deep link
      * event. This function should be called to complete `Magic Link`
@@ -231,4 +228,12 @@ class DescopeFlowView : ViewGroup {
         Inline,
         DoNothing,
     }
+    
+    // Deprecated
+
+    @Deprecated("Use startFlow instead", replaceWith = ReplaceWith("startFlow(flow)"))
+    fun run(flow: DescopeFlow) {
+        startFlow(flow)
+    }
+    
 }

descopesdk/src/main/java/com/descope/internal/http/ClientErrors.kt

@@ -30,7 +30,7 @@ internal fun failureFromResponseCode(code: Int): String? {
         403 -> "The request was forbidden"
         404 -> "The resource was not found"
         500, 503 -> "The request failed with status code $code"
-        in 500..599 -> "The server was unreachable"
+        in 500..599 -> "The server was unreachable with status code $code"
         else -> "The server returned status code $code"
     }
 }

descopesdk/src/main/java/com/descope/sdk/Config.kt

@@ -83,21 +83,21 @@ open class DescopeLogger(open val level: Level, open val unsafe: Boolean) {
         /**
          * A simple logger that prints basic error and info logs using `println`.
          */
-        val basicLogger: DescopeLogger = ConsoleLogger.basic
+        val basicLogger: DescopeLogger by lazy { ConsoleLogger.basic }
 
         /**
          * A simple logger that prints all logs using `println`, but does not output any
          * potentially unsafe runtime values unless a debugger is attached.
          */
-        val debugLogger: DescopeLogger = ConsoleLogger.debug
+        val debugLogger: DescopeLogger by lazy { ConsoleLogger.debug }
 
         /**
          * A simple logger that prints all logs using `println`, including potentially unsafe
          * runtime values such as secrets, personal information, network payloads, etc.
          * 
          * - **IMPORTANT**: Do not use unsafeLogger in release builds intended for production.
          */
-        val unsafeLogger: DescopeLogger = ConsoleLogger.unsafe
+        val unsafeLogger: DescopeLogger by lazy { ConsoleLogger.unsafe }
     }
 
     /** The severity of a log message. */

descopesdk/src/main/java/com/descope/sdk/Sdk.kt

@@ -78,6 +78,6 @@ class DescopeSdk(context: Context, projectId: String, configure: DescopeConfig.(
         const val NAME = "DescopeAndroid"
 
         /** The Descope SDK version */
-        const val VERSION = "0.16.0"
+        const val VERSION = "0.16.1"
     }
 }