performScrollTo doesn't support LazyLists [178483889]

Fixed

Feature Request

Status Update

No update yet.

Description

mv...@google.com

created issue #1

Jan 26, 2021 04:48PM

Compose 1.0.0-alpha11 doesn't support scrolling in tests in Lazy components (i.e. LazyColumn and LazyRow).

SemanticsNodeInteraction.performScrollTo fails to scroll to composables that hasn't been already composed.

Comments

pa...@google.com <pa...@google.com> #2Feb 3, 2021 04:43PM

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

mv...@google.com <mv...@google.com> #3Feb 5, 2021 07:12AM

Is this something to be used in tests? or for the testing framework?

ph...@monzo.com <ph...@monzo.com> #4Apr 16, 2021 12:06PM

Any pointers on how we should tackle testing lazy screens right now? The linked blocking issue is internal.

pa...@google.com <pa...@google.com> Apr 20, 2021 12:23PM

Reassigned to je...@google.com.

je...@google.com <je...@google.com> #5Apr 20, 2021 01:59PM

Re: #comment4

There is a change in progress that will add some support for scrolling in lazy lists (https://r.android.com/1649407) which can land anytime now.

Another effort is on its way to add support to scroll a lazy list to content identified by a SemanticsMatcher (e.g. performScrollToNode(hasTestTag("recently_watched"))), but that is blocked on a few bigger changes in the semantics system.

ap...@google.com <ap...@google.com> #6Apr 20, 2021 08:56PM

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

commit 14511a46e45e620505a22c007211df14848e436c
Author: Jelle Fresen <jellefresen@google.com>
Date: Mon Mar 22 18:59:38 2021

Add scroll to item actions for LazyLists in tests

Defines a set of SemanticsPropertyKeys that are added in LazyList and
used in test actions to the effect of scrolling a LazyList to an item
that might not yet be composed.

Bug: 182259407
Bug: 178483889
Bug: 161584524
Fix: 183714443
Test: LazySemanticsTest, ScrollToIndexTest, ScrollToKeyTest
Relnote: "Added `SemanticsActions.ScrollToIndex` to scroll a list with
indexed items to the item with a certain index, and
`SemanticsProperties.IndexForKey` to get the index of an item in a list
with keyed items. Both actions are implemented by LazyList."
Relnote: "Added `SemanticsNodeInteraction.performScrollToIndex` that
scrolls a list to the given index, and
`SemanticsNodeInteraction.performScrollToKey` that scrolls a list to the
item with the given key."

Change-Id: I4fe63399fb620794651e1973730658877bcfeff4

M compose/foundation/foundation/api/1.0.0-beta06.txt
M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/public_plus_experimental_1.0.0-beta06.txt
M compose/foundation/foundation/api/public_plus_experimental_current.txt
M compose/foundation/foundation/api/restricted_1.0.0-beta06.txt
M compose/foundation/foundation/api/restricted_current.txt
A compose/foundation/foundation/src/androidAndroidTest/kotlin/androidx/compose/foundation/lazy/LazySemanticsTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/LazyList.kt
A compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/lazy/LazySemantics.kt
M compose/ui/ui-test/api/public_plus_experimental_1.0.0-beta06.txt
M compose/ui/ui-test/api/public_plus_experimental_current.txt
A compose/ui/ui-test/src/androidAndroidTest/kotlin/androidx/compose/ui/test/actions/ScrollToIndexTest.kt
A compose/ui/ui-test/src/androidAndroidTest/kotlin/androidx/compose/ui/test/actions/ScrollToKeyTest.kt
M compose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Actions.kt
M compose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Filters.kt
M compose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Output.kt
M compose/ui/ui/api/1.0.0-beta06.txt
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/public_plus_experimental_1.0.0-beta06.txt
M compose/ui/ui/api/public_plus_experimental_current.txt
M compose/ui/ui/api/restricted_1.0.0-beta06.txt
M compose/ui/ui/api/restricted_current.txt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/semantics/SemanticsProperties.kt

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

ap...@google.com <ap...@google.com> #7Aug 25, 2021 10:10AM

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

commit 03a127f4328088d51d61998d47cdeacce5e94e74
Author: Jelle Fresen <jellefresen@google.com>
Date: Tue Aug 10 14:56:41 2021

Graduate lazy list test scroll API

Move performScrollToIndex, performScrollToKey, hasScrollToIndexAction
and hasScrollToKeyAction to supported API surface.

Bug: 178483889
Test: ./gradlew compose:ui:ui-test:cC
Relnote: "`performScrollToIndex`, `performScrollToKey`,
`hasScrollToIndexAction` and `hasScrollToKeyAction` are now stable API"

Change-Id: I142aefdd8455195d30a6b029b76255f1f737939f

M compose/ui/ui-test/api/current.txt
M compose/ui/ui-test/api/public_plus_experimental_current.txt
M compose/ui/ui-test/api/restricted_current.txt
M compose/ui/ui-test/src/androidAndroidTest/kotlin/androidx/compose/ui/test/actions/ScrollToIndexTest.kt
M compose/ui/ui-test/src/androidAndroidTest/kotlin/androidx/compose/ui/test/actions/ScrollToKeyTest.kt
M compose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Actions.kt
M compose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Filters.kt

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

je...@google.com <je...@google.com> Sep 23, 2021 08:46AM

Accepted by je...@google.com.

je...@google.com <je...@google.com> #8Sep 30, 2021 10:23AM

Marked as fixed.

Fixed by aosp/1815782

al...@mercari.com <al...@mercari.com> #9Oct 21, 2021 10:11AM

Which Compose version has this been fixed?

je...@google.com <je...@google.com> #10Oct 21, 2021 11:06AM

performScrollToNode(matcher: SemanticsMatcher) was added in 1.1.0-alpha06

Note that by "fixed" I mean there is a solution, which is to use performScrollToNode(matcher: SemanticsMatcher) on the lazy list instead of performScrollTo() on the destination node.

oh...@mozilla.com <oh...@mozilla.com> #11Jun 24, 2022 12:44PM

We use the compose version 1.1.1 and while trying to scroll on a lazy list with performScrollToNode [ rule.onNode(hasScrollAction()).performScrollToNode(hasText(language)) ], I get this error:

java.lang.IllegalArgumentException: Failed requirement.
at androidx.compose.ui.node.MeasureAndLayoutDelegate.measureAndLayout(MeasureAndLayoutDelegate.kt:190)
at androidx.compose.ui.platform.AndroidComposeView.measureAndLayout(AndroidComposeView.android.kt:662)
at androidx.compose.ui.node.Owner$DefaultImpls.measureAndLayout$default(Owner.kt:182)
at androidx.compose.ui.node.LayoutNode.forceRemeasure(LayoutNode.kt:1339)
at androidx.compose.foundation.lazy.layout.LazyLayoutState.remeasure(LazyLayoutState.kt:54)
at androidx.compose.foundation.lazy.LazyListState.snapToItemIndexInternal$foundation_release(LazyListState.kt:202)
at androidx.compose.foundation.lazy.LazyListState$scrollToItem$2.invokeSuspend(LazyListState.kt:194)
at androidx.compose.foundation.lazy.LazyListState$scrollToItem$2.invoke(Unknown Source:8)
at androidx.compose.foundation.lazy.LazyListState$scrollToItem$2.invoke(Unknown Source:4)

The only way it worked was by replacing scrollToItem(index) with animateScrollToItem(index) in the production code.

ma...@gmail.com <ma...@gmail.com> #12Mar 14, 2023 09:19PM

I had a similar error. My issue was solved when I found out that I called scrollToItem in from the IO dispatcher by accident, giving this same error.

se...@gmail.com <se...@gmail.com> #13Mar 18, 2023 08:36PM

Comment has been deleted.

Message last modified on Mar 18, 2023 09:55PM