DataSource.Factory with map/mapByPage does not invalidate source in Paging 3 [165313046]

Fixed

Bug

Status Update

No update yet.

Description

ti...@chainels.com

created issue #1

Aug 18, 2020 07:13PM

Component used: Paging
Version used: 3.0 alpha-04
Devices/Android versions reproduced on: n/a

Today (after many hours of debugging) I seem to have found a bug in latest alpha version of the Paging library. In my app I still have various lists that are not yet migrated to the new v3 API's, but since the documentation states it's backward compatible I figured that was okay.

Those lists use the database + remote pattern. One such list displayed strange behavior, it seemed to call all the boundary callbacks correctly, do the API call, and insert the new items in the database, however the items in the RecyclerView did not change.

The only difference that I could find between that list and other lists that were functioning correctly, is that it used a map function on the Datasource.Factory returned by Room

I think I found the underlying issue. The data source does not seem to be invalidated when using a map function.

DataSource has two variants of addOnValidationCallback. An open function DataSource.kt:366 and a final function that accepts Kotlin functions DataSource.kt:385

The Kotlin version is actually called in LegacyPagingSource

However when using a map/mapByPage function on the factory returned by room, the source is wrapped and in that class (WrappedDataSource, but also WrapperPositionalDataSource for example) only the non Kotlin version of addOnValidationCallback is overridden, and thus if called with the Kotlin version, addOnValidationCallback is never called on the source of the wrapper.

I could see when debugging that indeed onInvalidatedCallbacks is empty.

Hopefully this is actually the cause of the behavior I'm seeing. The Paging code is quite complex so I could be missing something else.

Comments

du...@google.com <du...@google.com> #2Aug 19, 2020 05:12PM

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

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

du...@google.com <du...@google.com> #3Sep 4, 2020 03:28AM

Accepted by du...@google.com.

Fix is up here: https://android-review.googlesource.com/c/platform/frameworks/support/+/1419738

Again, thank you for such detailed analysis on your part, made it a breeze to fix.

ti...@chainels.com <ti...@chainels.com> #4Sep 4, 2020 12:25PM

Thanks! I assume it will be released in the next alpha?

du...@google.com <du...@google.com> #5Sep 5, 2020 06:32PM

This fix is slated to be released with alpha07, which should be the next one.

du...@google.com <du...@google.com> #6Sep 23, 2020 04:18AM

Spoke too soon, I had thought it had already merged, but looks like this will instead end up landing in alpha08

ap...@google.com <ap...@google.com> #7Oct 13, 2020 04:11PM

Marked as fixed.

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

commit 0680b894e3f13d0a93415a3cc0d9543135e179c5
Author: Dustin Lam <dustinlam@google.com>
Date: Thu Sep 03 20:19:24 2020

Ensure kotlin invalidate callbacks are called by WrapperDataSources

Relnote: "The Kotlin / Java variants of DataSource.InvalidatedCallback
have been combined by enabling SAM-conversions in Kotlin via functional
interface (available in Kotlin 1.4). This also fixes a bug where the
kotlin variant of invalidate callbacks were not called after transformed
by .map or .mapByPage."
Fixes: 165313046
Test: ./gradlew paging:paging-common:test
Change-Id: I1f244498bd9f78bfed2744d9e6c9d5c1c1448971

M paging/common/api/current.txt
M paging/common/api/public_plus_experimental_current.txt
M paging/common/api/restricted_current.txt
M paging/common/src/main/kotlin/androidx/paging/DataSource.kt
M paging/common/src/main/kotlin/androidx/paging/WrapperPageKeyedDataSource.kt
M paging/common/src/main/kotlin/androidx/paging/WrapperPositionalDataSource.kt
M paging/common/src/test/kotlin/androidx/paging/LegacyPagingSourceTest.kt
M paging/common/src/test/kotlin/androidx/paging/PagedListTest.kt
A paging/common/src/test/kotlin/androidx/paging/WrappedItemKeyedDataSourceTest.kt
A paging/common/src/test/kotlin/androidx/paging/WrappedPageKeyedDataSourceTest.kt
A paging/common/src/test/kotlin/androidx/paging/WrappedPositionalDataSourceTest.kt
M paging/runtime/src/androidTest/java/androidx/paging/AsyncPagedListDifferTest.kt
M paging/rxjava2/src/test/java/androidx/paging/RxPagedListBuilderTest.kt
A testutils/testutils-paging/src/main/java/androidx/paging/TestItemKeyedDataSource.kt
A testutils/testutils-paging/src/main/java/androidx/paging/TestPageKeyedDataSource.kt
M testutils/testutils-paging/src/main/java/androidx/paging/TestPositionalDataSource.kt

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

Issue 165313046