Add deep link validation in addDeeplink

androidx · Jul 20, 2021 · 2a2d790 · 2a2d790
1 parent a76a2f5
commit 2a2d790
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/...n/navigation-common/src/androidTest/java/androidx/navigation/NavDestinationAndroidTest.kt b/...n/navigation-common/src/androidTest/java/androidx/navigation/NavDestinationAndroidTest.kt
@@ -282,9 +282,8 @@ class NavDestinationAndroidTest {
         val destination = NoOpNavigator().createDestination()
         destination.addArgument("testString", stringArgument())
         destination.addDeepLink("android-app://androidx.navigation.test/{testString}")
-        val deepLink = Uri.parse("android-app://androidx.navigation.test/test")
-        destination.addDeepLink(deepLink.toString())
 
+        val deepLink = Uri.parse("android-app://androidx.navigation.test/test")
         assertWithMessage("Deep link should match")
             .that(destination.hasDeepLink(deepLink)).isTrue()
     }

diff --git a/navigation/navigation-common/src/main/java/androidx/navigation/NavDeepLink.kt b/navigation/navigation-common/src/main/java/androidx/navigation/NavDeepLink.kt
@@ -54,6 +54,10 @@ public class NavDeepLink internal constructor(
 
     private var mimeTypePattern: Pattern? = null
 
+    /** Arguments present in the deep link, including both path and query arguments. */
+    internal val argumentsNames: List<String>
+        get() = arguments + paramArgMap.keys
+
     public var isExactDeepLink: Boolean = false
         /** @suppress */
         @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)

diff --git a/navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt b/navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt
@@ -314,6 +314,14 @@ public open class NavDestination(
      * @see NavController.navigate
      */
     public fun addDeepLink(navDeepLink: NavDeepLink) {
+        val missingRequiredArguments = arguments.filterValues { !it.isDefaultValuePresent }
+            .keys
+            .filter { it !in navDeepLink.argumentsNames }
+        require(missingRequiredArguments.isEmpty()) {
+            "Deep link ${navDeepLink.uriPattern} can't be used to open destination $this.\n" +
+                "Following required arguments are missing: $missingRequiredArguments"
+        }
+
         deepLinks.add(navDeepLink)
     }