mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
Find a Text's clickable spans only when a touch needs them
## Summary:
`PreparedLayoutTextView` collects the `ClickableSpan`s of its text every time its prepared layout changes, which is every time the text is updated: it walks the text with `nextSpanTransition`, calls `getSpans` for each segment and copies the results into a list. The list itself is never read. Touch handling only checks whether it is empty before hit testing a tap, and focus handling only checks it before clearing the selection.
With this change, touch handling checks whether the text has a `ClickableSpan` on its first touch after a layout change, with a single `getSpans`, and keeps the answer until the next layout change. Losing focus clears the selection when there is one, which is the state it resets, instead of looking at the spans. Texts that are never touched no longer pay for the scan.
This is the main thread work done for every update of a `Text` whose spannable has spans, so it adds up on screens where many texts change often (lists of messages, prices, scores, counters).
## Changelog:
[ANDROID] [CHANGED] - Find the clickable spans of a Text only when it is touched, instead of on every text update
## Test Plan:
- New `PreparedLayoutTextViewClickableSpanTest`: tapping a `ClickableSpan` clicks it; after the text is replaced by one without clickable spans a tap no longer clicks; after the text is replaced by one with a clickable span a tap clicks it. `./gradlew :packages:react-native:ReactAndroid:testDebugUnitTest --tests 'com.facebook.react.views.text.*'` passes (104 tests).
- `yarn format-check-kotlin` reports no changes.
- **On a device.** Two RNTester release APKs built from the same local checkout (with local benchmark screens, and `PreparedLayoutTextView.kt` identical to `main` at 9bc1a28a96), without and with this change, installed alternately on a moto g57 power (Android 16). Each install first opens a screen with a static text containing a nested `<Text onPress>` link and taps the link: `onPress` fired once on every install of both builds (10 installs). Then a Playground screen of 200 rich text rows (bold, colored, italic and a link per row) where every row changes every 100 ms runs for 30 s, and the main and JS thread CPU time is read from `/proc`:
| | before | this PR | change |
|---|--:|--:|--:|
| Main thread, 30 s | 4.88 / 5.01 s | 4.61 / 4.64 s | −6.5% |
| JS thread, 30 s | 15.00 / 14.66 s | 14.67 / 14.69 s | no change |
Three earlier rounds, with a build that differed only in the focus check (which this screen never runs), gave the same result: main thread 4.97 / 5.15 / 4.93 s before and 4.68 / 4.65 / 4.70 s after (−6.8%).
In a simpleperf profile of the same screen before this change, collecting the spans (`nextSpanTransition`, `getSpans` and the list copies in the `preparedLayout` setter, called from `PreparedLayoutTextViewManager.updateExtraData`) was about 5% of the main thread.
- Not covered by a unit test: the focus change path, which now checks `selection != null` (the selection is private).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Differential Revision: D128363239
Pull Request resolved: https://github.com/react/react-native/pull/59583
This commit is contained in:
1 parent
04c6ea43ad
commit
480fe97660
2 files changed
+156
-21
No files matched your search
+15
-21
@@ -48,7 +48,9 @@ import kotlin.math.roundToInt
|
||||
@DoNotStrip
|
||||
internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), ReactCompoundView {
|
||||
|
||||
private var clickableSpans: List<ClickableSpan> = emptyList()
|
||||
// Whether the text has a ClickableSpan. Only touch handling needs it, so it is found on first use
|
||||
// rather than on every text update; null until then.
|
||||
private var hasClickableSpansCache: Boolean? = null
|
||||
private var selection: TextSelection? = null
|
||||
private var lastFrameTimeNanos: Long = 0L
|
||||
|
||||
@@ -72,8 +74,7 @@ internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), Re
|
||||
}
|
||||
}
|
||||
|
||||
clickableSpans =
|
||||
effectiveValue?.layout?.text?.let { filterClickableSpans(it) } ?: emptyList()
|
||||
hasClickableSpansCache = null
|
||||
|
||||
field = effectiveValue
|
||||
invalidate()
|
||||
@@ -105,11 +106,11 @@ internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), Re
|
||||
fun recycleView() {
|
||||
BackgroundStyleApplicator.reset(this)
|
||||
overflow = Overflow.VISIBLE
|
||||
clickableSpans = emptyList()
|
||||
selection = null
|
||||
selectionColor = null
|
||||
lastFrameTimeNanos = 0L
|
||||
preparedLayout = null
|
||||
hasClickableSpansCache = null
|
||||
}
|
||||
|
||||
override fun onVisibilityChanged(changedView: View, visibility: Int) {
|
||||
@@ -277,7 +278,7 @@ internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), Re
|
||||
}
|
||||
|
||||
// Existing ClickableSpan handling
|
||||
if (clickableSpans.isEmpty()) {
|
||||
if (!hasClickableSpans()) {
|
||||
return super.onTouchEvent(event)
|
||||
}
|
||||
|
||||
@@ -301,6 +302,10 @@ internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), Re
|
||||
return true
|
||||
}
|
||||
|
||||
private fun hasClickableSpans(): Boolean =
|
||||
hasClickableSpansCache
|
||||
?: hasClickableSpan(preparedLayout?.layout?.text).also { hasClickableSpansCache = it }
|
||||
|
||||
private fun findRootView(): RootView? {
|
||||
var p: ViewParent? = parent
|
||||
while (p != null) {
|
||||
@@ -413,7 +418,7 @@ internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), Re
|
||||
direction: Int,
|
||||
previouslyFocusedRect: Rect?,
|
||||
) {
|
||||
if (clickableSpans.isNotEmpty() && !gainFocus) {
|
||||
if (!gainFocus && selection != null) {
|
||||
clearSelection()
|
||||
}
|
||||
super.onFocusChanged(gainFocus, direction, previouslyFocusedRect)
|
||||
@@ -475,21 +480,10 @@ internal class PreparedLayoutTextView(context: Context) : ViewGroup(context), Re
|
||||
private companion object {
|
||||
private val selectionPaint = Paint()
|
||||
|
||||
private fun filterClickableSpans(text: CharSequence): List<ClickableSpan> {
|
||||
if (text !is Spanned) {
|
||||
return emptyList()
|
||||
}
|
||||
|
||||
val spans = ArrayList<ClickableSpan>()
|
||||
var i = 0
|
||||
while (i < text.length) {
|
||||
val next = text.nextSpanTransition(i, text.length, ClickableSpan::class.java)
|
||||
spans.addAll(text.getSpans(i, next, ClickableSpan::class.java))
|
||||
i = next
|
||||
}
|
||||
|
||||
return spans
|
||||
}
|
||||
private fun hasClickableSpan(text: CharSequence?): Boolean =
|
||||
text is Spanned &&
|
||||
text.isNotEmpty() &&
|
||||
text.getSpans(0, text.length, ClickableSpan::class.java).isNotEmpty()
|
||||
|
||||
/**
|
||||
* If the layout contains [StatefulSpan]s, returns a new [PreparedLayout] whose spannable has
|
||||
|
||||
+141
@@ -0,0 +1,141 @@
|
||||
/*
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
package com.facebook.react.views.text
|
||||
|
||||
import android.annotation.SuppressLint
|
||||
import android.graphics.text.LineBreakConfig
|
||||
import android.os.SystemClock
|
||||
import android.text.Layout
|
||||
import android.text.Spannable
|
||||
import android.text.SpannableString
|
||||
import android.text.TextPaint
|
||||
import android.text.style.ClickableSpan
|
||||
import android.view.MotionEvent
|
||||
import android.view.View
|
||||
import com.facebook.react.common.annotations.UnstableReactNativeAPI
|
||||
import com.facebook.react.common.mapbuffer.WritableMapBuffer
|
||||
import com.facebook.yoga.YogaMeasureMode
|
||||
import org.assertj.core.api.Assertions.assertThat
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import org.robolectric.RobolectricTestRunner
|
||||
import org.robolectric.RuntimeEnvironment
|
||||
import org.robolectric.annotation.Config
|
||||
import org.robolectric.annotation.GraphicsMode
|
||||
|
||||
/** Tapping a [ClickableSpan] in a [PreparedLayoutTextView] clicks it, for the current text only. */
|
||||
@OptIn(UnstableReactNativeAPI::class)
|
||||
@RunWith(RobolectricTestRunner::class)
|
||||
@SuppressLint("NewApi")
|
||||
@Config(sdk = [34])
|
||||
@GraphicsMode(GraphicsMode.Mode.NATIVE)
|
||||
class PreparedLayoutTextViewClickableSpanTest {
|
||||
|
||||
private val view = PreparedLayoutTextView(RuntimeEnvironment.getApplication())
|
||||
|
||||
@Test
|
||||
fun `tapping a clickable span clicks it`() {
|
||||
val span = CountingClickableSpan()
|
||||
view.preparedLayout = preparedLayout(textWith(span))
|
||||
|
||||
assertThat(tap()).isTrue()
|
||||
assertThat(span.clicks).isEqualTo(1)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `tapping text without clickable spans does not click`() {
|
||||
val span = CountingClickableSpan()
|
||||
view.preparedLayout = preparedLayout(textWith(span))
|
||||
tap()
|
||||
|
||||
view.preparedLayout = preparedLayout(SpannableString(TEXT))
|
||||
|
||||
assertThat(tap()).isFalse()
|
||||
assertThat(span.clicks).isEqualTo(1)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `tapping a clickable span in new text clicks it`() {
|
||||
view.preparedLayout = preparedLayout(SpannableString(TEXT))
|
||||
tap()
|
||||
|
||||
val span = CountingClickableSpan()
|
||||
view.preparedLayout = preparedLayout(textWith(span))
|
||||
|
||||
assertThat(tap()).isTrue()
|
||||
assertThat(span.clicks).isEqualTo(1)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `a recycled view does not click spans of its previous text`() {
|
||||
val span = CountingClickableSpan()
|
||||
view.preparedLayout = preparedLayout(textWith(span))
|
||||
tap()
|
||||
|
||||
view.recycleView()
|
||||
|
||||
assertThat(tap()).isFalse()
|
||||
assertThat(span.clicks).isEqualTo(1)
|
||||
}
|
||||
|
||||
/** Sends a down and an up at the start of the text; returns whether the up was handled. */
|
||||
private fun tap(): Boolean {
|
||||
val time = SystemClock.uptimeMillis()
|
||||
val down = MotionEvent.obtain(time, time, MotionEvent.ACTION_DOWN, 5f, 5f, 0)
|
||||
val up = MotionEvent.obtain(time, time, MotionEvent.ACTION_UP, 5f, 5f, 0)
|
||||
view.onTouchEvent(down)
|
||||
val handled = view.onTouchEvent(up)
|
||||
down.recycle()
|
||||
up.recycle()
|
||||
return handled
|
||||
}
|
||||
|
||||
private fun textWith(span: ClickableSpan): SpannableString =
|
||||
SpannableString(TEXT).apply {
|
||||
setSpan(span, 0, TEXT.length, Spannable.SPAN_INCLUSIVE_INCLUSIVE)
|
||||
}
|
||||
|
||||
private fun preparedLayout(text: SpannableString): PreparedLayout =
|
||||
PreparedLayout(
|
||||
TextLayoutManager.createLayout(
|
||||
text,
|
||||
/* boring = */ null,
|
||||
/* width = */ 400f,
|
||||
YogaMeasureMode.EXACTLY,
|
||||
/* includeFontPadding = */ false,
|
||||
/* textBreakStrategy = */ Layout.BREAK_STRATEGY_HIGH_QUALITY,
|
||||
/* hyphenationFrequency = */ Layout.HYPHENATION_FREQUENCY_NONE,
|
||||
/* lineBreakStyle = */ LineBreakConfig.LINE_BREAK_STYLE_NONE,
|
||||
/* lineBreakWordStyle = */ LineBreakConfig.LINE_BREAK_WORD_STYLE_NONE,
|
||||
Layout.Alignment.ALIGN_NORMAL,
|
||||
/* justificationMode = */ 0,
|
||||
/* ellipsizeMode = */ null,
|
||||
/* maxNumberOfLines = */ 0,
|
||||
TextPaint(TextPaint.ANTI_ALIAS_FLAG).apply { textSize = 26f },
|
||||
),
|
||||
/* maximumNumberOfLines = */ 0,
|
||||
/* verticalOffset = */ 0f,
|
||||
/* reactTags = */ IntArray(0),
|
||||
/* textBreakStrategy = */ Layout.BREAK_STRATEGY_HIGH_QUALITY,
|
||||
/* justificationMode = */ 0,
|
||||
baseTextAttributes = TextAttributeProps.fromMapBuffer(WritableMapBuffer()),
|
||||
/* sourceText = */ text,
|
||||
)
|
||||
|
||||
private class CountingClickableSpan : ClickableSpan() {
|
||||
var clicks = 0
|
||||
|
||||
override fun onClick(widget: View) {
|
||||
clicks++
|
||||
}
|
||||
}
|
||||
|
||||
private companion object {
|
||||
const val TEXT = "Tap this text"
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user