Added error throwable to result in error case. (#340)

Added test for method deep link.

Co-authored-by: Andreas Rossbacher <[email protected]>

Author: rossbacher

deeplinkdispatch/src/main/java/com/airbnb/deeplinkdispatch/BaseDeepLinkDelegate.kt

@@ -273,21 +273,14 @@ open class BaseDeepLinkDelegate @JvmOverloads constructor(
         val originalIntentUri = sourceIntent.data
             ?: return DeepLinkResult(
                 isSuccessful = false,
-                uriString = null,
                 error = "No Uri in given activity's intent.",
                 deepLinkMatchResult = deeplinkMatchResult,
-                methodResult = DeepLinkMethodResult(null, null),
-                deepLinkHandlerResult = null
             )
         val deepLinkUri = DeepLinkUri.parse(originalIntentUri.toString())
         if (deeplinkMatchResult == null) {
             return DeepLinkResult(
                 isSuccessful = false,
-                uriString = null,
                 error = "DeepLinkEntry cannot be null",
-                deepLinkMatchResult = null,
-                methodResult = DeepLinkMethodResult(null, null),
-                deepLinkHandlerResult = null
             )
         }
         val queryAndPathParameters = queryAndPathParameters(
@@ -320,7 +313,6 @@ open class BaseDeepLinkDelegate @JvmOverloads constructor(
                 DeepLinkResult(
                     isSuccessful = true,
                     uriString = originalIntentUri.toString(),
-                    error = "",
                     deepLinkMatchResult = deeplinkMatchResult,
                     methodResult = DeepLinkMethodResult(
                         intent,
@@ -345,9 +337,8 @@ open class BaseDeepLinkDelegate @JvmOverloads constructor(
                 isSuccessful = false,
                 uriString = originalIntentUri.toString(),
                 error = deepLinkMethodError.message ?: "",
-                deepLinkMatchResult = deeplinkMatchResult,
-                methodResult = DeepLinkMethodResult(null, null),
-                deepLinkHandlerResult = null
+                errorThrowable = deepLinkMethodError,
+                deepLinkMatchResult = deeplinkMatchResult
             )
         }
     }
@@ -395,11 +386,20 @@ open class BaseDeepLinkDelegate @JvmOverloads constructor(
                         )
                     }
                 } catch (exception: NoSuchMethodException) {
-                    throw DeeplLinkMethodError("Deep link to non-existent method: ${matchedDeeplinkEntry.method}")
+                    throw DeeplLinkMethodError(
+                        message = "Deep link to non-existent method: ${matchedDeeplinkEntry.method}",
+                        cause = exception
+                    )
                 } catch (exception: IllegalAccessException) {
-                    throw DeeplLinkMethodError("Could not deep link to method: ${matchedDeeplinkEntry.method}")
+                    throw DeeplLinkMethodError(
+                        message = "Could not deep link to method: ${matchedDeeplinkEntry.method}",
+                        cause = exception
+                    )
                 } catch (exception: InvocationTargetException) {
-                    throw DeeplLinkMethodError("Could not deep link to method: ${matchedDeeplinkEntry.method}")
+                    throw DeeplLinkMethodError(
+                        message = "Could not deep link to method: ${matchedDeeplinkEntry.method}",
+                        cause = exception
+                    )
                 }
             }
             is DeepLinkEntry.HandlerDeepLinkEntry -> {
@@ -507,7 +507,10 @@ open class BaseDeepLinkDelegate @JvmOverloads constructor(
         }
     }
 
-    class DeeplLinkMethodError(message: String) : IllegalStateException(message)
+    class DeeplLinkMethodError(
+        message: String,
+        override val cause: Throwable? = null
+    ) : IllegalStateException(message, cause)
 
     /**
      * Retruns a bundle that contains all the parameter, either from placeholder (path/{parameterName})

deeplinkdispatch/src/main/java/com/airbnb/deeplinkdispatch/DeepLinkResult.kt

@@ -9,12 +9,13 @@ data class DeepLinkResult(
      * @return whether or not the dispatch was a success.
      */
     val isSuccessful: Boolean,
-    val uriString: String?,
-    val error: String,
-    val deepLinkMatchResult: DeepLinkMatchResult?,
-    val methodResult: DeepLinkMethodResult,
+    val uriString: String? = null,
+    val error: String = "",
+    val errorThrowable: Throwable? = null,
+    val deepLinkMatchResult: DeepLinkMatchResult? = null,
+    val methodResult: DeepLinkMethodResult = DeepLinkMethodResult(null, null),
     val parameters: Map<String, String> = emptyMap(),
-    val deepLinkHandlerResult: DeepLinkHandlerResult<Any>?,
+    val deepLinkHandlerResult: DeepLinkHandlerResult<Any>? = null,
 ) {
     /**
      * This exists so that calls from Kotlin code [error()] are maintained across major version 4.

deeplinkdispatch/src/test/java/com/airbnb/deeplinkdispatch/BaseDeepLinkDelegateTest.kt

@@ -12,6 +12,52 @@ import org.junit.Test
 @kotlin.ExperimentalUnsignedTypes
 class BaseDeepLinkDelegateTest {
 
+    @Test
+    fun testFindMethodDeepLinkWrongMethod() {
+        val uriTemplate = "airbnb://foo/{bar}"
+        val uriString = "airbnb://foo/1"
+        val uri = mockk<Uri>()
+        every { uri.toString() } returns uriString
+        val entry = methodDeepLinkEntry(
+            uriTemplate,
+            TestDeepLinkClassStatic::class.java.name,
+            "wrongMethod"
+        )
+        val activityMock = mockk<Activity>()
+        val testDelegate = getOneRegistryTestDelegate(listOf(entry), null)
+        val intent = mockk<Intent>(relaxed = true)
+        every { intent.data } returns uri
+        every { activityMock.intent } returns intent
+        val result =
+            testDelegate.createResult(activityMock, intent, testDelegate.findEntry(uriTemplate))
+        assertThat(result.isSuccessful).isFalse
+        assertThat(result.uriString).isEqualTo(uriString)
+        assertThat(result.error).isEqualTo("Deep link to non-existent method: wrongMethod")
+        assertThat(result.errorThrowable).isInstanceOf(BaseDeepLinkDelegate.DeeplLinkMethodError::class.java)
+        assertThat(result.errorThrowable?.cause).isInstanceOf(NoSuchMethodException::class.java)
+    }
+
+    @Test
+    fun testFindMethodDeepLinkethod() {
+        val uriTemplate = "airbnb://foo/{bar}"
+        val uriString = "airbnb://foo/1"
+        val uri = mockk<Uri>()
+        every { uri.toString() } returns uriString
+        val entry =
+            methodDeepLinkEntry(uriTemplate, TestDeepLinkClassStatic::class.java.name, "testMethod")
+        val activityMock = mockk<Activity>(relaxed = true)
+        val testDelegate = getOneRegistryTestDelegate(listOf(entry), null)
+        val intent = mockk<Intent>(relaxed = true)
+        every { intent.data } returns uri
+        every { activityMock.intent } returns intent
+        val result =
+            testDelegate.createResult(activityMock, intent, testDelegate.findEntry(uriTemplate))
+        assertThat(result.isSuccessful).isTrue
+        assertThat(result.uriString).isEqualTo(uriString)
+        assertThat(result.error).isEqualTo("")
+        assertThat(result.errorThrowable).isNull()
+    }
+
     @Test
     fun testFindEntry() {
         val entry = activityDeepLinkEntry("airbnb://foo/{bar}")
@@ -102,11 +148,8 @@ class BaseDeepLinkDelegateTest {
         val result = testDelegate.createResult(activity, intent, null)
         assertThat(result).isEqualTo(
             DeepLinkResult(
-                false, null, "No Uri in given activity's intent.", null,
-                DeepLinkMethodResult(
-                    null,
-                    null
-                ),
+                isSuccessful = false,
+                error = "No Uri in given activity's intent.",
                 deepLinkHandlerResult = null
             )
         )
@@ -128,7 +171,7 @@ class BaseDeepLinkDelegateTest {
         every { activity.applicationContext } returns appContext
         val errorHandler = DuplicatedMatchTestErrorHandler()
         val testDelegate = getTwoRegistriesTestDelegate(listOf(entry), listOf(entry), errorHandler)
-        val (_, _, _, match) = testDelegate.dispatchFrom(activity, intent)
+        val (_, _, _, _, match) = testDelegate.dispatchFrom(activity, intent)
         assertThat(errorHandler.duplicateMatchCalled).isTrue
         assertThat(errorHandler.duplicatedMatches).isNotNull
         assertThat(errorHandler.duplicatedMatches!!.size).isEqualTo(2)
@@ -155,7 +198,7 @@ class BaseDeepLinkDelegateTest {
         every { activity.applicationContext } returns appContext
         val errorHandler = DuplicatedMatchTestErrorHandler()
         val testDelegate = getTwoRegistriesTestDelegate(listOf(entry1), listOf(entry2), errorHandler)
-        val (_, _, _, deepLinkEntry) = testDelegate.dispatchFrom(activity, intent)
+        val (_, _, _, _, deepLinkEntry) = testDelegate.dispatchFrom(activity, intent)
         assertThat(errorHandler.duplicateMatchCalled).isFalse
         assertThat(deepLinkEntry!!.equals(entry2))
     }
@@ -184,6 +227,22 @@ class BaseDeepLinkDelegateTest {
             return DeepLinkEntry.ActivityDeeplinkEntry(uri, className)
         }
 
+        private fun methodDeepLinkEntry(
+            uri: String,
+            className: String,
+            methodName: String
+        ): DeepLinkEntry.MethodDeeplinkEntry {
+            return DeepLinkEntry.MethodDeeplinkEntry(uri, className, methodName)
+        }
+
+        private fun handlerDeepLinkEntry(
+            uri: String,
+            className: String,
+            methodName: String
+        ): DeepLinkEntry.MethodDeeplinkEntry {
+            return DeepLinkEntry.MethodDeeplinkEntry(uri, className, methodName)
+        }
+
         private fun getTwoRegistriesTestDelegate(entriesFirstRegistry: List<DeepLinkEntry>, entriesSecondRegistry: List<DeepLinkEntry>, errorHandler: ErrorHandler): TestDeepLinkDelegate {
             return TestDeepLinkDelegate(listOf(testRegistry(entriesFirstRegistry), testRegistry(entriesSecondRegistry)), errorHandler)
         }
@@ -193,3 +252,11 @@ class BaseDeepLinkDelegateTest {
         }
     }
 }
+
+object TestDeepLinkClassStatic {
+    @DeepLink("airbnb://foo/{bar}")
+    @JvmStatic
+    fun testMethod(context: Context): Intent {
+        return Intent()
+    }
+}