feat(flow): parse bridge errors into typed DescopeException

descope/etc#16441

Author: itaihanski

descopesdk/src/main/java/com/descope/android/flow/DescopeFlowBridge.kt

@@ -15,6 +15,7 @@ import com.descope.internal.http.REFRESH_COOKIE_NAME
 import com.descope.internal.others.error
 import com.descope.internal.others.info
 import com.descope.internal.others.stringOrEmptyAsNull
+import com.descope.internal.others.toDescopeException
 import com.descope.internal.others.with
 import com.descope.sdk.DescopeLogger
 import com.descope.types.DescopeException
@@ -100,7 +101,7 @@ internal class FlowBridge(webView: WebView) {
 
     private fun bridgeOnError(error: String) {
         handler.post {
-            listener?.onError(DescopeException.flowFailed.with(message = error))
+            listener?.onError(error.toDescopeException() ?: DescopeException.flowFailed.with(message = error))
         }
     }
 

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

@@ -3,19 +3,6 @@ package com.descope.internal.http
 import com.descope.internal.others.toMap
 import com.descope.internal.others.with
 import com.descope.types.DescopeException
-import org.json.JSONObject
-
-internal fun parseServerError(response: String): DescopeException? {
-    try {
-        val map = JSONObject(response).toMap()
-        val code = map["errorCode"] as? String ?: return null
-        val desc = map["errorDescription"] as? String ?: "Descope server error"
-        val message = map["errorMessage"] as? String
-        return DescopeException(code = code, desc = desc, message = message)
-    } catch (_: Exception) {
-        return null
-    }
-}
 
 internal fun exceptionFromResponseCode(code: Int): DescopeException? {
     val desc = failureFromResponseCode(code) ?: return null

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

@@ -1,6 +1,7 @@
 package com.descope.internal.http
 
 import com.descope.android.SystemInfo
+import com.descope.internal.others.toDescopeException
 import com.descope.sdk.DescopeConfig
 import com.descope.sdk.DescopeSdk
 import com.descope.types.DeliveryMethod
@@ -505,7 +506,7 @@ internal open class DescopeClient(internal val config: DescopeConfig, systemInfo
 
     override val defaultHeaders: Map<String, String> = makeDefaultHeaders(config, systemInfo)
 
-    override fun exceptionFromResponse(response: String): DescopeException? = parseServerError(response)
+    override fun exceptionFromResponse(response: String): DescopeException? = response.toDescopeException()
 
     // Internal
 

descopesdk/src/main/java/com/descope/internal/others/Errors.kt

@@ -1,10 +1,23 @@
 package com.descope.internal.others
 
 import com.descope.types.DescopeException
+import org.json.JSONObject
 
 internal fun DescopeException.with(desc: String? = null, message: String? = null, cause: Throwable? = null) = DescopeException(
     code = code,
     desc = desc ?: this.desc,
     message = message ?: this.message,
     cause = cause ?: this.cause,
 )
+
+internal fun String.toDescopeException(): DescopeException? {
+    try {
+        val map = JSONObject(this).toMap()
+        val code = map["errorCode"] as? String ?: return null
+        val desc = map["errorDescription"] as? String ?: "Descope server error"
+        val message = map["errorMessage"] as? String
+        return DescopeException(code = code, desc = desc, message = message)
+    } catch (_: Exception) {
+        return null
+    }
+}

descopesdk/src/main/java/com/descope/types/Error.kt

@@ -108,6 +108,7 @@ class DescopeException(
         val flowFailed = DescopeException(code = "K100001", desc = "Flow failed to run")
         val flowCancelled = DescopeException(code = "K100002", desc = "Flow cancelled")
         val flowSetup = DescopeException(code = "K100003", desc = "Flow not properly set up")
+        val flowAborted = DescopeException(code = "E102122", desc = "Flow aborted")
 
         val widgetFailed = DescopeException(code = "K100101", desc = "Widget failed to run")
         val widgetAuthenticationRequired = DescopeException(code = "K100102", desc = "Widget requires an authenticated session")

descopesdk/src/test/java/com/descope/types/DescopeExceptionTest.kt

@@ -1,8 +1,9 @@
 package com.descope.types
 
-import com.descope.internal.http.parseServerError
+import com.descope.internal.others.toDescopeException
 import org.json.JSONObject
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNull
 import org.junit.Assert.fail
 import org.junit.Test
 
@@ -15,12 +16,30 @@ class DescopeExceptionTest {
             put("errorDescription", "server description")
             put("errorMessage", "some reason")
         }.toString()
-        val serverException = parseServerError(mockResponse)
+        val serverException = mockResponse.toDescopeException()
         assertEquals(DescopeException.wrongOtpCode, serverException)
         when (serverException) {
             DescopeException.wrongOtpCode -> assertEquals("server description", serverException.desc)
             else -> fail("wrong when clause")
         }
     }
-    
+
+    @Test
+    fun flow_aborted_parsing() {
+        val payload = JSONObject().apply {
+            put("errorCode", "E102122")
+            put("errorDescription", "Flow aborted")
+            put("errorMessage", "User canceled")
+        }.toString()
+        val exception = payload.toDescopeException()
+        assertEquals(DescopeException.flowAborted, exception)
+        assertEquals("User canceled", exception?.message)
+    }
+
+    @Test
+    fun invalid_error_payload_parsing() {
+        assertNull("not a json error".toDescopeException())
+        assertNull(JSONObject().apply { put("errorMessage", "no code here") }.toString().toDescopeException())
+    }
+
 }