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

Using navigation version 2.6.0 and 2.7.1 the issue still persists.

After further investigation, the behaviour can be corrected by filtering on backstack entries where current state is at least started. In my opinion the name visibleEntries is misleading if it contains entries that are not actually visible or in transition.

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

Marked as fixed.

Note that as per the visibleEntries documentation, it is expected that there are entries that are in the CREATED state - those are the entries that are in the process of being removed (i.e., they are no longer in the back stack, but have not yet marked their transition as complete).

It is a bug that those entries aren't removed when their exit animation completes and that's what we'll be looking into.

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

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

commit f61da31809827bfac89af629c88ad9b8423e88b6
Author: Clara Fok <clarafok@google.com>
Date: Wed Sep 06 14:14:11 2023

Fix entry not marked complete after view is destroyed

As part of a fix for

b/279644470

in aosp/2566210, when the fragment view is destroyed, we would mark the transitioning (outgoing) entry as complete only if the entry has also been removed from backstack. However, in the simple navigate() case where the outgoing entry is not popped and remains in the backstack, this entry is not marked complete and ends up in the visibleEntries even though the view has been destroyed.

Now the backstack check in ON_DESTROY is no longer necessary to fix the original

b/279644470

bug -- the view being destroyed should be the right signal for completing entries regardless of whether transitioning effects are used. So this check is removed.

Test: ./gradlew navigation:navigation-fragment:cC
Test: ./gradlew navigation:navigation-runtime:cC
Bug: 288520638
Change-Id: I5caa9af1b5bd7084e76d7daf9515f7430bf2489d

M navigation/navigation-fragment/src/androidTest/java/androidx/navigation/fragment/FragmentNavigatorTest.kt
M navigation/navigation-fragment/src/androidTest/java/androidx/navigation/fragment/NavControllerWithFragmentTest.kt
M navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerTest.kt
M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.kt

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

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

Fixed internally and will be available in navigation 2.7.3

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

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.navigation:navigation-fragment:2.7.3
androidx.navigation:navigation-runtime:2.7.3

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

The issue no longer persists in version 2.7.3. Thank you all for the update.

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

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.navigation:navigation-fragment:2.8.0-alpha01
androidx.navigation:navigation-runtime:2.8.0-alpha01

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