AGP KMP breaks Gradle metadata for KMP projects that target JVM [396184120]

Fixed

Bug

Status Update

No update yet.

Description

da...@google.com

created issue #1

Feb 12, 2025 09:13PM

Applying the newer AGP KMP plugin to androidx.sqlite breaks the Gradle metadata such that a JVM project depending on the artifact will attempt (and fail) to use the android artifact instead of the JVM one.

This was originally reported in SQLite KMP b/396148592

Here is a diff on the metadata, left is before AGP KMP is used (i.e. after reverting the changes in this CL) and right is with AGP KMP applied: https://diff.googleplex.com/#key=EY2FqaJWQbUQ

Let me know if you need a sample project, but if you create a new JVM or Kotlin project and depend on androidx.sqlite:sqlite:2.5.0-beta01 and try to use classes from it, it will fail at runtime with a class not found exception. When inspecting the deps via :dependencies you will notice it attempts to use the -android artifact instead of the -jvm one:

runtimeClasspath - Runtime classpath of 'main'.
+--- org.jetbrains.kotlin:kotlin-stdlib:2.1.10
|    \--- org.jetbrains:annotations:13.0
\--- androidx.sqlite:sqlite:2.5.0-beta01
     +--- androidx.annotation:annotation:1.8.1
     |    \--- androidx.annotation:annotation-jvm:1.8.1
     |         \--- org.jetbrains.kotlin:kotlin-stdlib:1.7.10 -> 2.1.10 (*)
     +--- androidx.sqlite:sqlite-android:2.5.0-beta01
     |    +--- androidx.annotation:annotation:1.8.1 (*)
     |    +--- org.jetbrains.kotlin:kotlin-stdlib -> 2.1.10 (*)
     |    \--- org.jetbrains.kotlin:kotlin-stdlib:2.1.10 (c)
     \--- org.jetbrains.kotlin:kotlin-stdlib:2.1.10 (*)

Comments

au...@google.com <au...@google.com> #2Feb 12, 2025 09:28PM

Yes, this is correct. Having individual navigation graphs on each activities overrides or disallow up navigation to the main activity.

da...@google.com <da...@google.com> #3Feb 12, 2025 09:34PM

I believe I have found the potential problem that is causing this:
// @ androidx.navigation.NavController
// line 124

// Now record the pop operation that we were sent
if (!mBackStack.isEmpty()) {
mBackStack.removeLast();
}
// We never want to leave NavGraphs on the top of the stack
while (!mBackStack.isEmpty()
&& mBackStack.peekLast() instanceof NavGraph) {
popBackStack();
}

the condition in while loop is never satisfied because of the above `if` statement above it has already removed the last item of the mBackStack (which was the NavGraph) and thus popBackStack() is never called again.

au...@google.com <au...@google.com> #4Feb 12, 2025 09:39PM

According to Ian Lake, NavigationUI does not support up navigation yet, that is why this is a feature request.

+Pedro Varela - we don't support navigating up through activities as part of NavigationUI yet, please star the feature request:

https://issuetracker.google.com/issues/79993862 (this issue)

da...@google.com <da...@google.com> #5Feb 12, 2025 09:45PM

Ian Lake said Up navigation is not supported through activities, only through fragments.

Message last modified on Feb 12, 2025 09:46PM

sqlitedrivertest.zip

182 KB

Download

da...@google.com <da...@google.com> #6Feb 12, 2025 09:56PM

With the introduction of AppBarConfiguration, this is now possible with the setupActionBarWithNavController method by using an empty set of top level destinations (to always show the up button) and then overriding onSupportNavigateUp() as per the documentation:

https://developer.android.com/topic/libraries/architecture/navigation/navigation-ui#action_bar

I'll leave this bug open as we still need an equivalent API for the Toolbar versions.

hm...@google.com <hm...@google.com> #7Feb 13, 2025 10:15AM

https://android-review.googlesource.com/846338 adds a setFallbackOnNavigateUpListener method on AppBarConfiguration that allows you to register an OnNavigateUpListener to handle cases where navController.navigateUp() return false.

This allows you to call onSupportNavigateUp() (or super.onSupportNavigateUp() if you're using an ActionBar) from that method to have your Up button transition between activities.

This will be available in 1.0.0-alpha09.

Message last modified on Feb 13, 2025 12:58PM

hm...@google.com <hm...@google.com> #8Feb 13, 2025 01:15PM

There is Jarks when implementing this way to navigate up between activities.

hm...@google.com <hm...@google.com> #9Feb 13, 2025 01:46PM

Oh,i missed the libraryelements one from the list. Looks like jvmRuntimeElements does not publish that attribute and the android one does (and it's a wrong one as mentioned before). So it looks like that could the reason for the wrong variant resolution.

da...@google.com <da...@google.com> #10Feb 13, 2025 02:03PM

The library is from androidx, we are using 8.9.0-beta01

I did also notice the compile classpath is fine, after all it compiles correctly and the APIs do resolve in the IDE, but at runtime it fails.

da...@google.com <da...@google.com> #11Feb 13, 2025 07:22PM

So far we have found that from alpha12 (good version) to alpha13 (bad version) of androidx.sqlite, one change that affected the metadata was the upgrade from Gradle 8.11.1 to 8.12, this is a diff of the metadata: https://diff.googleplex.com/#key=2ZkNTETNoG0R.

Notice the removal of the org.gradle.libraryelements attribute. The attribute is also missing with Gradle 8.13-rc1

Message last modified on Feb 13, 2025 07:23PM

ow...@google.com <ow...@google.com> Feb 18, 2025 05:47PM

Reassigned to hm...@google.com.

hm...@google.com <hm...@google.com> #12Feb 26, 2025 12:40PM

Update on libraryelements attribute missing in jvm target publications with Gradle 8.12 - Jetbrain are saying it will be fixed after https://youtrack.jetbrains.com/issue/KT-36004/Update-org.gradle.usage-attribute-rules-to-support-the-JAVAAPI-and-JAVARUNTIME-value which is targeting KGP 2.1.21. Temporary fix could be for androidX to explicitly set libraryelements attribute to "jar" for the jvm api/runtime elements publications.

By the way I have noticed a weird behaviour - if you do ./gradlew publish in your project libraryelements is not there for jvm publications but if you do ./gradlew publishJvmPublicationToMavenRepository it's there

Daniel, Owen, let me know if this is enough info to proceed further with a fix.

hm...@google.com <hm...@google.com> #13Mar 3, 2025 10:25AM

Reassigned to da...@google.com.

For the issue of the android publications where "org.gradle.libraryelements" = "jar" instead of "aar" - that was fixed in AGP 8.10 canary 7. Please feel free to try it out and report back. Thank you

da...@google.com <da...@google.com> Mar 3, 2025 01:42PM

Marked as fixed.

au...@google.com <au...@google.com> #14Mar 4, 2025 05:12PM

FYI danysantiago@ we have upgraded to 8.10.0-alpha07 in androidx.