Unreachable NavBackStackEntryStates saved in NavController [309559751]

Fixed

Bug

Status Update

No update yet.

Description

ja...@icloud.com

created issue #1

Nov 7, 2023 03:50PM

Component used: Navigation
Version used: 2.5.3
Devices/Android versions reproduced on: Any

When popping the back stack with saveState=true, destinations are only added to backStackMap if they are not already present (courtesy of the takeWhile operations in popBackStackInternal). The savedState array is subsequently added to backStackStates regardless. In the case that no destinations are added to backStackMap, the savedState array subsequently becomes unreachable/unrestorable, as there is no reference to the back stack name/uuid key anywhere.

To reproduce the issue:

(1) Launch the NavigationAdvancedSample app in debug mode
(2) Repeat the following several times:
(a) Tap the "About" button to navigate to the about screen
(b) Tap the "Leaderboard" bottom navigation item to navigate to the leaderboard screen
(b) Tap the back button or swipe back to navigate to the title screen again
(3) After several repeats, inspect the navController's backStackStates (which will be sizeable) and backStackMap (the values of which will not contain most of backStackStates' keys, rendering them indefinitely unreachable in restoreStateInternal

Potential fix:

Make "backStackStates[firstState.id] = savedState" conditional on at least one addition to backStackMap

Comments

jb...@google.com <jb...@google.com> #2Nov 7, 2023 03:54PM

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

commit 016fab7f37837deb6e0924730ed70b81042c36db
Author: Elif Bilgin <elifbilgin@google.com>
Date: Tue Jan 25 15:16:26 2022

Converting `query interceptor` related files in `room-runtime` from Java to Kotlin.

Test: N/A
Bug: 206859668
Relnote: Converting `query` related files in `room-runtime` from Java to Kotlin.
Change-Id: I92b932b1a1037c68195140ffb038f8add17d8de4

M room/room-runtime/src/main/java/androidx/room/RoomDatabase.java
M room/room-runtime/src/main/java/androidx/room/QueryInterceptorStatement.kt
M room/room-runtime/src/main/java/androidx/room/QueryInterceptorOpenHelperFactory.kt
M room/room-runtime/src/main/java/androidx/room/QueryInterceptorOpenHelper.kt
M room/room-runtime/src/main/java/androidx/room/QueryInterceptorProgram.kt
M room/room-runtime/src/main/java/androidx/room/QueryInterceptorDatabase.kt

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

ja...@icloud.com <ja...@icloud.com> #3Nov 7, 2023 04:02PM

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

commit 049d12d74b775c193e641a3fd11fb4b3c5c20dc6
Author: Elif Bilgin <elifbilgin@google.com>
Date: Tue Jan 25 15:37:31 2022

Converting `paging` related files in `room-runtime` from Java to Kotlin.

Test: LimitOffsetDataSourceTest.java
Bug: 206859668
Relnote: Converting `paging` related files in `room-runtime` from Java to Kotlin.
Change-Id: I82fc81469540315dbe4865ccde68396a4339dfd9

M room/room-runtime/api/restricted_current.txt
M room/room-runtime/src/main/java/androidx/room/paging/LimitOffsetDataSource.kt
M room/room-runtime/api/restricted_current.ignore
M room/room-runtime/build.gradle

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

jb...@google.com <jb...@google.com> #4Nov 7, 2023 09:24PM

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

commit 04773d8513b7ce6fbea263031c7618144c6e695d
Author: Elif Bilgin <elifbilgin@google.com>
Date: Tue Jan 25 15:34:19 2022

Converting `util` related files in `room-runtime` from Java to Kotlin.

Test: Existing tests in Java for util/. These will be migrated later as a safe migration measure.
Bug: 206859668
Relnote: Converting `util` related files in `room-runtime` from Java to Kotlin.
Change-Id: I697ee52d9234358fd83dc8d94c66d4f2b849fc1b

M room/room-runtime/src/test/java/androidx/room/util/UUIDUtilTest.kt
M room/room-paging/src/androidTest/kotlin/androidx/room/paging/LimitOffsetPagingSourceTest.kt
M room/room-runtime/api/restricted_current.txt
M room/room-runtime/src/main/java/androidx/room/util/StringUtil.kt
M room/room-runtime/src/main/java/androidx/room/util/FileUtil.kt
M room/room-runtime/src/main/java/androidx/room/util/FtsTableInfo.kt
M room/room-runtime/src/main/java/androidx/room/util/UUIDUtil.kt
M room/room-runtime/src/main/java/androidx/room/util/CursorUtil.kt
M room/room-runtime/src/test/java/androidx/room/util/CursorUtilTest.kt
M room/room-paging/src/main/kotlin/androidx/room/paging/LimitOffsetPagingSource.kt
M room/room-runtime/src/main/java/androidx/room/util/TableInfo.kt
M room/room-compiler/build.gradle
M room/room-runtime/api/current.txt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/vo/StringToIntListConverters.kt
M room/room-runtime/src/main/java/androidx/room/util/ViewInfo.kt
M room/room-runtime/api/public_plus_experimental_current.txt
M room/room-runtime/api/restricted_current.ignore
M room/room-runtime/src/main/java/androidx/room/util/DBUtil.kt

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

ja...@icloud.com <ja...@icloud.com> #5Nov 8, 2023 12:08AM

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

commit 9e87eb671143418ff2f2412dc43516582c1e775f
Author: Elif Bilgin <elifbilgin@google.com>
Date: Mon Feb 07 22:00:47 2022

Converting `invalidation tracker` related files in `room-runtime` from Java to Kotlin.

Test: BuilderTest.kt, InvalidationTrackerTest.kt, InvalidationLiveDataContainerTest.kt, ObservedTableTrackerTest.kt
Bug: 206859668
Relnote: Converting `invalidation tracker` related files in `room-runtime` from Java to Kotlin. This includes a source incompatible change for Kotlin users, which will require them to declare their `onInvalidate()` in their `Observer` to have a param of type `Set` and not `MutableSet`.
Change-Id: If2069426a29fffe312a58fcd3e116551090c0b4e

M room/room-paging/src/androidTest/kotlin/androidx/room/InvalidationTrackerExtRoomPaging.kt
M room/integration-tests/testapp/src/androidTest/java/androidx/room/InvalidationTrackerTrojan.java
M room/room-paging/src/androidTest/kotlin/androidx/room/paging/LimitOffsetPagingSourceTest.kt
M room/room-runtime/api/restricted_current.txt
M room/room-common/build.gradle
M room/room-ktx/src/androidTest/java/androidx/room/CoroutineRoomCancellationTest.kt
M room/room-runtime/api/current.txt
M room/room-runtime/src/main/java/androidx/room/MultiInstanceInvalidationService.kt
M room/benchmark/src/androidTest/java/androidx/room/benchmark/InvalidationTrackerBenchmark.kt
M room/room-ktx/src/main/java/androidx/room/CoroutinesRoom.kt
M room/room-runtime/api/public_plus_experimental_current.txt
A room/room-runtime/api/current.ignore
M room/room-runtime/api/restricted_current.ignore
M room/room-paging/src/main/java/androidx/room/paging/util/ThreadSafeInvalidationObserver.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/PagingSourceTest.kt
M room/room-runtime/src/test/java/androidx/room/InvalidationTrackerTest.java
M room/room-runtime/src/test/java/androidx/room/BuilderTest.java
M room/room-runtime/src/main/java/androidx/room/InvalidationLiveDataContainer.kt
M room/room-runtime/src/main/java/androidx/room/MultiInstanceInvalidationClient.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/InvalidationTrackerExt.kt
M room/room-runtime/src/main/java/androidx/room/Room.kt
M room/room-runtime/src/test/java/androidx/room/InvalidationLiveDataContainerTest.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/SyncTriggersConcurrencyTest.kt
M room/room-runtime/src/main/java/androidx/room/RoomTrackingLiveData.kt
M sqlite/integration-tests/inspection-room-testapp/src/androidTest/java/androidx/sqlite/inspection/RoomInvalidationHookTest.kt
M room/room-runtime/src/main/java/androidx/room/AutoCloser.java
M room/room-runtime/src/main/java/androidx/room/InvalidationTracker.kt
M room/room-runtime/src/test/java/androidx/room/BuilderTest_TestDatabase_Impl.java

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

navigation-advanced-sample-v2.7.5-main.zip

370 KB

Download

screenshot-leaderboard.png

865 KB

View

Download

screenshot-title.png

880 KB

View

Download

jb...@google.com <jb...@google.com> Nov 8, 2023 06:04PM

Assigned to cl...@google.com.

cl...@google.com <cl...@google.com> #6Dec 5, 2023 11:19PM

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

commit 3267211f72168a905ff880a4e34558185dc6c313
Author: Elif Bilgin <elifbilgin@google.com>
Date: Wed Apr 27 14:28:44 2022

Converting `auto closer` related files in `room-runtime` from Java to Kotlin.

Test: Existing tests
Bug: 206859668
Relnote: Converting `auto closer` related files in `room-runtime` from Java to Kotlin.
Change-Id: I6ee76590c1d110a4bb46219c126ef79177e3c975

M room/room-runtime/src/androidTest/java/androidx/room/AutoClosingRoomOpenHelperFactoryTest.kt
M room/room-runtime/src/main/java/androidx/room/RoomDatabase.java
M room/room-runtime/src/main/java/androidx/room/AutoClosingRoomOpenHelper.kt
M room/room-runtime/src/main/java/androidx/room/AutoClosingRoomOpenHelperFactory.kt
M room/room-runtime/src/main/java/androidx/room/AutoCloser.kt

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

ja...@icloud.com <ja...@icloud.com> #7Dec 6, 2023 12:59AM

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

commit a6f3b46c1dd9f4f1b419462c50451a120a863232
Author: Elif Bilgin <elifbilgin@google.com>
Date: Thu Apr 14 16:25:45 2022

Converting the final set of Java files in `room-runtime` from Java to Kotlin.

Test: Existing tests
Bug: 206859668
Relnote: Converting the final set of Java files in `room-runtime` from Java to Kotlin.
Change-Id: I96c25112c3ab32f8df71c1408c8006bdae1b3b7f

M room/room-runtime/src/androidTest/java/androidx/room/AutoClosingRoomOpenHelperTest.kt
M room/room-runtime/src/main/java/androidx/room/RoomDatabase.java
M room/room-runtime/src/main/java/androidx/room/AutoClosingRoomOpenHelper.kt
M room/room-runtime/src/main/java/androidx/room/SQLiteCopyOpenHelperFactory.kt
M room/room-runtime/api/restricted_current.txt
M room/room-runtime/src/test/java/androidx/room/SQLiteCopyOpenHelperTest.kt
M room/room-runtime/src/main/java/androidx/room/DatabaseConfiguration.kt
M room/room-runtime/src/main/java/androidx/room/EntityInsertionAdapter.kt
M room/room-runtime/src/main/java/androidx/room/EntityDeletionOrUpdateAdapter.kt
M room/room-runtime/src/main/java/androidx/room/SQLiteCopyOpenHelper.kt
M room/room-runtime/src/main/java/androidx/room/SharedSQLiteStatement.kt
M room/room-runtime/api/current.txt
M room/room-runtime/api/public_plus_experimental_current.txt
M room/room-runtime/api/current.ignore
M room/room-runtime/src/main/java/androidx/room/ExperimentalRoomApi.kt
M room/room-runtime/src/main/java/androidx/room/QueryInterceptorOpenHelper.kt
M room/room-testing/src/main/java/androidx/room/testing/MigrationTestHelper.java
M room/room-runtime/api/restricted_current.ignore
M room/room-runtime/src/main/java/androidx/room/DelegatingOpenHelper.kt

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

ap...@google.com <ap...@google.com> #8Dec 14, 2023 09:03PM

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

commit 3e34c01fd2679c1deb0d5ef4cdd76823f425a3ec
Author: Elif Bilgin <elifbilgin@google.com>
Date: Tue Jan 25 15:58:34 2022

Converting all RoomDatabase related files in `room-runtime` from Java to Kotlin.

Test: Existing tests
Bug: 206859668
Relnote: Converting all RoomDatabase related files in `room-runtime` from Java to Kotlin.
Change-Id: Ie4b55827902c6ddcc4cc004de8bb5286823e9ab5

M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/MultiTypedPagingSourceTest.kt
M room/room-paging-rxjava3/src/main/java/androidx/room/paging/rxjava3/LimitOffsetRxPagingSource.kt
M room/room-runtime/src/main/java/androidx/room/TransactionExecutor.kt
M room/room-paging/src/androidTest/kotlin/androidx/room/paging/LimitOffsetPagingSourceTest.kt
M room/room-runtime/api/restricted_current.txt
M room/room-runtime/src/test/java/androidx/room/RoomSQLiteQueryTest.java
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/ListenableFuturePagingSourceTest.kt
M room/room-runtime/src/main/java/androidx/room/RoomDatabase.kt
M room/room-ktx/src/androidTest/java/androidx/room/CoroutineRoomCancellationTest.kt
M room/room-paging-guava/src/main/java/androidx/room/paging/guava/LimitOffsetListenableFuturePagingSource.kt
M room/room-compiler/src/test/data/databasewriter/output/ComplexDatabase.java
M room/room-ktx/src/main/java/androidx/room/RoomDatabaseExt.kt
M room/room-runtime/src/main/java/androidx/room/RoomSQLiteQuery.kt
M room/room-runtime/api/current.txt
M room/room-runtime/src/main/java/androidx/room/RoomOpenHelper.kt
M room/room-ktx/src/main/java/androidx/room/CoroutinesRoom.kt
M room/room-runtime/api/public_plus_experimental_current.txt
M room/room-runtime/api/current.ignore
M room/room-runtime/api/restricted_current.ignore
M development/build_log_simplifier/messages.ignore
M room/room-runtime/src/test/java/androidx/room/InvalidationTrackerTest.java
M room/room-runtime/src/main/java/androidx/room/AutoCloser.kt
M room/room-compiler/src/main/kotlin/androidx/room/writer/SQLiteOpenHelperWriter.kt
M room/room-ktx/src/test/java/androidx/room/CoroutinesRoomTest.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/AlteredTableColumnOrderTest.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/Rx3PagingSourceTest.kt
M room/room-runtime/src/main/java/androidx/room/RoomTrackingLiveData.kt
M room/integration-tests/testapp/src/main/java/androidx/room/integration/testapp/SampleDatabaseService.java
M room/room-testing/src/main/java/androidx/room/testing/MigrationTestHelper.java
M sqlite/integration-tests/inspection-room-testapp/src/androidTest/java/androidx/sqlite/inspection/RoomInvalidationHookTest.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/Rx2PagingSourceTest.kt
M room/room-paging-rxjava2/src/main/java/androidx/room/paging/rxjava2/LimitOffsetRxPagingSource.kt
M room/room-runtime/src/main/java/androidx/room/InvalidationTracker.kt
M room/integration-tests/kotlintestapp/src/androidTest/java/androidx/room/integration/kotlintestapp/test/QueryInterceptorTest.kt

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

cl...@google.com <cl...@google.com> #9Dec 14, 2023 09:13PM

Fixed internally and will be available in navigation 2.8.0-alpha01.

il...@google.com <il...@google.com> Dec 19, 2023 09:48PM

Marked as fixed.

na...@google.com <na...@google.com> #10Jan 24, 2024 07:53PM

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

androidx.navigation:navigation-runtime:2.8.0-alpha01

Issue 309559751

Description

Issue summary

Comments

jb...@google.com <jb...@google.com> #2Nov 7, 2023 03:54PM

ja...@icloud.com <ja...@icloud.com> #3Nov 7, 2023 04:02PM

jb...@google.com <jb...@google.com> #4Nov 7, 2023 09:24PM

ja...@icloud.com <ja...@icloud.com> #5Nov 8, 2023 12:08AM

jb...@google.com <jb...@google.com> Nov 8, 2023 06:04PM

cl...@google.com <cl...@google.com> #6Dec 5, 2023 11:19PM

ja...@icloud.com <ja...@icloud.com> #7Dec 6, 2023 12:59AM

ap...@google.com <ap...@google.com> #8Dec 14, 2023 09:03PM

cl...@google.com <cl...@google.com> #9Dec 14, 2023 09:13PM

il...@google.com <il...@google.com> Dec 19, 2023 09:48PM

na...@google.com <na...@google.com> #10Jan 24, 2024 07:53PM

Add comment

Issue metadata