open() and close() don't work when using LOCK_MODE_LOCKED_CLOSED [162253907]

Fixed

Bug

Status Update

No update yet.

Description

il...@google.com

created issue #1

Jul 27, 2020 08:18PM

Component used: DrawerLayout Version used: 1.1.0

When attempting to use the Openable APIs of open() and close(), they do not work if you are using LOCK_MODE_LOCKED_CLOSED. As per its documentation:

The user may not open it, though the app may open it programmatically.

So programmatically opening/closing the drawer should be allowed. This would make it consistent with openDrawer() and closeDrawer().

Comments

il...@google.com <il...@google.com> Jul 28, 2020 12:57AM

Accepted by il...@google.com.

ap...@google.com <ap...@google.com> #2Jul 28, 2020 03:42PM

Yigit, do you have time to fix it?

reemission of the same liveData is racy

il...@google.com <il...@google.com> #3Jul 28, 2020 05:47PM

Marked as fixed.

yea i'll take it.

ap...@google.com <ap...@google.com> #4Jul 28, 2020 05:55PM

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.

ap...@google.com <ap...@google.com> #5Jul 28, 2020 06:01PM

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()
}
}

ap...@google.com <ap...@google.com> #6Jul 28, 2020 07:29PM

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)

ap...@google.com <ap...@google.com> #7Jul 28, 2020 07:31PM

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} )
}

ap...@google.com <ap...@google.com> #8Jul 28, 2020 09:09PM

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> #9Jul 28, 2020 09:11PM

Project: platform/frameworks/support
Branch: snap-temp-L68100000649916060

commit e33fcbc8c30a40594cfcfbb643018e2bfe024820
Author: Ian Lake <ilake@google.com>
Date: Mon Jul 27 17:51:04 2020

Ensure open() and close() always work

As per the Javadoc on LOCK_MODE_LOCKED_CLOSED
and LOCK_MODE_LOCKED_OPEN, the app should
still be able to open() and close() the drawer
programmatically.

This change aligns open() and close() with
openDrawer() and closeDrawer() to allow
programmatic usage no matter what LOCK_MODE
is used.

Test: tested in sample app
BUG: 162253907
Change-Id: I74f2f7ea5ff8ce06bfcfeff09aedd980f385ffc7
(cherry picked from commit ae09f6e6686b32c5677c086d51d5737553e2aeb9)

M drawerlayout/drawerlayout/src/main/java/androidx/drawerlayout/widget/DrawerLayout.java

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

ap...@google.com <ap...@google.com> #10Jul 29, 2020 08:31PM

Project: platform/frameworks/support
Branch: snap-temp-L86900000650841826

commit 3ad4cab4e570828fddbf650934a4e9efdd8405e0
Author: Ian Lake <ilake@google.com>
Date: Mon Jul 27 17:51:04 2020

Ensure open() and close() always work

As per the Javadoc on LOCK_MODE_LOCKED_CLOSED
and LOCK_MODE_LOCKED_OPEN, the app should
still be able to open() and close() the drawer
programmatically.

This change aligns open() and close() with
openDrawer() and closeDrawer() to allow
programmatic usage no matter what LOCK_MODE
is used.

Test: tested in sample app
BUG: 162253907
Change-Id: I74f2f7ea5ff8ce06bfcfeff09aedd980f385ffc7
(cherry picked from commit ae09f6e6686b32c5677c086d51d5737553e2aeb9)

M drawerlayout/drawerlayout/src/main/java/androidx/drawerlayout/widget/DrawerLayout.java

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

ap...@google.com <ap...@google.com> #11Jul 29, 2020 08:35PM

Project: platform/frameworks/support
Branch: snap-temp-L89900000650843240

commit 978cae5a010bf4c0c1b6fcfd68fd1b1c7802e126
Author: Ian Lake <ilake@google.com>
Date: Mon Jul 27 17:51:04 2020

Ensure open() and close() always work

As per the Javadoc on LOCK_MODE_LOCKED_CLOSED
and LOCK_MODE_LOCKED_OPEN, the app should
still be able to open() and close() the drawer
programmatically.

This change aligns open() and close() with
openDrawer() and closeDrawer() to allow
programmatic usage no matter what LOCK_MODE
is used.

Test: tested in sample app
BUG: 162253907
Change-Id: I74f2f7ea5ff8ce06bfcfeff09aedd980f385ffc7
(cherry picked from commit ae09f6e6686b32c5677c086d51d5737553e2aeb9)

M drawerlayout/drawerlayout/src/main/java/androidx/drawerlayout/widget/DrawerLayout.java

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

ap...@google.com <ap...@google.com> #12Jul 29, 2020 08:55PM

Project: platform/frameworks/support
Branch: snap-temp-L89900000650864753

commit 2754768be7ccfd570f9355ab74406157e3a69d92
Author: Ian Lake <ilake@google.com>
Date: Mon Jul 27 17:51:04 2020

Ensure open() and close() always work

As per the Javadoc on LOCK_MODE_LOCKED_CLOSED
and LOCK_MODE_LOCKED_OPEN, the app should
still be able to open() and close() the drawer
programmatically.

This change aligns open() and close() with
openDrawer() and closeDrawer() to allow
programmatic usage no matter what LOCK_MODE
is used.

Test: tested in sample app
BUG: 162253907
Change-Id: I74f2f7ea5ff8ce06bfcfeff09aedd980f385ffc7
(cherry picked from commit ae09f6e6686b32c5677c086d51d5737553e2aeb9)

M drawerlayout/drawerlayout/src/main/java/androidx/drawerlayout/widget/DrawerLayout.java

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

an...@google.com <an...@google.com> #13Jul 29, 2020 08:56PM

The following changes were cherrypicked through Coastguard
Release Track: 5549033339944960
Changes: aosp/1373433

an...@google.com <an...@google.com> #14Oct 5, 2020 08:26PM

The following changes were cherrypicked through Coastguard
Release Track: 6205454677704704
Changes: aosp/1378185

ap...@google.com <ap...@google.com> #15Oct 6, 2020 09:30PM

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

commit c403da82b263cf8078bacafb9f4661e279a3089c
Author: Ian Lake <ilake@google.com>
Date: Tue Oct 06 13:24:40 2020

Update navigation-ui to depend on DrawerLayout 1.1.1

DrawerLayout 1.1.1 includes a fix to the open()
call used by NavigationUI when locking the drawer.

Test: tested as part of

b/162253907

Relnote: "`navigation-ui` now depends on
[DrawerLayout 1.1.1](/jetpack/androidx/releases/drawerlayout#1.1.1),
ensuring that `NavigationUI` is able to open the drawer
even when using `LOCK_MODE_LOCKED_CLOSED` or
`LOCK_MODE_LOCKED_OPEN`."

Change-Id: Ie2eeec35770138e9d69396c0eea3c1a45e7d757b

M navigation/navigation-ui/build.gradle

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

an...@google.com <an...@google.com> #16Oct 6, 2020 09:43PM

The following changes were cherrypicked through Coastguard
Release Track: 6205454677704704
Changes: aosp/1451099