AGP 8.7.0 - Lint False Positive RestrictedApi on NavOptionsBuilder.popUpTo [370694831]

Fixed

Bug

Status Update

No update yet.

Description

ey...@gmail.com

created issue #1

Oct 1, 2024 07:15PM

DESCRIBE THE ISSUE IN DETAIL:

After updating to 8.7.0 I am getting a false positive RestrictedApi error saying that I cannot call NavOptionsBuilder.popUpTo because it is restricted to the library scope.

My call:

navController.navigate(Routes.Onboarding) {
  popUpTo(navController.rootRoute()) {
    inclusive = true
  }
}

popUpTo resolves to:

@Suppress("BuilderSetStyle", "MissingJvmstatic")
public fun <T : Any> popUpTo(route: T, popUpToBuilder: PopUpToBuilder.() -> Unit = {}) {
    popUpToRouteObject = route
    popUpToId = -1
    popUpToRoute = null
    val builder = PopUpToBuilder().apply(popUpToBuilder)
    inclusive = builder.inclusive
    saveState = builder.saveState
}

which does not have a RestrictTo annotation. There is an overload that does though:

// this restricted public is needed so that the public reified [popUpTo] can call
// private popUpToRouteClass setter
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public fun <T : Any> popUpTo(klass: KClass<T>, popUpToBuilder: PopUpToBuilder.() -> Unit) {
    popUpToRouteClass = klass
    popUpToId = -1
    popUpToRoute = null
    val builder = PopUpToBuilder().apply(popUpToBuilder)
    inclusive = builder.inclusive
    saveState = builder.saveState
}

Comments

hu...@google.com <hu...@google.com> Oct 1, 2024 09:09PM

Assigned to an...@google.com.

js...@google.com <js...@google.com> #2Oct 2, 2024 06:54AM

Reassigned to js...@google.com.

I don't think the average developer understands the distinction between method references and method definitions in this context (inside a DEX file). I know I don't.

@jvg, can you elaborate?

ey...@gmail.com <ey...@gmail.com> #3Oct 2, 2024 11:44AM

people who are looking at the bytecode in the dex to optimize their app through shrinking hopefully will learn the difference as string tables for method references between various dex files can account for quite a bit of disk space. but more importantly a definition is something you can analyze its code for where a reference you can't so the UI can be confusing without seeing the difference

js...@google.com <js...@google.com> #4Oct 4, 2024 06:20AM

Accepted by js...@google.com.

How about something like this?

I think having defined members be directly under the class node while references are nested in a group makes more sense.

Also note that the method refs have a slightly different icon. There is no existing equivalent for field refs that I could find.

https://screenshot.googleplex.com/4yXVM9Rzh4wnkjM.png

js...@google.com <js...@google.com> Oct 4, 2024 03:24PM

Marked as fixed.

an...@google.com <an...@google.com> #5Oct 14, 2024 09:08PM

sounds reasonable to me, thanks

ey...@gmail.com <ey...@gmail.com> #6Oct 20, 2024 09:18AM

Thank you for your patience while our engineering team worked to resolve this issue. A fix for this issue is now available in:

Android Studio Ladybug Feature Drop | 2024.2.2 Canary 4
Android Gradle Plugin 8.8.0-alpha04

We encourage you to try the latest update.

If you notice further issues or have questions, please file a new bug report.

Thank you for taking the time to submit feedback — we really appreciate it!

js...@google.com <js...@google.com> #7Oct 20, 2024 05:44PM

Thanks for the question; I missed the patch 1, but then realized that the patch 2 is due soon. I'll prepare the cherry-pick.

js...@google.com <js...@google.com> #8Oct 21, 2024 06:08PM

^ Done. Will be in 8.7.2

an...@google.com <an...@google.com> #9Oct 31, 2024 07:41PM

The fixes for this issue are now also available in:

Android Studio Ladybug | 2024.2.1 Patch 2
Android Gradle Plugin 8.7.2

We encourage you to try the latest update.

If you notice further issues or have questions, please file a new bug report.

du...@gmail.com <du...@gmail.com> #10
Restricted+
Nov 22, 2024 02:37AM

Comment has been deleted.

deleted

Restricted+

0 B

ch...@gmail.com <ch...@gmail.com> #11Jan 2, 2025 04:07PM