IssueTracker

Project: platform/frameworks/support
Branch: androidx-main
Author: Clara Fok <clarafok@google.com>
Link:      https://android-review.googlesource.com/3490354

Fix deeplink incorrectly matching when deep link fields don’t match perfectly

Fix deeplink incorrectly matching when deep link fields don’t match perfectly 
 
Navigation used to allow matching as long as one of three (uri / action / mimType) matches. However this is erroneous, as each field is a defined filter - a potential match should at the very least fulfill all filters. 
 
This is fixed by applying these ground rules for deeplink matching: 
1. The added NavDeepLink field’s nullability has to match the NavDeepLinkRequest field’s nullability. i.e. if deeplink.uri is null, request.uri must also be null 
2. Any NavDeepLink non-null fields has to match exactly with NavDeepLinkRequest’s non-null fields 
 
To elaborate, consider this scenario where 
 
request: 
“www.example.com/13”, action = “theAction” 
 
potential matches: 
1. www.example.com/{id}, action = "theAction" 
2. www.differentUrl.com, action = "theAction" 
 
When handling this request , even though deeplink 2 has a matching action, the differing url will rule it out as a potential match. 
 
This fix also addresses a bug with wildcards where 
 
request: 
www.example.com/wildCardMatch?token=123, action = "theAction" 
 
potential matches: 
1. www.example.com/.*?token={id}, action = "theAction" 
2. www.example.com?token={id}, action = "theAction" 
 
Even though both deep links have a matching Action, deeplink 1 has a better Uri match, and so the request will now match with deeplink 1 instead of deeplink 2. 
 
Test: ./gradlew navigation:navigation-common:cC 
Test: ./gradlew navigation:navigation-runtime:cC 
Bug: 395712033 
Relnote: “NavDeepLink matching has been fixed where a deeplink and a deeplink request have to match exactly on uri, action, and mime. Matching is no longer allowed if only one or two fields match.“ 
Change-Id: I3b0295caa6324cc707d080856e88e62b4c3cd4d5

I think this fix has broken some other deeplinks.

I have the following defined in my NavHost file:

composable<Screen.AttractionDetail>(deepLinks = listOf(navDeepLink<Screen.AttractionDetail>(basePath = "gocity:/attraction"))) ...

@Serializable
data class AttractionDetail(val id: String, val hideBookmark: Boolean = false) : Screen

In one of my UI tests I have this code:

deeplinkNavigator("gocity:/attraction/$attractionId")

With 2.8.7 this works fine but as soon as I upgrade to 2.8.8 the deeplink no longer opens the AttractionDetail screen.

I've experimented with changing the data class to be val hideBookmark: Boolean? and to using uriPattern instead of basePath but I can't get this deeplink to work in 2.8.8

comment#6 I replicated your setup and the deeplink worked for me.

@Serializable
sealed interface Screen {
    @Serializable
    data class AttractionDetail(val id: String, val hideBookmark: Boolean = false) : Screen
}

controller.graph =
    controller.createGraph(startDestination = "start") {
        ...
        composable<Screen.AttractionDetail> { deepLink(navDeepLink<Screen.AttractionDetail>("gocity:/attraction")) }
    }

val request = NavDeepLinkRequest(Uri.parse("gocity:/attraction/13"), null, null)
val handled = controller.handleDeepLink(request)

Can you file a separate bug and attach a repro?

comment#6, comment#7

I also had problem after updating to version 2.8.8.

Explicitly setting action to Intent.ACTION_VIEW in the Deep Link builder now may be required if your intent filter for deeplink schema has android.intent.action.VIEW. At least that's how I solved the issue that I got after using version 2.8.8.

See example:

Manifest:

<intent-filter>
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data
                    android:scheme="company"
                    android:host="app"
                    android:pathPattern="/.*" />
            </intent-filter>

In broadcast receiver:

//...
val deepLinkUri = NavDeepLinks.progressDeepLink.uriPattern
val intent = Intent(
            Intent.ACTION_VIEW,
            Uri.parse(deepLinkUri) //
        ).apply {
            flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP
            `package` = context.packageName
        }

        val pendingIntent = PendingIntent.getActivity(
            context,
            0,
            intent,
            PendingIntent.FLAG_IMMUTABLE
        )
//...

Definition of DeepLink using builder:

    val progressDeepLink = navDeepLink {
        uriPattern = "$BASE/${Path.PROGRESS}"
        action = Intent.ACTION_VIEW
    }

Compose Navigation Graph Builder:

navigation<LimitsDirection>(
                deepLinks = listOf(NavDeepLinks.limitsDeepLink)
            ) {
                    LimitsScreen(viewModel = limitsViewModel)
            }

I hope that helps you.

Also, may be this fix requires some update for documentation and/or guides