Move Animation APIs from Accompanist back into Jetpack Navigation [197140101]

Fixed

Feature Request

Status Update

No update yet.

Description

jb...@google.com

created issue #1

Aug 18, 2021 08:31PM

As of compose 1.0.1 many of the Compose Animation APIs are still @Experimental.

Because of AndroidX internal restrictions, modules cannot depend on experimental APIs from other modules.

In the interest of providing a solution for Navigation with custom Compose Animations as soon as possible, we opted to provide a new module in Accompanist Navigation. Once all the required animation APIs become stable, which is planned as part of Compose 1.1.0, we will move the implementation back into the Jetpack Navigation library from Accompanist Navigation Animation.

For more details, see the Animations in Navigation Compose blog post.

Comments

ti...@gmail.com <ti...@gmail.com> #2Feb 12, 2022 08:03PM

Yigit, do you have time to fix it?

reemission of the same liveData is racy

il...@google.com <il...@google.com> #3Feb 14, 2022 05:19PM

yea i'll take it.

ti...@gmail.com <ti...@gmail.com> #4Aug 2, 2022 04:09PM

Thanks for the detailed analysis. This may not be an issue anymore since we've started using Main.immediate there but I' not sure; I'll try to create a test case.

ru...@gmail.com <ru...@gmail.com> #5Jan 25, 2023 06:32AM

just emitting same live data reproduces the issue.

@Test
fun raceTest() {
val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData)
emitSource(subLiveData) //crashes
}
subject.addObserver().apply {
testScope.advanceUntilIdle()
}
}

k8...@gmail.com <k8...@gmail.com> #6Mar 21, 2023 02:11PM

With 2.2.0-alpha04 (that use Main.immediate), the issue seems to be still there (I tested it by calling emitSource() twice, like your test case)

il...@google.com <il...@google.com> #7Mar 21, 2023 04:16PM

yea sorry immediate does not fix it.
I actually have a WIP fix for it:

https://android-review.googlesource.com/c/platform/frameworks/support/+/1112186

if your case is the one i found (emitting same LiveData multiple times, as shown in #5) you can work around it by adding a dummy transformation.

val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData.map {it })
emitSource(subLiveData.map {it} )
}

jb...@google.com <jb...@google.com> May 8, 2023 06:11PM

Reassigned to cl...@google.com.

ap...@google.com <ap...@google.com> #8May 11, 2023 04:32PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit af12e75e6b4110f48e44ca121466943909de8f06
Author: Yigit Boyar <yboyar@google.com>
Date: Tue Sep 03 12:58:11 2019

Fix coroutine livedata race condition

This CL fixes a bug in liveData builder where emitting same
LiveData source twice would make it crash because the second
emission registry could possibly happen before first one is
removed as source.

We fix it by using a suspending dispose function. It does feel
a bit hacky but we cannot make DisposableHandle.dispose async
and we do not want to block there. This does not mean that there
is a problem if developer disposes it manually since our emit
functions take care of making sure it disposes (and there is
no other way to add source to the underlying MediatorLiveData)

Bug: 140249349
Test: BuildLiveDataTest#raceTest_*

Change-Id: I0b464c242a583da4669af195cf2504e2adc4de40

M lifecycle/lifecycle-livedata-ktx/api/2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/current.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_current.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_current.txt
M lifecycle/lifecycle-livedata-ktx/src/main/java/androidx/lifecycle/CoroutineLiveData.kt
M lifecycle/lifecycle-livedata-ktx/src/test/java/androidx/lifecycle/BuildLiveDataTest.kt

https://android-review.googlesource.com/1112186

https://goto.google.com/android-sha1/af12e75e6b4110f48e44ca121466943909de8f06

ap...@google.com <ap...@google.com> #9May 11, 2023 04:32PM

Project: platform/frameworks/support
Branch: androidx-main

commit 256f919c6b8d579bc55e19d829aed438422f463b
Author: Clara Fok <clarafok@google.com>
Date: Wed May 10 10:48:32 2023

Migrate accompanist NavHost and NavController into androidx

Test: ./gradlew navigation:navigation-compose:cC
Bug: 197140101
Relnote: "NavHost and NavController now supports navigating in compose with Animations."
Change-Id: Ica95e794ef1794df4d1bdb38719b55624f832868

M navigation/navigation-compose/api/current.txt
M navigation/navigation-compose/api/public_plus_experimental_current.txt
M navigation/navigation-compose/api/restricted_current.txt
M navigation/navigation-compose/src/androidTest/java/androidx/navigation/compose/NavHostControllerTest.kt
M navigation/navigation-compose/src/androidTest/java/androidx/navigation/compose/NavHostTest.kt
M navigation/navigation-compose/src/main/java/androidx/navigation/compose/ComposeNavigator.kt
M navigation/navigation-compose/src/main/java/androidx/navigation/compose/NavGraphBuilder.kt
M navigation/navigation-compose/src/main/java/androidx/navigation/compose/NavHost.kt

https://android-review.googlesource.com/2584843

ap...@google.com <ap...@google.com> #10May 11, 2023 04:32PM

Project: platform/frameworks/support
Branch: androidx-main

commit 682bae8ada2b2b29376003d55455230ff7320a69
Author: Clara Fok <clarafok@google.com>
Date: Tue May 09 15:13:14 2023

Migrate accompanist NavGraphBuilder into androidx

Test: ./gradlew navigation:navigation-compose:cC
Bug: 197140101
Relnote: "NavGraphBuilder now supports building composables and NavGraphs with transition animations."
Change-Id: I5ca9e22c8c3b02acaf80ddaa35b58ba7426c993a

M navigation/navigation-compose/src/main/java/androidx/navigation/compose/NavGraphBuilder.kt

https://android-review.googlesource.com/2584842

ap...@google.com <ap...@google.com> #11May 11, 2023 04:32PM

Project: platform/frameworks/support
Branch: androidx-main

commit 895c4bb35ee11fe1c54f538699a845ddfaf7e2eb
Author: Clara Fok <clarafok@google.com>
Date: Tue May 09 13:14:10 2023

Migrate accompanist ComposeNavigator into androidx

Test: ./gradlew navigation:navigation-compose:cC
Bug: 197140101
Relnote: "ComposeNavigator now supports Destinations with Animations."
Change-Id: Ie33b4c2da53ff6c89494332a06be8123be67e879

M navigation/navigation-compose/src/main/java/androidx/navigation/compose/ComposeNavigator.kt

https://android-review.googlesource.com/2584841

ap...@google.com <ap...@google.com> #12May 11, 2023 04:32PM

Project: platform/frameworks/support
Branch: androidx-main

commit 169254301b8aad0454c253a65abff7bf174ba164
Author: Clara Fok <clarafok@google.com>
Date: Tue May 09 11:11:42 2023

Bump compose version in navigation-compose

Bump from 1.0.1 to ToT project dependency. Project dependency because compose is currently in alpha.

Test: n/a
Bug: 197140101
Relnote: "navigation-compose has bumped compose dependency to use latest compose dependency"
Change-Id: Ide442548636637c2b75d46ef99c9913b0ebb60b8

M navigation/navigation-compose/build.gradle

https://android-review.googlesource.com/2584840

il...@google.com <il...@google.com> #13May 11, 2023 11:12PM

Marked as fixed.

Now that AnimatedContent is stable, we were able to move the code from Accompanist Navigation Animation back into Navigation Compose itself.

This means all of the support for setting custom transitions that existed in AnimatedNavHost is directly supported in NavHost.

This is available in snapshot builds right now and will be released as part of Navigation 2.7.0-alpha01. Note that as part of this, Navigation Compose now depends on Compose 1.5.

We'll be publishing a deprecation guide once Navigation 2.7.0-alpha01 is released, but it'll be essentially the inverse of the migration guide with no other API changes required if you're already using the latest Accompanist alpha (0.31.2-alpha).