Skip to content

Commit

Permalink
Prevent unnecessary recompositions in the book overview screen.
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulWoitaschek committed Mar 13, 2022
1 parent df8174a commit 6d744cb
Show file tree
Hide file tree
Showing 7 changed files with 126 additions and 20 deletions.
1 change: 1 addition & 0 deletions .idea/dictionaries/ph1b.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

@@ -1,5 +1,6 @@
package voice.bookOverview

import androidx.compose.runtime.Immutable
import voice.data.Book
import java.io.File

Expand All @@ -23,6 +24,7 @@ sealed interface BookOverviewViewState {
override val showAddBookHint: Boolean,
) : BookOverviewViewState {

@Immutable
data class BookViewState(
val name: String,
val author: String?,
Expand Down
Expand Up @@ -79,10 +79,10 @@ fun BookOverview(
is BookOverviewViewState.Content -> {
when (viewState.layoutMode) {
BookOverviewViewState.Content.LayoutMode.List -> {
ListBooks(viewState, onBookClick)
ListBooks(viewState.books, onBookClick)
}
BookOverviewViewState.Content.LayoutMode.Grid -> {
GridBooks(viewState, onBookClick)
GridBooks(viewState.books, onBookClick)
}
}
}
Expand Down
17 changes: 11 additions & 6 deletions bookOverview/src/main/kotlin/voice/bookOverview/views/GridBooks.kt
@@ -1,7 +1,6 @@
package voice.bookOverview.views

import androidx.compose.foundation.Image
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.PaddingValues
Expand All @@ -25,21 +24,25 @@ import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.unit.dp
import coil.compose.rememberImagePainter
import voice.bookOverview.BookOverviewCategory
import voice.bookOverview.BookOverviewViewState
import voice.bookOverview.R
import voice.data.Book
import kotlin.math.roundToInt

@Composable
internal fun GridBooks(viewState: BookOverviewViewState.Content, onBookClick: (Book.Id) -> Unit) {
internal fun GridBooks(
books: Map<BookOverviewCategory, List<BookOverviewViewState.Content.BookViewState>>,
onBookClick: (Book.Id) -> Unit
) {
val cellCount = gridColumnCount()
LazyVerticalGrid(
columns = GridCells.Fixed(cellCount),
verticalArrangement = Arrangement.spacedBy(8.dp),
horizontalArrangement = Arrangement.spacedBy(8.dp),
contentPadding = PaddingValues(start = 8.dp, end = 8.dp, top = 24.dp, bottom = 4.dp),
) {
viewState.books.forEach { (category, books) ->
books.forEach { (category, books) ->
if (books.isEmpty()) return@forEach
item(
span = { GridItemSpan(maxLineSpan) },
Expand Down Expand Up @@ -68,9 +71,11 @@ private fun GridBook(
onBookClick: (Book.Id) -> Unit,
) {
Card(
Modifier
.fillMaxWidth()
.clickable { onBookClick(book.id) }) {
onClick = {
onBookClick(book.id)
},
modifier = Modifier.fillMaxWidth()
) {
Column {
Image(
modifier = Modifier
Expand Down
Expand Up @@ -2,7 +2,6 @@ package voice.bookOverview.views

import androidx.compose.foundation.Image
import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.PaddingValues
Expand All @@ -25,17 +24,18 @@ import androidx.compose.ui.text.intl.LocaleList
import androidx.compose.ui.text.toUpperCase
import androidx.compose.ui.unit.dp
import coil.compose.rememberImagePainter
import voice.bookOverview.BookOverviewCategory
import voice.bookOverview.BookOverviewViewState
import voice.bookOverview.R
import voice.data.Book

@Composable
internal fun ListBooks(viewState: BookOverviewViewState.Content, onBookClick: (Book.Id) -> Unit) {
internal fun ListBooks(books: Map<BookOverviewCategory, List<BookOverviewViewState.Content.BookViewState>>, onBookClick: (Book.Id) -> Unit) {
LazyColumn(
verticalArrangement = Arrangement.spacedBy(8.dp),
contentPadding = PaddingValues(top = 24.dp, start = 8.dp, end = 8.dp, bottom = 16.dp)
) {
viewState.books.forEach { (category, books) ->
books.forEach { (category, books) ->
if (books.isEmpty()) return@forEach
stickyHeader(
key = category,
Expand All @@ -51,11 +51,10 @@ internal fun ListBooks(viewState: BookOverviewViewState.Content, onBookClick: (B
}
items(
items = books,
key = { it.id },
key = { it.id.value },
contentType = { "item" }
) { book ->
ListBookRow(
modifier = Modifier.animateItemPlacement(),
book = book,
onBookClick = onBookClick
)
Expand All @@ -71,9 +70,10 @@ private fun ListBookRow(
onBookClick: (Book.Id) -> Unit,
) {
Card(
modifier
.fillMaxWidth()
.clickable { onBookClick(book.id) }
modifier = modifier.fillMaxWidth(),
onClick = {
onBookClick(book.id)
},
) {
Column {
Row {
Expand Down
102 changes: 102 additions & 0 deletions common/src/main/kotlin/voice/common/recomposeHighlighter.kt
@@ -0,0 +1,102 @@
package voice.common

import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.Stable
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.composed
import androidx.compose.ui.draw.drawWithCache
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.SolidColor
import androidx.compose.ui.graphics.drawscope.Fill
import androidx.compose.ui.graphics.drawscope.Stroke
import androidx.compose.ui.graphics.lerp
import androidx.compose.ui.platform.debugInspectorInfo
import androidx.compose.ui.unit.dp
import kotlinx.coroutines.delay
import kotlin.math.min

/**
* License: Apache 2,
* @see (https://github.com/android/snippets/blob/c4d6aaffb03721fdfe4dbb9612b4d3d9de4dd8e1/compose/recomposehighlighter/src/main/java/com/example/android/compose/recomposehighlighter/RecomposeHighlighter.kt)
* A [Modifier] that draws a border around elements that are recomposing. The border increases in
* size and interpolates from red to green as more recompositions occur before a timeout.
*/
@Suppress("unused")
@Stable
fun Modifier.recomposeHighlighter(): Modifier = this.then(recomposeModifier)

// Use a single instance + @Stable to ensure that recompositions can enable skipping optimizations
// Modifier.composed will still remember unique data per call site.
private val recomposeModifier =
Modifier.composed(inspectorInfo = debugInspectorInfo { name = "recomposeHighlighter" }) {
// The total number of compositions that have occurred. We're not using a State<> here be
// able to read/write the value without invalidating (which would cause infinite
// recomposition).
val totalCompositions = remember { arrayOf(0L) }
totalCompositions[0]++

// The value of totalCompositions at the last timeout.
val totalCompositionsAtLastTimeout = remember { mutableStateOf(0L) }

// Start the timeout, and reset everytime there's a recomposition. (Using totalCompositions
// as the key is really just to cause the timer to restart every composition).
LaunchedEffect(totalCompositions[0]) {
delay(3000)
totalCompositionsAtLastTimeout.value = totalCompositions[0]
}

Modifier.drawWithCache {
onDrawWithContent {
// Draw actual content.
drawContent()

// Below is to draw the highlight, if necessary. A lot of the logic is copied from
// Modifier.border
val numCompositionsSinceTimeout =
totalCompositions[0] - totalCompositionsAtLastTimeout.value

val hasValidBorderParams = size.minDimension > 0f
if (!hasValidBorderParams || numCompositionsSinceTimeout <= 0) {
return@onDrawWithContent
}

val (color, strokeWidthPx) =
when (numCompositionsSinceTimeout) {
// We need at least one composition to draw, so draw the smallest border
// color in blue.
1L -> Color.Blue to 1f
// 2 compositions is _probably_ okay.
2L -> Color.Green to 2.dp.toPx()
// 3 or more compositions before timeout may indicate an issue. lerp the
// color from yellow to red, and continually increase the border size.
else -> {
lerp(
Color.Yellow.copy(alpha = 0.8f),
Color.Red.copy(alpha = 0.5f),
min(1f, (numCompositionsSinceTimeout - 1).toFloat() / 100f)
) to numCompositionsSinceTimeout.toInt().dp.toPx()
}
}

val halfStroke = strokeWidthPx / 2
val topLeft = Offset(halfStroke, halfStroke)
val borderSize = Size(size.width - strokeWidthPx, size.height - strokeWidthPx)

val fillArea = (strokeWidthPx * 2) > size.minDimension
val rectTopLeft = if (fillArea) Offset.Zero else topLeft
val size = if (fillArea) size else borderSize
val style = if (fillArea) Fill else Stroke(strokeWidthPx)

drawRect(
brush = SolidColor(color),
topLeft = rectTopLeft,
size = size,
style = style
)
}
}
}
4 changes: 0 additions & 4 deletions data/src/main/kotlin/voice/data/Book.kt
Expand Up @@ -20,8 +20,6 @@ data class Book(

val id: Id = content.id

val transitionName: String = id.transitionName

init {
check(chapters.size == content.chapters.size) {
"Different chapter count in $this"
Expand Down Expand Up @@ -50,8 +48,6 @@ data class Book(
@Parcelize
data class Id(val value: String) : Parcelable {

val transitionName: String get() = value

constructor(uri: Uri) : this(uri.toString())

fun toUri(): Uri {
Expand Down

0 comments on commit 6d744cb

Please sign in to comment.