Improve usability of asPagingSourceFactory in paging-testing [280655188]

Fixed

Feature Request

Status Update

No update yet.

Description

cl...@google.com

created issue #1

May 3, 2023 08:22PM

UXR studies show difficulties with using the `Flow<List>.asPagingSourceFactory` API in paging-testing library.

Improvements considered include:
1. Add an actual `PagingSourceFactory` class. Right now this factory concept exists in Paging3 merely as lambda of type `() -> PagingSource<Key, Value>`.
2. Making `asPagingSourceFactory` return this concrete class rather than a lambda

Comments

ap...@google.com <ap...@google.com> #2May 4, 2023 05:32PM

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

commit 2099e20d0af61318ec59b5c6391498304979e024
Author: Clara Fok <clarafok@google.com>
Date: Wed May 03 14:38:14 2023

Migrate paging-testing to PagingSourceFactory

Migrate existing usages of lambda type () -> PagingSource<Key, Value> to concrete PagingSourceFactory<Key, Value> type

Test: ./gradlew paging:paging-testing:cC
Bug: 280655188
Relnote: "Migrated paging-testing's use of lambda type () -> PagingSource<Key, Value> to type PagingSourceFactory<Key, Value>."
Change-Id: I4a95067989fabf8258a3392007dbf8abd35d8efa

M paging/paging-testing/api/current.txt
M paging/paging-testing/api/public_plus_experimental_current.txt
M paging/paging-testing/api/restricted_current.txt
M paging/paging-testing/src/main/java/androidx/paging/testing/StaticListPagingSourceFactory.kt
M paging/paging-testing/src/test/kotlin/androidx/paging/testing/PagerFlowSnapshotTest.kt
M paging/paging-testing/src/test/kotlin/androidx/paging/testing/StaticListPagingSourceFactoryTest.kt

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

ap...@google.com <ap...@google.com> #3May 4, 2023 05:32PM

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

commit f06753ed29d67623b4061cb222717948d0a37ef7
Author: Clara Fok <clarafok@google.com>
Date: Wed May 03 13:16:53 2023

Add PagingSourceFactory interface

This functional interface allows creating a PagingSourceFactory by passing in a lambda that returns a PagingSource, or by creating a class that extends this interface. The factory can be passed into Pager as the pagingSourceFactory.

Test: ./gradlew paging:paging-common:test
Bug: 280655188
Relnote: "Added a new PagingSourceFactory functional interface. Override the invoke() method with an implementation that returns a new instance of PagingSource. This factory can be used to instantiate a Pager."
Change-Id: I3316590a0d667566edeb40d4e99e005cd6cee3ac

M paging/paging-common/api/current.txt
M paging/paging-common/api/public_plus_experimental_current.txt
M paging/paging-common/api/restricted_current.txt
M paging/paging-common/src/main/kotlin/androidx/paging/InvalidatingPagingSourceFactory.kt
A paging/paging-common/src/main/kotlin/androidx/paging/PagingSourceFactory.kt

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

ap...@google.com <ap...@google.com> #4May 5, 2023 12:47AM

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

commit 967c97f18d7f2a717222b09be6227f0f7dabb323
Author: Clara Fok <clarafok@google.com>
Date: Thu May 04 13:06:24 2023

Update documentation for asPagingSourceFactory API

Kdocs updated to reflec the API's migration from returning a lambda to returning a Class.

Test: n/a
Bug: 280655188
Change-Id: Ib3f9b5c9215ba9e5ee38d6b192e9858bbe080346

M paging/paging-testing/src/main/java/androidx/paging/testing/StaticListPagingSourceFactory.kt

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

ap...@google.com <ap...@google.com> #5May 5, 2023 12:47AM

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

commit 59e0f757ba85b81b800e6fb0d60dd25dd88bee54
Author: Clara Fok <clarafok@google.com>
Date: Thu May 04 12:52:34 2023

Expand asPagingSourceFactory API to singe list

In addition to Flow<List<Value>>.asPagingSourceFactory API, we added a List<Value>.asPagingSourceFactory. All PagingSoruces produced by this new API will load from the exact same static list of data. It supports multi-generational operations such as refresh, but it does not support any updates to the source data. Because it operates on a static list, collection is not required which removes the requirement for a coroutineScope.

Test: ./gradlew paging:paging-testing:test
Bug: 280655188
Relnote: "Added new API List<Value>.asPagingSourceFactory to get a factory that creates PagingSource instances that loads from the immutable list of data."
Change-Id: Id34d1361119413d0c19a054a2e23dd26241faa6f

M paging/paging-testing/api/current.txt
M paging/paging-testing/api/public_plus_experimental_current.txt
M paging/paging-testing/api/restricted_current.txt
M paging/paging-testing/src/main/java/androidx/paging/testing/StaticListPagingSourceFactory.kt
M paging/paging-testing/src/test/kotlin/androidx/paging/testing/PagerFlowSnapshotTest.kt
M paging/paging-testing/src/test/kotlin/androidx/paging/testing/StaticListPagingSourceFactoryTest.kt

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

cl...@google.com <cl...@google.com> #6May 17, 2023 10:14PM

Marked as fixed.

Fixed internally and will be available in paging 3.2.0-alpha06.

ju...@google.com <ju...@google.com> #7May 24, 2023 07:37PM

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

androidx.paging:paging-common:3.2.0-alpha06
androidx.paging:paging-testing:3.2.0-alpha06

Issue 280655188