Provide a Navigation Compose API for correctly adding a custom Navigator [193555369]

Fixed

Bug

androidx-bug-bounty

Status Update

No update yet.

Description

ch...@stageten.tv

created issue #1

Jul 14, 2021 02:54PM

Component used: Navigation
Version used: 2.4.0-alpha04
Devices/Android versions reproduced on: Samsung A51, Android version 11

It's my understanding that when using a custom Navigator, this should be added to NavController via SideEffect. However, doing so produces IllegalStateException:

java.lang.IllegalStateException: Could not find Navigator with name "MyCustomNavigator". You must call NavController.addNavigator() for each navigation type.
at androidx.navigation.NavigatorProvider.getNavigator(NavigatorProvider.kt:67)
at androidx.navigation.NavigatorProvider.getNavigator(NavigatorProvider.kt:49)
at tv.stageten.composesideeffectaddnavigator.MainActivityKt.customDestination(MainActivity.kt:72)
...

If you add the Navigator outside of SideEffect, there is no exception.

The issue can be reproduced with this app:
https://github.com/chrisfillmore/compose_side_effect_add_navigator

Here's MainActivity with the relevant code:
https://github.com/chrisfillmore/compose_side_effect_add_navigator/blob/master/app/src/main/java/tv/stageten/composesideeffectaddnavigator/MainActivity.kt

Comments

ch...@stageten.tv <ch...@stageten.tv> #2Jul 14, 2021 02:59PM

Known issue, we cannot do anything because AGP doesn't provide an API to fetch Kotlin sources (specifically here https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:buildSrc/private/src/main/kotlin/androidx/build/java/JavaCompileInputs.kt;l=88), i failed to find an FR for it, so it must have been a chat conversation.

il...@google.com <il...@google.com> #3Jul 14, 2021 11:38PM

Would you be opposed to failing the build if we see a src/kotlin directory?

il...@google.com <il...@google.com> Jul 16, 2021 06:13PM

Assigned to il...@google.com.

ap...@google.com <ap...@google.com> #4Sep 20, 2021 03:17PM

No, go ahead if you want to add that check.

il...@google.com <il...@google.com> #5Sep 20, 2021 06:26PM

Marked as fixed.

Adding to bounty list since this isn't a frequent occurrence.

Sponsor: alanv
Tech stack: Gradle build plugin
Summary: Add check in AndroidXPluginImpl that raises an exception if a project is using src/kotlin for its source sets. The exception should indicate that src/kotlin is not fully supported by AGP and that src/java should be used instead.

ch...@stageten.tv <ch...@stageten.tv> #6Sep 20, 2021 07:37PM

I'm seeing one library that's using src/main/kotlin and seems to generate API files without issue: paging/paging-common. Aurimas, any idea what might be going on there?

Issue 193555369